Mercurial > vim
annotate runtime/doc/options.txt @ 28313:b418e073b42f v8.2.4682
patch 8.2.4682: Vim9: can use :unlockvar for const variable
Commit: https://github.com/vim/vim/commit/7a411a306f90339d8686e42ac16e1ae4fc7533c5
Author: Bram Moolenaar <Bram@vim.org>
Date: Mon Apr 4 14:58:06 2022 +0100
patch 8.2.4682: Vim9: can use :unlockvar for const variable
Problem: Vim9: can use :unlockvar for const variable. (Ernie Rael)
Solution: Check whether the variable is a const.
| author | Bram Moolenaar <Bram@vim.org> |
|---|---|
| date | Mon, 04 Apr 2022 16:00:03 +0200 |
| parents | 4190b932e6ca |
| children | 8bc8071928ed |
| rev | line source |
|---|---|
| 28246 | 1 *options.txt* For Vim version 8.2. Last change: 2022 Mar 29 |
| 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* | |
|
19137
69f0e9b5c107
patch 8.2.0128: cannot list options one per line
Bram Moolenaar <Bram@vim.org>
parents:
19116
diff
changeset
|
25 :se[t][!] Show all options that differ from their default value. |
|
69f0e9b5c107
patch 8.2.0128: cannot list options one per line
Bram Moolenaar <Bram@vim.org>
parents:
19116
diff
changeset
|
26 When [!] is present every option is on a separate |
|
69f0e9b5c107
patch 8.2.0128: cannot list options one per line
Bram Moolenaar <Bram@vim.org>
parents:
19116
diff
changeset
|
27 line. |
|
69f0e9b5c107
patch 8.2.0128: cannot list options one per line
Bram Moolenaar <Bram@vim.org>
parents:
19116
diff
changeset
|
28 |
|
69f0e9b5c107
patch 8.2.0128: cannot list options one per line
Bram Moolenaar <Bram@vim.org>
parents:
19116
diff
changeset
|
29 :se[t][!] all Show all but terminal options. |
|
69f0e9b5c107
patch 8.2.0128: cannot list options one per line
Bram Moolenaar <Bram@vim.org>
parents:
19116
diff
changeset
|
30 When [!] is present every option is on a separate |
|
69f0e9b5c107
patch 8.2.0128: cannot list options one per line
Bram Moolenaar <Bram@vim.org>
parents:
19116
diff
changeset
|
31 line. |
| 7 | 32 |
| 33 :se[t] termcap Show all terminal options. Note that in the GUI the | |
| 34 key codes are not shown, because they are generated | |
| 35 internally and can't be changed. Changing the terminal | |
| 36 codes in the GUI is not useful either... | |
| 37 | |
| 26438 | 38 :se[t]! termcap Idem, but don't use multiple columns. |
| 39 | |
| 7 | 40 *E518* *E519* |
| 41 :se[t] {option}? Show value of {option}. | |
| 42 | |
| 43 :se[t] {option} Toggle option: set, switch it on. | |
| 44 Number option: show value. | |
| 45 String option: show value. | |
| 46 | |
| 47 :se[t] no{option} Toggle option: Reset, switch it off. | |
| 48 | |
| 2152 | 49 *:set-!* *:set-inv* |
| 7 | 50 :se[t] {option}! or |
|
16443
32a543152dc0
patch 8.1.1226: {not in Vi} remarks get in the way of useful help text
Bram Moolenaar <Bram@vim.org>
parents:
16439
diff
changeset
|
51 :se[t] inv{option} Toggle option: Invert value. |
| 7 | 52 |
| 53 *:set-default* *:set-&* *:set-&vi* *:set-&vim* | |
| 54 :se[t] {option}& Reset option to its default value. May depend on the | |
|
16443
32a543152dc0
patch 8.1.1226: {not in Vi} remarks get in the way of useful help text
Bram Moolenaar <Bram@vim.org>
parents:
16439
diff
changeset
|
55 current value of 'compatible'. |
|
32a543152dc0
patch 8.1.1226: {not in Vi} remarks get in the way of useful help text
Bram Moolenaar <Bram@vim.org>
parents:
16439
diff
changeset
|
56 :se[t] {option}&vi Reset option to its Vi default value. |
|
32a543152dc0
patch 8.1.1226: {not in Vi} remarks get in the way of useful help text
Bram Moolenaar <Bram@vim.org>
parents:
16439
diff
changeset
|
57 :se[t] {option}&vim Reset option to its Vim default value. |
| 7 | 58 |
|
13341
acd7eaa13d2b
Updated runtime files.
Christian Brabandt <cb@256bit.org>
parents:
13314
diff
changeset
|
59 :se[t] all& Set all options to their default value. The values of |
|
7051
eff26a8620ce
commit https://github.com/vim/vim/commit/88774fdd23f08355297bb8cda78856859051d3c7
Christian Brabandt <cb@256bit.org>
parents:
6949
diff
changeset
|
60 these options are not changed: |
|
eff26a8620ce
commit https://github.com/vim/vim/commit/88774fdd23f08355297bb8cda78856859051d3c7
Christian Brabandt <cb@256bit.org>
parents:
6949
diff
changeset
|
61 all terminal options, starting with t_ |
|
eff26a8620ce
commit https://github.com/vim/vim/commit/88774fdd23f08355297bb8cda78856859051d3c7
Christian Brabandt <cb@256bit.org>
parents:
6949
diff
changeset
|
62 'columns' |
|
eff26a8620ce
commit https://github.com/vim/vim/commit/88774fdd23f08355297bb8cda78856859051d3c7
Christian Brabandt <cb@256bit.org>
parents:
6949
diff
changeset
|
63 'cryptmethod' |
|
eff26a8620ce
commit https://github.com/vim/vim/commit/88774fdd23f08355297bb8cda78856859051d3c7
Christian Brabandt <cb@256bit.org>
parents:
6949
diff
changeset
|
64 'encoding' |
|
eff26a8620ce
commit https://github.com/vim/vim/commit/88774fdd23f08355297bb8cda78856859051d3c7
Christian Brabandt <cb@256bit.org>
parents:
6949
diff
changeset
|
65 'key' |
|
eff26a8620ce
commit https://github.com/vim/vim/commit/88774fdd23f08355297bb8cda78856859051d3c7
Christian Brabandt <cb@256bit.org>
parents:
6949
diff
changeset
|
66 'lines' |
|
eff26a8620ce
commit https://github.com/vim/vim/commit/88774fdd23f08355297bb8cda78856859051d3c7
Christian Brabandt <cb@256bit.org>
parents:
6949
diff
changeset
|
67 'term' |
|
eff26a8620ce
commit https://github.com/vim/vim/commit/88774fdd23f08355297bb8cda78856859051d3c7
Christian Brabandt <cb@256bit.org>
parents:
6949
diff
changeset
|
68 'ttymouse' |
|
eff26a8620ce
commit https://github.com/vim/vim/commit/88774fdd23f08355297bb8cda78856859051d3c7
Christian Brabandt <cb@256bit.org>
parents:
6949
diff
changeset
|
69 'ttytype' |
|
eff26a8620ce
commit https://github.com/vim/vim/commit/88774fdd23f08355297bb8cda78856859051d3c7
Christian Brabandt <cb@256bit.org>
parents:
6949
diff
changeset
|
70 Warning: This may have a lot of side effects. |
| 7 | 71 |
| 72 *:set-args* *E487* *E521* | |
| 73 :se[t] {option}={value} or | |
| 74 :se[t] {option}:{value} | |
| 75 Set string or number option to {value}. | |
| 76 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
|
77 hex (preceded with 0x) or octal (preceded with '0'). |
| 7 | 78 The old value can be inserted by typing 'wildchar' (by |
| 79 default this is a <Tab> or CTRL-E if 'compatible' is | |
| 80 set). See |cmdline-completion|. | |
| 81 White space between {option} and '=' is allowed and | |
| 82 will be ignored. White space between '=' and {value} | |
| 83 is not allowed. | |
| 84 See |option-backslash| for using white space and | |
| 85 backslashes in {value}. | |
| 86 | |
| 87 :se[t] {option}+={value} *:set+=* | |
| 88 Add the {value} to a number option, or append the | |
| 89 {value} to a string option. When the option is a | |
| 90 comma separated list, a comma is added, unless the | |
| 91 value was empty. | |
| 92 If the option is a list of flags, superfluous flags | |
| 557 | 93 are removed. When adding a flag that was already |
| 94 present the option value doesn't change. | |
| 809 | 95 Also see |:set-args| above. |
| 7 | 96 |
| 97 :se[t] {option}^={value} *:set^=* | |
| 98 Multiply the {value} to a number option, or prepend | |
| 99 the {value} to a string option. When the option is a | |
| 100 comma separated list, a comma is added, unless the | |
| 101 value was empty. | |
| 102 Also see |:set-args| above. | |
| 103 | |
| 104 :se[t] {option}-={value} *:set-=* | |
| 105 Subtract the {value} from a number option, or remove | |
| 106 the {value} from a string option, if it is there. | |
| 107 If the {value} is not found in a string option, there | |
| 108 is no error or warning. When the option is a comma | |
| 109 separated list, a comma is deleted, unless the option | |
| 110 becomes empty. | |
| 111 When the option is a list of flags, {value} must be | |
| 112 exactly as they appear in the option. Remove flags | |
| 113 one by one to avoid problems. | |
| 114 Also see |:set-args| above. | |
| 115 | |
| 116 The {option} arguments to ":set" may be repeated. For example: > | |
| 117 :set ai nosi sw=3 ts=3 | |
| 118 If you make an error in one of the arguments, an error message will be given | |
| 119 and the following arguments will be ignored. | |
| 120 | |
| 121 *:set-verbose* | |
| 122 When 'verbose' is non-zero, displaying an option value will also tell where it | |
| 123 was last set. Example: > | |
| 124 :verbose set shiftwidth cindent? | |
| 14864 | 125 < shiftwidth=4 ~ |
| 126 Last set from modeline line 1 ~ | |
| 127 cindent ~ | |
| 128 Last set from /usr/local/share/vim/vim60/ftplugin/c.vim line 30 ~ | |
| 1621 | 129 This is only done when specific option values are requested, not for ":verbose |
| 130 set all" or ":verbose set" without an argument. | |
| 131 When the option was set by hand there is no "Last set" message. | |
| 7 | 132 When the option was set while executing a function, user command or |
| 133 autocommand, the script in which it was defined is reported. | |
| 134 Note that an option may also have been set as a side effect of setting | |
| 135 'compatible'. | |
| 1621 | 136 A few special texts: |
| 14864 | 137 Last set from modeline line 1 ~ |
| 1621 | 138 Option was set in a |modeline|. |
| 139 Last set from --cmd argument ~ | |
| 140 Option was set with command line argument |--cmd| or +. | |
| 141 Last set from -c argument ~ | |
| 142 Option was set with command line argument |-c|, +, |-S| or | |
| 143 |-q|. | |
| 144 Last set from environment variable ~ | |
| 145 Option was set from an environment variable, $VIMINIT, | |
| 146 $GVIMINIT or $EXINIT. | |
| 147 Last set from error handler ~ | |
| 148 Option was cleared when evaluating it resulted in an error. | |
| 149 | |
|
2570
71b56b4e7785
Make the references to features in the help more consistent. (Sylvain Hitier)
Bram Moolenaar <bram@vim.org>
parents:
2561
diff
changeset
|
150 {not available when compiled without the |+eval| feature} |
| 7 | 151 |
| 152 *:set-termcap* *E522* | |
| 667 | 153 For {option} the form "t_xx" may be used to set a terminal option. This will |
| 7 | 154 override the value from the termcap. You can then use it in a mapping. If |
| 155 the "xx" part contains special characters, use the <t_xx> form: > | |
| 156 :set <t_#4>=^[Ot | |
| 157 This can also be used to translate a special code for a normal key. For | |
| 158 example, if Alt-b produces <Esc>b, use this: > | |
| 159 :set <M-b>=^[b | |
| 160 (the ^[ is a real <Esc> here, use CTRL-V <Esc> to enter it) | |
| 161 The advantage over a mapping is that it works in all situations. | |
| 162 | |
| 2726 | 163 You can define any key codes, e.g.: > |
| 164 :set t_xy=^[foo; | |
| 165 There is no warning for using a name that isn't recognized. You can map these | |
| 166 codes as you like: > | |
| 167 :map <t_xy> something | |
| 168 < *E846* | |
| 169 When a key code is not set, it's like it does not exist. Trying to get its | |
| 170 value will result in an error: > | |
| 171 :set t_kb= | |
| 172 :set t_kb | |
| 27321 | 173 < E846: Key code not set: t_kb ~ |
| 2726 | 174 |
| 36 | 175 The t_xx options cannot be set from a |modeline| or in the |sandbox|, for |
| 176 security reasons. | |
| 177 | |
| 7 | 178 The listing from ":set" looks different from Vi. Long string options are put |
| 10 | 179 at the end of the list. The number of options is quite large. The output of |
| 7 | 180 "set all" probably does not fit on the screen, causing Vim to give the |
| 181 |more-prompt|. | |
| 182 | |
| 183 *option-backslash* | |
| 184 To include white space in a string option value it has to be preceded with a | |
| 185 backslash. To include a backslash you have to use two. Effectively this | |
| 186 means that the number of backslashes in an option value is halved (rounded | |
| 187 down). | |
| 188 A few examples: > | |
| 189 :set tags=tags\ /usr/tags results in "tags /usr/tags" | |
| 190 :set tags=tags\\,file results in "tags\,file" | |
| 191 :set tags=tags\\\ file results in "tags\ file" | |
| 192 | |
| 10 | 193 The "|" character separates a ":set" command from a following command. To |
| 194 include the "|" in the option value, use "\|" instead. This example sets the | |
| 7 | 195 'titlestring' option to "hi|there": > |
| 196 :set titlestring=hi\|there | |
| 197 This sets the 'titlestring' option to "hi" and 'iconstring' to "there": > | |
| 198 :set titlestring=hi|set iconstring=there | |
| 199 | |
| 25700 | 200 Similarly, in legacy script the double quote character starts a comment. To |
| 201 include the '"' in the option value, use '\"' instead. This example sets the | |
| 202 'titlestring' option to 'hi "there"': > | |
| 642 | 203 :set titlestring=hi\ \"there\" |
| 204 | |
| 25700 | 205 In |Vim9| script it's simpler, comments start with a '#' character, and only |
| 206 when preceded by white space. A backslash is needed less often: > | |
| 207 vim9script | |
| 208 set titlestring=hi\ "there" | |
| 209 set titlestring=hi#there# | |
| 210 set titlestring=hi\ \#there# | |
| 211 | |
| 18972 | 212 For Win32 backslashes in file names are mostly not removed. More precise: For |
| 213 options that expect a file name (those where environment variables are | |
| 214 expanded) a backslash before a normal file name character is not removed. But | |
| 215 a backslash before a special character (space, backslash, comma, etc.) is used | |
| 216 like explained above. | |
| 7 | 217 There is one special situation, when the value starts with "\\": > |
| 218 :set dir=\\machine\path results in "\\machine\path" | |
| 219 :set dir=\\\\machine\\path results in "\\machine\path" | |
| 220 :set dir=\\path\\file results in "\\path\file" (wrong!) | |
| 221 For the first one the start is kept, but for the second one the backslashes | |
| 222 are halved. This makes sure it works both when you expect backslashes to be | |
| 10 | 223 halved and when you expect the backslashes to be kept. The third gives a |
| 7 | 224 result which is probably not what you want. Avoid it. |
| 225 | |
| 226 *add-option-flags* *remove-option-flags* | |
| 227 *E539* *E550* *E551* *E552* | |
| 228 Some options are a list of flags. When you want to add a flag to such an | |
| 229 option, without changing the existing ones, you can do it like this: > | |
| 230 :set guioptions+=a | |
| 231 Remove a flag from an option like this: > | |
| 232 :set guioptions-=a | |
| 233 This removes the 'a' flag from 'guioptions'. | |
| 10 | 234 Note that you should add or remove one flag at a time. If 'guioptions' has |
| 7 | 235 the value "ab", using "set guioptions-=ba" won't work, because the string "ba" |
| 236 doesn't appear. | |
| 237 | |
| 238 *:set_env* *expand-env* *expand-environment-var* | |
| 22 | 239 Environment variables in specific string options will be expanded. If the |
| 7 | 240 environment variable exists the '$' and the following environment variable |
| 241 name is replaced with its value. If it does not exist the '$' and the name | |
| 242 are not modified. Any non-id character (not a letter, digit or '_') may | |
| 243 follow the environment variable name. That character and what follows is | |
| 244 appended to the value of the environment variable. Examples: > | |
| 245 :set term=$TERM.new | |
| 246 :set path=/usr/$INCLUDE,$HOME/include,. | |
| 247 When adding or removing a string from an option with ":set opt-=val" or ":set | |
| 248 opt+=val" the expansion is done before the adding or removing. | |
| 249 | |
| 250 | |
| 251 Handling of local options *local-options* | |
| 252 | |
| 253 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
|
254 has its own copy of this option, thus each can have its own value. This |
| 7 | 255 allows you to set 'list' in one window but not in another. And set |
| 256 'shiftwidth' to 3 in one buffer and 4 in another. | |
| 257 | |
| 258 The following explains what happens to these local options in specific | |
| 259 situations. You don't really need to know all of this, since Vim mostly uses | |
| 260 the option values you would expect. Unfortunately, doing what the user | |
| 261 expects is a bit complicated... | |
| 262 | |
| 263 When splitting a window, the local options are copied to the new window. Thus | |
| 264 right after the split the contents of the two windows look the same. | |
| 265 | |
| 266 When editing a new buffer, its local option values must be initialized. Since | |
| 267 the local options of the current buffer might be specifically for that buffer, | |
| 268 these are not used. Instead, for each buffer-local option there also is a | |
| 269 global value, which is used for new buffers. With ":set" both the local and | |
| 270 global value is changed. With "setlocal" only the local value is changed, | |
| 271 thus this value is not used when editing a new buffer. | |
| 272 | |
|
9852
4eea48b76d03
commit https://github.com/vim/vim/commit/95ec9d6a6ab3117d60ff638670a803d43974ba51
Christian Brabandt <cb@256bit.org>
parents:
9737
diff
changeset
|
273 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
|
274 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
|
275 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
|
276 last closed window where the buffer was edited last are used. |
| 7 | 277 |
| 278 It's possible to set a local window option specifically for a type of buffer. | |
| 279 When you edit another buffer in the same window, you don't want to keep | |
| 280 using these local window options. Therefore Vim keeps a global value of the | |
| 281 local window options, which is used when editing another buffer. Each window | |
| 282 has its own copy of these values. Thus these are local to the window, but | |
| 283 global to all buffers in the window. With this you can do: > | |
| 284 :e one | |
| 285 :set list | |
| 286 :e two | |
| 287 Now the 'list' option will also be set in "two", since with the ":set list" | |
| 288 command you have also set the global value. > | |
| 289 :set nolist | |
| 290 :e one | |
| 291 :setlocal list | |
| 292 :e two | |
| 293 Now the 'list' option is not set, because ":set nolist" resets the global | |
| 294 value, ":setlocal list" only changes the local value and ":e two" gets the | |
| 295 global value. Note that if you do this next: > | |
| 296 :e one | |
| 4358 | 297 You will get back the 'list' value as it was the last time you edited "one". |
| 298 The options local to a window are remembered for each buffer. This also | |
| 299 happens when the buffer is not loaded, but they are lost when the buffer is | |
| 300 wiped out |:bwipe|. | |
| 7 | 301 |
| 302 *:setl* *:setlocal* | |
|
19137
69f0e9b5c107
patch 8.2.0128: cannot list options one per line
Bram Moolenaar <Bram@vim.org>
parents:
19116
diff
changeset
|
303 :setl[ocal][!] ... Like ":set" but set only the value local to the |
| 7 | 304 current buffer or window. Not all options have a |
| 305 local value. If the option does not have a local | |
| 306 value the global value is set. | |
| 2413 | 307 With the "all" argument: display local values for all |
| 308 local options. | |
| 309 Without argument: Display local values for all local | |
| 310 options which are different from the default. | |
| 7 | 311 When displaying a specific local option, show the |
| 1621 | 312 local value. For a global/local boolean option, when |
| 313 the global value is being used, "--" is displayed | |
| 314 before the option name. | |
| 315 For a global option the global value is | |
| 7 | 316 shown (but that might change in the future). |
| 317 | |
| 809 | 318 :setl[ocal] {option}< Set the local value of {option} to its global value by |
| 319 copying the value. | |
| 320 | |
| 3281 | 321 :se[t] {option}< For |global-local| options: Remove the local value of |
| 322 {option}, so that the global value will be used. | |
| 7 | 323 |
| 324 *:setg* *:setglobal* | |
|
19137
69f0e9b5c107
patch 8.2.0128: cannot list options one per line
Bram Moolenaar <Bram@vim.org>
parents:
19116
diff
changeset
|
325 :setg[lobal][!] ... Like ":set" but set only the global value for a local |
| 7 | 326 option without changing the local value. |
| 327 When displaying an option, the global value is shown. | |
| 2413 | 328 With the "all" argument: display global values for all |
| 329 local options. | |
| 330 Without argument: display global values for all local | |
| 331 options which are different from the default. | |
| 7 | 332 |
| 333 For buffer-local and window-local options: | |
| 334 Command global value local value ~ | |
| 335 :set option=value set set | |
| 336 :setlocal option=value - set | |
| 337 :setglobal option=value set - | |
| 338 :set option? - display | |
| 339 :setlocal option? - display | |
| 340 :setglobal option? display - | |
| 341 | |
| 342 | |
| 343 Global options with a local value *global-local* | |
| 344 | |
| 40 | 345 Options are global when you mostly use one value for all buffers and windows. |
| 346 For some global options it's useful to sometimes have a different local value. | |
| 347 You can set the local value with ":setlocal". That buffer or window will then | |
| 348 use the local value, while other buffers and windows continue using the global | |
| 349 value. | |
| 7 | 350 |
| 351 For example, you have two windows, both on C source code. They use the global | |
| 352 'makeprg' option. If you do this in one of the two windows: > | |
| 353 :set makeprg=gmake | |
| 354 then the other window will switch to the same value. There is no need to set | |
| 355 the 'makeprg' option in the other C source window too. | |
| 356 However, if you start editing a Perl file in a new window, you want to use | |
| 1152 | 357 another 'makeprg' for it, without changing the value used for the C source |
| 10 | 358 files. You use this command: > |
| 7 | 359 :setlocal makeprg=perlmake |
| 360 You can switch back to using the global value by making the local value empty: > | |
| 361 :setlocal makeprg= | |
| 15729 | 362 This only works for a string option. For a number or boolean option you need |
| 363 to use the "<" flag, like this: > | |
| 7 | 364 :setlocal autoread< |
| 15729 | 365 Note that for non-boolean and non-number options using "<" copies the global |
| 366 value to the local value, it doesn't switch back to using the global value | |
| 367 (that matters when the global value changes later). You can also use: > | |
| 809 | 368 :set path< |
| 369 This will make the local value of 'path' empty, so that the global value is | |
| 370 used. Thus it does the same as: > | |
| 371 :setlocal path= | |
| 27036 | 372 Note: In the future more global options can be made |global-local|. Using |
| 7 | 373 ":setlocal" on a global option might work differently then. |
| 374 | |
| 375 | |
|
26175
6b4f017d7005
patch 8.2.3619: cannot use a lambda for 'operatorfunc'
Bram Moolenaar <Bram@vim.org>
parents:
26148
diff
changeset
|
376 *option-value-function* |
|
6b4f017d7005
patch 8.2.3619: cannot use a lambda for 'operatorfunc'
Bram Moolenaar <Bram@vim.org>
parents:
26148
diff
changeset
|
377 Some options ('completefunc', 'imactivatefunc', 'imstatusfunc', 'omnifunc', |
|
26388
8aba638e91eb
patch 8.2.3725: cannot use a lambda for 'completefunc' and 'omnifunc'
Bram Moolenaar <Bram@vim.org>
parents:
26362
diff
changeset
|
378 'operatorfunc', 'quickfixtextfunc', 'tagfunc' and 'thesaurusfunc') are set to |
|
26441
65ab0b035dd8
patch 8.2.3751: cannot assign a lambda to an option that takes a function
Bram Moolenaar <Bram@vim.org>
parents:
26438
diff
changeset
|
379 a function name or a function reference or a lambda function. When using a |
|
65ab0b035dd8
patch 8.2.3751: cannot assign a lambda to an option that takes a function
Bram Moolenaar <Bram@vim.org>
parents:
26438
diff
changeset
|
380 lambda it will be converted to the name, e.g. "<lambda>123". Examples: |
|
26175
6b4f017d7005
patch 8.2.3619: cannot use a lambda for 'operatorfunc'
Bram Moolenaar <Bram@vim.org>
parents:
26148
diff
changeset
|
381 > |
|
6b4f017d7005
patch 8.2.3619: cannot use a lambda for 'operatorfunc'
Bram Moolenaar <Bram@vim.org>
parents:
26148
diff
changeset
|
382 set opfunc=MyOpFunc |
|
26268
3aa48d4e3dc8
patch 8.2.3665: cannot use a lambda for 'tagfunc'
Bram Moolenaar <Bram@vim.org>
parents:
26219
diff
changeset
|
383 set opfunc=function('MyOpFunc') |
|
3aa48d4e3dc8
patch 8.2.3665: cannot use a lambda for 'tagfunc'
Bram Moolenaar <Bram@vim.org>
parents:
26219
diff
changeset
|
384 set opfunc=funcref('MyOpFunc') |
|
26362
dbe615b75f15
patch 8.2.3712: cannot use Vim9 lambda for 'tagfunc'
Bram Moolenaar <Bram@vim.org>
parents:
26336
diff
changeset
|
385 set opfunc={a\ ->\ MyOpFunc(a)} |
|
27780
f1d5822ca0d7
patch 8.2.4416: Vim9: using a script-local function requires using "s:"
Bram Moolenaar <Bram@vim.org>
parents:
27623
diff
changeset
|
386 |
|
f1d5822ca0d7
patch 8.2.4416: Vim9: using a script-local function requires using "s:"
Bram Moolenaar <Bram@vim.org>
parents:
27623
diff
changeset
|
387 Set to a script-local function: > |
|
f1d5822ca0d7
patch 8.2.4416: Vim9: using a script-local function requires using "s:"
Bram Moolenaar <Bram@vim.org>
parents:
27623
diff
changeset
|
388 set opfunc=s:MyLocalFunc |
|
f1d5822ca0d7
patch 8.2.4416: Vim9: using a script-local function requires using "s:"
Bram Moolenaar <Bram@vim.org>
parents:
27623
diff
changeset
|
389 set opfunc=<SID>MyLocalFunc |
|
f1d5822ca0d7
patch 8.2.4416: Vim9: using a script-local function requires using "s:"
Bram Moolenaar <Bram@vim.org>
parents:
27623
diff
changeset
|
390 In |Vim9| script the "s:" and "<SID>" can be omitted if the function exists in |
|
f1d5822ca0d7
patch 8.2.4416: Vim9: using a script-local function requires using "s:"
Bram Moolenaar <Bram@vim.org>
parents:
27623
diff
changeset
|
391 the script: > |
|
f1d5822ca0d7
patch 8.2.4416: Vim9: using a script-local function requires using "s:"
Bram Moolenaar <Bram@vim.org>
parents:
27623
diff
changeset
|
392 set opfunc=MyLocalFunc |
|
f1d5822ca0d7
patch 8.2.4416: Vim9: using a script-local function requires using "s:"
Bram Moolenaar <Bram@vim.org>
parents:
27623
diff
changeset
|
393 |
|
f1d5822ca0d7
patch 8.2.4416: Vim9: using a script-local function requires using "s:"
Bram Moolenaar <Bram@vim.org>
parents:
27623
diff
changeset
|
394 Set using a funcref variable: > |
|
26362
dbe615b75f15
patch 8.2.3712: cannot use Vim9 lambda for 'tagfunc'
Bram Moolenaar <Bram@vim.org>
parents:
26336
diff
changeset
|
395 let Fn = function('MyTagFunc') |
| 26708 | 396 let &tagfunc = Fn |
|
27780
f1d5822ca0d7
patch 8.2.4416: Vim9: using a script-local function requires using "s:"
Bram Moolenaar <Bram@vim.org>
parents:
27623
diff
changeset
|
397 |
|
f1d5822ca0d7
patch 8.2.4416: Vim9: using a script-local function requires using "s:"
Bram Moolenaar <Bram@vim.org>
parents:
27623
diff
changeset
|
398 Set using a lambda expression: > |
|
26441
65ab0b035dd8
patch 8.2.3751: cannot assign a lambda to an option that takes a function
Bram Moolenaar <Bram@vim.org>
parents:
26438
diff
changeset
|
399 let &tagfunc = {t -> MyTagFunc(t)} |
|
27780
f1d5822ca0d7
patch 8.2.4416: Vim9: using a script-local function requires using "s:"
Bram Moolenaar <Bram@vim.org>
parents:
27623
diff
changeset
|
400 |
|
f1d5822ca0d7
patch 8.2.4416: Vim9: using a script-local function requires using "s:"
Bram Moolenaar <Bram@vim.org>
parents:
27623
diff
changeset
|
401 Set using a variable with lambda expression: > |
|
26362
dbe615b75f15
patch 8.2.3712: cannot use Vim9 lambda for 'tagfunc'
Bram Moolenaar <Bram@vim.org>
parents:
26336
diff
changeset
|
402 let L = {a, b, c -> MyTagFunc(a, b , c)} |
|
26441
65ab0b035dd8
patch 8.2.3751: cannot assign a lambda to an option that takes a function
Bram Moolenaar <Bram@vim.org>
parents:
26438
diff
changeset
|
403 let &tagfunc = L |
|
26508
a0bc10e83cf8
patch 8.2.3784: the help for options is outdated
Bram Moolenaar <Bram@vim.org>
parents:
26441
diff
changeset
|
404 |
|
a0bc10e83cf8
patch 8.2.3784: the help for options is outdated
Bram Moolenaar <Bram@vim.org>
parents:
26441
diff
changeset
|
405 In Vim9 script, in a compiled function, you can use a lambda, but a |
|
a0bc10e83cf8
patch 8.2.3784: the help for options is outdated
Bram Moolenaar <Bram@vim.org>
parents:
26441
diff
changeset
|
406 closured does not work, because the function will be called without the |
|
a0bc10e83cf8
patch 8.2.3784: the help for options is outdated
Bram Moolenaar <Bram@vim.org>
parents:
26441
diff
changeset
|
407 context of where it was defined. |
|
a0bc10e83cf8
patch 8.2.3784: the help for options is outdated
Bram Moolenaar <Bram@vim.org>
parents:
26441
diff
changeset
|
408 |
|
26175
6b4f017d7005
patch 8.2.3619: cannot use a lambda for 'operatorfunc'
Bram Moolenaar <Bram@vim.org>
parents:
26148
diff
changeset
|
409 |
| 7 | 410 Setting the filetype |
| 411 | |
| 11473 | 412 :setf[iletype] [FALLBACK] {filetype} *:setf* *:setfiletype* |
| 7 | 413 Set the 'filetype' option to {filetype}, but only if |
| 414 not done yet in a sequence of (nested) autocommands. | |
| 415 This is short for: > | |
| 416 :if !did_filetype() | |
| 417 : setlocal filetype={filetype} | |
| 418 :endif | |
| 419 < This command is used in a filetype.vim file to avoid | |
| 420 setting the 'filetype' option twice, causing different | |
| 421 settings and syntax files to be loaded. | |
| 11473 | 422 |
| 423 When the optional FALLBACK argument is present, a | |
| 424 later :setfiletype command will override the | |
| 16023 | 425 'filetype'. This is to be used for filetype |
| 426 detections that are just a guess. |did_filetype()| | |
| 427 will return false after this command. | |
| 11473 | 428 |
|
2698
b6471224d2af
Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents:
2681
diff
changeset
|
429 *option-window* *optwin* |
| 7 | 430 :bro[wse] se[t] *:set-browse* *:browse-set* *:opt* *:options* |
| 431 :opt[ions] Open a window for viewing and setting all options. | |
| 432 Options are grouped by function. | |
| 433 Offers short help for each option. Hit <CR> on the | |
| 434 short help to open a help window with more help for | |
| 435 the option. | |
| 436 Modify the value of the option and hit <CR> on the | |
| 437 "set" line to set the new value. For window and | |
| 438 buffer specific options, the last accessed window is | |
| 439 used to set the option value in, unless this is a help | |
| 440 window, in which case the window below help window is | |
| 441 used (skipping the option-window). | |
| 13437 | 442 {not available when compiled without the |+eval| |
| 443 feature} | |
| 7 | 444 |
| 445 *$HOME* | |
| 446 Using "~" is like using "$HOME", but it is only recognized at the start of an | |
| 447 option and after a space or comma. | |
| 448 | |
| 449 On Unix systems "~user" can be used too. It is replaced by the home directory | |
| 450 of user "user". Example: > | |
| 451 :set path=~mool/include,/usr/include,. | |
| 452 | |
| 453 On Unix systems the form "${HOME}" can be used too. The name between {} can | |
| 454 contain non-id characters then. Note that if you want to use this for the | |
| 455 "gf" command, you need to add the '{' and '}' characters to 'isfname'. | |
| 456 | |
| 12254 | 457 NOTE: expanding environment variables and "~/" is only done with the ":set" |
| 458 command, not when assigning a value to an option with ":let". | |
| 459 | |
| 460 *$HOME-windows* | |
| 3224 | 461 On MS-Windows, if $HOME is not defined as an environment variable, then |
| 462 at runtime Vim will set it to the expansion of $HOMEDRIVE$HOMEPATH. | |
| 12499 | 463 If $HOMEDRIVE is not set then $USERPROFILE is used. |
| 464 | |
| 465 This expanded value is not exported to the environment, this matters when | |
| 466 running an external command: > | |
| 467 :echo system('set | findstr ^HOME=') | |
| 468 and > | |
| 469 :echo luaeval('os.getenv("HOME")') | |
| 470 should echo nothing (an empty string) despite exists('$HOME') being true. | |
| 471 When setting $HOME to a non-empty string it will be exported to the | |
| 472 subprocesses. | |
| 3224 | 473 |
| 7 | 474 |
| 475 Note the maximum length of an expanded option is limited. How much depends on | |
| 476 the system, mostly it is something like 256 or 1024 characters. | |
| 477 | |
| 478 *:fix* *:fixdel* | |
| 479 :fix[del] Set the value of 't_kD': | |
| 480 't_kb' is 't_kD' becomes ~ | |
| 481 CTRL-? CTRL-H | |
| 482 not CTRL-? CTRL-? | |
| 483 | |
| 23573 | 484 (CTRL-? is 0o177 octal, 0x7f hex) |
| 7 | 485 |
| 486 If your delete key terminal code is wrong, but the | |
| 487 code for backspace is alright, you can put this in | |
| 488 your .vimrc: > | |
| 489 :fixdel | |
| 490 < This works no matter what the actual code for | |
| 491 backspace is. | |
| 492 | |
| 493 If the backspace key terminal code is wrong you can | |
| 494 use this: > | |
| 495 :if &term == "termname" | |
| 496 : set t_kb=^V<BS> | |
| 497 : fixdel | |
| 498 :endif | |
| 499 < Where "^V" is CTRL-V and "<BS>" is the backspace key | |
| 10 | 500 (don't type four characters!). Replace "termname" |
| 7 | 501 with your terminal name. |
| 502 | |
| 503 If your <Delete> key sends a strange key sequence (not | |
| 504 CTRL-? or CTRL-H) you cannot use ":fixdel". Then use: > | |
| 505 :if &term == "termname" | |
| 506 : set t_kD=^V<Delete> | |
| 507 :endif | |
| 508 < Where "^V" is CTRL-V and "<Delete>" is the delete key | |
| 509 (don't type eight characters!). Replace "termname" | |
| 510 with your terminal name. | |
| 511 | |
| 512 *Linux-backspace* | |
| 513 Note about Linux: By default the backspace key | |
| 514 produces CTRL-?, which is wrong. You can fix it by | |
| 515 putting this line in your rc.local: > | |
| 516 echo "keycode 14 = BackSpace" | loadkeys | |
| 517 < | |
| 518 *NetBSD-backspace* | |
| 519 Note about NetBSD: If your backspace doesn't produce | |
| 520 the right code, try this: > | |
| 521 xmodmap -e "keycode 22 = BackSpace" | |
| 522 < If this works, add this in your .Xmodmap file: > | |
| 523 keysym 22 = BackSpace | |
| 524 < You need to restart for this to take effect. | |
| 525 | |
| 526 ============================================================================== | |
| 527 2. Automatically setting options *auto-setting* | |
| 528 | |
| 529 Besides changing options with the ":set" command, there are three alternatives | |
| 530 to set options automatically for one or more files: | |
| 531 | |
| 532 1. When starting Vim initializations are read from various places. See | |
| 533 |initialization|. Most of them are performed for all editing sessions, | |
| 534 and some of them depend on the directory where Vim is started. | |
| 535 You can create an initialization file with |:mkvimrc|, |:mkview| and | |
| 536 |:mksession|. | |
| 537 2. If you start editing a new file, the automatic commands are executed. | |
| 538 This can be used to set options for files matching a particular pattern and | |
| 539 many other things. See |autocommand|. | |
| 540 3. If you start editing a new file, and the 'modeline' option is on, a | |
| 541 number of lines at the beginning and end of the file are checked for | |
| 542 modelines. This is explained here. | |
| 543 | |
| 544 *modeline* *vim:* *vi:* *ex:* *E520* | |
| 545 There are two forms of modelines. The first form: | |
| 18831 | 546 [text{white}]{vi:|vim:|ex:}[white]{options} |
| 547 | |
| 548 [text{white}] empty or any text followed by at least one blank | |
| 549 character (<Space> or <Tab>); "ex:" always requires at | |
| 550 least one blank character | |
| 5055 | 551 {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
|
552 [white] optional white space |
|
7a2ffd685c0e
Update runtime files. Remove duplicate tags in help.
Bram Moolenaar <bram@vim.org>
parents:
5008
diff
changeset
|
553 {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
|
554 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
|
555 for a ":set" command (can be empty) |
| 7 | 556 |
| 5055 | 557 Examples: |
| 782 | 558 vi:noai:sw=3 ts=6 ~ |
| 5055 | 559 vim: tw=77 ~ |
| 7 | 560 |
| 561 The second form (this is compatible with some versions of Vi): | |
| 562 | |
| 19163 | 563 [text{white}]{vi:|vim:|Vim:|ex:}[white]se[t] {options}:[text] |
| 564 | |
| 565 [text{white}] empty or any text followed by at least one blank | |
| 566 character (<Space> or <Tab>); "ex:" always requires at | |
| 567 least one blank character | |
|
5024
7a2ffd685c0e
Update runtime files. Remove duplicate tags in help.
Bram Moolenaar <bram@vim.org>
parents:
5008
diff
changeset
|
568 {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
|
569 [white] optional white space |
| 5055 | 570 se[t] the string "set " or "se " (note the space); When |
| 571 "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
|
572 {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
|
573 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
|
574 : a colon |
|
7a2ffd685c0e
Update runtime files. Remove duplicate tags in help.
Bram Moolenaar <bram@vim.org>
parents:
5008
diff
changeset
|
575 [text] any text or empty |
| 7 | 576 |
| 5055 | 577 Examples: |
| 782 | 578 /* vim: set ai tw=75: */ ~ |
| 5055 | 579 /* Vim: set ai tw=75: */ ~ |
| 7 | 580 |
|
5024
7a2ffd685c0e
Update runtime files. Remove duplicate tags in help.
Bram Moolenaar <bram@vim.org>
parents:
5008
diff
changeset
|
581 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
|
582 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
|
583 "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
|
584 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
|
585 could be short for "example:"). |
| 7 | 586 |
|
25696
64fa341cc33b
patch 8.2.3384: cannot disable modeline for an individual file
Bram Moolenaar <Bram@vim.org>
parents:
25487
diff
changeset
|
587 If the modeline is disabled within a modeline, subsequent modelines will be |
|
64fa341cc33b
patch 8.2.3384: cannot disable modeline for an individual file
Bram Moolenaar <Bram@vim.org>
parents:
25487
diff
changeset
|
588 ignored. This is to allow turning off modeline on a per-file basis. This is |
|
64fa341cc33b
patch 8.2.3384: cannot disable modeline for an individual file
Bram Moolenaar <Bram@vim.org>
parents:
25487
diff
changeset
|
589 useful when a line looks like a modeline but isn't. For example, it would be |
|
64fa341cc33b
patch 8.2.3384: cannot disable modeline for an individual file
Bram Moolenaar <Bram@vim.org>
parents:
25487
diff
changeset
|
590 good to start a YAML file containing strings like "vim:" with |
|
64fa341cc33b
patch 8.2.3384: cannot disable modeline for an individual file
Bram Moolenaar <Bram@vim.org>
parents:
25487
diff
changeset
|
591 # vim: nomodeline ~ |
|
64fa341cc33b
patch 8.2.3384: cannot disable modeline for an individual file
Bram Moolenaar <Bram@vim.org>
parents:
25487
diff
changeset
|
592 so as to avoid modeline misdetection. Following options on the same line |
|
64fa341cc33b
patch 8.2.3384: cannot disable modeline for an individual file
Bram Moolenaar <Bram@vim.org>
parents:
25487
diff
changeset
|
593 after modeline deactivation, if any, are still evaluated (but you would |
|
64fa341cc33b
patch 8.2.3384: cannot disable modeline for an individual file
Bram Moolenaar <Bram@vim.org>
parents:
25487
diff
changeset
|
594 normally not have any). |
|
64fa341cc33b
patch 8.2.3384: cannot disable modeline for an individual file
Bram Moolenaar <Bram@vim.org>
parents:
25487
diff
changeset
|
595 |
| 7 | 596 *modeline-local* |
| 597 The options are set like with ":setlocal": The new value only applies to the | |
| 11 | 598 buffer and window that contain the file. Although it's possible to set global |
| 599 options from a modeline, this is unusual. If you have two windows open and | |
| 600 the files in it set the same global option to a different value, the result | |
| 601 depends on which one was opened last. | |
| 7 | 602 |
| 23 | 603 When editing a file that was already loaded, only the window-local options |
| 604 from the modeline are used. Thus if you manually changed a buffer-local | |
| 605 option after opening the file, it won't be changed if you edit the same buffer | |
| 606 in another window. But window-local options will be set. | |
| 607 | |
| 7 | 608 *modeline-version* |
| 609 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
|
610 number can be specified where "vim:" or "Vim:" is used: |
| 7 | 611 vim{vers}: version {vers} or later |
| 612 vim<{vers}: version before {vers} | |
| 613 vim={vers}: version {vers} | |
| 614 vim>{vers}: version after {vers} | |
| 6647 | 615 {vers} is 700 for Vim 7.0 (hundred times the major version plus minor). |
| 616 For example, to use a modeline only for Vim 7.0: | |
| 617 /* vim700: set foldmethod=marker */ ~ | |
| 618 To use a modeline for Vim after version 7.2: | |
| 619 /* vim>702: set cole=2: */ ~ | |
| 7 | 620 There can be no blanks between "vim" and the ":". |
| 621 | |
| 622 | |
| 623 The number of lines that are checked can be set with the 'modelines' option. | |
| 624 If 'modeline' is off or 'modelines' is 0 no lines are checked. | |
| 625 | |
| 626 Note that for the first form all of the rest of the line is used, thus a line | |
| 782 | 627 like: |
| 628 /* vi:ts=4: */ ~ | |
| 629 will give an error message for the trailing "*/". This line is OK: | |
| 630 /* vi:set ts=4: */ ~ | |
| 7 | 631 |
| 632 If an error is detected the rest of the line is skipped. | |
| 633 | |
| 634 If you want to include a ':' in a set command precede it with a '\'. The | |
| 782 | 635 backslash in front of the ':' will be removed. Example: |
| 18928 | 636 /* vi:set fillchars=stl\:^,vert\:\|: */ ~ |
| 637 This sets the 'fillchars' option to "stl:^,vert:\|". Only a single backslash | |
| 638 before the ':' is removed. Thus to include "\:" you have to specify "\\:". | |
|
16728
e55c26aaf484
patch 8.1.1366: using expressions in a modeline is unsafe
Bram Moolenaar <Bram@vim.org>
parents:
16610
diff
changeset
|
639 *E992* |
| 7 | 640 No other commands than "set" are supported, for security reasons (somebody |
| 1111 | 641 might create a Trojan horse text file with modelines). And not all options |
|
16728
e55c26aaf484
patch 8.1.1366: using expressions in a modeline is unsafe
Bram Moolenaar <Bram@vim.org>
parents:
16610
diff
changeset
|
642 can be set. For some options a flag is set, so that when the value is used |
|
e55c26aaf484
patch 8.1.1366: using expressions in a modeline is unsafe
Bram Moolenaar <Bram@vim.org>
parents:
16610
diff
changeset
|
643 the |sandbox| is effective. Some options can only be set from the modeline |
|
e55c26aaf484
patch 8.1.1366: using expressions in a modeline is unsafe
Bram Moolenaar <Bram@vim.org>
parents:
16610
diff
changeset
|
644 when 'modelineexpr' is set (the default is off). |
|
e55c26aaf484
patch 8.1.1366: using expressions in a modeline is unsafe
Bram Moolenaar <Bram@vim.org>
parents:
16610
diff
changeset
|
645 |
|
e55c26aaf484
patch 8.1.1366: using expressions in a modeline is unsafe
Bram Moolenaar <Bram@vim.org>
parents:
16610
diff
changeset
|
646 Still, there is always a small risk that a modeline causes trouble. E.g., |
|
e55c26aaf484
patch 8.1.1366: using expressions in a modeline is unsafe
Bram Moolenaar <Bram@vim.org>
parents:
16610
diff
changeset
|
647 when some joker sets 'textwidth' to 5 all your lines are wrapped unexpectedly. |
|
e55c26aaf484
patch 8.1.1366: using expressions in a modeline is unsafe
Bram Moolenaar <Bram@vim.org>
parents:
16610
diff
changeset
|
648 So disable modelines before editing untrusted text. The mail ftplugin does |
|
e55c26aaf484
patch 8.1.1366: using expressions in a modeline is unsafe
Bram Moolenaar <Bram@vim.org>
parents:
16610
diff
changeset
|
649 this, for example. |
| 7 | 650 |
| 651 Hint: If you would like to do something else than setting an option, you could | |
| 652 define an autocommand that checks the file for a specific string. For | |
| 653 example: > | |
| 654 au BufReadPost * if getline(1) =~ "VAR" | call SetVar() | endif | |
| 655 And define a function SetVar() that does something with the line containing | |
| 656 "VAR". | |
| 657 | |
| 658 ============================================================================== | |
| 659 3. Options summary *option-summary* | |
| 660 | |
| 661 In the list below all the options are mentioned with their full name and with | |
| 662 an abbreviation if there is one. Both forms may be used. | |
| 663 | |
| 664 In this document when a boolean option is "set" that means that ":set option" | |
| 665 is entered. When an option is "reset", ":set nooption" is used. | |
| 666 | |
| 667 For some options there are two default values: The "Vim default", which is | |
| 668 used when 'compatible' is not set, and the "Vi default", which is used when | |
| 669 'compatible' is set. | |
| 670 | |
| 671 Most options are the same in all windows and buffers. There are a few that | |
| 10 | 672 are specific to how the text is presented in a window. These can be set to a |
| 7 | 673 different value in each window. For example the 'list' option can be set in |
| 674 one window and reset in another for the same text, giving both types of view | |
| 675 at the same time. There are a few options that are specific to a certain | |
| 676 file. These can have a different value for each file or buffer. For example | |
| 677 the 'textwidth' option can be 78 for a normal text file and 0 for a C | |
| 678 program. | |
| 679 | |
| 680 global one option for all buffers and windows | |
| 681 local to window each window has its own copy of this option | |
| 682 local to buffer each buffer has its own copy of this option | |
| 683 | |
| 684 When creating a new window the option values from the currently active window | |
| 685 are used as a default value for the window-specific options. For the | |
| 686 buffer-specific options this depends on the 's' and 'S' flags in the | |
| 687 'cpoptions' option. If 's' is included (which is the default) the values for | |
| 688 buffer options are copied from the currently active buffer when a buffer is | |
| 10 | 689 first entered. If 'S' is present the options are copied each time the buffer |
| 690 is entered, this is almost like having global options. If 's' and 'S' are not | |
| 7 | 691 present, the options are copied from the currently active buffer when the |
| 692 buffer is created. | |
| 693 | |
| 519 | 694 Hidden options *hidden-options* |
| 695 | |
| 696 Not all options are supported in all versions. This depends on the supported | |
| 697 features and sometimes on the system. A remark about this is in curly braces | |
| 698 below. When an option is not supported it may still be set without getting an | |
| 699 error, this is called a hidden option. You can't get the value of a hidden | |
| 700 option though, it is not stored. | |
| 701 | |
| 702 To test if option "foo" can be used with ":set" use something like this: > | |
| 703 if exists('&foo') | |
| 704 This also returns true for a hidden option. To test if option "foo" is really | |
| 705 supported use something like this: > | |
| 706 if exists('+foo') | |
| 707 < | |
| 7 | 708 *E355* |
| 709 A jump table for the options with a short description can be found at |Q_op|. | |
| 710 | |
| 711 *'aleph'* *'al'* *aleph* *Aleph* | |
| 18972 | 712 'aleph' 'al' number (default 128 for MS-Windows, 224 otherwise) |
| 7 | 713 global |
| 714 {only available when compiled with the |+rightleft| | |
| 715 feature} | |
| 716 The ASCII code for the first letter of the Hebrew alphabet. The | |
| 717 routine that maps the keyboard in Hebrew mode, both in Insert mode | |
| 718 (when hkmap is set) and on the command-line (when hitting CTRL-_) | |
| 719 outputs the Hebrew characters in the range [aleph..aleph+26]. | |
| 720 aleph=128 applies to PC code, and aleph=224 applies to ISO 8859-8. | |
| 721 See |rileft.txt|. | |
| 722 | |
| 723 *'allowrevins'* *'ari'* *'noallowrevins'* *'noari'* | |
| 724 'allowrevins' 'ari' boolean (default off) | |
| 725 global | |
| 726 {only available when compiled with the |+rightleft| | |
| 727 feature} | |
| 728 Allow CTRL-_ in Insert and Command-line mode. This is default off, to | |
| 729 avoid that users that accidentally type CTRL-_ instead of SHIFT-_ get | |
| 730 into reverse Insert mode, and don't know how to get out. See | |
| 731 'revins'. | |
| 732 NOTE: This option is reset when 'compatible' is set. | |
| 733 | |
| 734 *'altkeymap'* *'akm'* *'noaltkeymap'* *'noakm'* | |
| 735 'altkeymap' 'akm' boolean (default off) | |
| 736 global | |
| 737 {only available when compiled with the |+farsi| | |
| 738 feature} | |
|
15850
a6ca8cf07a98
patch 8.1.0932: Farsi support is outdated and unused
Bram Moolenaar <Bram@vim.org>
parents:
15840
diff
changeset
|
739 This option was for using Farsi, which has been removed. See |
|
a6ca8cf07a98
patch 8.1.0932: Farsi support is outdated and unused
Bram Moolenaar <Bram@vim.org>
parents:
15840
diff
changeset
|
740 |farsi.txt|. |
| 7 | 741 |
| 742 *'ambiwidth'* *'ambw'* | |
| 743 'ambiwidth' 'ambw' string (default: "single") | |
| 744 global | |
| 745 Only effective when 'encoding' is "utf-8" or another Unicode encoding. | |
| 746 Tells Vim what to do with characters with East Asian Width Class | |
| 747 Ambiguous (such as Euro, Registered Sign, Copyright Sign, Greek | |
| 748 letters, Cyrillic letters). | |
| 749 | |
| 750 There are currently two possible values: | |
| 233 | 751 "single": Use the same width as characters in US-ASCII. This is |
| 7 | 752 expected by most users. |
| 753 "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
|
754 *E834* *E835* |
|
c945fdb34ce3
Disallow setting 'ambiwidth' to "double" when 'listchars' or 'fillchars'
Bram Moolenaar <bram@vim.org>
parents:
2490
diff
changeset
|
755 The value "double" cannot be used if 'listchars' or 'fillchars' |
| 26050 | 756 contains a character that would be double width. These errors may |
| 757 also be given when calling setcellwidths(). | |
|
21971
0bc43a704f56
patch 8.2.1535: it is not possible to specify cell widths of characters
Bram Moolenaar <Bram@vim.org>
parents:
21825
diff
changeset
|
758 |
|
0bc43a704f56
patch 8.2.1535: it is not possible to specify cell widths of characters
Bram Moolenaar <Bram@vim.org>
parents:
21825
diff
changeset
|
759 The values are overruled for characters specified with |
|
0bc43a704f56
patch 8.2.1535: it is not possible to specify cell widths of characters
Bram Moolenaar <Bram@vim.org>
parents:
21825
diff
changeset
|
760 |setcellwidths()|. |
| 7 | 761 |
| 762 There are a number of CJK fonts for which the width of glyphs for | |
| 763 those characters are solely based on how many octets they take in | |
| 764 legacy/traditional CJK encodings. In those encodings, Euro, | |
| 765 Registered sign, Greek/Cyrillic letters are represented by two octets, | |
| 233 | 766 therefore those fonts have "wide" glyphs for them. This is also |
| 7 | 767 true of some line drawing characters used to make tables in text |
| 233 | 768 file. Therefore, when a CJK font is used for GUI Vim or |
| 7 | 769 Vim is running inside a terminal (emulators) that uses a CJK font |
| 770 (or Vim is run inside an xterm invoked with "-cjkwidth" option.), | |
| 771 this option should be set to "double" to match the width perceived | |
| 772 by Vim with the width of glyphs in the font. Perhaps it also has | |
| 19116 | 773 to be set to "double" under CJK MS-Windows when the system locale is |
| 774 set to one of CJK locales. See Unicode Standard Annex #11 | |
| 775 (http://www.unicode.org/reports/tr11). | |
| 7 | 776 |
| 4229 | 777 Vim may set this option automatically at startup time when Vim is |
| 778 compiled with the |+termresponse| feature and if |t_u7| is set to the | |
| 12499 | 779 escape sequence to request cursor position report. The response can |
| 780 be found in |v:termu7resp|. | |
| 4229 | 781 |
| 7 | 782 *'antialias'* *'anti'* *'noantialias'* *'noanti'* |
| 783 'antialias' 'anti' boolean (default: off) | |
| 784 global | |
| 785 {only available when compiled with GUI enabled | |
| 21825 | 786 on macOS} |
| 787 This option only has an effect in the GUI version of Vim on macOS | |
| 7 | 788 v10.2 or later. When on, Vim will use smooth ("antialiased") fonts, |
| 789 which can be easier to read at certain sizes on certain displays. | |
| 790 Setting this option can sometimes cause problems if 'guifont' is set | |
| 791 to its default (empty string). | |
| 11160 | 792 NOTE: This option is reset when 'compatible' is set. |
| 7 | 793 |
| 794 *'autochdir'* *'acd'* *'noautochdir'* *'noacd'* | |
| 795 'autochdir' 'acd' boolean (default off) | |
| 796 global | |
| 2152 | 797 {only available when compiled with it, use |
| 798 exists("+autochdir") to check} | |
| 438 | 799 When on, Vim will change the current working directory whenever you |
| 800 open a file, switch buffers, delete a buffer or open/close a window. | |
| 801 It will change to the directory containing the file which was opened | |
| 802 or selected. | |
| 819 | 803 Note: When this option is on some plugins may not work. |
| 7 | 804 |
|
24268
9257f3980f4a
patch 8.2.2675: directory change in a terminal window shell is not followed
Bram Moolenaar <Bram@vim.org>
parents:
24055
diff
changeset
|
805 *'autoshelldir'* *'asd'* *'noautoshelldir'* *'noasd'* |
|
9257f3980f4a
patch 8.2.2675: directory change in a terminal window shell is not followed
Bram Moolenaar <Bram@vim.org>
parents:
24055
diff
changeset
|
806 'autoshelldir' 'asd' boolean (default off) |
|
9257f3980f4a
patch 8.2.2675: directory change in a terminal window shell is not followed
Bram Moolenaar <Bram@vim.org>
parents:
24055
diff
changeset
|
807 global |
|
9257f3980f4a
patch 8.2.2675: directory change in a terminal window shell is not followed
Bram Moolenaar <Bram@vim.org>
parents:
24055
diff
changeset
|
808 When on, Vim will change the current working directory whenever you |
|
9257f3980f4a
patch 8.2.2675: directory change in a terminal window shell is not followed
Bram Moolenaar <Bram@vim.org>
parents:
24055
diff
changeset
|
809 change the directory of the shell running in a terminal window. You |
|
9257f3980f4a
patch 8.2.2675: directory change in a terminal window shell is not followed
Bram Moolenaar <Bram@vim.org>
parents:
24055
diff
changeset
|
810 need proper setting-up, so whenever the shell's pwd changes an OSC 7 |
|
9257f3980f4a
patch 8.2.2675: directory change in a terminal window shell is not followed
Bram Moolenaar <Bram@vim.org>
parents:
24055
diff
changeset
|
811 escape sequence will be emitted. For example, on Linux, you can source |
|
9257f3980f4a
patch 8.2.2675: directory change in a terminal window shell is not followed
Bram Moolenaar <Bram@vim.org>
parents:
24055
diff
changeset
|
812 /etc/profile.d/vte.sh in your shell profile if you use bash or zsh. |
| 27537 | 813 When the parsing of the OSC sequence fails you get *E1179* . |
|
24268
9257f3980f4a
patch 8.2.2675: directory change in a terminal window shell is not followed
Bram Moolenaar <Bram@vim.org>
parents:
24055
diff
changeset
|
814 |
| 7 | 815 *'arabic'* *'arab'* *'noarabic'* *'noarab'* |
| 816 'arabic' 'arab' boolean (default off) | |
| 817 local to window | |
| 818 {only available when compiled with the |+arabic| | |
| 819 feature} | |
| 820 This option can be set to start editing Arabic text. | |
| 821 Setting this option will: | |
| 822 - Set the 'rightleft' option, unless 'termbidi' is set. | |
| 823 - Set the 'arabicshape' option, unless 'termbidi' is set. | |
| 824 - Set the 'keymap' option to "arabic"; in Insert mode CTRL-^ toggles | |
| 825 between typing English and Arabic key mapping. | |
| 826 - Set the 'delcombine' option | |
| 827 Note that 'encoding' must be "utf-8" for working with Arabic text. | |
| 828 | |
| 829 Resetting this option will: | |
| 830 - Reset the 'rightleft' option. | |
| 831 - Disable the use of 'keymap' (without changing its value). | |
| 832 Note that 'arabicshape' and 'delcombine' are not reset (it is a global | |
| 3557 | 833 option). |
| 11160 | 834 NOTE: This option is reset when 'compatible' is set. |
| 7 | 835 Also see |arabic.txt|. |
| 836 | |
| 837 *'arabicshape'* *'arshape'* | |
| 838 *'noarabicshape'* *'noarshape'* | |
| 839 'arabicshape' 'arshape' boolean (default on) | |
| 840 global | |
| 841 {only available when compiled with the |+arabic| | |
| 842 feature} | |
| 843 When on and 'termbidi' is off, the required visual character | |
| 844 corrections that need to take place for displaying the Arabic language | |
| 3893 | 845 take effect. Shaping, in essence, gets enabled; the term is a broad |
| 7 | 846 one which encompasses: |
| 847 a) the changing/morphing of characters based on their location | |
| 848 within a word (initial, medial, final and stand-alone). | |
| 849 b) the enabling of the ability to compose characters | |
| 850 c) the enabling of the required combining of some characters | |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
851 When disabled the display shows each character's true stand-alone |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
852 form. |
| 7 | 853 Arabic is a complex language which requires other settings, for |
| 854 further details see |arabic.txt|. | |
| 11160 | 855 NOTE: This option is set when 'compatible' is set. |
| 7 | 856 |
| 857 *'autoindent'* *'ai'* *'noautoindent'* *'noai'* | |
| 858 'autoindent' 'ai' boolean (default off) | |
| 859 local to buffer | |
| 860 Copy indent from current line when starting a new line (typing <CR> | |
| 861 in Insert mode or when using the "o" or "O" command). If you do not | |
| 862 type anything on the new line except <BS> or CTRL-D and then type | |
| 1152 | 863 <Esc>, CTRL-O or <CR>, the indent is deleted again. Moving the cursor |
| 864 to another line has the same effect, unless the 'I' flag is included | |
| 865 in 'cpoptions'. | |
| 10 | 866 When autoindent is on, formatting (with the "gq" command or when you |
| 867 reach 'textwidth' in Insert mode) uses the indentation of the first | |
| 868 line. | |
| 7 | 869 When 'smartindent' or 'cindent' is on the indent is changed in |
| 870 a different way. | |
|
7147
c590de398af9
commit https://github.com/vim/vim/commit/ca63501fbcd1cf9c8aa9ff12c093c95b62a89ed7
Christian Brabandt <cb@256bit.org>
parents:
7080
diff
changeset
|
871 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
|
872 restored when 'paste' is reset. |
| 7 | 873 |
| 874 *'autoread'* *'ar'* *'noautoread'* *'noar'* | |
| 875 'autoread' 'ar' boolean (default off) | |
| 876 global or local to buffer |global-local| | |
| 877 When a file has been detected to have been changed outside of Vim and | |
| 878 it has not been changed inside of Vim, automatically read it again. | |
|
14298
4a588e3afd4a
Update runtime files, add Danish translations.
Christian Brabandt <cb@256bit.org>
parents:
14249
diff
changeset
|
879 When the file has been deleted this is not done, so you have the text |
|
4a588e3afd4a
Update runtime files, add Danish translations.
Christian Brabandt <cb@256bit.org>
parents:
14249
diff
changeset
|
880 from before it was deleted. When it appears again then it is read. |
|
4a588e3afd4a
Update runtime files, add Danish translations.
Christian Brabandt <cb@256bit.org>
parents:
14249
diff
changeset
|
881 |timestamp| |
| 7 | 882 If this option has a local value, use this command to switch back to |
| 883 using the global value: > | |
| 884 :set autoread< | |
| 885 < | |
| 886 *'autowrite'* *'aw'* *'noautowrite'* *'noaw'* | |
| 887 'autowrite' 'aw' boolean (default off) | |
| 888 global | |
| 889 Write the contents of the file, if it has been modified, on each | |
| 26438 | 890 `:next`, `:rewind`, `:last`, `:first`, `:previous`, `:stop`, |
| 27036 | 891 `:suspend`, `:tag`, `:!`, `:make`, CTRL-] and CTRL-^ command; and when |
| 892 a `:buffer`, CTRL-O, CTRL-I, '{A-Z0-9}, or `{A-Z0-9} command takes one | |
| 26438 | 893 to another file. |
| 894 A buffer is not written if it becomes hidden, e.g. when 'bufhidden' is | |
| 27036 | 895 set to "hide" and `:next` is used. |
| 7 | 896 Note that for some commands the 'autowrite' option is not used, see |
| 897 'autowriteall' for that. | |
| 14695 | 898 Some buffers will not be written, specifically when 'buftype' is |
| 14668 | 899 "nowrite", "nofile", "terminal" or "prompt". |
| 7 | 900 |
| 901 *'autowriteall'* *'awa'* *'noautowriteall'* *'noawa'* | |
| 902 'autowriteall' 'awa' boolean (default off) | |
| 903 global | |
| 904 Like 'autowrite', but also used for commands ":edit", ":enew", ":quit", | |
| 905 ":qall", ":exit", ":xit", ":recover" and closing the Vim window. | |
| 906 Setting this option also implies that Vim behaves like 'autowrite' has | |
| 907 been set. | |
| 908 | |
| 909 *'background'* *'bg'* | |
| 2826 | 910 'background' 'bg' string (default "dark" or "light", see below) |
| 7 | 911 global |
| 912 When set to "dark", Vim will try to use colors that look good on a | |
| 913 dark background. When set to "light", Vim will try to use colors that | |
| 914 look good on a light background. Any other value is illegal. | |
| 915 Vim tries to set the default value according to the terminal used. | |
| 916 This will not always be correct. | |
| 917 Setting this option does not change the background color, it tells Vim | |
| 918 what the background color looks like. For changing the background | |
| 919 color, see |:hi-normal|. | |
| 920 | |
| 921 When 'background' is set Vim will adjust the default color groups for | |
| 10 | 922 the new value. But the colors used for syntax highlighting will not |
| 1621 | 923 change. *g:colors_name* |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
924 When a color scheme is loaded (the "g:colors_name" variable is set) |
| 7 | 925 setting 'background' will cause the color scheme to be reloaded. If |
| 926 the color scheme adjusts to the value of 'background' this will work. | |
| 927 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
|
928 be undone. First delete the "g:colors_name" variable when needed. |
| 7 | 929 |
| 930 When setting 'background' to the default value with: > | |
| 931 :set background& | |
| 932 < Vim will guess the value. In the GUI this should work correctly, | |
| 933 in other cases Vim might not be able to guess the right value. | |
| 18343 | 934 If the GUI supports a dark theme, you can use the "d" flag in |
|
18078
5ae41d0ea397
patch 8.1.2034: dark them of GTK 3 not supported
Bram Moolenaar <Bram@vim.org>
parents:
18068
diff
changeset
|
935 'guioptions', see 'go-d'. |
| 7 | 936 |
| 12499 | 937 When the |t_RB| option is set, Vim will use it to request the background |
| 11442 | 938 color from the terminal. If the returned RGB value is dark/light and |
| 939 'background' is not dark/light, 'background' will be set and the | |
| 940 screen is redrawn. This may have side effects, make t_BG empty in | |
| 12499 | 941 your .vimrc if you suspect this problem. The response to |t_RB| can |
|
12756
3b26420fc639
Long overdue runtime update.
Christian Brabandt <cb@256bit.org>
parents:
12744
diff
changeset
|
942 be found in |v:termrbgresp|. |
| 11442 | 943 |
| 7 | 944 When starting the GUI, the default value for 'background' will be |
| 945 "light". When the value is not set in the .gvimrc, and Vim detects | |
| 946 that the background is actually quite dark, 'background' is set to | |
| 947 "dark". But this happens only AFTER the .gvimrc file has been read | |
| 948 (because the window needs to be opened to find the actual background | |
| 949 color). To get around this, force the GUI window to be opened by | |
| 950 putting a ":gui" command in the .gvimrc file, before where the value | |
| 951 of 'background' is used (e.g., before ":syntax on"). | |
| 2826 | 952 |
|
18912
ccd16426a1f9
patch 8.2.0017: OS/2 and MS-DOS are still mentioned
Bram Moolenaar <Bram@vim.org>
parents:
18879
diff
changeset
|
953 For MS-Windows the default is "dark". |
| 2826 | 954 For other systems "dark" is used when 'term' is "linux", |
| 955 "screen.linux", "cygwin" or "putty", or $COLORFGBG suggests a dark | |
| 956 background. Otherwise the default is "light". | |
| 957 | |
| 12254 | 958 The |:terminal| command and the |term_start()| function use the |
| 959 'background' value to decide whether the terminal window will start | |
| 960 with a white or black background. | |
| 961 | |
| 7 | 962 Normally this option would be set in the .vimrc file. Possibly |
| 963 depending on the terminal name. Example: > | |
| 964 :if &term == "pcterm" | |
| 965 : set background=dark | |
| 966 :endif | |
| 967 < When this option is set, the default settings for the highlight groups | |
| 968 will change. To use other settings, place ":highlight" commands AFTER | |
| 969 the setting of the 'background' option. | |
| 970 This option is also used in the "$VIMRUNTIME/syntax/syntax.vim" file | |
| 971 to select the colors for syntax highlighting. After changing this | |
| 972 option, you must load syntax.vim again to see the result. This can be | |
| 973 done with ":syntax on". | |
| 974 | |
| 975 *'backspace'* *'bs'* | |
|
9669
284b4eb307fc
commit https://github.com/vim/vim/commit/8c08b5b569e2a9e9f63dea514591ecfa2d3bb392
Christian Brabandt <cb@256bit.org>
parents:
9665
diff
changeset
|
976 '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
|
977 in |defaults.vim|) |
| 7 | 978 global |
| 979 Influences the working of <BS>, <Del>, CTRL-W and CTRL-U in Insert | |
| 980 mode. This is a list of items, separated by commas. Each item allows | |
| 981 a way to backspace over something: | |
| 982 value effect ~ | |
| 983 indent allow backspacing over autoindent | |
| 984 eol allow backspacing over line breaks (join lines) | |
| 985 start allow backspacing over the start of insert; CTRL-W and CTRL-U | |
| 986 stop once at the start of insert. | |
|
20069
9a67d41708d2
patch 8.2.0590: no 'backspace' value allows ignoring the insertion point
Bram Moolenaar <Bram@vim.org>
parents:
19968
diff
changeset
|
987 nostop like start, except CTRL-W and CTRL-U do not stop at the start of |
|
9a67d41708d2
patch 8.2.0590: no 'backspace' value allows ignoring the insertion point
Bram Moolenaar <Bram@vim.org>
parents:
19968
diff
changeset
|
988 insert. |
| 7 | 989 |
| 28246 | 990 When the value is empty, Vi compatible backspacing is used, none of |
| 991 the ways mentioned for the items above are possible. | |
| 7 | 992 |
| 993 For backwards compatibility with version 5.4 and earlier: | |
| 994 value effect ~ | |
| 995 0 same as ":set backspace=" (Vi compatible) | |
| 996 1 same as ":set backspace=indent,eol" | |
| 997 2 same as ":set backspace=indent,eol,start" | |
|
20069
9a67d41708d2
patch 8.2.0590: no 'backspace' value allows ignoring the insertion point
Bram Moolenaar <Bram@vim.org>
parents:
19968
diff
changeset
|
998 3 same as ":set backspace=indent,eol,nostop" |
| 7 | 999 |
| 1000 See |:fixdel| if your <BS> or <Del> key does not do what you want. | |
| 1001 NOTE: This option is set to "" when 'compatible' is set. | |
| 1002 | |
| 1003 *'backup'* *'bk'* *'nobackup'* *'nobk'* | |
| 1004 'backup' 'bk' boolean (default off) | |
| 1005 global | |
| 1006 Make a backup before overwriting a file. Leave it around after the | |
| 1007 file has been successfully written. If you do not want to keep the | |
| 1008 backup file, but you do want a backup while the file is being | |
| 1009 written, reset this option and set the 'writebackup' option (this is | |
| 1010 the default). If you do not want a backup file at all reset both | |
| 10 | 1011 options (use this if your file system is almost full). See the |
| 7 | 1012 |backup-table| for more explanations. |
| 1013 When the 'backupskip' pattern matches, a backup is not made anyway. | |
| 1014 When 'patchmode' is set, the backup may be renamed to become the | |
| 1015 oldest version of a file. | |
| 1016 NOTE: This option is reset when 'compatible' is set. | |
| 1017 | |
| 1018 *'backupcopy'* *'bkc'* | |
| 1019 'backupcopy' 'bkc' string (Vi default for Unix: "yes", otherwise: "auto") | |
| 6243 | 1020 global or local to buffer |global-local| |
| 7 | 1021 When writing a file and a backup is made, this option tells how it's |
| 1022 done. This is a comma separated list of words. | |
| 1023 | |
| 1024 The main values are: | |
| 1025 "yes" make a copy of the file and overwrite the original one | |
| 1026 "no" rename the file and write a new one | |
| 1027 "auto" one of the previous, what works best | |
| 1028 | |
| 1029 Extra values that can be combined with the ones above are: | |
| 1030 "breaksymlink" always break symlinks when writing | |
| 1031 "breakhardlink" always break hardlinks when writing | |
| 1032 | |
| 1033 Making a copy and overwriting the original file: | |
| 1034 - Takes extra time to copy the file. | |
| 1035 + When the file has special attributes, is a (hard/symbolic) link or | |
| 1036 has a resource fork, all this is preserved. | |
| 1037 - When the file is a link the backup will have the name of the link, | |
| 1038 not of the real file. | |
| 1039 | |
| 1040 Renaming the file and writing a new one: | |
| 1041 + It's fast. | |
| 1042 - Sometimes not all attributes of the file can be copied to the new | |
| 1043 file. | |
| 1044 - When the file is a link the new file will not be a link. | |
| 1045 | |
| 1046 The "auto" value is the middle way: When Vim sees that renaming file | |
| 1047 is possible without side effects (the attributes can be passed on and | |
| 1152 | 1048 the file is not a link) that is used. When problems are expected, a |
| 1049 copy will be made. | |
| 7 | 1050 |
| 1051 The "breaksymlink" and "breakhardlink" values can be used in | |
| 1052 combination with any of "yes", "no" and "auto". When included, they | |
| 1053 force Vim to always break either symbolic or hard links by doing | |
| 1054 exactly what the "no" option does, renaming the original file to | |
| 1055 become the backup and writing a new file in its place. This can be | |
| 1056 useful for example in source trees where all the files are symbolic or | |
| 1057 hard links and any changes should stay in the local source tree, not | |
| 1058 be propagated back to the original source. | |
| 1059 *crontab* | |
| 1060 One situation where "no" and "auto" will cause problems: A program | |
| 1061 that opens a file, invokes Vim to edit that file, and then tests if | |
| 1062 the open file was changed (through the file descriptor) will check the | |
| 10 | 1063 backup file instead of the newly created file. "crontab -e" is an |
| 7 | 1064 example. |
| 1065 | |
| 1066 When a copy is made, the original file is truncated and then filled | |
| 1067 with the new text. This means that protection bits, owner and | |
| 1068 symbolic links of the original file are unmodified. The backup file | |
| 10 | 1069 however, is a new file, owned by the user who edited the file. The |
| 7 | 1070 group of the backup is set to the group of the original file. If this |
| 1071 fails, the protection bits for the group are made the same as for | |
| 1072 others. | |
| 1073 | |
| 1074 When the file is renamed this is the other way around: The backup has | |
| 1075 the same attributes of the original file, and the newly written file | |
| 1076 is owned by the current user. When the file was a (hard/symbolic) | |
| 1077 link, the new file will not! That's why the "auto" value doesn't | |
| 1078 rename when the file is a link. The owner and group of the newly | |
| 1079 written file will be set to the same ones as the original file, but | |
| 1080 the system may refuse to do this. In that case the "auto" value will | |
| 1081 again not rename the file. | |
| 1082 | |
| 11160 | 1083 NOTE: This option is set to the Vi default value when 'compatible' is |
| 1084 set and to the Vim default value when 'compatible' is reset. | |
| 1085 | |
| 7 | 1086 *'backupdir'* *'bdir'* |
| 1087 'backupdir' 'bdir' string (default for Amiga: ".,t:", | |
| 18972 | 1088 for Win32: ".,$TEMP,c:/tmp,c:/temp" |
| 7 | 1089 for Unix: ".,~/tmp,~/") |
| 1090 global | |
| 1091 List of directories for the backup file, separated with commas. | |
| 1092 - 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
|
1093 where this is possible. The directory must exist, Vim will not |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
1094 create it for you. |
|
8629
54ac275e3fc4
commit https://github.com/vim/vim/commit/3848e00e0177abdb31bc600234967863ec487233
Christian Brabandt <cb@256bit.org>
parents:
8560
diff
changeset
|
1095 - Empty means that no backup file will be created ('patchmode' is |
| 7 | 1096 impossible!). Writing may fail because of this. |
| 1097 - A directory "." means to put the backup file in the same directory | |
| 1098 as the edited file. | |
| 19116 | 1099 - A directory starting with "./" (or ".\" for MS-Windows) means to put |
| 1100 the backup file relative to where the edited file is. The leading | |
| 1101 "." is replaced with the path name of the edited file. | |
| 7 | 1102 ("." inside a directory name has no special meaning). |
| 1103 - Spaces after the comma are ignored, other spaces are considered part | |
| 1104 of the directory name. To have a space at the start of a directory | |
| 1105 name, precede it with a backslash. | |
| 1106 - To include a comma in a directory name precede it with a backslash. | |
| 1107 - A directory name may end in an '/'. | |
|
14475
dddba3937532
patch 8.1.0251: using full path is not supported for 'backupdir'
Christian Brabandt <cb@256bit.org>
parents:
14421
diff
changeset
|
1108 - For Unix and Win32, if a directory ends in two path separators "//", |
| 15033 | 1109 the backup file name will be built from the complete path to the |
| 1110 file with all path separators changed to percent '%' signs. This | |
| 1111 will ensure file name uniqueness in the backup directory. | |
|
14475
dddba3937532
patch 8.1.0251: using full path is not supported for 'backupdir'
Christian Brabandt <cb@256bit.org>
parents:
14421
diff
changeset
|
1112 On Win32, it is also possible to end with "\\". However, When a |
|
dddba3937532
patch 8.1.0251: using full path is not supported for 'backupdir'
Christian Brabandt <cb@256bit.org>
parents:
14421
diff
changeset
|
1113 separating comma is following, you must use "//", since "\\" will |
|
dddba3937532
patch 8.1.0251: using full path is not supported for 'backupdir'
Christian Brabandt <cb@256bit.org>
parents:
14421
diff
changeset
|
1114 include the comma in the file name. Therefore it is recommended to |
|
dddba3937532
patch 8.1.0251: using full path is not supported for 'backupdir'
Christian Brabandt <cb@256bit.org>
parents:
14421
diff
changeset
|
1115 use '//', instead of '\\'. |
| 7 | 1116 - Environment variables are expanded |:set_env|. |
| 1117 - Careful with '\' characters, type one before a space, type two to | |
| 1118 get one in the option (see |option-backslash|), for example: > | |
| 1119 :set bdir=c:\\tmp,\ dir\\,with\\,commas,\\\ dir\ with\ spaces | |
| 1120 < - For backwards compatibility with Vim version 3.0 a '>' at the start | |
| 1121 of the option is removed. | |
| 1122 See also 'backup' and 'writebackup' options. | |
| 1123 If you want to hide your backup files on Unix, consider this value: > | |
| 1124 :set backupdir=./.backup,~/.backup,.,/tmp | |
| 1125 < You must create a ".backup" directory in each directory and in your | |
| 1126 home directory for this to work properly. | |
| 1127 The use of |:set+=| and |:set-=| is preferred when adding or removing | |
| 1128 directories from the list. This avoids problems when a future version | |
| 1129 uses another default. | |
| 1130 This option cannot be set from a |modeline| or in the |sandbox|, for | |
| 1131 security reasons. | |
| 1132 | |
| 1133 *'backupext'* *'bex'* *E589* | |
| 1134 'backupext' 'bex' string (default "~", for VMS: "_") | |
| 1135 global | |
| 1136 String which is appended to a file name to make the name of the | |
| 1137 backup file. The default is quite unusual, because this avoids | |
| 1138 accidentally overwriting existing files with a backup file. You might | |
| 1139 prefer using ".bak", but make sure that you don't have files with | |
| 1140 ".bak" that you want to keep. | |
| 36 | 1141 Only normal file name characters can be used, "/\*?[|<>" are illegal. |
| 7 | 1142 |
| 26 | 1143 If you like to keep a lot of backups, you could use a BufWritePre |
| 1144 autocommand to change 'backupext' just before writing the file to | |
| 1145 include a timestamp. > | |
| 27903 | 1146 :au BufWritePre * let &bex = '-' .. strftime("%Y%b%d%X") .. '~' |
| 26 | 1147 < Use 'backupdir' to put the backup in a different directory. |
| 1148 | |
| 7 | 1149 *'backupskip'* *'bsk'* |
|
13664
f64c5e636c9f
patch 8.0.1704: 'backupskip' default doesn't work for Mac
Christian Brabandt <cb@256bit.org>
parents:
13482
diff
changeset
|
1150 'backupskip' 'bsk' string (default: "$TMPDIR/*,$TMP/*,$TEMP/*" |
|
f64c5e636c9f
patch 8.0.1704: 'backupskip' default doesn't work for Mac
Christian Brabandt <cb@256bit.org>
parents:
13482
diff
changeset
|
1151 Unix: "/tmp/*,$TMPDIR/*,$TMP/*,$TEMP/*" |
|
f64c5e636c9f
patch 8.0.1704: 'backupskip' default doesn't work for Mac
Christian Brabandt <cb@256bit.org>
parents:
13482
diff
changeset
|
1152 Mac: "/private/tmp/*,$TMPDIR/*,$TMP/*,$TEMP/*") |
| 7 | 1153 global |
| 1154 {not available when compiled without the |+wildignore| | |
| 1155 feature} | |
| 1156 A list of file patterns. When one of the patterns matches with the | |
| 1157 name of the file which is written, no backup file is created. Both | |
| 1158 the specified file name and the full path name of the file are used. | |
| 1159 The pattern is used like with |:autocmd|, see |autocmd-patterns|. | |
| 1160 Watch out for special characters, see |option-backslash|. | |
| 1161 When $TMPDIR, $TMP or $TEMP is not defined, it is not used for the | |
| 233 | 1162 default value. "/tmp/*" is only used for Unix. |
| 1152 | 1163 |
| 3513 | 1164 WARNING: Not having a backup file means that when Vim fails to write |
| 1165 your buffer correctly and then, for whatever reason, Vim exits, you | |
| 1166 lose both the original file and what you were writing. Only disable | |
| 1167 backups if you don't care about losing the file. | |
| 1168 | |
| 1152 | 1169 Note that environment variables are not expanded. If you want to use |
| 1170 $HOME you must expand it explicitly, e.g.: > | |
| 27903 | 1171 :let &backupskip = escape(expand('$HOME'), '\') .. '/tmp/*' |
| 1152 | 1172 |
| 1173 < Note that the default also makes sure that "crontab -e" works (when a | |
| 557 | 1174 backup would be made by renaming the original file crontab won't see |
| 1175 the newly created file). Also see 'backupcopy' and |crontab|. | |
| 7 | 1176 |
| 1177 *'balloondelay'* *'bdlay'* | |
| 1178 'balloondelay' 'bdlay' number (default: 600) | |
| 1179 global | |
| 1180 {only available when compiled with the |+balloon_eval| | |
| 1181 feature} | |
| 1182 Delay in milliseconds before a balloon may pop up. See |balloon-eval|. | |
| 1183 | |
| 1184 *'ballooneval'* *'beval'* *'noballooneval'* *'nobeval'* | |
| 1185 'ballooneval' 'beval' boolean (default off) | |
| 1186 global | |
| 1187 {only available when compiled with the |+balloon_eval| | |
| 189 | 1188 feature} |
|
12865
ebb4f6c93598
patch 8.0.1309: cannot use 'balloonexpr' in a terminal
Christian Brabandt <cb@256bit.org>
parents:
12826
diff
changeset
|
1189 Switch on the |balloon-eval| functionality for the GUI. |
|
ebb4f6c93598
patch 8.0.1309: cannot use 'balloonexpr' in a terminal
Christian Brabandt <cb@256bit.org>
parents:
12826
diff
changeset
|
1190 |
|
ebb4f6c93598
patch 8.0.1309: cannot use 'balloonexpr' in a terminal
Christian Brabandt <cb@256bit.org>
parents:
12826
diff
changeset
|
1191 *'balloonevalterm'* *'bevalterm'* *'noballoonevalterm'* |
|
ebb4f6c93598
patch 8.0.1309: cannot use 'balloonexpr' in a terminal
Christian Brabandt <cb@256bit.org>
parents:
12826
diff
changeset
|
1192 *'nobevalterm'* |
|
ebb4f6c93598
patch 8.0.1309: cannot use 'balloonexpr' in a terminal
Christian Brabandt <cb@256bit.org>
parents:
12826
diff
changeset
|
1193 'balloonevalterm' 'bevalterm' boolean (default off) |
|
ebb4f6c93598
patch 8.0.1309: cannot use 'balloonexpr' in a terminal
Christian Brabandt <cb@256bit.org>
parents:
12826
diff
changeset
|
1194 global |
|
ebb4f6c93598
patch 8.0.1309: cannot use 'balloonexpr' in a terminal
Christian Brabandt <cb@256bit.org>
parents:
12826
diff
changeset
|
1195 {only available when compiled with the |
|
ebb4f6c93598
patch 8.0.1309: cannot use 'balloonexpr' in a terminal
Christian Brabandt <cb@256bit.org>
parents:
12826
diff
changeset
|
1196 |+balloon_eval_term| feature} |
|
ebb4f6c93598
patch 8.0.1309: cannot use 'balloonexpr' in a terminal
Christian Brabandt <cb@256bit.org>
parents:
12826
diff
changeset
|
1197 Switch on the |balloon-eval| functionality for the terminal. |
| 7 | 1198 |
| 189 | 1199 *'balloonexpr'* *'bexpr'* |
| 1200 'balloonexpr' 'bexpr' string (default "") | |
| 790 | 1201 global or local to buffer |global-local| |
| 189 | 1202 {only available when compiled with the |+balloon_eval| |
| 1203 feature} | |
| 782 | 1204 Expression for text to show in evaluation balloon. It is only used |
| 16610 | 1205 when 'ballooneval' or 'balloonevalterm' is on. These variables can be |
| 1206 used: | |
| 189 | 1207 |
| 1208 v:beval_bufnr number of the buffer in which balloon is going to show | |
| 1209 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
|
1210 v:beval_winid ID of the window |
| 189 | 1211 v:beval_lnum line number |
| 1212 v:beval_col column number (byte index) | |
| 1213 v:beval_text word under or after the mouse pointer | |
| 1214 | |
| 17571 | 1215 Instead of showing a balloon, which is limited to plain text, consider |
| 1216 using a popup window, see |popup_beval_example|. A popup window can | |
| 1217 use highlighting and show a border. | |
| 1218 | |
| 189 | 1219 The evaluation of the expression must not have side effects! |
| 1220 Example: > | |
| 16610 | 1221 function MyBalloonExpr() |
| 27903 | 1222 return 'Cursor is at line ' .. v:beval_lnum .. |
| 1223 \ ', column ' .. v:beval_col .. | |
| 1224 \ ' of file ' .. bufname(v:beval_bufnr) .. | |
| 1225 \ ' on word "' .. v:beval_text .. '"' | |
| 189 | 1226 endfunction |
| 1227 set bexpr=MyBalloonExpr() | |
| 1228 set ballooneval | |
| 1229 < | |
| 17372 | 1230 Also see |balloon_show()|, it can be used if the content of the balloon |
| 1231 is to be fetched asynchronously. In that case evaluating | |
| 1232 'balloonexpr' should result in an empty string. If you get a balloon | |
| 1233 with only "0" you probably didn't return anything from your function. | |
| 11062 | 1234 |
| 189 | 1235 NOTE: The balloon is displayed only if the cursor is on a text |
| 1236 character. If the result of evaluating 'balloonexpr' is not empty, | |
| 1237 Vim does not try to send a message to an external debugger (Netbeans | |
| 1238 or Sun Workshop). | |
| 1239 | |
|
26743
c2c40cefc17b
patch 8.2.3900: it is not easy to use a script-local function for an option
Bram Moolenaar <Bram@vim.org>
parents:
26708
diff
changeset
|
1240 If the expression starts with s: or |<SID>|, then it is replaced with |
|
c2c40cefc17b
patch 8.2.3900: it is not easy to use a script-local function for an option
Bram Moolenaar <Bram@vim.org>
parents:
26708
diff
changeset
|
1241 the script ID (|local-function|). Example: > |
|
c2c40cefc17b
patch 8.2.3900: it is not easy to use a script-local function for an option
Bram Moolenaar <Bram@vim.org>
parents:
26708
diff
changeset
|
1242 set bexpr=s:MyBalloonExpr() |
|
c2c40cefc17b
patch 8.2.3900: it is not easy to use a script-local function for an option
Bram Moolenaar <Bram@vim.org>
parents:
26708
diff
changeset
|
1243 set bexpr=<SID>SomeBalloonExpr() |
| 27321 | 1244 < Otherwise, the expression is evaluated in the context of the script |
| 1245 where the option was set, thus script-local items are available. | |
| 1246 | |
| 3682 | 1247 The expression will be evaluated in the |sandbox| when set from a |
| 1248 modeline, see |sandbox-option|. | |
|
16728
e55c26aaf484
patch 8.1.1366: using expressions in a modeline is unsafe
Bram Moolenaar <Bram@vim.org>
parents:
16610
diff
changeset
|
1249 This option cannot be set in a modeline when 'modelineexpr' is off. |
| 634 | 1250 |
| 1251 It is not allowed to change text or jump to another window while | |
| 17372 | 1252 evaluating 'balloonexpr', see |textlock|. |
| 634 | 1253 |
| 446 | 1254 To check whether line breaks in the balloon text work use this check: > |
| 435 | 1255 if has("balloon_multiline") |
| 714 | 1256 < When they are supported "\n" characters will start a new line. If the |
| 1257 expression evaluates to a |List| this is equal to using each List item | |
| 1258 as a string and putting "\n" in between them. | |
| 11160 | 1259 NOTE: This option is set to "" when 'compatible' is set. |
| 714 | 1260 |
| 6949 | 1261 *'belloff'* *'bo'* |
| 1262 'belloff' 'bo' string (default "") | |
| 1263 global | |
| 1264 Specifies for which events the bell will not be rung. It is a comma | |
| 1265 separated list of items. For each item that is present, the bell | |
| 1266 will be silenced. This is most useful to specify specific events in | |
| 1267 insert mode to be silenced. | |
| 1268 | |
| 1269 item meaning when present ~ | |
| 1270 all All events. | |
| 1271 backspace When hitting <BS> or <Del> and deleting results in an | |
| 1272 error. | |
| 1273 cursor Fail to move around using the cursor keys or | |
| 1274 <PageUp>/<PageDown> in |Insert-mode|. | |
| 1275 complete Error occurred when using |i_CTRL-X_CTRL-K| or | |
| 1276 |i_CTRL-X_CTRL-T|. | |
| 1277 copy Cannot copy char from insert mode using |i_CTRL-Y| or | |
| 1278 |i_CTRL-E|. | |
| 1279 ctrlg Unknown Char after <C-G> in Insert mode. | |
| 1280 error Other Error occurred (e.g. try to join last line) | |
| 1281 (mostly used in |Normal-mode| or |Cmdline-mode|). | |
| 1282 esc hitting <Esc> in |Normal-mode|. | |
| 1283 ex In |Visual-mode|, hitting |Q| results in an error. | |
| 18719 | 1284 hangul Ignored. |
| 6949 | 1285 insertmode Pressing <Esc> in 'insertmode'. |
| 1286 lang Calling the beep module for Lua/Mzscheme/TCL. | |
| 1287 mess No output available for |g<|. | |
| 1288 showmatch Error occurred for 'showmatch' function. | |
| 1289 operator Empty region error |cpo-E|. | |
| 1290 register Unknown register after <C-R> in |Insert-mode|. | |
| 1291 shell Bell from shell output |:!|. | |
| 1292 spell Error happened on spell suggest. | |
| 1293 wildmode More matches in |cmdline-completion| available | |
| 1294 (depends on the 'wildmode' setting). | |
| 1295 | |
| 11160 | 1296 This is most useful to fine tune when in Insert mode the bell should |
| 1297 be rung. For Normal mode and Ex commands, the bell is often rung to | |
| 6949 | 1298 indicate that an error occurred. It can be silenced by adding the |
| 1299 "error" keyword. | |
| 1300 | |
| 7 | 1301 *'binary'* *'bin'* *'nobinary'* *'nobin'* |
| 1302 'binary' 'bin' boolean (default off) | |
| 1303 local to buffer | |
| 1304 This option should be set before editing a binary file. You can also | |
| 1305 use the |-b| Vim argument. When this option is switched on a few | |
| 1306 options will be changed (also when it already was on): | |
| 1307 'textwidth' will be set to 0 | |
| 1308 'wrapmargin' will be set to 0 | |
| 1309 'modeline' will be off | |
| 1310 'expandtab' will be off | |
| 1311 Also, 'fileformat' and 'fileformats' options will not be used, the | |
| 1312 file is read and written like 'fileformat' was "unix" (a single <NL> | |
| 1313 separates lines). | |
| 1314 The 'fileencoding' and 'fileencodings' options will not be used, the | |
| 1315 file is read without conversion. | |
| 1316 NOTE: When you start editing a(nother) file while the 'bin' option is | |
| 1317 on, settings from autocommands may change the settings again (e.g., | |
| 1318 'textwidth'), causing trouble when editing. You might want to set | |
| 1319 'bin' again when the file has been loaded. | |
| 1320 The previous values of these options are remembered and restored when | |
| 1321 'bin' is switched from on to off. Each buffer has its own set of | |
| 1322 saved option values. | |
| 1323 To edit a file with 'binary' set you can use the |++bin| argument. | |
| 1324 This avoids you have to do ":set bin", which would have effect for all | |
| 1325 files you edit. | |
| 1326 When writing a file the <EOL> for the last line is only written if | |
| 1327 there was one in the original file (normally Vim appends an <EOL> to | |
| 1328 the last line if there is none; this would make the file longer). See | |
| 1329 the 'endofline' option. | |
| 1330 | |
| 1331 *'bioskey'* *'biosk'* *'nobioskey'* *'nobiosk'* | |
| 1332 'bioskey' 'biosk' boolean (default on) | |
| 1333 global | |
|
16443
32a543152dc0
patch 8.1.1226: {not in Vi} remarks get in the way of useful help text
Bram Moolenaar <Bram@vim.org>
parents:
16439
diff
changeset
|
1334 {only for MS-DOS} |
|
8246
f16bfe02cef1
commit https://github.com/vim/vim/commit/f391327adbbffb11180cf6038a92af1ed144e907
Christian Brabandt <cb@256bit.org>
parents:
8182
diff
changeset
|
1335 This was for MS-DOS and is no longer supported. |
| 7 | 1336 |
| 1337 *'bomb'* *'nobomb'* | |
| 1338 'bomb' boolean (default off) | |
| 1339 local to buffer | |
| 1340 When writing a file and the following conditions are met, a BOM (Byte | |
| 1341 Order Mark) is prepended to the file: | |
| 1342 - this option is on | |
| 1343 - the 'binary' option is off | |
| 1344 - 'fileencoding' is "utf-8", "ucs-2", "ucs-4" or one of the little/big | |
| 1345 endian variants. | |
| 1346 Some applications use the BOM to recognize the encoding of the file. | |
| 1347 Often used for UCS-2 files on MS-Windows. For other applications it | |
| 1348 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
|
1349 appear halfway the resulting file. Gcc doesn't accept a BOM. |
| 7 | 1350 When Vim reads a file and 'fileencodings' starts with "ucs-bom", a |
| 1351 check for the presence of the BOM is done and 'bomb' set accordingly. | |
| 1352 Unless 'binary' is set, it is removed from the first line, so that you | |
| 1353 don't see it when editing. When you don't change the options, the BOM | |
| 1354 will be restored when writing the file. | |
| 1355 | |
| 1356 *'breakat'* *'brk'* | |
| 1357 'breakat' 'brk' string (default " ^I!@*-+;:,./?") | |
| 1358 global | |
|
2570
71b56b4e7785
Make the references to features in the help more consistent. (Sylvain Hitier)
Bram Moolenaar <bram@vim.org>
parents:
2561
diff
changeset
|
1359 {not available when compiled without the |+linebreak| |
| 7 | 1360 feature} |
| 1361 This option lets you choose which characters might cause a line | |
| 500 | 1362 break if 'linebreak' is on. Only works for ASCII and also for 8-bit |
| 1363 characters when 'encoding' is an 8-bit encoding. | |
| 7 | 1364 |
|
8835
c1a5623cfc86
commit https://github.com/vim/vim/commit/7c1c6dbb6817640fd3956a0d5417da23fde336d8
Christian Brabandt <cb@256bit.org>
parents:
8748
diff
changeset
|
1365 *'breakindent'* *'bri'* *'nobreakindent'* *'nobri'* |
| 6009 | 1366 'breakindent' 'bri' boolean (default off) |
| 1367 local to window | |
| 1368 {not available when compiled without the |+linebreak| | |
| 1369 feature} | |
| 1370 Every wrapped line will continue visually indented (same amount of | |
| 1371 space as the beginning of that line), thus preserving horizontal blocks | |
| 1372 of text. | |
| 11160 | 1373 NOTE: This option is reset when 'compatible' is set. |
| 6009 | 1374 |
| 1375 *'breakindentopt'* *'briopt'* | |
| 1376 'breakindentopt' 'briopt' string (default empty) | |
| 1377 local to window | |
| 1378 {not available when compiled without the |+linebreak| | |
| 1379 feature} | |
| 1380 Settings for 'breakindent'. It can consist of the following optional | |
| 6026 | 1381 items and must be separated by a comma: |
| 6009 | 1382 min:{n} Minimum text width that will be kept after |
| 1383 applying 'breakindent', even if the resulting | |
| 1384 text should normally be narrower. This prevents | |
| 1385 text indented almost to the right window border | |
| 1386 occupying lot of vertical space when broken. | |
|
27128
164d59ddd48a
patch 8.2.4093: cached breakindent values not initialized properly
Bram Moolenaar <Bram@vim.org>
parents:
27036
diff
changeset
|
1387 (default: 20) |
| 6026 | 1388 shift:{n} After applying 'breakindent', the wrapped line's |
| 1389 beginning will be shifted by the given number of | |
| 1390 characters. It permits dynamic French paragraph | |
| 6009 | 1391 indentation (negative) or emphasizing the line |
| 1392 continuation (positive). | |
|
13341
acd7eaa13d2b
Updated runtime files.
Christian Brabandt <cb@256bit.org>
parents:
13314
diff
changeset
|
1393 sbr Display the 'showbreak' value before applying the |
| 6009 | 1394 additional indent. |
|
25322
b3d7becabe99
patch 8.2.3198: cannot use 'formatlistpat' for breakindent
Bram Moolenaar <Bram@vim.org>
parents:
25248
diff
changeset
|
1395 list:{n} Adds an additional indent for lines that match a |
|
25248
cf0774d010b7
patch 8.2.3160: 'breakindent' does not work well for bulleted lists
Bram Moolenaar <Bram@vim.org>
parents:
25084
diff
changeset
|
1396 numbered or bulleted list (using the |
|
cf0774d010b7
patch 8.2.3160: 'breakindent' does not work well for bulleted lists
Bram Moolenaar <Bram@vim.org>
parents:
25084
diff
changeset
|
1397 'formatlistpat' setting). |
|
25322
b3d7becabe99
patch 8.2.3198: cannot use 'formatlistpat' for breakindent
Bram Moolenaar <Bram@vim.org>
parents:
25248
diff
changeset
|
1398 list:-1 Uses the length of a match with 'formatlistpat' |
|
b3d7becabe99
patch 8.2.3198: cannot use 'formatlistpat' for breakindent
Bram Moolenaar <Bram@vim.org>
parents:
25248
diff
changeset
|
1399 for indentation. |
|
25248
cf0774d010b7
patch 8.2.3160: 'breakindent' does not work well for bulleted lists
Bram Moolenaar <Bram@vim.org>
parents:
25084
diff
changeset
|
1400 The default value for min is 20, shift and list is 0. |
| 6009 | 1401 |
| 7 | 1402 *'browsedir'* *'bsdir'* |
| 29 | 1403 'browsedir' 'bsdir' string (default: "last") |
| 7 | 1404 global |
|
16443
32a543152dc0
patch 8.1.1226: {not in Vi} remarks get in the way of useful help text
Bram Moolenaar <Bram@vim.org>
parents:
16439
diff
changeset
|
1405 {only for Motif, Athena, GTK, Mac and Win32 GUI} |
| 7 | 1406 Which directory to use for the file browser: |
| 1621 | 1407 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
|
1408 file was opened or saved. |
| 7 | 1409 buffer Use the directory of the related buffer. |
| 1410 current Use the current directory. | |
| 1411 {path} Use the specified directory | |
| 1412 | |
| 1413 *'bufhidden'* *'bh'* | |
| 1414 'bufhidden' 'bh' string (default: "") | |
| 1415 local to buffer | |
| 1416 This option specifies what happens when a buffer is no longer | |
| 1417 displayed in a window: | |
| 1418 <empty> follow the global 'hidden' option | |
| 1419 hide hide the buffer (don't unload it), also when 'hidden' | |
| 1420 is not set | |
| 1421 unload unload the buffer, also when 'hidden' is set or using | |
| 1422 |:hide| | |
| 1423 delete delete the buffer from the buffer list, also when | |
| 1424 'hidden' is set or using |:hide|, like using | |
| 1425 |:bdelete| | |
| 1426 wipe wipe out the buffer from the buffer list, also when | |
| 1427 'hidden' is set or using |:hide|, like using | |
| 1428 |:bwipeout| | |
| 1429 | |
| 82 | 1430 CAREFUL: when "unload", "delete" or "wipe" is used changes in a buffer |
| 3224 | 1431 are lost without a warning. Also, these values may break autocommands |
| 1432 that switch between buffers temporarily. | |
| 7 | 1433 This option is used together with 'buftype' and 'swapfile' to specify |
| 1434 special kinds of buffers. See |special-buffers|. | |
| 1435 | |
| 1436 *'buflisted'* *'bl'* *'nobuflisted'* *'nobl'* *E85* | |
| 1437 'buflisted' 'bl' boolean (default: on) | |
| 1438 local to buffer | |
| 1439 When this option is set, the buffer shows up in the buffer list. If | |
| 1440 it is reset it is not used for ":bnext", "ls", the Buffers menu, etc. | |
| 1441 This option is reset by Vim for buffers that are only used to remember | |
| 1442 a file name or marks. Vim sets it when starting to edit a buffer. | |
| 1443 But not when moving to a buffer with ":buffer". | |
| 1444 | |
| 1445 *'buftype'* *'bt'* *E382* | |
| 1446 'buftype' 'bt' string (default: "") | |
| 1447 local to buffer | |
| 1448 The value of this option specifies the type of a buffer: | |
| 1449 <empty> normal buffer | |
| 1450 nofile buffer which is not related to a file and will not be | |
| 1451 written | |
| 1452 nowrite buffer which will not be written | |
| 17 | 1453 acwrite buffer which will always be written with BufWriteCmd |
| 13437 | 1454 autocommands. |
| 7 | 1455 quickfix quickfix buffer, contains list of errors |:cwindow| |
| 648 | 1456 or list of locations |:lwindow| |
| 7 | 1457 help help buffer (you are not supposed to set this |
| 1458 manually) | |
|
11757
74abb6c84984
patch 8.0.0761: options not set properly for a terminal buffer
Christian Brabandt <cb@256bit.org>
parents:
11666
diff
changeset
|
1459 terminal buffer for a |terminal| (you are not supposed to set |
|
74abb6c84984
patch 8.0.0761: options not set properly for a terminal buffer
Christian Brabandt <cb@256bit.org>
parents:
11666
diff
changeset
|
1460 this manually) |
|
14019
dc67449d648c
patch 8.1.0027: difficult to make a plugin that feeds a line to a job
Christian Brabandt <cb@256bit.org>
parents:
14006
diff
changeset
|
1461 prompt buffer where only the last line can be edited, meant |
|
dc67449d648c
patch 8.1.0027: difficult to make a plugin that feeds a line to a job
Christian Brabandt <cb@256bit.org>
parents:
14006
diff
changeset
|
1462 to be used by a plugin, see |prompt-buffer| |
|
dc67449d648c
patch 8.1.0027: difficult to make a plugin that feeds a line to a job
Christian Brabandt <cb@256bit.org>
parents:
14006
diff
changeset
|
1463 {only when compiled with the |+channel| feature} |
|
16778
eda4d65f232c
patch 8.1.1391: no popup window support
Bram Moolenaar <Bram@vim.org>
parents:
16740
diff
changeset
|
1464 popup buffer used in a popup window, see |popup|. |
|
eda4d65f232c
patch 8.1.1391: no popup window support
Bram Moolenaar <Bram@vim.org>
parents:
16740
diff
changeset
|
1465 {only when compiled with the |+textprop| feature} |
| 7 | 1466 |
| 1467 This option is used together with 'bufhidden' and 'swapfile' to | |
| 1468 specify special kinds of buffers. See |special-buffers|. | |
| 19404 | 1469 Also see |win_gettype()|, which returns the type of the window. |
| 7 | 1470 |
| 1471 Be careful with changing this option, it can have many side effects! | |
| 26100 | 1472 One such effect is that Vim will not check the timestamp of the file, |
| 1473 if the file is changed by another program this will not be noticed. | |
| 7 | 1474 |
| 648 | 1475 A "quickfix" buffer is only used for the error list and the location |
| 1476 list. This value is set by the |:cwindow| and |:lwindow| commands and | |
| 1477 you are not supposed to change it. | |
| 7 | 1478 |
| 1479 "nofile" and "nowrite" buffers are similar: | |
| 1480 both: The buffer is not to be written to disk, ":w" doesn't | |
| 1481 work (":w filename" does work though). | |
| 1482 both: The buffer is never considered to be |'modified'|. | |
| 1483 There is no warning when the changes will be lost, for | |
| 1484 example when you quit Vim. | |
| 1485 both: A swap file is only created when using too much memory | |
| 1486 (when 'swapfile' has been reset there is never a swap | |
| 1487 file). | |
| 1488 nofile only: The buffer name is fixed, it is not handled like a | |
| 1489 file name. It is not modified in response to a |:cd| | |
| 1490 command. | |
| 6647 | 1491 both: When using ":e bufname" and already editing "bufname" |
| 1492 the buffer is made empty and autocommands are | |
| 1493 triggered as usual for |:edit|. | |
| 17 | 1494 *E676* |
| 1495 "acwrite" implies that the buffer name is not related to a file, like | |
| 1496 "nofile", but it will be written. Thus, in contrast to "nofile" and | |
| 1497 "nowrite", ":w" does work and a modified buffer can't be abandoned | |
| 1498 without saving. For writing there must be matching |BufWriteCmd|, | |
| 1499 |FileWriteCmd| or |FileAppendCmd| autocommands. | |
| 7 | 1500 |
| 1501 *'casemap'* *'cmp'* | |
| 1502 'casemap' 'cmp' string (default: "internal,keepascii") | |
| 1503 global | |
| 1504 Specifies details about changing the case of letters. It may contain | |
| 1505 these words, separated by a comma: | |
| 1506 internal Use internal case mapping functions, the current | |
| 1507 locale does not change the case mapping. This only | |
| 493 | 1508 matters when 'encoding' is a Unicode encoding, |
| 1509 "latin1" or "iso-8859-15". When "internal" is | |
| 1510 omitted, the towupper() and towlower() system library | |
| 1511 functions are used when available. | |
| 7 | 1512 keepascii For the ASCII characters (0x00 to 0x7f) use the US |
| 1513 case mapping, the current locale is not effective. | |
| 1514 This probably only matters for Turkish. | |
| 1515 | |
|
26508
a0bc10e83cf8
patch 8.2.3784: the help for options is outdated
Bram Moolenaar <Bram@vim.org>
parents:
26441
diff
changeset
|
1516 *'cdhome'* *'cdh'* |
|
a0bc10e83cf8
patch 8.2.3784: the help for options is outdated
Bram Moolenaar <Bram@vim.org>
parents:
26441
diff
changeset
|
1517 'cdhome' 'cdh' boolean (default: off) |
|
a0bc10e83cf8
patch 8.2.3784: the help for options is outdated
Bram Moolenaar <Bram@vim.org>
parents:
26441
diff
changeset
|
1518 global |
|
a0bc10e83cf8
patch 8.2.3784: the help for options is outdated
Bram Moolenaar <Bram@vim.org>
parents:
26441
diff
changeset
|
1519 When on, |:cd|, |:tcd| and |:lcd| without an argument changes the |
|
a0bc10e83cf8
patch 8.2.3784: the help for options is outdated
Bram Moolenaar <Bram@vim.org>
parents:
26441
diff
changeset
|
1520 current working directory to the |$HOME| directory like in Unix. |
|
a0bc10e83cf8
patch 8.2.3784: the help for options is outdated
Bram Moolenaar <Bram@vim.org>
parents:
26441
diff
changeset
|
1521 When off, those commands just print the current directory name. |
|
a0bc10e83cf8
patch 8.2.3784: the help for options is outdated
Bram Moolenaar <Bram@vim.org>
parents:
26441
diff
changeset
|
1522 On Unix this option has no effect. |
|
a0bc10e83cf8
patch 8.2.3784: the help for options is outdated
Bram Moolenaar <Bram@vim.org>
parents:
26441
diff
changeset
|
1523 NOTE: This option is reset when 'compatible' is set. |
|
a0bc10e83cf8
patch 8.2.3784: the help for options is outdated
Bram Moolenaar <Bram@vim.org>
parents:
26441
diff
changeset
|
1524 |
| 7 | 1525 *'cdpath'* *'cd'* *E344* *E346* |
| 1526 'cdpath' 'cd' string (default: equivalent to $CDPATH or ",,") | |
| 1527 global | |
| 1528 {not available when compiled without the | |
| 1529 |+file_in_path| feature} | |
| 1530 This is a list of directories which will be searched when using the | |
|
16427
8c3a1bd270bb
patch 8.1.1218: cannot set a directory for a tab page
Bram Moolenaar <Bram@vim.org>
parents:
16380
diff
changeset
|
1531 |:cd|, |:tcd| and |:lcd| commands, provided that the directory being |
|
8c3a1bd270bb
patch 8.1.1218: cannot set a directory for a tab page
Bram Moolenaar <Bram@vim.org>
parents:
16380
diff
changeset
|
1532 searched for has a relative path, not an absolute part starting with |
|
8c3a1bd270bb
patch 8.1.1218: cannot set a directory for a tab page
Bram Moolenaar <Bram@vim.org>
parents:
16380
diff
changeset
|
1533 "/", "./" or "../", the 'cdpath' option is not used then. |
| 7 | 1534 The 'cdpath' option's value has the same form and semantics as |
| 1535 |'path'|. Also see |file-searching|. | |
| 1536 The default value is taken from $CDPATH, with a "," prepended to look | |
| 1537 in the current directory first. | |
| 1538 If the default value taken from $CDPATH is not what you want, include | |
| 1539 a modified version of the following command in your vimrc file to | |
| 1540 override it: > | |
| 27903 | 1541 :let &cdpath = ',' .. substitute(substitute($CDPATH, '[, ]', '\\\0', 'g'), ':', ',', 'g') |
| 7 | 1542 < This option cannot be set from a |modeline| or in the |sandbox|, for |
| 1543 security reasons. | |
| 1544 (parts of 'cdpath' can be passed to the shell to expand file names). | |
| 1545 | |
| 1546 *'cedit'* | |
| 1547 'cedit' string (Vi default: "", Vim default: CTRL-F) | |
| 1548 global | |
| 1549 The key used in Command-line Mode to open the command-line window. | |
| 1550 The default is CTRL-F when 'compatible' is off. | |
| 1551 Only non-printable keys are allowed. | |
| 1552 The key can be specified as a single character, but it is difficult to | |
| 1553 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
|
1554 :exe "set cedit=\<C-Y>" |
|
619a98a67f67
commit https://github.com/vim/vim/commit/e18dbe865d190e74fb5d43ac8bc6ac22507d0223
Christian Brabandt <cb@256bit.org>
parents:
9344
diff
changeset
|
1555 :exe "set cedit=\<Esc>" |
| 7 | 1556 < |Nvi| also has this option, but it only uses the first character. |
| 1557 See |cmdwin|. | |
| 11160 | 1558 NOTE: This option is set to the Vim default value when 'compatible' |
| 1559 is reset. | |
| 7 | 1560 |
| 1561 *'charconvert'* *'ccv'* *E202* *E214* *E513* | |
| 1562 'charconvert' 'ccv' string (default "") | |
| 1563 global | |
| 15878 | 1564 {only available when compiled with the |+eval| feature} |
| 7 | 1565 An expression that is used for character encoding conversion. It is |
| 1566 evaluated when a file that is to be read or has been written has a | |
| 1567 different encoding from what is desired. | |
| 1568 'charconvert' is not used when the internal iconv() function is | |
| 1569 supported and is able to do the conversion. Using iconv() is | |
| 1570 preferred, because it is much faster. | |
| 1571 'charconvert' is not used when reading stdin |--|, because there is no | |
| 1572 file to convert from. You will have to save the text in a file first. | |
| 27459 | 1573 The expression must return zero, false or an empty string for success, |
| 1574 non-zero or true for failure. | |
| 7 | 1575 The possible encoding names encountered are in 'encoding'. |
| 1576 Additionally, names given in 'fileencodings' and 'fileencoding' are | |
| 1577 used. | |
| 1578 Conversion between "latin1", "unicode", "ucs-2", "ucs-4" and "utf-8" | |
| 1579 is done internally by Vim, 'charconvert' is not used for this. | |
| 1580 'charconvert' is also used to convert the viminfo file, if the 'c' | |
| 1581 flag is present in 'viminfo'. Also used for Unicode conversion. | |
| 1582 Example: > | |
| 1583 set charconvert=CharConvert() | |
| 1584 fun CharConvert() | |
| 1585 system("recode " | |
| 27903 | 1586 \ .. v:charconvert_from .. ".." .. v:charconvert_to |
| 1587 \ .. " <" .. v:fname_in .. " >" .. v:fname_out) | |
| 7 | 1588 return v:shell_error |
| 1589 endfun | |
| 1590 < The related Vim variables are: | |
| 1591 v:charconvert_from name of the current encoding | |
| 1592 v:charconvert_to name of the desired encoding | |
| 1593 v:fname_in name of the input file | |
| 1594 v:fname_out name of the output file | |
| 1595 Note that v:fname_in and v:fname_out will never be the same. | |
| 1596 Note that v:charconvert_from and v:charconvert_to may be different | |
| 1597 from 'encoding'. Vim internally uses UTF-8 instead of UCS-2 or UCS-4. | |
| 27459 | 1598 |
| 7 | 1599 Encryption is not done by Vim when using 'charconvert'. If you want |
| 1600 to encrypt the file after conversion, 'charconvert' should take care | |
| 1601 of this. | |
| 27459 | 1602 |
| 1603 If the 'charconvert' expression starts with s: or |<SID>|, then it is | |
| 1604 replaced with the script ID (|local-function|). Example: > | |
| 1605 set charconvert=s:MyConvert() | |
| 1606 set charconvert=<SID>SomeConvert() | |
| 1607 < Otherwise the expression is evaluated in the context of the script | |
| 1608 where the option was set, thus script-local items are available. | |
| 1609 | |
| 7 | 1610 This option cannot be set from a |modeline| or in the |sandbox|, for |
| 1611 security reasons. | |
| 1612 | |
| 1613 *'cindent'* *'cin'* *'nocindent'* *'nocin'* | |
| 1614 'cindent' 'cin' boolean (default off) | |
| 1615 local to buffer | |
| 1616 {not available when compiled without the |+cindent| | |
| 1617 feature} | |
| 1621 | 1618 Enables automatic C program indenting. See 'cinkeys' to set the keys |
| 7 | 1619 that trigger reindenting in insert mode and 'cinoptions' to set your |
| 1620 preferred indent style. | |
| 1621 If 'indentexpr' is not empty, it overrules 'cindent'. | |
| 1622 If 'lisp' is not on and both 'indentexpr' and 'equalprg' are empty, | |
| 1623 the "=" operator indents using this algorithm rather than calling an | |
| 1624 external program. | |
| 1625 See |C-indenting|. | |
| 1626 When you don't like the way 'cindent' works, try the 'smartindent' | |
| 1627 option or 'indentexpr'. | |
| 1628 This option is not used when 'paste' is set. | |
| 1629 NOTE: This option is reset when 'compatible' is set. | |
| 1630 | |
| 1631 *'cinkeys'* *'cink'* | |
|
15701
9cd11f6beb70
patch 8.1.0858: 'indentkeys' and 'cinkeys' defaults are different
Bram Moolenaar <Bram@vim.org>
parents:
15512
diff
changeset
|
1632 'cinkeys' 'cink' string (default "0{,0},0),0],:,0#,!^F,o,O,e") |
| 7 | 1633 local to buffer |
| 1634 {not available when compiled without the |+cindent| | |
| 1635 feature} | |
| 1636 A list of keys that, when typed in Insert mode, cause reindenting of | |
| 1637 the current line. Only used if 'cindent' is on and 'indentexpr' is | |
| 1638 empty. | |
| 1639 For the format of this option see |cinkeys-format|. | |
| 1640 See |C-indenting|. | |
| 1641 | |
| 1642 *'cinoptions'* *'cino'* | |
| 1643 'cinoptions' 'cino' string (default "") | |
| 1644 local to buffer | |
| 1645 {not available when compiled without the |+cindent| | |
| 1646 feature} | |
| 1647 The 'cinoptions' affect the way 'cindent' reindents lines in a C | |
| 1648 program. See |cinoptions-values| for the values of this option, and | |
| 1649 |C-indenting| for info on C indenting in general. | |
| 1650 | |
| 1651 | |
| 1652 *'cinwords'* *'cinw'* | |
| 1653 'cinwords' 'cinw' string (default "if,else,while,do,for,switch") | |
| 1654 local to buffer | |
| 1655 {not available when compiled without both the | |
| 1656 |+cindent| and the |+smartindent| features} | |
| 1657 These keywords start an extra indent in the next line when | |
| 1658 'smartindent' or 'cindent' is set. For 'cindent' this is only done at | |
| 1659 an appropriate place (inside {}). | |
| 1660 Note that 'ignorecase' isn't used for 'cinwords'. If case doesn't | |
| 1661 matter, include the keyword both the uppercase and lowercase: | |
| 1662 "if,If,IF". | |
| 1663 | |
| 1664 *'clipboard'* *'cb'* | |
| 1665 'clipboard' 'cb' string (default "autoselect,exclude:cons\|linux" | |
| 1666 for X-windows, "" otherwise) | |
| 1667 global | |
| 1668 {only in GUI versions or when the |+xterm_clipboard| | |
| 1669 feature is included} | |
| 1670 This option is a list of comma separated names. | |
| 23931 | 1671 Note: if one of the items is "exclude:", then you can't add an item |
| 1672 after that. Therefore do append an item with += but use ^= to | |
| 1673 prepend, e.g.: > | |
| 1674 set clipboard^=unnamed | |
| 1675 < These names are recognized: | |
| 7 | 1676 |
| 3674 | 1677 *clipboard-unnamed* |
| 7 | 1678 unnamed When included, Vim will use the clipboard register '*' |
| 1679 for all yank, delete, change and put operations which | |
| 1680 would normally go to the unnamed register. When a | |
| 1681 register is explicitly specified, it will always be | |
| 1682 used regardless of whether "unnamed" is in 'clipboard' | |
| 1683 or not. The clipboard register can always be | |
| 1684 explicitly accessed using the "* notation. Also see | |
| 1685 |gui-clipboard|. | |
| 1686 | |
| 3682 | 1687 *clipboard-unnamedplus* |
| 4119 | 1688 unnamedplus A variant of the "unnamed" flag which uses the |
| 1689 clipboard register '+' (|quoteplus|) instead of | |
| 1690 register '*' for all yank, delete, change and put | |
| 1691 operations which would normally go to the unnamed | |
| 1692 register. When "unnamed" is also included to the | |
| 1693 option, yank operations (but not delete, change or | |
| 1694 put) will additionally copy the text into register | |
| 1695 '*'. | |
| 2662 | 1696 Only available with the |+X11| feature. |
| 2654 | 1697 Availability can be checked with: > |
| 1698 if has('unnamedplus') | |
| 1699 < | |
| 3682 | 1700 *clipboard-autoselect* |
| 7 | 1701 autoselect Works like the 'a' flag in 'guioptions': If present, |
| 1702 then whenever Visual mode is started, or the Visual | |
| 1703 area extended, Vim tries to become the owner of the | |
| 1704 windowing system's global selection or put the | |
| 1705 selected text on the clipboard used by the selection | |
| 14999 | 1706 register "*. See |'go-a'| and |quotestar| for details. |
| 1707 When the GUI is active, the 'a' flag in 'guioptions' | |
| 1708 is used, when the GUI is not active, this "autoselect" | |
| 1709 flag is used. | |
| 7 | 1710 Also applies to the modeless selection. |
| 1711 | |
| 3674 | 1712 *clipboard-autoselectplus* |
| 1713 autoselectplus Like "autoselect" but using the + register instead of | |
| 1714 the * register. Compare to the 'P' flag in | |
| 1715 'guioptions'. | |
| 1716 | |
| 1717 *clipboard-autoselectml* | |
| 7 | 1718 autoselectml Like "autoselect", but for the modeless selection |
| 1719 only. Compare to the 'A' flag in 'guioptions'. | |
| 1720 | |
| 3674 | 1721 *clipboard-html* |
| 1904 | 1722 html When the clipboard contains HTML, use this when |
| 1723 pasting. When putting text on the clipboard, mark it | |
| 1724 as HTML. This works to copy rendered HTML from | |
| 1725 Firefox, paste it as raw HTML in Vim, select the HTML | |
| 1726 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
|
1727 You probably want to add this only temporarily, |
|
6b4879aea261
Add test for gettabvar() and settabvar().
Bram Moolenaar <bram@vim.org>
parents:
2220
diff
changeset
|
1728 possibly use BufEnter autocommands. |
| 1904 | 1729 Only supported for GTK version 2 and later. |
| 1730 | |
| 3674 | 1731 *clipboard-exclude* |
| 7 | 1732 exclude:{pattern} |
| 1733 Defines a pattern that is matched against the name of | |
| 1734 the terminal 'term'. If there is a match, no | |
| 1735 connection will be made to the X server. This is | |
| 1736 useful in this situation: | |
| 1737 - Running Vim in a console. | |
| 1738 - $DISPLAY is set to start applications on another | |
| 1739 display. | |
| 1740 - You do not want to connect to the X server in the | |
| 1741 console, but do want this in a terminal emulator. | |
| 1742 To never connect to the X server use: > | |
| 1743 exclude:.* | |
| 1744 < This has the same effect as using the |-X| argument. | |
| 1745 Note that when there is no connection to the X server | |
| 1746 the window title won't be restored and the clipboard | |
| 1747 cannot be accessed. | |
| 1748 The value of 'magic' is ignored, {pattern} is | |
| 1749 interpreted as if 'magic' was on. | |
| 1750 The rest of the option value will be used for | |
| 1751 {pattern}, this must be the last entry. | |
| 1752 | |
| 1753 *'cmdheight'* *'ch'* | |
| 1754 'cmdheight' 'ch' number (default 1) | |
| 1755 global | |
| 1756 Number of screen lines to use for the command-line. Helps avoiding | |
| 1757 |hit-enter| prompts. | |
| 824 | 1758 The value of this option is stored with the tab page, so that each tab |
| 1759 page can have a different value. | |
| 7 | 1760 |
| 1761 *'cmdwinheight'* *'cwh'* | |
| 1762 'cmdwinheight' 'cwh' number (default 7) | |
| 1763 global | |
| 1764 Number of screen lines to use for the command-line window. |cmdwin| | |
| 1765 | |
|
2608
7d8af31066c8
Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents:
2607
diff
changeset
|
1766 *'colorcolumn'* *'cc'* |
|
7d8af31066c8
Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents:
2607
diff
changeset
|
1767 'colorcolumn' 'cc' string (default "") |
|
7d8af31066c8
Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents:
2607
diff
changeset
|
1768 local to window |
|
7d8af31066c8
Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents:
2607
diff
changeset
|
1769 {not available when compiled without the |+syntax| |
|
7d8af31066c8
Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents:
2607
diff
changeset
|
1770 feature} |
|
7d8af31066c8
Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents:
2607
diff
changeset
|
1771 '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
|
1772 highlighted with ColorColumn |hl-ColorColumn|. Useful to align |
|
7d8af31066c8
Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents:
2607
diff
changeset
|
1773 text. Will make screen redrawing slower. |
|
7d8af31066c8
Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents:
2607
diff
changeset
|
1774 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
|
1775 '+' or '-', which is added to or subtracted from 'textwidth'. > |
|
7d8af31066c8
Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents:
2607
diff
changeset
|
1776 |
|
7d8af31066c8
Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents:
2607
diff
changeset
|
1777 :set cc=+1 " highlight column after 'textwidth' |
|
7d8af31066c8
Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents:
2607
diff
changeset
|
1778 :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
|
1779 :hi ColorColumn ctermbg=lightgrey guibg=lightgrey |
|
7d8af31066c8
Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents:
2607
diff
changeset
|
1780 < |
|
7d8af31066c8
Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents:
2607
diff
changeset
|
1781 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
|
1782 A maximum of 256 columns are highlighted. |
|
7d8af31066c8
Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents:
2607
diff
changeset
|
1783 |
| 7 | 1784 *'columns'* *'co'* *E594* |
| 1785 'columns' 'co' number (default 80 or terminal width) | |
| 1786 global | |
| 1787 Number of columns of the screen. Normally this is set by the terminal | |
| 161 | 1788 initialization and does not have to be set by hand. Also see |
| 1789 |posix-screen-size|. | |
| 7 | 1790 When Vim is running in the GUI or in a resizable window, setting this |
| 1791 option will cause the window size to be changed. When you only want | |
| 1792 to use the size for the GUI, put the command in your |gvimrc| file. | |
| 1793 When you set this option and Vim is unable to change the physical | |
| 1152 | 1794 number of columns of the display, the display may be messed up. For |
| 1795 the GUI it is always possible and Vim limits the number of columns to | |
| 1796 what fits on the screen. You can use this command to get the widest | |
| 1797 window possible: > | |
| 1798 :set columns=9999 | |
| 1799 < Minimum value is 12, maximum value is 10000. | |
| 7 | 1800 |
| 1801 *'comments'* *'com'* *E524* *E525* | |
| 1802 'comments' 'com' string (default | |
| 1803 "s1:/*,mb:*,ex:*/,://,b:#,:%,:XCOMM,n:>,fb:-") | |
| 1804 local to buffer | |
| 1805 A comma separated list of strings that can start a comment line. See | |
| 1806 |format-comments|. See |option-backslash| about using backslashes to | |
| 1807 insert a space. | |
| 1808 | |
| 1809 *'commentstring'* *'cms'* *E537* | |
| 1810 'commentstring' 'cms' string (default "/*%s*/") | |
| 1811 local to buffer | |
| 1812 {not available when compiled without the |+folding| | |
| 1813 feature} | |
| 1814 A template for a comment. The "%s" in the value is replaced with the | |
| 1815 comment text. Currently only used to add markers for folding, see | |
| 1816 |fold-marker|. | |
| 1817 | |
| 1818 *'compatible'* *'cp'* *'nocompatible'* *'nocp'* | |
| 819 | 1819 '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
|
1820 file is found, reset in |defaults.vim|) |
| 7 | 1821 global |
| 1822 This option has the effect of making Vim either more Vi-compatible, or | |
| 1823 make Vim behave in a more useful way. | |
| 11062 | 1824 |
| 7 | 1825 This is a special kind of option, because when it's set or reset, |
| 11062 | 1826 other options are also changed as a side effect. |
| 1827 NOTE: Setting or resetting this option can have a lot of unexpected | |
| 1828 effects: Mappings are interpreted in another way, undo behaves | |
| 1829 differently, etc. If you set this option in your vimrc file, you | |
| 1830 should probably put it at the very start. | |
| 1831 | |
| 7 | 1832 By default this option is on and the Vi defaults are used for the |
| 1833 options. This default was chosen for those people who want to use Vim | |
| 1834 just like Vi, and don't even (want to) know about the 'compatible' | |
| 1835 option. | |
| 819 | 1836 When a |vimrc| or |gvimrc| file is found while Vim is starting up, |
| 378 | 1837 this option is switched off, and all options that have not been |
| 1838 modified will be set to the Vim defaults. Effectively, this means | |
| 819 | 1839 that when a |vimrc| or |gvimrc| file exists, Vim will use the Vim |
| 378 | 1840 defaults, otherwise it will use the Vi defaults. (Note: This doesn't |
| 1152 | 1841 happen for the system-wide vimrc or gvimrc file, nor for a file given |
| 1842 with the |-u| argument). Also see |compatible-default| and | |
| 1843 |posix-compliance|. | |
| 7 | 1844 You can also set this option with the "-C" argument, and reset it with |
| 1845 "-N". See |-C| and |-N|. | |
| 11062 | 1846 See 'cpoptions' for more fine tuning of Vi compatibility. |
| 1847 | |
| 1848 When this option is set, numerous other options are set to make Vim as | |
| 1849 Vi-compatible as possible. When this option is unset, various options | |
| 1850 are set to make Vim more useful. The table below lists all the | |
| 1851 options affected. | |
| 1852 The {?} column indicates when the options are affected: | |
| 1853 + Means that the option is set to the value given in {set value} when | |
| 1854 'compatible' is set. | |
| 1855 & Means that the option is set to the value given in {set value} when | |
| 1856 'compatible' is set AND is set to its Vim default value when | |
| 1857 'compatible' is unset. | |
| 1858 - Means the option is NOT changed when setting 'compatible' but IS | |
| 1859 set to its Vim default when 'compatible' is unset. | |
| 1860 The {effect} column summarises the change when 'compatible' is set. | |
| 1861 | |
| 11160 | 1862 option ? set value effect ~ |
| 11062 | 1863 |
| 1864 'allowrevins' + off no CTRL-_ command | |
| 1865 'antialias' + off don't use antialiased fonts | |
| 1866 'arabic' + off reset arabic-related options | |
| 1867 'arabicshape' + on correct character shapes | |
| 1868 'backspace' + "" normal backspace | |
| 1869 'backup' + off no backup file | |
| 1870 'backupcopy' & Unix: "yes" backup file is a copy | |
| 1871 else: "auto" copy or rename backup file | |
| 1872 'balloonexpr' + "" text to show in evaluation balloon | |
| 1873 'breakindent' + off don't indent when wrapping lines | |
| 1874 'cedit' - {unchanged} {set vim default only on resetting 'cp'} | |
|
26508
a0bc10e83cf8
patch 8.2.3784: the help for options is outdated
Bram Moolenaar <Bram@vim.org>
parents:
26441
diff
changeset
|
1875 'cdhome' + off ":cd" don't chdir to home on non-Unix |
| 11062 | 1876 'cindent' + off no C code indentation |
| 1877 'compatible' - {unchanged} {set vim default only on resetting 'cp'} | |
| 1878 'copyindent' + off don't copy indent structure | |
| 1879 'cpoptions' & (all flags) Vi-compatible flags | |
| 1880 'cscopepathcomp'+ 0 don't show directories in tags list | |
|
13341
acd7eaa13d2b
Updated runtime files.
Christian Brabandt <cb@256bit.org>
parents:
13314
diff
changeset
|
1881 'cscoperelative'+ off don't use basename of path as prefix |
| 11062 | 1882 'cscopetag' + off don't use cscope for ":tag" |
| 11160 | 1883 'cscopetagorder'+ 0 see |cscopetagorder| |
| 11062 | 1884 'cscopeverbose' + off see |cscopeverbose| |
| 1885 'delcombine' + off unicode: delete whole char combination | |
| 1886 'digraph' + off no digraphs | |
| 1887 'esckeys' & off no <Esc>-keys in Insert mode | |
| 1888 'expandtab' + off tabs not expanded to spaces | |
| 1889 'fileformats' & "" no automatic file format detection, | |
|
18912
ccd16426a1f9
patch 8.2.0017: OS/2 and MS-DOS are still mentioned
Bram Moolenaar <Bram@vim.org>
parents:
18879
diff
changeset
|
1890 "dos,unix" except for MS-Windows |
| 11062 | 1891 'formatexpr' + "" use 'formatprg' for auto-formatting |
| 1892 'formatoptions' & "vt" Vi compatible formatting | |
| 1893 'gdefault' + off no default 'g' flag for ":s" | |
| 1894 'history' & 0 no commandline history | |
| 1895 'hkmap' + off no Hebrew keyboard mapping | |
| 1896 'hkmapp' + off no phonetic Hebrew keyboard mapping | |
| 1897 'hlsearch' + off no highlighting of search matches | |
| 1898 'incsearch' + off no incremental searching | |
| 1899 'indentexpr' + "" no indenting by expression | |
| 1900 'insertmode' + off do not start in Insert mode | |
| 1901 'iskeyword' & "@,48-57,_" keywords contain alphanumeric | |
| 7 | 1902 characters and '_' |
| 11062 | 1903 'joinspaces' + on insert 2 spaces after period |
| 1904 'modeline' & off no modelines | |
| 1905 'more' & off no pauses in listings | |
| 1906 'mzquantum' - {unchanged} {set vim default only on resetting 'cp'} | |
| 1907 'numberwidth' & 8 min number of columns for line number | |
| 1908 'preserveindent'+ off don't preserve current indent structure | |
| 1909 when changing it | |
| 1910 'revins' + off no reverse insert | |
| 1911 'ruler' + off no ruler | |
| 1912 'scrolljump' + 1 no jump scroll | |
| 1913 'scrolloff' + 0 no scroll offset | |
| 1914 'shelltemp' - {unchanged} {set vim default only on resetting 'cp'} | |
| 1915 'shiftround' + off indent not rounded to shiftwidth | |
|
16533
5e25171e0e75
patch 8.1.1270: cannot see current match position
Bram Moolenaar <Bram@vim.org>
parents:
16447
diff
changeset
|
1916 'shortmess' & "S" no shortening of messages |
| 11062 | 1917 'showcmd' & off command characters not shown |
| 1918 'showmode' & off current mode not shown | |
| 1919 'sidescrolloff' + 0 cursor moves to edge of screen in scroll | |
| 1920 'smartcase' + off no automatic ignore case switch | |
| 1921 'smartindent' + off no smart indentation | |
| 1922 'smarttab' + off no smart tab size | |
| 1923 'softtabstop' + 0 tabs are always 'tabstop' positions | |
| 1924 'startofline' + on goto startofline with some commands | |
| 1925 'tagcase' & "followic" 'ignorecase' when searching tags file | |
| 1926 'tagrelative' & off tag file names are not relative | |
| 1927 'termguicolors' + off don't use highlight-(guifg|guibg) | |
| 1928 'textauto' & off no automatic textmode detection | |
| 1929 'textwidth' + 0 no automatic line wrap | |
| 1930 'tildeop' + off tilde is not an operator | |
| 1931 'ttimeout' + off no terminal timeout | |
| 1932 'undofile' + off don't use an undo file | |
| 11160 | 1933 'viminfo' - {unchanged} {set Vim default only on resetting 'cp'} |
| 11062 | 1934 'virtualedit' + "" cursor can only be placed on characters |
| 1935 'whichwrap' & "" left-right movements don't wrap | |
| 1936 'wildchar' & CTRL-E only when the current value is <Tab> | |
| 7 | 1937 use CTRL-E for cmdline completion |
| 11062 | 1938 'writebackup' + on or off depends on the |+writebackup| feature |
| 7 | 1939 |
| 1940 *'complete'* *'cpt'* *E535* | |
| 1941 'complete' 'cpt' string (default: ".,w,b,u,t,i") | |
| 1942 local to buffer | |
| 1943 This option specifies how keyword completion |ins-completion| works | |
| 1944 when CTRL-P or CTRL-N are used. It is also used for whole-line | |
| 1945 completion |i_CTRL-X_CTRL-L|. It indicates the type of completion | |
| 1946 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
|
1947 . scan the current buffer ('wrapscan' is ignored) |
| 7 | 1948 w scan buffers from other windows |
| 1949 b scan other loaded buffers that are in the buffer list | |
| 1950 u scan the unloaded buffers that are in the buffer list | |
| 1951 U scan the buffers that are not in the buffer list | |
| 1952 k scan the files given with the 'dictionary' option | |
| 703 | 1953 kspell use the currently active spell checking |spell| |
| 7 | 1954 k{dict} scan the file {dict}. Several "k" flags can be given, |
| 1955 patterns are valid too. For example: > | |
| 1956 :set cpt=k/usr/dict/*,k~/spanish | |
| 1957 < s scan the files given with the 'thesaurus' option | |
| 1958 s{tsr} scan the file {tsr}. Several "s" flags can be given, patterns | |
| 1959 are valid too. | |
| 1960 i scan current and included files | |
| 1961 d scan current and included files for defined name or macro | |
| 1962 |i_CTRL-X_CTRL-D| | |
| 1963 ] tag completion | |
| 1964 t same as "]" | |
| 1965 | |
| 1966 Unloaded buffers are not loaded, thus their autocmds |:autocmd| are | |
| 1967 not executed, this may lead to unexpected completions from some files | |
| 1968 (gzipped files for example). Unloaded buffers are not scanned for | |
| 1969 whole-line completion. | |
| 1970 | |
| 1971 The default is ".,w,b,u,t,i", which means to scan: | |
| 1972 1. the current buffer | |
| 1973 2. buffers in other windows | |
| 1974 3. other loaded buffers | |
| 1975 4. unloaded buffers | |
| 1976 5. tags | |
| 1977 6. included files | |
| 1978 | |
| 1979 As you can see, CTRL-N and CTRL-P can be used to do any 'iskeyword'- | |
| 233 | 1980 based expansion (e.g., dictionary |i_CTRL-X_CTRL-K|, included patterns |
| 1981 |i_CTRL-X_CTRL-I|, tags |i_CTRL-X_CTRL-]| and normal expansions). | |
| 7 | 1982 |
| 12 | 1983 *'completefunc'* *'cfu'* |
| 1984 'completefunc' 'cfu' string (default: empty) | |
| 1985 local to buffer | |
|
2570
71b56b4e7785
Make the references to features in the help more consistent. (Sylvain Hitier)
Bram Moolenaar <bram@vim.org>
parents:
2561
diff
changeset
|
1986 {not available when compiled without the |+eval| |
|
17809
59f8948b7590
patch 8.1.1901: the +insert_expand feature is not always available
Bram Moolenaar <Bram@vim.org>
parents:
17771
diff
changeset
|
1987 feature} |
| 623 | 1988 This option specifies a function to be used for Insert mode completion |
| 1989 with CTRL-X CTRL-U. |i_CTRL-X_CTRL-U| | |
| 648 | 1990 See |complete-functions| for an explanation of how the function is |
|
26388
8aba638e91eb
patch 8.2.3725: cannot use a lambda for 'completefunc' and 'omnifunc'
Bram Moolenaar <Bram@vim.org>
parents:
26362
diff
changeset
|
1991 invoked and what it should return. The value can be the name of a |
|
8aba638e91eb
patch 8.2.3725: cannot use a lambda for 'completefunc' and 'omnifunc'
Bram Moolenaar <Bram@vim.org>
parents:
26362
diff
changeset
|
1992 function, a |lambda| or a |Funcref|. See |option-value-function| for |
|
8aba638e91eb
patch 8.2.3725: cannot use a lambda for 'completefunc' and 'omnifunc'
Bram Moolenaar <Bram@vim.org>
parents:
26362
diff
changeset
|
1993 more information. |
| 2642 | 1994 This option cannot be set from a |modeline| or in the |sandbox|, for |
| 1995 security reasons. | |
| 14 | 1996 |
|
17543
77c3f6428b6c
patch 8.1.1769: 'shellslash' is also used for completion
Bram Moolenaar <Bram@vim.org>
parents:
17433
diff
changeset
|
1997 *'completeslash'* *'csl'* |
|
77c3f6428b6c
patch 8.1.1769: 'shellslash' is also used for completion
Bram Moolenaar <Bram@vim.org>
parents:
17433
diff
changeset
|
1998 'completeslash' 'csl' string (default: "") |
|
77c3f6428b6c
patch 8.1.1769: 'shellslash' is also used for completion
Bram Moolenaar <Bram@vim.org>
parents:
17433
diff
changeset
|
1999 local to buffer |
| 18343 | 2000 {only for MS-Windows} |
|
17543
77c3f6428b6c
patch 8.1.1769: 'shellslash' is also used for completion
Bram Moolenaar <Bram@vim.org>
parents:
17433
diff
changeset
|
2001 When this option is set it overrules 'shellslash' for completion: |
|
77c3f6428b6c
patch 8.1.1769: 'shellslash' is also used for completion
Bram Moolenaar <Bram@vim.org>
parents:
17433
diff
changeset
|
2002 - When this option is set to "slash", a forward slash is used for path |
|
77c3f6428b6c
patch 8.1.1769: 'shellslash' is also used for completion
Bram Moolenaar <Bram@vim.org>
parents:
17433
diff
changeset
|
2003 completion in insert mode. This is useful when editing HTML tag, or |
|
18912
ccd16426a1f9
patch 8.2.0017: OS/2 and MS-DOS are still mentioned
Bram Moolenaar <Bram@vim.org>
parents:
18879
diff
changeset
|
2004 Makefile with 'noshellslash' on MS-Windows. |
|
17543
77c3f6428b6c
patch 8.1.1769: 'shellslash' is also used for completion
Bram Moolenaar <Bram@vim.org>
parents:
17433
diff
changeset
|
2005 - When this option is set to "backslash", backslash is used. This is |
|
18912
ccd16426a1f9
patch 8.2.0017: OS/2 and MS-DOS are still mentioned
Bram Moolenaar <Bram@vim.org>
parents:
18879
diff
changeset
|
2006 useful when editing a batch file with 'shellslash' set on MS-Windows. |
|
17543
77c3f6428b6c
patch 8.1.1769: 'shellslash' is also used for completion
Bram Moolenaar <Bram@vim.org>
parents:
17433
diff
changeset
|
2007 - When this option is empty, same character is used as for |
|
77c3f6428b6c
patch 8.1.1769: 'shellslash' is also used for completion
Bram Moolenaar <Bram@vim.org>
parents:
17433
diff
changeset
|
2008 'shellslash'. |
|
77c3f6428b6c
patch 8.1.1769: 'shellslash' is also used for completion
Bram Moolenaar <Bram@vim.org>
parents:
17433
diff
changeset
|
2009 For Insert mode completion the buffer-local value is used. For |
|
77c3f6428b6c
patch 8.1.1769: 'shellslash' is also used for completion
Bram Moolenaar <Bram@vim.org>
parents:
17433
diff
changeset
|
2010 command line completion the global value is used. |
|
77c3f6428b6c
patch 8.1.1769: 'shellslash' is also used for completion
Bram Moolenaar <Bram@vim.org>
parents:
17433
diff
changeset
|
2011 |
| 540 | 2012 *'completeopt'* *'cot'* |
| 730 | 2013 'completeopt' 'cot' string (default: "menu,preview") |
| 540 | 2014 global |
| 665 | 2015 A comma separated list of options for Insert mode completion |
| 2016 |ins-completion|. The supported values are: | |
| 540 | 2017 |
| 2018 menu Use a popup menu to show the possible completions. The | |
| 2019 menu is only shown when there is more than one match and | |
| 2020 sufficient colors are available. |ins-completion-menu| | |
| 2021 | |
| 707 | 2022 menuone Use the popup menu also when there is only one match. |
| 856 | 2023 Useful when there is additional information about the |
| 707 | 2024 match, e.g., what file it comes from. |
| 2025 | |
| 836 | 2026 longest Only insert the longest common text of the matches. If |
| 2027 the menu is displayed you can use CTRL-L to add more | |
| 2028 characters. Whether case is ignored depends on the kind | |
| 2029 of completion. For buffer text the 'ignorecase' option is | |
| 2030 used. | |
| 665 | 2031 |
| 730 | 2032 preview Show extra information about the currently selected |
| 1152 | 2033 completion in the preview window. Only works in |
| 2034 combination with "menu" or "menuone". | |
| 2035 | |
|
17767
c75da1064e33
patch 8.1.1880: cannot show extra info for completion in a popup window
Bram Moolenaar <Bram@vim.org>
parents:
17571
diff
changeset
|
2036 popup Show extra information about the currently selected |
|
c75da1064e33
patch 8.1.1880: cannot show extra info for completion in a popup window
Bram Moolenaar <Bram@vim.org>
parents:
17571
diff
changeset
|
2037 completion in a popup window. Only works in combination |
|
c75da1064e33
patch 8.1.1880: cannot show extra info for completion in a popup window
Bram Moolenaar <Bram@vim.org>
parents:
17571
diff
changeset
|
2038 with "menu" or "menuone". Overrides "preview". |
|
17771
4bd21046902b
patch 8.1.1882: cannot specify properties of the info popup window
Bram Moolenaar <Bram@vim.org>
parents:
17767
diff
changeset
|
2039 See |'completepopup'| for specifying properties. |
| 18343 | 2040 {only works when compiled with the |+textprop| feature} |
|
17767
c75da1064e33
patch 8.1.1880: cannot show extra info for completion in a popup window
Bram Moolenaar <Bram@vim.org>
parents:
17571
diff
changeset
|
2041 |
|
18396
ba5d8c5d77d7
patch 8.1.2192: cannot easily fill the info popup asynchronously
Bram Moolenaar <Bram@vim.org>
parents:
18372
diff
changeset
|
2042 popuphidden |
| 18719 | 2043 Just like "popup" but initially hide the popup. Use a |
|
18396
ba5d8c5d77d7
patch 8.1.2192: cannot easily fill the info popup asynchronously
Bram Moolenaar <Bram@vim.org>
parents:
18372
diff
changeset
|
2044 |CompleteChanged| autocommand to fetch the info and call |
|
ba5d8c5d77d7
patch 8.1.2192: cannot easily fill the info popup asynchronously
Bram Moolenaar <Bram@vim.org>
parents:
18372
diff
changeset
|
2045 |popup_show()| once the popup has been filled. |
|
ba5d8c5d77d7
patch 8.1.2192: cannot easily fill the info popup asynchronously
Bram Moolenaar <Bram@vim.org>
parents:
18372
diff
changeset
|
2046 See the example at |complete-popuphidden|. |
|
ba5d8c5d77d7
patch 8.1.2192: cannot easily fill the info popup asynchronously
Bram Moolenaar <Bram@vim.org>
parents:
18372
diff
changeset
|
2047 {only works when compiled with the |+textprop| feature} |
|
ba5d8c5d77d7
patch 8.1.2192: cannot easily fill the info popup asynchronously
Bram Moolenaar <Bram@vim.org>
parents:
18372
diff
changeset
|
2048 |
| 6911 | 2049 noinsert Do not insert any text for a match until the user selects |
| 2050 a match from the menu. Only works in combination with | |
| 2051 "menu" or "menuone". No effect if "longest" is present. | |
| 2052 | |
| 2053 noselect Do not select a match in the menu, force the user to | |
| 2054 select one from the menu. Only works in combination with | |
| 2055 "menu" or "menuone". | |
| 2056 | |
| 730 | 2057 |
|
17771
4bd21046902b
patch 8.1.1882: cannot specify properties of the info popup window
Bram Moolenaar <Bram@vim.org>
parents:
17767
diff
changeset
|
2058 *'completepopup'* *'cpp'* |
|
4bd21046902b
patch 8.1.1882: cannot specify properties of the info popup window
Bram Moolenaar <Bram@vim.org>
parents:
17767
diff
changeset
|
2059 'completepopup' 'cpp' string (default empty) |
|
4bd21046902b
patch 8.1.1882: cannot specify properties of the info popup window
Bram Moolenaar <Bram@vim.org>
parents:
17767
diff
changeset
|
2060 global |
|
4bd21046902b
patch 8.1.1882: cannot specify properties of the info popup window
Bram Moolenaar <Bram@vim.org>
parents:
17767
diff
changeset
|
2061 {not available when compiled without the |+textprop| |
|
4bd21046902b
patch 8.1.1882: cannot specify properties of the info popup window
Bram Moolenaar <Bram@vim.org>
parents:
17767
diff
changeset
|
2062 or |+quickfix| feature} |
|
4bd21046902b
patch 8.1.1882: cannot specify properties of the info popup window
Bram Moolenaar <Bram@vim.org>
parents:
17767
diff
changeset
|
2063 When 'completeopt' contains "popup" then this option is used for the |
|
21373
3d73cdd173ab
patch 8.2.1237: changing 'completepopup' after opening popup has no effect
Bram Moolenaar <Bram@vim.org>
parents:
21250
diff
changeset
|
2064 properties of the info popup when it is created. If an info popup |
|
3d73cdd173ab
patch 8.2.1237: changing 'completepopup' after opening popup has no effect
Bram Moolenaar <Bram@vim.org>
parents:
21250
diff
changeset
|
2065 window already exists it is closed, so that the option value is |
|
3d73cdd173ab
patch 8.2.1237: changing 'completepopup' after opening popup has no effect
Bram Moolenaar <Bram@vim.org>
parents:
21250
diff
changeset
|
2066 applied when it is created again. |
|
3d73cdd173ab
patch 8.2.1237: changing 'completepopup' after opening popup has no effect
Bram Moolenaar <Bram@vim.org>
parents:
21250
diff
changeset
|
2067 You can also use |popup_findinfo()| and then set properties for an |
|
3d73cdd173ab
patch 8.2.1237: changing 'completepopup' after opening popup has no effect
Bram Moolenaar <Bram@vim.org>
parents:
21250
diff
changeset
|
2068 existing info popup with |popup_setoptions()|. See |complete-popup|. |
|
17771
4bd21046902b
patch 8.1.1882: cannot specify properties of the info popup window
Bram Moolenaar <Bram@vim.org>
parents:
17767
diff
changeset
|
2069 |
|
4bd21046902b
patch 8.1.1882: cannot specify properties of the info popup window
Bram Moolenaar <Bram@vim.org>
parents:
17767
diff
changeset
|
2070 |
|
2378
85b7dc8da5eb
Add the 'concealcursor' option to decide when the cursor line is to be
Bram Moolenaar <bram@vim.org>
parents:
2365
diff
changeset
|
2071 *'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
|
2072 '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
|
2073 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
|
2074 {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
|
2075 feature} |
|
85b7dc8da5eb
Add the 'concealcursor' option to decide when the cursor line is to be
Bram Moolenaar <bram@vim.org>
parents:
2365
diff
changeset
|
2076 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
|
2077 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
|
2078 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
|
2079 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
|
2080 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
|
2081 i Insert mode |
|
2382
3a5ededa240a
Add the 'c' flag to 'concealcursor'.
Bram Moolenaar <bram@vim.org>
parents:
2380
diff
changeset
|
2082 c Command line editing, for 'incsearch' |
|
3a5ededa240a
Add the 'c' flag to 'concealcursor'.
Bram Moolenaar <bram@vim.org>
parents:
2380
diff
changeset
|
2083 |
|
2400
e6f1424dd66a
Let 'v' flag in 'concealcursor' apply to all lines in the Visual area.
Bram Moolenaar <bram@vim.org>
parents:
2394
diff
changeset
|
2084 '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
|
2085 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
|
2086 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
|
2087 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
|
2088 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
|
2089 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
|
2090 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
|
2091 |
|
85b7dc8da5eb
Add the 'concealcursor' option to decide when the cursor line is to be
Bram Moolenaar <bram@vim.org>
parents:
2365
diff
changeset
|
2092 |
| 14864 | 2093 *'conceallevel'* *'cole'* |
| 2094 'conceallevel' 'cole' number (default 0) | |
|
2250
1bac28a53fae
Add the conceal patch from Vince Negri.
Bram Moolenaar <bram@vim.org>
parents:
2249
diff
changeset
|
2095 local to window |
|
1bac28a53fae
Add the conceal patch from Vince Negri.
Bram Moolenaar <bram@vim.org>
parents:
2249
diff
changeset
|
2096 {not available when compiled without the |+conceal| |
|
1bac28a53fae
Add the conceal patch from Vince Negri.
Bram Moolenaar <bram@vim.org>
parents:
2249
diff
changeset
|
2097 feature} |
|
2340
99c1eba60b2d
Make automatic prototype generation work with more interfaces.
Bram Moolenaar <bram@vim.org>
parents:
2337
diff
changeset
|
2098 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
|
2099 is shown: |
|
99c1eba60b2d
Make automatic prototype generation work with more interfaces.
Bram Moolenaar <bram@vim.org>
parents:
2337
diff
changeset
|
2100 |
|
99c1eba60b2d
Make automatic prototype generation work with more interfaces.
Bram Moolenaar <bram@vim.org>
parents:
2337
diff
changeset
|
2101 Value Effect ~ |
|
2250
1bac28a53fae
Add the conceal patch from Vince Negri.
Bram Moolenaar <bram@vim.org>
parents:
2249
diff
changeset
|
2102 0 Text is shown normally |
| 2426 | 2103 1 Each block of concealed text is replaced with one |
| 2104 character. If the syntax item does not have a custom | |
| 2105 replacement character defined (see |:syn-cchar|) the | |
| 2106 character defined in 'listchars' is used (default is a | |
| 2107 space). | |
| 2108 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
|
2109 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
|
2110 custom replacement character defined (see |
| 2426 | 2111 |: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
|
2112 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
|
2113 |
|
586a459f3980
Never hide text for conceal in cursor line. Do hide when there is
Bram Moolenaar <bram@vim.org>
parents:
2348
diff
changeset
|
2114 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
|
2115 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
|
2116 option. |
|
2250
1bac28a53fae
Add the conceal patch from Vince Negri.
Bram Moolenaar <bram@vim.org>
parents:
2249
diff
changeset
|
2117 |
| 7 | 2118 *'confirm'* *'cf'* *'noconfirm'* *'nocf'* |
| 2119 'confirm' 'cf' boolean (default off) | |
| 2120 global | |
| 2121 When 'confirm' is on, certain operations that would normally | |
| 2122 fail because of unsaved changes to a buffer, e.g. ":q" and ":e", | |
| 2123 instead raise a |dialog| asking if you wish to save the current | |
| 2124 file(s). You can still use a ! to unconditionally |abandon| a buffer. | |
| 2125 If 'confirm' is off you can still activate confirmation for one | |
| 2126 command only (this is most useful in mappings) with the |:confirm| | |
| 2127 command. | |
| 2128 Also see the |confirm()| function and the 'v' flag in 'guioptions'. | |
| 2129 | |
| 2130 *'conskey'* *'consk'* *'noconskey'* *'noconsk'* | |
| 2131 'conskey' 'consk' boolean (default off) | |
| 2132 global | |
|
8246
f16bfe02cef1
commit https://github.com/vim/vim/commit/f391327adbbffb11180cf6038a92af1ed144e907
Christian Brabandt <cb@256bit.org>
parents:
8182
diff
changeset
|
2133 This was for MS-DOS and is no longer supported. |
| 7 | 2134 |
| 2135 *'copyindent'* *'ci'* *'nocopyindent'* *'noci'* | |
| 2136 'copyindent' 'ci' boolean (default off) | |
| 2137 local to buffer | |
| 2138 Copy the structure of the existing lines indent when autoindenting a | |
| 2139 new line. Normally the new indent is reconstructed by a series of | |
| 2140 tabs followed by spaces as required (unless |'expandtab'| is enabled, | |
| 2141 in which case only spaces are used). Enabling this option makes the | |
| 2142 new line copy whatever characters were used for indenting on the | |
| 1621 | 2143 existing line. 'expandtab' has no effect on these characters, a Tab |
| 2144 remains a Tab. If the new indent is greater than on the existing | |
| 7 | 2145 line, the remaining space is filled in the normal manner. |
| 11160 | 2146 NOTE: This option is reset when 'compatible' is set. |
| 7 | 2147 Also see 'preserveindent'. |
| 2148 | |
|
8148
f5da459c5698
commit https://github.com/vim/vim/commit/e0fa3742ead676a3074a10edadbc955e1a89153d
Christian Brabandt <cb@256bit.org>
parents:
8061
diff
changeset
|
2149 *'cpoptions'* *'cpo'* *cpo* |
| 7 | 2150 'cpoptions' 'cpo' string (Vim default: "aABceFs", |
| 2151 Vi default: all flags) | |
| 2152 global | |
| 2153 A sequence of single character flags. When a character is present | |
| 5340 | 2154 this indicates Vi-compatible behavior. This is used for things where |
| 2155 not being Vi-compatible is mostly or sometimes preferred. | |
| 7 | 2156 'cpoptions' stands for "compatible-options". |
| 2157 Commas can be added for readability. | |
| 2158 To avoid problems with flags that are added in the future, use the | |
| 2159 "+=" and "-=" feature of ":set" |add-option-flags|. | |
|
26745
dcd1c244e332
patch 8.2.3901: Vim9: Cannot set 'cpo' in main .vimrc if using Vim9 script
Bram Moolenaar <Bram@vim.org>
parents:
26743
diff
changeset
|
2160 |
| 7 | 2161 NOTE: This option is set to the Vi default value when 'compatible' is |
| 2162 set and to the Vim default value when 'compatible' is reset. | |
|
26745
dcd1c244e332
patch 8.2.3901: Vim9: Cannot set 'cpo' in main .vimrc if using Vim9 script
Bram Moolenaar <Bram@vim.org>
parents:
26743
diff
changeset
|
2163 |
|
dcd1c244e332
patch 8.2.3901: Vim9: Cannot set 'cpo' in main .vimrc if using Vim9 script
Bram Moolenaar <Bram@vim.org>
parents:
26743
diff
changeset
|
2164 NOTE: In a |Vim9| script, when `vim9script` is encountered, the value |
|
dcd1c244e332
patch 8.2.3901: Vim9: Cannot set 'cpo' in main .vimrc if using Vim9 script
Bram Moolenaar <Bram@vim.org>
parents:
26743
diff
changeset
|
2165 is saved, 'cpoptions' is set to the Vim default, and the saved value |
|
dcd1c244e332
patch 8.2.3901: Vim9: Cannot set 'cpo' in main .vimrc if using Vim9 script
Bram Moolenaar <Bram@vim.org>
parents:
26743
diff
changeset
|
2166 is restored at the end of the script. Changes to the value of |
|
dcd1c244e332
patch 8.2.3901: Vim9: Cannot set 'cpo' in main .vimrc if using Vim9 script
Bram Moolenaar <Bram@vim.org>
parents:
26743
diff
changeset
|
2167 'cpoptions' will be applied to the saved value, but keep in mind that |
|
dcd1c244e332
patch 8.2.3901: Vim9: Cannot set 'cpo' in main .vimrc if using Vim9 script
Bram Moolenaar <Bram@vim.org>
parents:
26743
diff
changeset
|
2168 removing a flag that is not present when 'cpoptions' is changed has no |
|
dcd1c244e332
patch 8.2.3901: Vim9: Cannot set 'cpo' in main .vimrc if using Vim9 script
Bram Moolenaar <Bram@vim.org>
parents:
26743
diff
changeset
|
2169 effect. In the |.vimrc| file the value is not restored, thus using |
|
dcd1c244e332
patch 8.2.3901: Vim9: Cannot set 'cpo' in main .vimrc if using Vim9 script
Bram Moolenaar <Bram@vim.org>
parents:
26743
diff
changeset
|
2170 `vim9script` in the |.vimrc| file results in using the Vim default. |
|
dcd1c244e332
patch 8.2.3901: Vim9: Cannot set 'cpo' in main .vimrc if using Vim9 script
Bram Moolenaar <Bram@vim.org>
parents:
26743
diff
changeset
|
2171 |
| 164 | 2172 NOTE: This option is set to the POSIX default value at startup when |
| 2173 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
|
2174 variable exists |posix|. This means Vim tries to behave like the |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
2175 POSIX specification. |
| 7 | 2176 |
| 2177 contains behavior ~ | |
| 2178 *cpo-a* | |
| 2179 a When included, a ":read" command with a file name | |
| 2180 argument will set the alternate file name for the | |
| 2181 current window. | |
| 2182 *cpo-A* | |
| 2183 A When included, a ":write" command with a file name | |
| 2184 argument will set the alternate file name for the | |
| 2185 current window. | |
| 2186 *cpo-b* | |
| 2187 b "\|" in a ":map" command is recognized as the end of | |
| 2188 the map command. The '\' is included in the mapping, | |
| 2189 the text after the '|' is interpreted as the next | |
| 2190 command. Use a CTRL-V instead of a backslash to | |
| 2191 include the '|' in the mapping. Applies to all | |
| 2192 mapping, abbreviation, menu and autocmd commands. | |
| 2193 See also |map_bar|. | |
| 2194 *cpo-B* | |
| 2195 B A backslash has no special meaning in mappings, | |
| 14372 | 2196 abbreviations, user commands and the "to" part of the |
| 2197 menu commands. Remove this flag to be able to use a | |
| 2198 backslash like a CTRL-V. For example, the command | |
| 2199 ":map X \<Esc>" results in X being mapped to: | |
| 7 | 2200 'B' included: "\^[" (^[ is a real <Esc>) |
| 2201 'B' excluded: "<Esc>" (5 characters) | |
| 2202 ('<' excluded in both cases) | |
| 2203 *cpo-c* | |
| 2204 c Searching continues at the end of any match at the | |
| 2205 cursor position, but not further than the start of the | |
| 2206 next line. When not present searching continues | |
| 2207 one character from the cursor position. With 'c' | |
| 2208 "abababababab" only gets three matches when repeating | |
| 2209 "/abab", without 'c' there are five matches. | |
| 2210 *cpo-C* | |
| 2211 C Do not concatenate sourced lines that start with a | |
| 2212 backslash. See |line-continuation|. | |
| 2213 *cpo-d* | |
| 2214 d Using "./" in the 'tags' option doesn't mean to use | |
| 2215 the tags file relative to the current file, but the | |
| 2216 tags file in the current directory. | |
| 2217 *cpo-D* | |
| 2218 D Can't use CTRL-K to enter a digraph after Normal mode | |
| 2219 commands with a character argument, like |r|, |f| and | |
| 2220 |t|. | |
| 2221 *cpo-e* | |
| 2222 e When executing a register with ":@r", always add a | |
| 2223 <CR> to the last line, also when the register is not | |
| 2224 linewise. If this flag is not present, the register | |
| 2225 is not linewise and the last line does not end in a | |
| 2226 <CR>, then the last line is put on the command-line | |
| 2227 and can be edited before hitting <CR>. | |
| 2228 *cpo-E* | |
| 2229 E It is an error when using "y", "d", "c", "g~", "gu" or | |
| 2230 "gU" on an Empty region. The operators only work when | |
|
13818
28ac7914b2b6
Update runtime files and translations
Christian Brabandt <cb@256bit.org>
parents:
13742
diff
changeset
|
2231 at least one character is to be operated on. Example: |
| 7 | 2232 This makes "y0" fail in the first column. |
| 2233 *cpo-f* | |
| 2234 f When included, a ":read" command with a file name | |
| 2235 argument will set the file name for the current buffer, | |
| 2236 if the current buffer doesn't have a file name yet. | |
| 2237 *cpo-F* | |
| 2238 F When included, a ":write" command with a file name | |
| 2239 argument will set the file name for the current | |
| 2240 buffer, if the current buffer doesn't have a file name | |
| 590 | 2241 yet. Also see |cpo-P|. |
| 7 | 2242 *cpo-g* |
| 2243 g Goto line 1 when using ":edit" without argument. | |
| 164 | 2244 *cpo-H* |
| 2245 H When using "I" on a line with only blanks, insert | |
| 2246 before the last blank. Without this flag insert after | |
| 2247 the last blank. | |
| 7 | 2248 *cpo-i* |
| 2249 i When included, interrupting the reading of a file will | |
| 2250 leave it modified. | |
| 10 | 2251 *cpo-I* |
| 2252 I When moving the cursor up or down just after inserting | |
| 2253 indent for 'autoindent', do not delete the indent. | |
| 7 | 2254 *cpo-j* |
| 2255 j When joining lines, only add two spaces after a '.', | |
| 2256 not after '!' or '?'. Also see 'joinspaces'. | |
| 2257 *cpo-J* | |
| 2258 J A |sentence| has to be followed by two spaces after | |
| 233 | 2259 the '.', '!' or '?'. A <Tab> is not recognized as |
| 7 | 2260 white space. |
| 2261 *cpo-k* | |
| 2262 k Disable the recognition of raw key codes in | |
| 2263 mappings, abbreviations, and the "to" part of menu | |
| 2264 commands. For example, if <Key> sends ^[OA (where ^[ | |
| 2265 is <Esc>), the command ":map X ^[OA" results in X | |
| 2266 being mapped to: | |
| 2267 'k' included: "^[OA" (3 characters) | |
| 2268 'k' excluded: "<Key>" (one key code) | |
| 2269 Also see the '<' flag below. | |
| 2270 *cpo-K* | |
| 2271 K Don't wait for a key code to complete when it is | |
| 2272 halfway a mapping. This breaks mapping <F1><F1> when | |
| 2273 only part of the second <F1> has been read. It | |
| 2274 enables cancelling the mapping by typing <F1><Esc>. | |
| 2275 *cpo-l* | |
| 2276 l Backslash in a [] range in a search pattern is taken | |
| 168 | 2277 literally, only "\]", "\^", "\-" and "\\" are special. |
| 2278 See |/[]| | |
| 7 | 2279 'l' included: "/[ \t]" finds <Space>, '\' and 't' |
| 2280 'l' excluded: "/[ \t]" finds <Space> and <Tab> | |
| 168 | 2281 Also see |cpo-\|. |
| 7 | 2282 *cpo-L* |
| 2283 L When the 'list' option is set, 'wrapmargin', | |
| 2284 'textwidth', 'softtabstop' and Virtual Replace mode | |
| 2285 (see |gR|) count a <Tab> as two characters, instead of | |
| 2286 the normal behavior of a <Tab>. | |
| 2287 *cpo-m* | |
| 2288 m When included, a showmatch will always wait half a | |
| 2289 second. When not included, a showmatch will wait half | |
| 2290 a second or until a character is typed. |'showmatch'| | |
| 2291 *cpo-M* | |
| 2292 M When excluded, "%" matching will take backslashes into | |
| 2293 account. Thus in "( \( )" and "\( ( \)" the outer | |
| 2294 parenthesis match. When included "%" ignores | |
| 2295 backslashes, which is Vi compatible. | |
| 2296 *cpo-n* | |
|
2178
c6f1aa1e9f32
Add 'relativenumber' patch from Markus Heidelberg.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2297 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
|
2298 '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
|
2299 lines. |
| 7 | 2300 *cpo-o* |
| 2301 o Line offset to search command is not remembered for | |
| 2302 next search. | |
| 2303 *cpo-O* | |
| 2304 O Don't complain if a file is being overwritten, even | |
| 2305 when it didn't exist when editing it. This is a | |
| 2306 protection against a file unexpectedly created by | |
| 2307 someone else. Vi didn't complain about this. | |
| 2308 *cpo-p* | |
| 2309 p Vi compatible Lisp indenting. When not present, a | |
| 2310 slightly better algorithm is used. | |
| 590 | 2311 *cpo-P* |
| 2312 P When included, a ":write" command that appends to a | |
| 2313 file will set the file name for the current buffer, if | |
| 2314 the current buffer doesn't have a file name yet and | |
| 2315 the 'F' flag is also included |cpo-F|. | |
| 164 | 2316 *cpo-q* |
| 2317 q When joining multiple lines leave the cursor at the | |
| 2318 position where it would be when joining two lines. | |
| 7 | 2319 *cpo-r* |
| 2320 r Redo ("." command) uses "/" to repeat a search | |
| 2321 command, instead of the actually used search string. | |
| 2322 *cpo-R* | |
| 2323 R Remove marks from filtered lines. Without this flag | |
| 2324 marks are kept like |:keepmarks| was used. | |
| 2325 *cpo-s* | |
| 2326 s Set buffer options when entering the buffer for the | |
| 2327 first time. This is like it is in Vim version 3.0. | |
| 10 | 2328 And it is the default. If not present the options are |
| 7 | 2329 set when the buffer is created. |
| 2330 *cpo-S* | |
| 2331 S Set buffer options always when entering a buffer | |
| 2332 (except 'readonly', 'fileformat', 'filetype' and | |
| 2333 'syntax'). This is the (most) Vi compatible setting. | |
| 2334 The options are set to the values in the current | |
| 2335 buffer. When you change an option and go to another | |
| 2336 buffer, the value is copied. Effectively makes the | |
| 2337 buffer options global to all buffers. | |
| 2338 | |
| 2339 's' 'S' copy buffer options | |
| 2340 no no when buffer created | |
| 2341 yes no when buffer first entered (default) | |
| 2342 X yes each time when buffer entered (vi comp.) | |
| 2343 *cpo-t* | |
| 2344 t Search pattern for the tag command is remembered for | |
| 2345 "n" command. Otherwise Vim only puts the pattern in | |
| 2346 the history for search pattern, but doesn't change the | |
| 2347 last used search pattern. | |
| 2348 *cpo-u* | |
| 10 | 2349 u Undo is Vi compatible. See |undo-two-ways|. |
| 7 | 2350 *cpo-v* |
| 2351 v Backspaced characters remain visible on the screen in | |
| 2352 Insert mode. Without this flag the characters are | |
| 2353 erased from the screen right away. With this flag the | |
| 2354 screen newly typed text overwrites backspaced | |
| 2355 characters. | |
| 2356 *cpo-w* | |
| 2357 w When using "cw" on a blank character, only change one | |
| 2358 character and not all blanks until the start of the | |
| 2359 next word. | |
| 2360 *cpo-W* | |
| 2361 W Don't overwrite a readonly file. When omitted, ":w!" | |
| 2362 overwrites a readonly file, if possible. | |
| 2363 *cpo-x* | |
| 2364 x <Esc> on the command-line executes the command-line. | |
| 2365 The default in Vim is to abandon the command-line, | |
| 2366 because <Esc> normally aborts a command. |c_<Esc>| | |
| 164 | 2367 *cpo-X* |
| 2368 X When using a count with "R" the replaced text is | |
| 2369 deleted only once. Also when repeating "R" with "." | |
| 2370 and a count. | |
| 7 | 2371 *cpo-y* |
| 15512 | 2372 y A yank command can be redone with ".". Think twice if |
| 2373 you really want to use this, it may break some | |
| 2374 plugins, since most people expect "." to only repeat a | |
| 2375 change. | |
| 164 | 2376 *cpo-Z* |
| 2377 Z When using "w!" while the 'readonly' option is set, | |
| 2378 don't reset 'readonly'. | |
| 7 | 2379 *cpo-!* |
| 2380 ! When redoing a filter command, use the last used | |
| 2381 external command, whatever it was. Otherwise the last | |
| 2382 used -filter- command is used. | |
| 2383 *cpo-$* | |
| 2384 $ When making a change to one line, don't redisplay the | |
| 2385 line, but put a '$' at the end of the changed text. | |
| 2386 The changed text will be overwritten when you type the | |
| 2387 new text. The line is redisplayed if you type any | |
| 2388 command that moves the cursor from the insertion | |
| 2389 point. | |
| 2390 *cpo-%* | |
| 2391 % Vi-compatible matching is done for the "%" command. | |
| 2392 Does not recognize "#if", "#endif", etc. | |
| 2393 Does not recognize "/*" and "*/". | |
| 2394 Parens inside single and double quotes are also | |
| 2395 counted, causing a string that contains a paren to | |
| 2396 disturb the matching. For example, in a line like | |
| 2397 "if (strcmp("foo(", s))" the first paren does not | |
| 2398 match the last one. When this flag is not included, | |
| 2399 parens inside single and double quotes are treated | |
| 2400 specially. When matching a paren outside of quotes, | |
| 2401 everything inside quotes is ignored. When matching a | |
| 2402 paren inside quotes, it will find the matching one (if | |
| 10 | 2403 there is one). This works very well for C programs. |
| 36 | 2404 This flag is also used for other features, such as |
| 2405 C-indenting. | |
| 161 | 2406 *cpo--* |
| 2407 - When included, a vertical movement command fails when | |
| 632 | 2408 it would go above the first line or below the last |
| 2409 line. Without it the cursor moves to the first or | |
| 2410 last line, unless it already was in that line. | |
| 161 | 2411 Applies to the commands "-", "k", CTRL-P, "+", "j", |
| 632 | 2412 CTRL-N, CTRL-J and ":1234". |
| 39 | 2413 *cpo-+* |
| 2414 + When included, a ":write file" command will reset the | |
| 2415 'modified' flag of the buffer, even though the buffer | |
| 2416 itself may still be different from its file. | |
| 856 | 2417 *cpo-star* |
| 7 | 2418 * Use ":*" in the same way as ":@". When not included, |
| 2419 ":*" is an alias for ":'<,'>", select the Visual area. | |
| 2420 *cpo-<* | |
| 2421 < Disable the recognition of special key codes in |<>| | |
| 2422 form in mappings, abbreviations, and the "to" part of | |
| 10 | 2423 menu commands. For example, the command |
| 7 | 2424 ":map X <Tab>" results in X being mapped to: |
| 2425 '<' included: "<Tab>" (5 characters) | |
| 2426 '<' excluded: "^I" (^I is a real <Tab>) | |
| 2427 Also see the 'k' flag above. | |
| 164 | 2428 *cpo->* |
| 2429 > When appending to a register, put a line break before | |
| 2430 the appended text. | |
| 2925 | 2431 *cpo-;* |
| 2432 ; When using |,| or |;| to repeat the last |t| search | |
| 2433 and the cursor is right in front of the searched | |
| 2434 character, the cursor won't move. When not included, | |
| 2435 the cursor would skip over it and jump to the | |
| 3557 | 2436 following occurrence. |
| 164 | 2437 |
| 2438 POSIX flags. These are not included in the Vi default value, except | |
| 2439 when $VIM_POSIX was set on startup. |posix| | |
| 2440 | |
| 2441 contains behavior ~ | |
| 856 | 2442 *cpo-#* |
| 164 | 2443 # A count before "D", "o" and "O" has no effect. |
| 168 | 2444 *cpo-&* |
| 2445 & When ":preserve" was used keep the swap file when | |
| 2446 exiting normally while this buffer is still loaded. | |
| 2447 This flag is tested when exiting. | |
| 2448 *cpo-\* | |
| 2449 \ Backslash in a [] range in a search pattern is taken | |
| 2450 literally, only "\]" is special See |/[]| | |
| 488 | 2451 '\' included: "/[ \-]" finds <Space>, '\' and '-' |
| 2452 '\' excluded: "/[ \-]" finds <Space> and '-' | |
| 2453 Also see |cpo-l|. | |
| 168 | 2454 *cpo-/* |
| 2455 / When "%" is used as the replacement string in a |:s| | |
| 2456 command, use the previous replacement string. |:s%| | |
| 164 | 2457 *cpo-{* |
| 2458 { The |{| and |}| commands also stop at a "{" character | |
| 2459 at the start of a line. | |
| 168 | 2460 *cpo-.* |
| 2461 . The ":chdir" and ":cd" commands fail if the current | |
| 2462 buffer is modified, unless ! is used. Vim doesn't | |
| 2463 need this, since it remembers the full path of an | |
| 2464 opened file. | |
| 164 | 2465 *cpo-bar* |
| 2466 | The value of the $LINES and $COLUMNS environment | |
| 2467 variables overrule the terminal size values obtained | |
| 2468 with system specific functions. | |
| 2469 | |
| 7 | 2470 |
|
2180
f60a0c9cbe6c
Add the blowfish encryption patch from Mohsin Ahmed. Needs more work.
Bram Moolenaar <bram@vim.org>
parents:
2178
diff
changeset
|
2471 *'cryptmethod'* *'cm'* |
|
15192
690da0a83419
patch 8.1.0606: 'cryptmethod' defaults to a very old method
Bram Moolenaar <Bram@vim.org>
parents:
15131
diff
changeset
|
2472 'cryptmethod' 'cm' string (default "blowfish2") |
|
2360
d8e4b27cef80
Change 'cryptmethod' from a number to a string option. Make it global-local.
Bram Moolenaar <bram@vim.org>
parents:
2350
diff
changeset
|
2473 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
|
2474 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
|
2475 *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
|
2476 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
|
2477 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
|
2478 *blowfish* |
| 6122 | 2479 blowfish Blowfish method. Medium strong encryption but it has |
| 2480 an implementation flaw. Requires Vim 7.3 or later, | |
| 2481 files can NOT be read by Vim 7.2 and older. This adds | |
| 2482 a "seed" to the file, every time you write the file | |
| 2483 the encrypted bytes will be different. | |
| 2484 *blowfish2* | |
| 2485 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
|
2486 Vim 7.4.401 or later, files can NOT be read by Vim 7.3 |
| 6122 | 2487 and older. This adds a "seed" to the file, every time |
| 2488 you write the file the encrypted bytes will be | |
| 2489 different. The whole undo file is encrypted, not just | |
| 2490 the pieces of text. | |
| 27537 | 2491 *E1193* *E1194* *E1195* *E1196* *E1230* |
|
24970
7e9e53a0368f
patch 8.2.3022: available encryption methods are not strong enough
Bram Moolenaar <Bram@vim.org>
parents:
24911
diff
changeset
|
2492 *E1197* *E1198* *E1199* *E1200* *E1201* |
|
7e9e53a0368f
patch 8.2.3022: available encryption methods are not strong enough
Bram Moolenaar <Bram@vim.org>
parents:
24911
diff
changeset
|
2493 xchacha20 XChaCha20 Cipher with Poly1305 Message Authentication |
|
7e9e53a0368f
patch 8.2.3022: available encryption methods are not strong enough
Bram Moolenaar <Bram@vim.org>
parents:
24911
diff
changeset
|
2494 Code. Medium strong till strong encryption. |
|
7e9e53a0368f
patch 8.2.3022: available encryption methods are not strong enough
Bram Moolenaar <Bram@vim.org>
parents:
24911
diff
changeset
|
2495 Encryption is provided by the libsodium library, it |
| 25973 | 2496 requires Vim to be built with |+sodium|. |
|
24970
7e9e53a0368f
patch 8.2.3022: available encryption methods are not strong enough
Bram Moolenaar <Bram@vim.org>
parents:
24911
diff
changeset
|
2497 It adds a seed and a message authentication code (MAC) |
|
7e9e53a0368f
patch 8.2.3022: available encryption methods are not strong enough
Bram Moolenaar <Bram@vim.org>
parents:
24911
diff
changeset
|
2498 to the file. This needs at least a Vim 8.2.3022 to |
|
7e9e53a0368f
patch 8.2.3022: available encryption methods are not strong enough
Bram Moolenaar <Bram@vim.org>
parents:
24911
diff
changeset
|
2499 read the encrypted file. |
|
7e9e53a0368f
patch 8.2.3022: available encryption methods are not strong enough
Bram Moolenaar <Bram@vim.org>
parents:
24911
diff
changeset
|
2500 Encryption of swap files is not supported, therefore |
|
7e9e53a0368f
patch 8.2.3022: available encryption methods are not strong enough
Bram Moolenaar <Bram@vim.org>
parents:
24911
diff
changeset
|
2501 no swap file will be used when xchacha20 encryption is |
|
7e9e53a0368f
patch 8.2.3022: available encryption methods are not strong enough
Bram Moolenaar <Bram@vim.org>
parents:
24911
diff
changeset
|
2502 enabled. |
|
7e9e53a0368f
patch 8.2.3022: available encryption methods are not strong enough
Bram Moolenaar <Bram@vim.org>
parents:
24911
diff
changeset
|
2503 Encryption of undo files is not yet supported, |
|
7e9e53a0368f
patch 8.2.3022: available encryption methods are not strong enough
Bram Moolenaar <Bram@vim.org>
parents:
24911
diff
changeset
|
2504 therefore no undo file will currently be written. |
|
7e9e53a0368f
patch 8.2.3022: available encryption methods are not strong enough
Bram Moolenaar <Bram@vim.org>
parents:
24911
diff
changeset
|
2505 CURRENTLY EXPERIMENTAL: Files written with this method |
|
7e9e53a0368f
patch 8.2.3022: available encryption methods are not strong enough
Bram Moolenaar <Bram@vim.org>
parents:
24911
diff
changeset
|
2506 might have to be read back with the same version of |
|
7e9e53a0368f
patch 8.2.3022: available encryption methods are not strong enough
Bram Moolenaar <Bram@vim.org>
parents:
24911
diff
changeset
|
2507 Vim if the binary format changes later. |
|
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
|
2508 |
|
8748
b1a19a2f73f0
commit https://github.com/vim/vim/commit/4f3f668c8486444e53163c29d2fc79bf47eb3c82
Christian Brabandt <cb@256bit.org>
parents:
8629
diff
changeset
|
2509 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
|
2510 |
|
2180
f60a0c9cbe6c
Add the blowfish encryption patch from Mohsin Ahmed. Needs more work.
Bram Moolenaar <bram@vim.org>
parents:
2178
diff
changeset
|
2511 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
|
2512 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
|
2513 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
|
2514 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
|
2515 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
|
2516 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
|
2517 |
|
d8e4b27cef80
Change 'cryptmethod' from a number to a string option. Make it global-local.
Bram Moolenaar <bram@vim.org>
parents:
2350
diff
changeset
|
2518 When setting the global value to an empty string, it will end up with |
|
15192
690da0a83419
patch 8.1.0606: 'cryptmethod' defaults to a very old method
Bram Moolenaar <Bram@vim.org>
parents:
15131
diff
changeset
|
2519 the value "blowfish2". When setting the local value to an empty |
|
690da0a83419
patch 8.1.0606: 'cryptmethod' defaults to a very old method
Bram Moolenaar <Bram@vim.org>
parents:
15131
diff
changeset
|
2520 string the buffer will use the global value. |
|
2360
d8e4b27cef80
Change 'cryptmethod' from a number to a string option. Make it global-local.
Bram Moolenaar <bram@vim.org>
parents:
2350
diff
changeset
|
2521 |
|
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
|
2522 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
|
2523 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
|
2524 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
|
2525 |
|
f60a0c9cbe6c
Add the blowfish encryption patch from Mohsin Ahmed. Needs more work.
Bram Moolenaar <bram@vim.org>
parents:
2178
diff
changeset
|
2526 |
| 7 | 2527 *'cscopepathcomp'* *'cspc'* |
| 2528 'cscopepathcomp' 'cspc' number (default 0) | |
| 2529 global | |
| 2530 {not available when compiled without the |+cscope| | |
| 2531 feature} | |
| 2532 Determines how many components of the path to show in a list of tags. | |
| 2533 See |cscopepathcomp|. | |
| 11160 | 2534 NOTE: This option is set to 0 when 'compatible' is set. |
| 7 | 2535 |
| 2536 *'cscopeprg'* *'csprg'* | |
| 2537 'cscopeprg' 'csprg' string (default "cscope") | |
| 2538 global | |
| 2539 {not available when compiled without the |+cscope| | |
| 2540 feature} | |
| 2541 Specifies the command to execute cscope. See |cscopeprg|. | |
| 2542 This option cannot be set from a |modeline| or in the |sandbox|, for | |
| 2543 security reasons. | |
| 2544 | |
| 2545 *'cscopequickfix'* *'csqf'* | |
| 2546 'cscopequickfix' 'csqf' string (default "") | |
| 2547 global | |
| 2548 {not available when compiled without the |+cscope| | |
| 2549 or |+quickfix| features} | |
| 2550 Specifies whether to use quickfix window to show cscope results. | |
| 2551 See |cscopequickfix|. | |
| 2552 | |
| 4869 | 2553 *'cscoperelative'* *'csre'* *'nocscoperelative'* *'nocsre'* |
| 2873 | 2554 'cscoperelative' 'csre' boolean (default off) |
| 2555 global | |
| 2556 {not available when compiled without the |+cscope| | |
| 2557 feature} | |
| 2558 In the absence of a prefix (-P) for cscope. setting this option enables | |
| 2559 to use the basename of cscope.out path as the prefix. | |
| 2560 See |cscoperelative|. | |
| 11160 | 2561 NOTE: This option is reset when 'compatible' is set. |
| 2873 | 2562 |
| 7 | 2563 *'cscopetag'* *'cst'* *'nocscopetag'* *'nocst'* |
| 2564 'cscopetag' 'cst' boolean (default off) | |
| 2565 global | |
| 2566 {not available when compiled without the |+cscope| | |
| 2567 feature} | |
| 2568 Use cscope for tag commands. See |cscope-options|. | |
| 2569 NOTE: This option is reset when 'compatible' is set. | |
| 2570 | |
| 2571 *'cscopetagorder'* *'csto'* | |
| 2572 'cscopetagorder' 'csto' number (default 0) | |
| 2573 global | |
| 2574 {not available when compiled without the |+cscope| | |
| 2575 feature} | |
| 2576 Determines the order in which ":cstag" performs a search. See | |
| 2577 |cscopetagorder|. | |
| 2578 NOTE: This option is set to 0 when 'compatible' is set. | |
| 2579 | |
| 2580 *'cscopeverbose'* *'csverb'* | |
| 2581 *'nocscopeverbose'* *'nocsverb'* | |
| 2582 'cscopeverbose' 'csverb' boolean (default off) | |
| 2583 global | |
| 2584 {not available when compiled without the |+cscope| | |
| 2585 feature} | |
| 2586 Give messages when adding a cscope database. See |cscopeverbose|. | |
| 2587 NOTE: This option is reset when 'compatible' is set. | |
| 2588 | |
|
2250
1bac28a53fae
Add the conceal patch from Vince Negri.
Bram Moolenaar <bram@vim.org>
parents:
2249
diff
changeset
|
2589 *'cursorbind'* *'crb'* *'nocursorbind'* *'nocrb'* |
|
1bac28a53fae
Add the conceal patch from Vince Negri.
Bram Moolenaar <bram@vim.org>
parents:
2249
diff
changeset
|
2590 'cursorbind' 'crb' boolean (default off) |
|
1bac28a53fae
Add the conceal patch from Vince Negri.
Bram Moolenaar <bram@vim.org>
parents:
2249
diff
changeset
|
2591 local to window |
|
1bac28a53fae
Add the conceal patch from Vince Negri.
Bram Moolenaar <bram@vim.org>
parents:
2249
diff
changeset
|
2592 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
|
2593 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
|
2594 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
|
2595 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
|
2596 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
|
2597 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
|
2598 taken into account. |
|
2250
1bac28a53fae
Add the conceal patch from Vince Negri.
Bram Moolenaar <bram@vim.org>
parents:
2249
diff
changeset
|
2599 |
| 743 | 2600 |
| 2601 *'cursorcolumn'* *'cuc'* *'nocursorcolumn'* *'nocuc'* | |
| 2602 'cursorcolumn' 'cuc' boolean (default off) | |
| 2603 local to window | |
|
2570
71b56b4e7785
Make the references to features in the help more consistent. (Sylvain Hitier)
Bram Moolenaar <bram@vim.org>
parents:
2561
diff
changeset
|
2604 {not available when compiled without the |+syntax| |
| 743 | 2605 feature} |
| 2606 Highlight the screen column of the cursor with CursorColumn | |
| 2607 |hl-CursorColumn|. Useful to align text. Will make screen redrawing | |
| 2608 slower. | |
| 826 | 2609 If you only want the highlighting in the current window you can use |
| 2610 these autocommands: > | |
| 2611 au WinLeave * set nocursorline nocursorcolumn | |
| 2612 au WinEnter * set cursorline cursorcolumn | |
| 2613 < | |
| 743 | 2614 |
| 2615 *'cursorline'* *'cul'* *'nocursorline'* *'nocul'* | |
| 2616 'cursorline' 'cul' boolean (default off) | |
| 2617 local to window | |
|
2570
71b56b4e7785
Make the references to features in the help more consistent. (Sylvain Hitier)
Bram Moolenaar <bram@vim.org>
parents:
2561
diff
changeset
|
2618 {not available when compiled without the |+syntax| |
| 743 | 2619 feature} |
|
18047
6650e3dff8d4
patch 8.1.2019: 'cursorline' always highlights the whole line
Bram Moolenaar <Bram@vim.org>
parents:
17909
diff
changeset
|
2620 Highlight the text line of the cursor with CursorLine |hl-CursorLine|. |
|
6650e3dff8d4
patch 8.1.2019: 'cursorline' always highlights the whole line
Bram Moolenaar <Bram@vim.org>
parents:
17909
diff
changeset
|
2621 Useful to easily spot the cursor. Will make screen redrawing slower. |
| 818 | 2622 When Visual mode is active the highlighting isn't used to make it |
| 825 | 2623 easier to see the selected text. |
| 743 | 2624 |
| 2625 | |
|
18047
6650e3dff8d4
patch 8.1.2019: 'cursorline' always highlights the whole line
Bram Moolenaar <Bram@vim.org>
parents:
17909
diff
changeset
|
2626 *'cursorlineopt'* *'culopt'* |
|
18068
1101eacc1444
patch 8.1.2029: cannot control 'cursorline' highlighting well
Bram Moolenaar <Bram@vim.org>
parents:
18053
diff
changeset
|
2627 'cursorlineopt' 'culopt' string (default: "number,line") |
|
18047
6650e3dff8d4
patch 8.1.2019: 'cursorline' always highlights the whole line
Bram Moolenaar <Bram@vim.org>
parents:
17909
diff
changeset
|
2628 local to window |
|
6650e3dff8d4
patch 8.1.2019: 'cursorline' always highlights the whole line
Bram Moolenaar <Bram@vim.org>
parents:
17909
diff
changeset
|
2629 {not available when compiled without the |+syntax| |
|
6650e3dff8d4
patch 8.1.2019: 'cursorline' always highlights the whole line
Bram Moolenaar <Bram@vim.org>
parents:
17909
diff
changeset
|
2630 feature} |
|
18068
1101eacc1444
patch 8.1.2029: cannot control 'cursorline' highlighting well
Bram Moolenaar <Bram@vim.org>
parents:
18053
diff
changeset
|
2631 Comma separated list of settings for how 'cursorline' is displayed. |
|
1101eacc1444
patch 8.1.2029: cannot control 'cursorline' highlighting well
Bram Moolenaar <Bram@vim.org>
parents:
18053
diff
changeset
|
2632 Valid values: |
|
1101eacc1444
patch 8.1.2029: cannot control 'cursorline' highlighting well
Bram Moolenaar <Bram@vim.org>
parents:
18053
diff
changeset
|
2633 "line" Highlight the text line of the cursor with |
|
1101eacc1444
patch 8.1.2029: cannot control 'cursorline' highlighting well
Bram Moolenaar <Bram@vim.org>
parents:
18053
diff
changeset
|
2634 CursorLine |hl-CursorLine|. |
|
1101eacc1444
patch 8.1.2029: cannot control 'cursorline' highlighting well
Bram Moolenaar <Bram@vim.org>
parents:
18053
diff
changeset
|
2635 "screenline" Highlight only the screen line of the cursor with |
|
18047
6650e3dff8d4
patch 8.1.2019: 'cursorline' always highlights the whole line
Bram Moolenaar <Bram@vim.org>
parents:
17909
diff
changeset
|
2636 CursorLine |hl-CursorLine|. |
|
18068
1101eacc1444
patch 8.1.2029: cannot control 'cursorline' highlighting well
Bram Moolenaar <Bram@vim.org>
parents:
18053
diff
changeset
|
2637 "number" Highlight the line number of the cursor with |
|
18047
6650e3dff8d4
patch 8.1.2019: 'cursorline' always highlights the whole line
Bram Moolenaar <Bram@vim.org>
parents:
17909
diff
changeset
|
2638 CursorLineNr |hl-CursorLineNr|. |
|
18068
1101eacc1444
patch 8.1.2029: cannot control 'cursorline' highlighting well
Bram Moolenaar <Bram@vim.org>
parents:
18053
diff
changeset
|
2639 |
|
1101eacc1444
patch 8.1.2029: cannot control 'cursorline' highlighting well
Bram Moolenaar <Bram@vim.org>
parents:
18053
diff
changeset
|
2640 Special value: |
|
1101eacc1444
patch 8.1.2029: cannot control 'cursorline' highlighting well
Bram Moolenaar <Bram@vim.org>
parents:
18053
diff
changeset
|
2641 "both" Alias for the values "line,number". |
|
1101eacc1444
patch 8.1.2029: cannot control 'cursorline' highlighting well
Bram Moolenaar <Bram@vim.org>
parents:
18053
diff
changeset
|
2642 |
|
1101eacc1444
patch 8.1.2029: cannot control 'cursorline' highlighting well
Bram Moolenaar <Bram@vim.org>
parents:
18053
diff
changeset
|
2643 "line" and "screenline" cannot be used together. |
|
18047
6650e3dff8d4
patch 8.1.2019: 'cursorline' always highlights the whole line
Bram Moolenaar <Bram@vim.org>
parents:
17909
diff
changeset
|
2644 |
|
6650e3dff8d4
patch 8.1.2019: 'cursorline' always highlights the whole line
Bram Moolenaar <Bram@vim.org>
parents:
17909
diff
changeset
|
2645 |
| 7 | 2646 *'debug'* |
| 2647 'debug' string (default "") | |
| 2648 global | |
| 839 | 2649 These values can be used: |
| 2650 msg Error messages that would otherwise be omitted will be given | |
| 2651 anyway. | |
| 2652 throw Error messages that would otherwise be omitted will be given | |
| 2653 anyway and also throw an exception and set |v:errmsg|. | |
| 2654 beep A message will be given when otherwise only a beep would be | |
| 2655 produced. | |
| 168 | 2656 The values can be combined, separated by a comma. |
| 839 | 2657 "msg" and "throw" are useful for debugging 'foldexpr', 'formatexpr' or |
| 2658 'indentexpr'. | |
| 7 | 2659 |
| 2660 *'define'* *'def'* | |
| 2661 'define' 'def' string (default "^\s*#\s*define") | |
| 2662 global or local to buffer |global-local| | |
| 10 | 2663 Pattern to be used to find a macro definition. It is a search |
| 7 | 2664 pattern, just like for the "/" command. This option is used for the |
| 2665 commands like "[i" and "[d" |include-search|. The 'isident' option is | |
| 2666 used to recognize the defined name after the match: | |
| 2667 {match with 'define'}{non-ID chars}{defined name}{non-ID char} | |
| 2668 See |option-backslash| about inserting backslashes to include a space | |
| 2669 or backslash. | |
| 2670 The default value is for C programs. For C++ this value would be | |
| 2671 useful, to include const type declarations: > | |
| 2672 ^\(#\s*define\|[a-z]*\s*const\s*[a-z]*\) | |
| 16086 | 2673 < You can also use "\ze" just before the name and continue the pattern |
| 2674 to check what is following. E.g. for Javascript, if a function is | |
| 2675 defined with "func_name = function(args)": > | |
| 2676 ^\s*\ze\i\+\s*=\s*function( | |
| 2677 < If the function is defined with "func_name : function() {...": > | |
| 2678 ^\s*\ze\i\+\s*[:]\s*(*function\s*( | |
| 7 | 2679 < When using the ":set" command, you need to double the backslashes! |
| 16086 | 2680 To avoid that use `:let` with a single quote string: > |
| 2681 let &l:define = '^\s*\ze\k\+\s*=\s*function(' | |
| 16380 | 2682 < |
| 7 | 2683 |
| 2684 *'delcombine'* *'deco'* *'nodelcombine'* *'nodeco'* | |
| 2685 'delcombine' 'deco' boolean (default off) | |
| 2686 global | |
| 2687 If editing Unicode and this option is set, backspace and Normal mode | |
| 2688 "x" delete each combining character on its own. When it is off (the | |
| 2689 default) the character along with its combining characters are | |
| 2690 deleted. | |
| 22565 | 2691 Note: When 'delcombine' is set "xx" may work differently from "2x"! |
| 7 | 2692 |
| 2693 This is useful for Arabic, Hebrew and many other languages where one | |
| 2694 may have combining characters overtop of base characters, and want | |
| 2695 to remove only the combining ones. | |
| 11160 | 2696 NOTE: This option is reset when 'compatible' is set. |
| 7 | 2697 |
| 2698 *'dictionary'* *'dict'* | |
| 2699 'dictionary' 'dict' string (default "") | |
| 2700 global or local to buffer |global-local| | |
| 2701 List of file names, separated by commas, that are used to lookup words | |
| 2702 for keyword completion commands |i_CTRL-X_CTRL-K|. Each file should | |
| 2703 contain a list of words. This can be one word per line, or several | |
| 2704 words per line, separated by non-keyword characters (white space is | |
| 2705 preferred). Maximum line length is 510 bytes. | |
|
13950
741b1feeac9f
patch 8.0.1845: various comment updates needed, missing white space
Christian Brabandt <cb@256bit.org>
parents:
13818
diff
changeset
|
2706 |
|
741b1feeac9f
patch 8.0.1845: various comment updates needed, missing white space
Christian Brabandt <cb@256bit.org>
parents:
13818
diff
changeset
|
2707 When this option is empty or an entry "spell" is present, and spell |
|
741b1feeac9f
patch 8.0.1845: various comment updates needed, missing white space
Christian Brabandt <cb@256bit.org>
parents:
13818
diff
changeset
|
2708 checking is enabled, words in the word lists for the currently active |
|
741b1feeac9f
patch 8.0.1845: various comment updates needed, missing white space
Christian Brabandt <cb@256bit.org>
parents:
13818
diff
changeset
|
2709 'spelllang' are used. See |spell|. |
|
741b1feeac9f
patch 8.0.1845: various comment updates needed, missing white space
Christian Brabandt <cb@256bit.org>
parents:
13818
diff
changeset
|
2710 |
| 10 | 2711 To include a comma in a file name precede it with a backslash. Spaces |
| 7 | 2712 after a comma are ignored, otherwise spaces are included in the file |
| 2713 name. See |option-backslash| about using backslashes. | |
| 99 | 2714 This has nothing to do with the |Dictionary| variable type. |
| 7 | 2715 Where to find a list of words? |
| 2716 - On FreeBSD, there is the file "/usr/share/dict/words". | |
| 2717 - In the Simtel archive, look in the "msdos/linguist" directory. | |
| 2718 - In "miscfiles" of the GNU collection. | |
| 2719 The use of |:set+=| and |:set-=| is preferred when adding or removing | |
| 2720 directories from the list. This avoids problems when a future version | |
| 2721 uses another default. | |
| 2722 Backticks cannot be used in this option for security reasons. | |
| 2723 | |
| 2724 *'diff'* *'nodiff'* | |
| 2725 'diff' boolean (default off) | |
| 2726 local to window | |
| 2727 {not available when compiled without the |+diff| | |
| 2728 feature} | |
| 2729 Join the current window in the group of windows that shows differences | |
| 10 | 2730 between files. See |vimdiff|. |
| 7 | 2731 |
| 2732 *'dex'* *'diffexpr'* | |
| 2733 'diffexpr' 'dex' string (default "") | |
| 2734 global | |
| 2735 {not available when compiled without the |+diff| | |
| 2736 feature} | |
|
14696
195e8b1fcbbf
patch 8.1.0360: using an external diff program is slow and inflexible
Christian Brabandt <cb@256bit.org>
parents:
14695
diff
changeset
|
2737 Expression which is evaluated to obtain a diff file (either ed-style |
|
195e8b1fcbbf
patch 8.1.0360: using an external diff program is slow and inflexible
Christian Brabandt <cb@256bit.org>
parents:
14695
diff
changeset
|
2738 or unified-style) from two versions of a file. See |diff-diffexpr|. |
| 7 | 2739 This option cannot be set from a |modeline| or in the |sandbox|, for |
| 2740 security reasons. | |
| 2741 | |
| 2742 *'dip'* *'diffopt'* | |
|
18590
41484f342f80
patch 8.1.2289: after :diffsplit closing the window does not disable diff
Bram Moolenaar <Bram@vim.org>
parents:
18574
diff
changeset
|
2743 'diffopt' 'dip' string (default "internal,filler,closeoff") |
| 7 | 2744 global |
| 2745 {not available when compiled without the |+diff| | |
| 2746 feature} | |
| 10 | 2747 Option settings for diff mode. It can consist of the following items. |
| 7 | 2748 All are optional. Items must be separated by a comma. |
| 2749 | |
| 2750 filler Show filler lines, to keep the text | |
| 2751 synchronized with a window that has inserted | |
| 2752 lines at the same position. Mostly useful | |
| 2753 when windows are side-by-side and 'scrollbind' | |
| 2754 is set. | |
| 2755 | |
| 2756 context:{n} Use a context of {n} lines between a change | |
| 2757 and a fold that contains unchanged lines. | |
| 2758 When omitted a context of six lines is used. | |
| 15932 | 2759 When using zero the context is actually one, |
| 2760 since folds require a line in between, also | |
| 2761 for a deleted line. | |
| 7 | 2762 See |fold-diff|. |
| 2763 | |
| 14864 | 2764 iblank Ignore changes where lines are all blank. Adds |
| 2765 the "-B" flag to the "diff" command if | |
| 2766 'diffexpr' is empty. Check the documentation | |
| 2767 of the "diff" command for what this does | |
| 2768 exactly. | |
| 2769 NOTE: the diff windows will get out of sync, | |
| 2770 because no differences between blank lines are | |
| 2771 taken into account. | |
| 2772 | |
| 7 | 2773 icase Ignore changes in case of text. "a" and "A" |
| 2774 are considered the same. Adds the "-i" flag | |
| 2775 to the "diff" command if 'diffexpr' is empty. | |
| 2776 | |
| 2777 iwhite Ignore changes in amount of white space. Adds | |
| 2778 the "-b" flag to the "diff" command if | |
| 2779 'diffexpr' is empty. Check the documentation | |
| 2780 of the "diff" command for what this does | |
| 2781 exactly. It should ignore adding trailing | |
| 2782 white space, but not leading white space. | |
| 2783 | |
| 14864 | 2784 iwhiteall Ignore all white space changes. Adds |
| 2785 the "-w" flag to the "diff" command if | |
| 2786 'diffexpr' is empty. Check the documentation | |
| 2787 of the "diff" command for what this does | |
| 2788 exactly. | |
| 2789 | |
| 2790 iwhiteeol Ignore white space changes at end of line. | |
| 2791 Adds the "-Z" flag to the "diff" command if | |
| 2792 'diffexpr' is empty. Check the documentation | |
| 2793 of the "diff" command for what this does | |
| 2794 exactly. | |
| 2795 | |
| 766 | 2796 horizontal Start diff mode with horizontal splits (unless |
| 2797 explicitly specified otherwise). | |
| 2798 | |
| 2799 vertical Start diff mode with vertical splits (unless | |
| 2800 explicitly specified otherwise). | |
| 2801 | |
|
18590
41484f342f80
patch 8.1.2289: after :diffsplit closing the window does not disable diff
Bram Moolenaar <Bram@vim.org>
parents:
18574
diff
changeset
|
2802 closeoff When a window is closed where 'diff' is set |
|
41484f342f80
patch 8.1.2289: after :diffsplit closing the window does not disable diff
Bram Moolenaar <Bram@vim.org>
parents:
18574
diff
changeset
|
2803 and there is only one window remaining in the |
|
41484f342f80
patch 8.1.2289: after :diffsplit closing the window does not disable diff
Bram Moolenaar <Bram@vim.org>
parents:
18574
diff
changeset
|
2804 same tab page with 'diff' set, execute |
|
41484f342f80
patch 8.1.2289: after :diffsplit closing the window does not disable diff
Bram Moolenaar <Bram@vim.org>
parents:
18574
diff
changeset
|
2805 `:diffoff` in that window. This undoes a |
|
41484f342f80
patch 8.1.2289: after :diffsplit closing the window does not disable diff
Bram Moolenaar <Bram@vim.org>
parents:
18574
diff
changeset
|
2806 `:diffsplit` command. |
|
41484f342f80
patch 8.1.2289: after :diffsplit closing the window does not disable diff
Bram Moolenaar <Bram@vim.org>
parents:
18574
diff
changeset
|
2807 |
|
12971
ca3cb1997f08
patch 8.0.1361: some users don't want to diff with hidden buffers
Christian Brabandt <cb@256bit.org>
parents:
12968
diff
changeset
|
2808 hiddenoff Do not use diff mode for a buffer when it |
|
ca3cb1997f08
patch 8.0.1361: some users don't want to diff with hidden buffers
Christian Brabandt <cb@256bit.org>
parents:
12968
diff
changeset
|
2809 becomes hidden. |
|
ca3cb1997f08
patch 8.0.1361: some users don't want to diff with hidden buffers
Christian Brabandt <cb@256bit.org>
parents:
12968
diff
changeset
|
2810 |
| 766 | 2811 foldcolumn:{n} Set the 'foldcolumn' option to {n} when |
| 2812 starting diff mode. Without this 2 is used. | |
| 2813 | |
|
23895
e313b6ee2d9c
patch 8.2.2490: 'wrap' option is always reset when starting diff mode
Bram Moolenaar <Bram@vim.org>
parents:
23825
diff
changeset
|
2814 followwrap Follow the 'wrap' option and leave as it is. |
|
e313b6ee2d9c
patch 8.2.2490: 'wrap' option is always reset when starting diff mode
Bram Moolenaar <Bram@vim.org>
parents:
23825
diff
changeset
|
2815 |
|
14696
195e8b1fcbbf
patch 8.1.0360: using an external diff program is slow and inflexible
Christian Brabandt <cb@256bit.org>
parents:
14695
diff
changeset
|
2816 internal Use the internal diff library. This is |
|
195e8b1fcbbf
patch 8.1.0360: using an external diff program is slow and inflexible
Christian Brabandt <cb@256bit.org>
parents:
14695
diff
changeset
|
2817 ignored when 'diffexpr' is set. *E960* |
|
195e8b1fcbbf
patch 8.1.0360: using an external diff program is slow and inflexible
Christian Brabandt <cb@256bit.org>
parents:
14695
diff
changeset
|
2818 When running out of memory when writing a |
|
195e8b1fcbbf
patch 8.1.0360: using an external diff program is slow and inflexible
Christian Brabandt <cb@256bit.org>
parents:
14695
diff
changeset
|
2819 buffer this item will be ignored for diffs |
|
195e8b1fcbbf
patch 8.1.0360: using an external diff program is slow and inflexible
Christian Brabandt <cb@256bit.org>
parents:
14695
diff
changeset
|
2820 involving that buffer. Set the 'verbose' |
|
195e8b1fcbbf
patch 8.1.0360: using an external diff program is slow and inflexible
Christian Brabandt <cb@256bit.org>
parents:
14695
diff
changeset
|
2821 option to see when this happens. |
|
195e8b1fcbbf
patch 8.1.0360: using an external diff program is slow and inflexible
Christian Brabandt <cb@256bit.org>
parents:
14695
diff
changeset
|
2822 |
|
195e8b1fcbbf
patch 8.1.0360: using an external diff program is slow and inflexible
Christian Brabandt <cb@256bit.org>
parents:
14695
diff
changeset
|
2823 indent-heuristic |
| 15033 | 2824 Use the indent heuristic for the internal |
| 2825 diff library. | |
|
14696
195e8b1fcbbf
patch 8.1.0360: using an external diff program is slow and inflexible
Christian Brabandt <cb@256bit.org>
parents:
14695
diff
changeset
|
2826 |
|
195e8b1fcbbf
patch 8.1.0360: using an external diff program is slow and inflexible
Christian Brabandt <cb@256bit.org>
parents:
14695
diff
changeset
|
2827 algorithm:{text} Use the specified diff algorithm with the |
| 15033 | 2828 internal diff engine. Currently supported |
|
14696
195e8b1fcbbf
patch 8.1.0360: using an external diff program is slow and inflexible
Christian Brabandt <cb@256bit.org>
parents:
14695
diff
changeset
|
2829 algorithms are: |
|
195e8b1fcbbf
patch 8.1.0360: using an external diff program is slow and inflexible
Christian Brabandt <cb@256bit.org>
parents:
14695
diff
changeset
|
2830 myers the default algorithm |
|
195e8b1fcbbf
patch 8.1.0360: using an external diff program is slow and inflexible
Christian Brabandt <cb@256bit.org>
parents:
14695
diff
changeset
|
2831 minimal spend extra time to generate the |
|
195e8b1fcbbf
patch 8.1.0360: using an external diff program is slow and inflexible
Christian Brabandt <cb@256bit.org>
parents:
14695
diff
changeset
|
2832 smallest possible diff |
|
195e8b1fcbbf
patch 8.1.0360: using an external diff program is slow and inflexible
Christian Brabandt <cb@256bit.org>
parents:
14695
diff
changeset
|
2833 patience patience diff algorithm |
|
195e8b1fcbbf
patch 8.1.0360: using an external diff program is slow and inflexible
Christian Brabandt <cb@256bit.org>
parents:
14695
diff
changeset
|
2834 histogram histogram diff algorithm |
|
195e8b1fcbbf
patch 8.1.0360: using an external diff program is slow and inflexible
Christian Brabandt <cb@256bit.org>
parents:
14695
diff
changeset
|
2835 |
| 7 | 2836 Examples: > |
|
14696
195e8b1fcbbf
patch 8.1.0360: using an external diff program is slow and inflexible
Christian Brabandt <cb@256bit.org>
parents:
14695
diff
changeset
|
2837 :set diffopt=internal,filler,context:4 |
| 7 | 2838 :set diffopt= |
|
14696
195e8b1fcbbf
patch 8.1.0360: using an external diff program is slow and inflexible
Christian Brabandt <cb@256bit.org>
parents:
14695
diff
changeset
|
2839 :set diffopt=internal,filler,foldcolumn:3 |
|
195e8b1fcbbf
patch 8.1.0360: using an external diff program is slow and inflexible
Christian Brabandt <cb@256bit.org>
parents:
14695
diff
changeset
|
2840 :set diffopt-=internal " do NOT use the internal diff parser |
| 7 | 2841 < |
| 2842 *'digraph'* *'dg'* *'nodigraph'* *'nodg'* | |
| 2843 'digraph' 'dg' boolean (default off) | |
| 2844 global | |
| 2845 {not available when compiled without the |+digraphs| | |
| 2846 feature} | |
| 2847 Enable the entering of digraphs in Insert mode with {char1} <BS> | |
| 2848 {char2}. See |digraphs|. | |
| 2849 NOTE: This option is reset when 'compatible' is set. | |
| 2850 | |
| 2851 *'directory'* *'dir'* | |
| 2852 'directory' 'dir' string (default for Amiga: ".,t:", | |
| 18972 | 2853 for Win32: ".,$TEMP,c:\tmp,c:\temp" |
| 7 | 2854 for Unix: ".,~/tmp,/var/tmp,/tmp") |
| 2855 global | |
| 2856 List of directory names for the swap file, separated with commas. | |
| 21676 | 2857 Recommended value: ".,~/vimswap//" - this will put the swap file next |
| 2858 to the edited file if possible, and in your personal swap directory | |
| 2859 otherwise. Make sure "~/vimswap//" is only readable for you. | |
| 2860 | |
| 2861 Possible items: | |
| 7 | 2862 - The swap file will be created in the first directory where this is |
| 2863 possible. | |
| 2864 - Empty means that no swap file will be used (recovery is | |
|
18372
11394af51615
patch 8.1.2180: Error E303 is not useful when 'directory' is empty
Bram Moolenaar <Bram@vim.org>
parents:
18343
diff
changeset
|
2865 impossible!) and no |E303| error will be given. |
| 7 | 2866 - A directory "." means to put the swap file in the same directory as |
| 2867 the edited file. On Unix, a dot is prepended to the file name, so | |
| 2868 it doesn't show in a directory listing. On MS-Windows the "hidden" | |
| 2869 attribute is set and a dot prepended if possible. | |
| 19116 | 2870 - A directory starting with "./" (or ".\" for MS-Windows) means to put |
| 2871 the swap file relative to where the edited file is. The leading "." | |
| 2872 is replaced with the path name of the edited file. | |
|
14475
dddba3937532
patch 8.1.0251: using full path is not supported for 'backupdir'
Christian Brabandt <cb@256bit.org>
parents:
14421
diff
changeset
|
2873 - For Unix and Win32, if a directory ends in two path separators "//", |
|
dddba3937532
patch 8.1.0251: using full path is not supported for 'backupdir'
Christian Brabandt <cb@256bit.org>
parents:
14421
diff
changeset
|
2874 the swap file name will be built from the complete path to the file |
| 21991 | 2875 with all path separators replaced by percent '%' signs (including |
| 2876 the colon following the drive letter on Win32). This will ensure | |
| 2877 file name uniqueness in the preserve directory. | |
|
14475
dddba3937532
patch 8.1.0251: using full path is not supported for 'backupdir'
Christian Brabandt <cb@256bit.org>
parents:
14421
diff
changeset
|
2878 On Win32, it is also possible to end with "\\". However, When a |
|
dddba3937532
patch 8.1.0251: using full path is not supported for 'backupdir'
Christian Brabandt <cb@256bit.org>
parents:
14421
diff
changeset
|
2879 separating comma is following, you must use "//", since "\\" will |
|
dddba3937532
patch 8.1.0251: using full path is not supported for 'backupdir'
Christian Brabandt <cb@256bit.org>
parents:
14421
diff
changeset
|
2880 include the comma in the file name. Therefore it is recommended to |
|
dddba3937532
patch 8.1.0251: using full path is not supported for 'backupdir'
Christian Brabandt <cb@256bit.org>
parents:
14421
diff
changeset
|
2881 use '//', instead of '\\'. |
| 7 | 2882 - Spaces after the comma are ignored, other spaces are considered part |
| 2883 of the directory name. To have a space at the start of a directory | |
| 2884 name, precede it with a backslash. | |
| 2885 - To include a comma in a directory name precede it with a backslash. | |
| 2886 - A directory name may end in an ':' or '/'. | |
| 2887 - Environment variables are expanded |:set_env|. | |
| 2888 - Careful with '\' characters, type one before a space, type two to | |
| 2889 get one in the option (see |option-backslash|), for example: > | |
| 2890 :set dir=c:\\tmp,\ dir\\,with\\,commas,\\\ dir\ with\ spaces | |
| 2891 < - For backwards compatibility with Vim version 3.0 a '>' at the start | |
| 2892 of the option is removed. | |
| 2893 Using "." first in the list is recommended. This means that editing | |
| 2894 the same file twice will result in a warning. Using "/tmp" on Unix is | |
| 2895 discouraged: When the system crashes you lose the swap file. | |
| 2896 "/var/tmp" is often not cleared when rebooting, thus is a better | |
| 21676 | 2897 choice than "/tmp". But others on the computer may be able to see the |
| 2898 files, and it can contain a lot of files, your swap files get lost in | |
| 2899 the crowd. That is why a "tmp" directory in your home directory is | |
| 2900 tried first. | |
| 7 | 2901 The use of |:set+=| and |:set-=| is preferred when adding or removing |
| 2902 directories from the list. This avoids problems when a future version | |
| 2903 uses another default. | |
| 2904 This option cannot be set from a |modeline| or in the |sandbox|, for | |
| 2905 security reasons. | |
| 2906 | |
| 2907 *'display'* *'dy'* | |
|
9737
35ce559b8553
commit https://github.com/vim/vim/commit/bc8801c9317eb721a2ee91322669f2dd5d136380
Christian Brabandt <cb@256bit.org>
parents:
9669
diff
changeset
|
2908 '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
|
2909 |defaults.vim|) |
| 7 | 2910 global |
| 2911 Change the way text is displayed. This is comma separated list of | |
| 2912 flags: | |
| 2913 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
|
2914 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
|
2915 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
|
2916 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
|
2917 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
|
2918 column of the last screen line. Overrules "lastline". |
| 7 | 2919 uhex Show unprintable characters hexadecimal as <xx> |
| 2920 instead of using ^C and ~C. | |
| 2921 | |
|
10211
b7da8d4c594c
commit https://github.com/vim/vim/commit/d07969093a9b3051511c478d71c36de6fc33c0d6
Christian Brabandt <cb@256bit.org>
parents:
10198
diff
changeset
|
2922 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
|
2923 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
|
2924 |
| 7 | 2925 *'eadirection'* *'ead'* |
| 2926 'eadirection' 'ead' string (default "both") | |
| 2927 global | |
| 2928 Tells when the 'equalalways' option applies: | |
| 2929 ver vertically, width of windows is not affected | |
| 2930 hor horizontally, height of windows is not affected | |
| 2931 both width and height of windows is affected | |
| 2932 | |
| 2933 *'ed'* *'edcompatible'* *'noed'* *'noedcompatible'* | |
| 2934 'edcompatible' 'ed' boolean (default off) | |
| 2935 global | |
| 2936 Makes the 'g' and 'c' flags of the ":substitute" command to be | |
| 2937 toggled each time the flag is given. See |complex-change|. See | |
| 2938 also 'gdefault' option. | |
| 11442 | 2939 Switching this option on may break plugins! |
| 23305 | 2940 This option is not used in |Vim9| script. |
| 7 | 2941 |
|
8876
47f17f66da3d
commit https://github.com/vim/vim/commit/03413f44167c4b5cd0012def9bb331e2518c83cf
Christian Brabandt <cb@256bit.org>
parents:
8835
diff
changeset
|
2942 *'emoji'* *'emo'* *'noemoji'* *'noemo'* |
|
8629
54ac275e3fc4
commit https://github.com/vim/vim/commit/3848e00e0177abdb31bc600234967863ec487233
Christian Brabandt <cb@256bit.org>
parents:
8560
diff
changeset
|
2943 'emoji' 'emo' boolean (default: on) |
|
54ac275e3fc4
commit https://github.com/vim/vim/commit/3848e00e0177abdb31bc600234967863ec487233
Christian Brabandt <cb@256bit.org>
parents:
8560
diff
changeset
|
2944 global |
|
54ac275e3fc4
commit https://github.com/vim/vim/commit/3848e00e0177abdb31bc600234967863ec487233
Christian Brabandt <cb@256bit.org>
parents:
8560
diff
changeset
|
2945 When on all Unicode emoji characters are considered to be full width. |
| 22328 | 2946 This excludes "text emoji" characters, which are normally displayed as |
| 2947 single width. Unfortunately there is no good specification for this | |
| 2948 and it has been determined on trial-and-error basis. Use the | |
| 2949 |setcellwidths()| function to change the behavior. | |
|
8629
54ac275e3fc4
commit https://github.com/vim/vim/commit/3848e00e0177abdb31bc600234967863ec487233
Christian Brabandt <cb@256bit.org>
parents:
8560
diff
changeset
|
2950 |
| 7 | 2951 *'encoding'* *'enc'* *E543* |
|
24747
7da496081b91
patch 8.2.2912: MS-Windows: most users expect using Unicode
Bram Moolenaar <Bram@vim.org>
parents:
24636
diff
changeset
|
2952 'encoding' 'enc' string (default for MS-Windows: "utf-8", |
|
7da496081b91
patch 8.2.2912: MS-Windows: most users expect using Unicode
Bram Moolenaar <Bram@vim.org>
parents:
24636
diff
changeset
|
2953 otherwise: value from $LANG or "latin1") |
| 7 | 2954 global |
| 2955 Sets the character encoding used inside Vim. It applies to text in | |
| 2956 the buffers, registers, Strings in expressions, text stored in the | |
| 2957 viminfo file, etc. It sets the kind of characters which Vim can work | |
| 2958 with. See |encoding-names| for the possible values. | |
| 2959 | |
| 2960 NOTE: Changing this option will not change the encoding of the | |
| 39 | 2961 existing text in Vim. It may cause non-ASCII text to become invalid. |
| 7 | 2962 It should normally be kept at its default value, or set when Vim |
| 1152 | 2963 starts up. See |multibyte|. To reload the menus see |:menutrans|. |
| 7 | 2964 |
|
2317
2b2cd34569eb
Disallow setting 'enc' in a modeline. (Patrick Texier)
Bram Moolenaar <bram@vim.org>
parents:
2314
diff
changeset
|
2965 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
|
2966 corrupt the text. |
|
2b2cd34569eb
Disallow setting 'enc' in a modeline. (Patrick Texier)
Bram Moolenaar <bram@vim.org>
parents:
2314
diff
changeset
|
2967 |
|
10895
c391bfbdb452
Updated runtime files.
Christian Brabandt <cb@256bit.org>
parents:
10734
diff
changeset
|
2968 NOTE: For GTK+ 2 or later, it is highly recommended to set 'encoding' |
|
c391bfbdb452
Updated runtime files.
Christian Brabandt <cb@256bit.org>
parents:
10734
diff
changeset
|
2969 to "utf-8". Although care has been taken to allow different values of |
| 7 | 2970 'encoding', "utf-8" is the natural choice for the environment and |
| 2971 avoids unnecessary conversion overhead. "utf-8" has not been made | |
| 10 | 2972 the default to prevent different behavior of the GUI and terminal |
| 7 | 2973 versions, and to avoid changing the encoding of newly created files |
| 2974 without your knowledge (in case 'fileencodings' is empty). | |
| 2975 | |
| 2976 The character encoding of files can be different from 'encoding'. | |
| 10 | 2977 This is specified with 'fileencoding'. The conversion is done with |
| 7 | 2978 iconv() or as specified with 'charconvert'. |
| 2979 | |
| 21991 | 2980 If you need to know whether 'encoding' is a multibyte encoding, you |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
2981 can use: > |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
2982 if has("multi_byte_encoding") |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
2983 < |
| 7 | 2984 Normally 'encoding' will be equal to your current locale. This will |
| 2985 be the default if Vim recognizes your environment settings. If | |
| 2986 'encoding' is not set to the current locale, 'termencoding' must be | |
| 2987 set to convert typed and displayed text. See |encoding-table|. | |
| 2988 | |
| 2989 When you set this option, it fires the |EncodingChanged| autocommand | |
| 2990 event so that you can set up fonts if necessary. | |
| 2991 | |
| 2992 When the option is set, the value is converted to lowercase. Thus | |
| 2993 you can set it with uppercase values too. Underscores are translated | |
| 2994 to '-' signs. | |
| 2995 When the encoding is recognized, it is changed to the standard name. | |
| 2996 For example "Latin-1" becomes "latin1", "ISO_88592" becomes | |
| 2997 "iso-8859-2" and "utf8" becomes "utf-8". | |
| 2998 | |
| 2999 Note: "latin1" is also used when the encoding could not be detected. | |
| 3000 This only works when editing files in the same encoding! When the | |
| 3001 actual character set is not latin1, make sure 'fileencoding' and | |
| 3002 'fileencodings' are empty. When conversion is needed, switch to using | |
| 3003 utf-8. | |
| 3004 | |
| 3005 When "unicode", "ucs-2" or "ucs-4" is used, Vim internally uses utf-8. | |
| 3006 You don't notice this while editing, but it does matter for the | |
| 3007 |viminfo-file|. And Vim expects the terminal to use utf-8 too. Thus | |
| 3008 setting 'encoding' to one of these values instead of utf-8 only has | |
| 3009 effect for encoding used for files when 'fileencoding' is empty. | |
| 448 | 3010 |
| 3011 When 'encoding' is set to a Unicode encoding, and 'fileencodings' was | |
| 3012 not set yet, the default for 'fileencodings' is changed. | |
| 7 | 3013 |
| 3014 *'endofline'* *'eol'* *'noendofline'* *'noeol'* | |
| 3015 'endofline' 'eol' boolean (default on) | |
| 3016 local to buffer | |
| 3017 When writing a file and this option is off and the 'binary' option | |
| 6933 | 3018 is on, or 'fixeol' option is off, no <EOL> will be written for the |
| 3019 last line in the file. This option is automatically set or reset when | |
| 3020 starting to edit a new file, depending on whether file has an <EOL> | |
| 3021 for the last line in the file. Normally you don't have to set or | |
| 3022 reset this option. | |
| 3023 When 'binary' is off and 'fixeol' is on the value is not used when | |
| 3024 writing the file. When 'binary' is on or 'fixeol' is off it is used | |
| 3025 to remember the presence of a <EOL> for the last line in the file, so | |
| 3026 that when you write the file the situation from the original file can | |
| 3027 be kept. But you can change it if you want to. | |
| 7 | 3028 |
| 3029 *'equalalways'* *'ea'* *'noequalalways'* *'noea'* | |
| 3030 'equalalways' 'ea' boolean (default on) | |
| 3031 global | |
| 3032 When on, all the windows are automatically made the same size after | |
| 33 | 3033 splitting or closing a window. This also happens the moment the |
| 3034 option is switched on. When off, splitting a window will reduce the | |
| 3035 size of the current window and leave the other windows the same. When | |
| 3036 closing a window the extra lines are given to the window next to it | |
| 3037 (depending on 'splitbelow' and 'splitright'). | |
| 7 | 3038 When mixing vertically and horizontally split windows, a minimal size |
| 3039 is computed and some windows may be larger if there is room. The | |
| 3040 'eadirection' option tells in which direction the size is affected. | |
| 1354 | 3041 Changing the height and width of a window can be avoided by setting |
| 3042 'winfixheight' and 'winfixwidth', respectively. | |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
3043 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
|
3044 currently not equalized (it's complicated, but may be implemented in |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
3045 the future). |
| 7 | 3046 |
| 3047 *'equalprg'* *'ep'* | |
| 3048 'equalprg' 'ep' string (default "") | |
| 3049 global or local to buffer |global-local| | |
| 3050 External program to use for "=" command. When this option is empty | |
| 1621 | 3051 the internal formatting functions are used; either 'lisp', 'cindent' |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
3052 or 'indentexpr'. When Vim was compiled without internal formatting, |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
3053 the "indent" program is used. |
| 10 | 3054 Environment variables are expanded |:set_env|. See |option-backslash| |
| 7 | 3055 about including spaces and backslashes. |
| 3056 This option cannot be set from a |modeline| or in the |sandbox|, for | |
| 3057 security reasons. | |
| 3058 | |
| 3059 *'errorbells'* *'eb'* *'noerrorbells'* *'noeb'* | |
| 3060 'errorbells' 'eb' boolean (default off) | |
| 3061 global | |
| 3062 Ring the bell (beep or screen flash) for error messages. This only | |
| 3063 makes a difference for error messages, the bell will be used always | |
| 3064 for a lot of errors without a message (e.g., hitting <Esc> in Normal | |
| 10 | 3065 mode). See 'visualbell' on how to make the bell behave like a beep, |
| 6949 | 3066 screen flash or do nothing. See 'belloff' to finetune when to ring the |
| 3067 bell. | |
| 7 | 3068 |
| 3069 *'errorfile'* *'ef'* | |
| 3070 'errorfile' 'ef' string (Amiga default: "AztecC.Err", | |
| 3071 others: "errors.err") | |
| 3072 global | |
| 3073 {not available when compiled without the |+quickfix| | |
| 3074 feature} | |
| 3075 Name of the errorfile for the QuickFix mode (see |:cf|). | |
| 3076 When the "-q" command-line argument is used, 'errorfile' is set to the | |
| 3077 following argument. See |-q|. | |
| 3078 NOT used for the ":make" command. See 'makeef' for that. | |
| 3079 Environment variables are expanded |:set_env|. | |
| 3080 See |option-backslash| about including spaces and backslashes. | |
| 3081 This option cannot be set from a |modeline| or in the |sandbox|, for | |
| 3082 security reasons. | |
| 3083 | |
| 3084 *'errorformat'* *'efm'* | |
| 3085 'errorformat' 'efm' string (default is very long) | |
| 3086 global or local to buffer |global-local| | |
| 3087 {not available when compiled without the |+quickfix| | |
| 3088 feature} | |
| 3089 Scanf-like description of the format for the lines in the error file | |
| 3090 (see |errorformat|). | |
| 3091 | |
| 3092 *'esckeys'* *'ek'* *'noesckeys'* *'noek'* | |
| 3093 'esckeys' 'ek' boolean (Vim default: on, Vi default: off) | |
| 3094 global | |
| 3095 Function keys that start with an <Esc> are recognized in Insert | |
| 3096 mode. When this option is off, the cursor and function keys cannot be | |
| 3097 used in Insert mode if they start with an <Esc>. The advantage of | |
| 3098 this is that the single <Esc> is recognized immediately, instead of | |
| 3099 after one second. Instead of resetting this option, you might want to | |
| 3100 try changing the values for 'timeoutlen' and 'ttimeoutlen'. Note that | |
| 3101 when 'esckeys' is off, you can still map anything, but the cursor keys | |
| 3102 won't work by default. | |
| 3103 NOTE: This option is set to the Vi default value when 'compatible' is | |
| 3104 set and to the Vim default value when 'compatible' is reset. | |
|
18590
41484f342f80
patch 8.1.2289: after :diffsplit closing the window does not disable diff
Bram Moolenaar <Bram@vim.org>
parents:
18574
diff
changeset
|
3105 NOTE: when this option is off then the |modifyOtherKeys| functionality |
|
41484f342f80
patch 8.1.2289: after :diffsplit closing the window does not disable diff
Bram Moolenaar <Bram@vim.org>
parents:
18574
diff
changeset
|
3106 is disabled while in Insert mode to avoid ending Insert mode with any |
|
41484f342f80
patch 8.1.2289: after :diffsplit closing the window does not disable diff
Bram Moolenaar <Bram@vim.org>
parents:
18574
diff
changeset
|
3107 key that has a modifier. |
| 7 | 3108 |
| 3109 *'eventignore'* *'ei'* | |
| 3110 'eventignore' 'ei' string (default "") | |
| 3111 global | |
| 3112 A list of autocommand event names, which are to be ignored. | |
| 844 | 3113 When set to "all" or when "all" is one of the items, all autocommand |
| 3114 events are ignored, autocommands will not be executed. | |
| 7 | 3115 Otherwise this is a comma separated list of event names. Example: > |
| 3116 :set ei=WinEnter,WinLeave | |
| 3117 < | |
| 3118 *'expandtab'* *'et'* *'noexpandtab'* *'noet'* | |
| 3119 'expandtab' 'et' boolean (default off) | |
| 3120 local to buffer | |
| 3121 In Insert mode: Use the appropriate number of spaces to insert a | |
| 10 | 3122 <Tab>. Spaces are used in indents with the '>' and '<' commands and |
| 7 | 3123 when 'autoindent' is on. To insert a real tab when 'expandtab' is |
| 3124 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
|
3125 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
|
3126 the 'paste' option is reset. |
| 7 | 3127 NOTE: This option is reset when 'compatible' is set. |
| 3128 | |
| 3129 *'exrc'* *'ex'* *'noexrc'* *'noex'* | |
| 3130 'exrc' 'ex' boolean (default off) | |
| 3131 global | |
| 3132 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
|
3133 directory. |
|
018fead968c1
commit https://github.com/vim/vim/commit/36f44c21da2e912c008683a0c4447fca2a071e9a
Christian Brabandt <cb@256bit.org>
parents:
9975
diff
changeset
|
3134 |
|
018fead968c1
commit https://github.com/vim/vim/commit/36f44c21da2e912c008683a0c4447fca2a071e9a
Christian Brabandt <cb@256bit.org>
parents:
9975
diff
changeset
|
3135 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
|
3136 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
|
3137 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
|
3138 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
|
3139 matching directory. |
|
018fead968c1
commit https://github.com/vim/vim/commit/36f44c21da2e912c008683a0c4447fca2a071e9a
Christian Brabandt <cb@256bit.org>
parents:
9975
diff
changeset
|
3140 |
|
018fead968c1
commit https://github.com/vim/vim/commit/36f44c21da2e912c008683a0c4447fca2a071e9a
Christian Brabandt <cb@256bit.org>
parents:
9975
diff
changeset
|
3141 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
|
3142 'secure' option (see |initialization|). |
|
018fead968c1
commit https://github.com/vim/vim/commit/36f44c21da2e912c008683a0c4447fca2a071e9a
Christian Brabandt <cb@256bit.org>
parents:
9975
diff
changeset
|
3143 Also see |.vimrc| and |gui-init|. |
| 7 | 3144 This option cannot be set from a |modeline| or in the |sandbox|, for |
| 3145 security reasons. | |
| 3146 | |
| 3147 *'fileencoding'* *'fenc'* *E213* | |
| 3148 'fileencoding' 'fenc' string (default: "") | |
| 3149 local to buffer | |
| 3150 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
|
3151 |
| 7 | 3152 When 'fileencoding' is different from 'encoding', conversion will be |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
3153 done when writing the file. For reading see below. |
| 7 | 3154 When 'fileencoding' is empty, the same value as 'encoding' will be |
| 3155 used (no conversion when reading or writing a file). | |
| 11062 | 3156 No error will be given when the value is set, only when it is used, |
| 3157 only when writing a file. | |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
3158 Conversion will also be done when 'encoding' and 'fileencoding' are |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
3159 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
|
3160 because internally Unicode is always stored as utf-8. |
| 7 | 3161 WARNING: Conversion can cause loss of information! When |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
3162 'encoding' is "utf-8" or another Unicode encoding, conversion |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
3163 is most likely done in a way that the reverse conversion |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
3164 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
|
3165 characters may be lost! |
|
2317
2b2cd34569eb
Disallow setting 'enc' in a modeline. (Patrick Texier)
Bram Moolenaar <bram@vim.org>
parents:
2314
diff
changeset
|
3166 |
| 7 | 3167 See 'encoding' for the possible values. Additionally, values may be |
| 3168 specified that can be handled by the converter, see | |
| 3169 |mbyte-conversion|. | |
|
2317
2b2cd34569eb
Disallow setting 'enc' in a modeline. (Patrick Texier)
Bram Moolenaar <bram@vim.org>
parents:
2314
diff
changeset
|
3170 |
| 7 | 3171 When reading a file 'fileencoding' will be set from 'fileencodings'. |
| 3172 To read a file in a certain encoding it won't work by setting | |
| 1152 | 3173 'fileencoding', use the |++enc| argument. One exception: when |
| 3174 'fileencodings' is empty the value of 'fileencoding' is used. | |
| 692 | 3175 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
|
3176 |
| 7 | 3177 Prepending "8bit-" and "2byte-" has no meaning here, they are ignored. |
| 3178 When the option is set, the value is converted to lowercase. Thus | |
| 3179 you can set it with uppercase values too. '_' characters are | |
| 3180 replaced with '-'. If a name is recognized from the list for | |
| 3181 'encoding', it is replaced by the standard name. For example | |
| 3182 "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
|
3183 |
| 7 | 3184 When this option is set, after starting to edit a file, the 'modified' |
| 3185 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
|
3186 |
|
2b2cd34569eb
Disallow setting 'enc' in a modeline. (Patrick Texier)
Bram Moolenaar <bram@vim.org>
parents:
2314
diff
changeset
|
3187 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
|
3188 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
|
3189 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
|
3190 '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
|
3191 |
| 7 | 3192 This option can not be changed when 'modifiable' is off. |
| 3193 | |
| 3194 *'fe'* | |
| 3195 NOTE: Before version 6.0 this option specified the encoding for the | |
| 10 | 3196 whole of Vim, this was a mistake. Now use 'encoding' instead. The |
| 7 | 3197 old short name was 'fe', which is no longer used. |
| 3198 | |
| 3199 *'fileencodings'* *'fencs'* | |
| 39 | 3200 'fileencodings' 'fencs' string (default: "ucs-bom", |
| 3201 "ucs-bom,utf-8,default,latin1" when | |
| 3202 'encoding' is set to a Unicode value) | |
| 7 | 3203 global |
| 3204 This is a list of character encodings considered when starting to edit | |
| 3205 an existing file. When a file is read, Vim tries to use the first | |
| 3206 mentioned character encoding. If an error is detected, the next one | |
| 3207 in the list is tried. When an encoding is found that works, | |
| 10 | 3208 'fileencoding' is set to it. If all fail, 'fileencoding' is set to |
| 7 | 3209 an empty string, which means the value of 'encoding' is used. |
| 3210 WARNING: Conversion can cause loss of information! When | |
| 3211 'encoding' is "utf-8" (or one of the other Unicode variants) | |
| 3212 conversion is most likely done in a way that the reverse | |
| 3213 conversion results in the same text. When 'encoding' is not | |
| 596 | 3214 "utf-8" some non-ASCII characters may be lost! You can use |
| 3215 the |++bad| argument to specify what is done with characters | |
| 3216 that can't be converted. | |
| 7 | 3217 For an empty file or a file with only ASCII characters most encodings |
| 3218 will work and the first entry of 'fileencodings' will be used (except | |
| 3219 "ucs-bom", which requires the BOM to be present). If you prefer | |
| 3220 another encoding use an BufReadPost autocommand event to test if your | |
| 3221 preferred encoding is to be used. Example: > | |
| 3222 au BufReadPost * if search('\S', 'w') == 0 | | |
| 3223 \ set fenc=iso-2022-jp | endif | |
| 3224 < This sets 'fileencoding' to "iso-2022-jp" if the file does not contain | |
| 3225 non-blank characters. | |
| 596 | 3226 When the |++enc| argument is used then the value of 'fileencodings' is |
| 3227 not used. | |
| 692 | 3228 Note that 'fileencodings' is not used for a new file, the global value |
| 3229 of 'fileencoding' is used instead. You can set it with: > | |
| 3230 :setglobal fenc=iso-8859-2 | |
| 3231 < This means that a non-existing file may get a different encoding than | |
| 3232 an empty file. | |
| 7 | 3233 The special value "ucs-bom" can be used to check for a Unicode BOM |
| 3234 (Byte Order Mark) at the start of the file. It must not be preceded | |
| 3235 by "utf-8" or another Unicode encoding for this to work properly. | |
| 3236 An entry for an 8-bit encoding (e.g., "latin1") should be the last, | |
| 3237 because Vim cannot detect an error, thus the encoding is always | |
| 3238 accepted. | |
| 39 | 3239 The special value "default" can be used for the encoding from the |
|
24754
a4cb7499fa11
patch 8.2.2915: MS-Windows: when using "default" for encoding utf-8 is used
Bram Moolenaar <Bram@vim.org>
parents:
24751
diff
changeset
|
3240 environment. On MS-Windows this is the system encoding. Otherwise |
|
a4cb7499fa11
patch 8.2.2915: MS-Windows: when using "default" for encoding utf-8 is used
Bram Moolenaar <Bram@vim.org>
parents:
24751
diff
changeset
|
3241 this is the default value for 'encoding'. It is useful when |
|
a4cb7499fa11
patch 8.2.2915: MS-Windows: when using "default" for encoding utf-8 is used
Bram Moolenaar <Bram@vim.org>
parents:
24751
diff
changeset
|
3242 'encoding' is set to "utf-8" and your environment uses a non-latin1 |
|
a4cb7499fa11
patch 8.2.2915: MS-Windows: when using "default" for encoding utf-8 is used
Bram Moolenaar <Bram@vim.org>
parents:
24751
diff
changeset
|
3243 encoding, such as Russian. |
| 777 | 3244 When 'encoding' is "utf-8" and a file contains an illegal byte |
| 3245 sequence it won't be recognized as UTF-8. You can use the |8g8| | |
| 3246 command to find the illegal byte sequence. | |
| 7 | 3247 WRONG VALUES: WHAT'S WRONG: |
| 3248 latin1,utf-8 "latin1" will always be used | |
| 3249 utf-8,ucs-bom,latin1 BOM won't be recognized in an utf-8 | |
| 3250 file | |
| 3251 cp1250,latin1 "cp1250" will always be used | |
| 3252 If 'fileencodings' is empty, 'fileencoding' is not modified. | |
| 3253 See 'fileencoding' for the possible values. | |
| 3254 Setting this option does not have an effect until the next time a file | |
| 3255 is read. | |
| 3256 | |
| 3257 *'fileformat'* *'ff'* | |
|
15840
734b1928a5aa
patch 8.1.0927: USE_CR is never defined
Bram Moolenaar <Bram@vim.org>
parents:
15804
diff
changeset
|
3258 'fileformat' 'ff' string (MS-Windows default: "dos", |
|
734b1928a5aa
patch 8.1.0927: USE_CR is never defined
Bram Moolenaar <Bram@vim.org>
parents:
15804
diff
changeset
|
3259 Unix, macOS default: "unix") |
| 7 | 3260 local to buffer |
| 3261 This gives the <EOL> of the current buffer, which is used for | |
| 3262 reading/writing the buffer from/to a file: | |
| 23305 | 3263 dos <CR><NL> |
| 7 | 3264 unix <NL> |
| 3265 mac <CR> | |
| 3266 When "dos" is used, CTRL-Z at the end of a file is ignored. | |
| 3267 See |file-formats| and |file-read|. | |
| 3268 For the character encoding of the file see 'fileencoding'. | |
| 3269 When 'binary' is set, the value of 'fileformat' is ignored, file I/O | |
| 4264 | 3270 works like it was set to "unix". |
| 7 | 3271 This option is set automatically when starting to edit a file and |
| 3272 'fileformats' is not empty and 'binary' is off. | |
| 3273 When this option is set, after starting to edit a file, the 'modified' | |
| 3274 option is set, because the file would be different when written. | |
| 3275 This option can not be changed when 'modifiable' is off. | |
| 3276 For backwards compatibility: When this option is set to "dos", | |
| 3277 'textmode' is set, otherwise 'textmode' is reset. | |
| 3278 | |
| 3279 *'fileformats'* *'ffs'* | |
| 3280 'fileformats' 'ffs' string (default: | |
|
15840
734b1928a5aa
patch 8.1.0927: USE_CR is never defined
Bram Moolenaar <Bram@vim.org>
parents:
15804
diff
changeset
|
3281 Vim+Vi MS-Windows: "dos,unix", |
|
734b1928a5aa
patch 8.1.0927: USE_CR is never defined
Bram Moolenaar <Bram@vim.org>
parents:
15804
diff
changeset
|
3282 Vim Unix, macOS: "unix,dos", |
| 7 | 3283 Vi Cygwin: "unix,dos", |
| 3284 Vi others: "") | |
| 3285 global | |
| 3286 This gives the end-of-line (<EOL>) formats that will be tried when | |
| 3287 starting to edit a new buffer and when reading a file into an existing | |
| 3288 buffer: | |
| 3289 - When empty, the format defined with 'fileformat' will be used | |
| 3290 always. It is not set automatically. | |
| 3291 - When set to one name, that format will be used whenever a new buffer | |
| 10 | 3292 is opened. 'fileformat' is set accordingly for that buffer. The |
| 7 | 3293 'fileformats' name will be used when a file is read into an existing |
| 3294 buffer, no matter what 'fileformat' for that buffer is set to. | |
| 3295 - When more than one name is present, separated by commas, automatic | |
| 3296 <EOL> detection will be done when reading a file. When starting to | |
| 3297 edit a file, a check is done for the <EOL>: | |
| 3298 1. If all lines end in <CR><NL>, and 'fileformats' includes "dos", | |
| 3299 'fileformat' is set to "dos". | |
| 3300 2. If a <NL> is found and 'fileformats' includes "unix", 'fileformat' | |
| 10 | 3301 is set to "unix". Note that when a <NL> is found without a |
| 7 | 3302 preceding <CR>, "unix" is preferred over "dos". |
| 6647 | 3303 3. If 'fileformat' has not yet been set, and if a <CR> is found, and |
| 3304 if 'fileformats' includes "mac", 'fileformat' is set to "mac". | |
| 2587 | 3305 This means that "mac" is only chosen when: |
| 3306 "unix" is not present or no <NL> is found in the file, and | |
| 3307 "dos" is not present or no <CR><NL> is found in the file. | |
| 3308 Except: if "unix" was chosen, but there is a <CR> before | |
| 3309 the first <NL>, and there appear to be more <CR>s than <NL>s in | |
| 2642 | 3310 the first few lines, "mac" is used. |
| 7 | 3311 4. If 'fileformat' is still not set, the first name from |
| 3312 'fileformats' is used. | |
| 3313 When reading a file into an existing buffer, the same is done, but | |
| 3314 this happens like 'fileformat' has been set appropriately for that | |
| 3315 file only, the option is not changed. | |
| 3316 When 'binary' is set, the value of 'fileformats' is not used. | |
| 3317 | |
|
8748
b1a19a2f73f0
commit https://github.com/vim/vim/commit/4f3f668c8486444e53163c29d2fc79bf47eb3c82
Christian Brabandt <cb@256bit.org>
parents:
8629
diff
changeset
|
3318 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
|
3319 can overrule this by setting 'fileformat' in your .vimrc. |
| 2662 | 3320 |
| 7 | 3321 For systems with a Dos-like <EOL> (<CR><NL>), when reading files that |
| 3322 are ":source"ed and for vimrc files, automatic <EOL> detection may be | |
| 3323 done: | |
| 3324 - When 'fileformats' is empty, there is no automatic detection. Dos | |
| 3325 format will be used. | |
| 3326 - When 'fileformats' is set to one or more names, automatic detection | |
| 3327 is done. This is based on the first <NL> in the file: If there is a | |
| 3328 <CR> in front of it, Dos format is used, otherwise Unix format is | |
| 3329 used. | |
| 3330 Also see |file-formats|. | |
| 3331 For backwards compatibility: When this option is set to an empty | |
| 3332 string or one format (no comma is included), 'textauto' is reset, | |
| 3333 otherwise 'textauto' is set. | |
| 3334 NOTE: This option is set to the Vi default value when 'compatible' is | |
| 3335 set and to the Vim default value when 'compatible' is reset. | |
| 3336 | |
| 4264 | 3337 *'fileignorecase'* *'fic'* *'nofileignorecase'* *'nofic'* |
| 3338 'fileignorecase' 'fic' boolean (default on for systems where case in file | |
| 3339 names is normally ignored) | |
| 4242 | 3340 global |
| 3341 When set case is ignored when using file names and directories. | |
| 3342 See 'wildignorecase' for only ignoring case when doing completion. | |
| 3343 | |
| 7 | 3344 *'filetype'* *'ft'* |
| 3345 'filetype' 'ft' string (default: "") | |
| 3346 local to buffer | |
| 3347 When this option is set, the FileType autocommand event is triggered. | |
| 3348 All autocommands that match with the value of this option will be | |
| 3349 executed. Thus the value of 'filetype' is used in place of the file | |
| 3350 name. | |
| 3351 Otherwise this option does not always reflect the current file type. | |
| 3352 This option is normally set when the file type is detected. To enable | |
| 3353 this use the ":filetype on" command. |:filetype| | |
| 3354 Setting this option to a different value is most useful in a modeline, | |
| 3355 for a file for which the file type is not automatically recognized. | |
| 782 | 3356 Example, for in an IDL file: |
| 3357 /* vim: set filetype=idl : */ ~ | |
| 3358 |FileType| |filetypes| | |
| 3359 When a dot appears in the value then this separates two filetype | |
| 3360 names. Example: | |
| 3361 /* vim: set filetype=c.doxygen : */ ~ | |
| 3362 This will use the "c" filetype first, then the "doxygen" filetype. | |
| 3363 This works both for filetype plugins and for syntax files. More than | |
| 3364 one dot may appear. | |
| 7 | 3365 This option is not copied to another buffer, independent of the 's' or |
| 3366 'S' flag in 'cpoptions'. | |
| 36 | 3367 Only normal file name characters can be used, "/\*?[|<>" are illegal. |
| 7 | 3368 |
| 3369 *'fillchars'* *'fcs'* | |
|
23932
4549133c1e77
patch 8.2.2508: cannot change the character displayed in non existing lines
Bram Moolenaar <Bram@vim.org>
parents:
23931
diff
changeset
|
3370 'fillchars' 'fcs' string (default "vert:|,fold:-,eob:~") |
| 7 | 3371 global |
|
17771
4bd21046902b
patch 8.1.1882: cannot specify properties of the info popup window
Bram Moolenaar <Bram@vim.org>
parents:
17767
diff
changeset
|
3372 {not available when compiled without the |+folding| |
|
4bd21046902b
patch 8.1.1882: cannot specify properties of the info popup window
Bram Moolenaar <Bram@vim.org>
parents:
17767
diff
changeset
|
3373 feature} |
| 7 | 3374 Characters to fill the statuslines and vertical separators. |
| 3375 It is a comma separated list of items: | |
| 3376 | |
| 3377 item default Used for ~ | |
| 3378 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
|
3379 stlnc:c ' ' or '=' statusline of the non-current windows |
| 7 | 3380 vert:c '|' vertical separators |:vsplit| |
| 3381 fold:c '-' filling 'foldtext' | |
|
23964
17697c4e5d48
patch 8.2.2524: cannot change the characters displayed in the foldcolumn
Bram Moolenaar <Bram@vim.org>
parents:
23952
diff
changeset
|
3382 foldopen:c '-' mark the beginning of a fold |
|
17697c4e5d48
patch 8.2.2524: cannot change the characters displayed in the foldcolumn
Bram Moolenaar <Bram@vim.org>
parents:
23952
diff
changeset
|
3383 foldclose:c '+' show a closed fold |
|
17697c4e5d48
patch 8.2.2524: cannot change the characters displayed in the foldcolumn
Bram Moolenaar <Bram@vim.org>
parents:
23952
diff
changeset
|
3384 foldsep:c '|' open fold middle character |
| 7 | 3385 diff:c '-' deleted lines of the 'diff' option |
|
23932
4549133c1e77
patch 8.2.2508: cannot change the character displayed in non existing lines
Bram Moolenaar <Bram@vim.org>
parents:
23931
diff
changeset
|
3386 eob:c '~' empty lines below the end of a buffer |
| 7 | 3387 |
| 10 | 3388 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
|
3389 "stlnc" the space will be used when there is highlighting, '^' or '=' |
| 7 | 3390 otherwise. |
| 3391 | |
| 3392 Example: > | |
|
8061
abd64cf67bcf
commit https://github.com/vim/vim/commit/38a55639d603823efcf2d2fdf542dbffdeb60b75
Christian Brabandt <cb@256bit.org>
parents:
7876
diff
changeset
|
3393 :set fillchars=stl:^,stlnc:=,vert:\|,fold:-,diff:- |
| 7 | 3394 < This is similar to the default, except that these characters will also |
| 3395 be used when there is highlighting. | |
| 3396 | |
|
24055
90d1636a8fcb
patch 8.2.2569: 'fillchars' "stl" and "stlnc" items must be single byte
Bram Moolenaar <Bram@vim.org>
parents:
23964
diff
changeset
|
3397 For "stl" and "stlnc" single-byte and multibyte characters are |
|
90d1636a8fcb
patch 8.2.2569: 'fillchars' "stl" and "stlnc" items must be single byte
Bram Moolenaar <Bram@vim.org>
parents:
23964
diff
changeset
|
3398 supported. But double-width characters are not supported. |
| 819 | 3399 |
| 7 | 3400 The highlighting used for these items: |
| 3401 item highlight group ~ | |
| 3402 stl:c StatusLine |hl-StatusLine| | |
| 3403 stlnc:c StatusLineNC |hl-StatusLineNC| | |
| 3404 vert:c VertSplit |hl-VertSplit| | |
| 3405 fold:c Folded |hl-Folded| | |
| 3406 diff:c DiffDelete |hl-DiffDelete| | |
|
23932
4549133c1e77
patch 8.2.2508: cannot change the character displayed in non existing lines
Bram Moolenaar <Bram@vim.org>
parents:
23931
diff
changeset
|
3407 eob:c EndOfBuffer |hl-EndOfBuffer| |
| 7 | 3408 |
| 6933 | 3409 *'fixendofline'* *'fixeol'* *'nofixendofline'* *'nofixeol'* |
| 3410 'fixendofline' 'fixeol' boolean (default on) | |
| 3411 local to buffer | |
| 3412 When writing a file and this option is on, <EOL> at the end of file | |
| 3413 will be restored if missing. Turn this option off if you want to | |
| 3414 preserve the situation from the original file. | |
| 3415 When the 'binary' option is set the value of this option doesn't | |
| 3416 matter. | |
| 3417 See the 'endofline' option. | |
| 3418 | |
| 7 | 3419 *'fkmap'* *'fk'* *'nofkmap'* *'nofk'* |
| 23666 | 3420 'fkmap' 'fk' boolean (default off) |
| 7 | 3421 global |
| 3422 {only available when compiled with the |+rightleft| | |
| 3423 feature} | |
|
15850
a6ca8cf07a98
patch 8.1.0932: Farsi support is outdated and unused
Bram Moolenaar <Bram@vim.org>
parents:
15840
diff
changeset
|
3424 This option was for using Farsi, which has been removed. See |
|
a6ca8cf07a98
patch 8.1.0932: Farsi support is outdated and unused
Bram Moolenaar <Bram@vim.org>
parents:
15840
diff
changeset
|
3425 |farsi.txt|. |
| 7 | 3426 |
| 3427 *'foldclose'* *'fcl'* | |
| 3428 'foldclose' 'fcl' string (default "") | |
| 3429 global | |
| 3430 {not available when compiled without the |+folding| | |
| 3431 feature} | |
| 3432 When set to "all", a fold is closed when the cursor isn't in it and | |
| 3433 its level is higher than 'foldlevel'. Useful if you want folds to | |
| 3434 automatically close when moving out of them. | |
| 3435 | |
| 3436 *'foldcolumn'* *'fdc'* | |
| 3437 'foldcolumn' 'fdc' number (default 0) | |
| 3438 local to window | |
| 3439 {not available when compiled without the |+folding| | |
| 3440 feature} | |
| 3441 When non-zero, a column with the specified width is shown at the side | |
| 3442 of the window which indicates open and closed folds. The maximum | |
| 3443 value is 12. | |
| 3444 See |folding|. | |
| 3445 | |
| 3446 *'foldenable'* *'fen'* *'nofoldenable'* *'nofen'* | |
| 3447 'foldenable' 'fen' boolean (default on) | |
| 3448 local to window | |
| 3449 {not available when compiled without the |+folding| | |
| 3450 feature} | |
| 3451 When off, all folds are open. This option can be used to quickly | |
| 3452 switch between showing all text unfolded and viewing the text with | |
| 3453 folds (including manually opened or closed folds). It can be toggled | |
| 10 | 3454 with the |zi| command. The 'foldcolumn' will remain blank when |
| 7 | 3455 'foldenable' is off. |
| 3456 This option is set by commands that create a new fold or close a fold. | |
| 3457 See |folding|. | |
| 3458 | |
| 3459 *'foldexpr'* *'fde'* | |
| 3460 'foldexpr' 'fde' string (default: "0") | |
| 3461 local to window | |
| 3462 {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
|
3463 or |+eval| features} |
| 7 | 3464 The expression used for when 'foldmethod' is "expr". It is evaluated |
| 27321 | 3465 for each line to obtain its fold level. The context is set to the |
| 3466 script where 'foldexpr' was set, script-local items can be accessed. | |
| 3467 See |fold-expr| for the usage. | |
| 782 | 3468 |
| 3682 | 3469 The expression will be evaluated in the |sandbox| if set from a |
| 3470 modeline, see |sandbox-option|. | |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
3471 This option can't be set from a |modeline| when the 'diff' option is |
|
16728
e55c26aaf484
patch 8.1.1366: using expressions in a modeline is unsafe
Bram Moolenaar <Bram@vim.org>
parents:
16610
diff
changeset
|
3472 on or the 'modelineexpr' option is off. |
| 634 | 3473 |
| 3474 It is not allowed to change text or jump to another window while | |
| 3475 evaluating 'foldexpr' |textlock|. | |
| 7 | 3476 |
| 3477 *'foldignore'* *'fdi'* | |
| 3478 'foldignore' 'fdi' string (default: "#") | |
| 3479 local to window | |
| 3480 {not available when compiled without the |+folding| | |
| 3481 feature} | |
| 3482 Used only when 'foldmethod' is "indent". Lines starting with | |
| 3483 characters in 'foldignore' will get their fold level from surrounding | |
| 10 | 3484 lines. White space is skipped before checking for this character. |
| 7 | 3485 The default "#" works well for C programs. See |fold-indent|. |
| 3486 | |
| 3487 *'foldlevel'* *'fdl'* | |
| 3488 'foldlevel' 'fdl' number (default: 0) | |
| 3489 local to window | |
| 3490 {not available when compiled without the |+folding| | |
| 3491 feature} | |
| 3492 Sets the fold level: Folds with a higher level will be closed. | |
| 3493 Setting this option to zero will close all folds. Higher numbers will | |
| 3494 close fewer folds. | |
| 3495 This option is set by commands like |zm|, |zM| and |zR|. | |
| 3496 See |fold-foldlevel|. | |
| 3497 | |
| 3498 *'foldlevelstart'* *'fdls'* | |
| 3499 'foldlevelstart' 'fdls' number (default: -1) | |
| 3500 global | |
| 3501 {not available when compiled without the |+folding| | |
| 3502 feature} | |
| 3503 Sets 'foldlevel' when starting to edit another buffer in a window. | |
| 3504 Useful to always start editing with all folds closed (value zero), | |
| 3505 some folds closed (one) or no folds closed (99). | |
| 3506 This is done before reading any modeline, thus a setting in a modeline | |
| 10 | 3507 overrules this option. Starting to edit a file for |diff-mode| also |
| 7 | 3508 ignores this option and closes all folds. |
| 3509 It is also done before BufReadPre autocommands, to allow an autocmd to | |
| 3510 overrule the 'foldlevel' value for specific files. | |
| 3511 When the value is negative, it is not used. | |
| 3512 | |
| 3513 *'foldmarker'* *'fmr'* *E536* | |
| 3514 'foldmarker' 'fmr' string (default: "{{{,}}}") | |
| 3515 local to window | |
| 3516 {not available when compiled without the |+folding| | |
| 3517 feature} | |
| 3518 The start and end marker used when 'foldmethod' is "marker". There | |
| 3519 must be one comma, which separates the start and end marker. The | |
| 3520 marker is a literal string (a regular expression would be too slow). | |
| 3521 See |fold-marker|. | |
| 3522 | |
| 3523 *'foldmethod'* *'fdm'* | |
| 3524 'foldmethod' 'fdm' string (default: "manual") | |
| 3525 local to window | |
| 3526 {not available when compiled without the |+folding| | |
| 3527 feature} | |
| 3528 The kind of folding used for the current window. Possible values: | |
| 3529 |fold-manual| manual Folds are created manually. | |
| 3530 |fold-indent| indent Lines with equal indent form a fold. | |
| 3531 |fold-expr| expr 'foldexpr' gives the fold level of a line. | |
| 3532 |fold-marker| marker Markers are used to specify folds. | |
| 3533 |fold-syntax| syntax Syntax highlighting items specify folds. | |
| 3534 |fold-diff| diff Fold text that is not changed. | |
| 3535 | |
| 3536 *'foldminlines'* *'fml'* | |
| 3537 'foldminlines' 'fml' number (default: 1) | |
| 3538 local to window | |
| 3539 {not available when compiled without the |+folding| | |
| 3540 feature} | |
| 2709 | 3541 Sets the number of screen lines above which a fold can be displayed |
| 3542 closed. Also for manually closed folds. With the default value of | |
| 3543 one a fold can only be closed if it takes up two or more screen lines. | |
| 3544 Set to zero to be able to close folds of just one screen line. | |
| 2826 | 3545 Note that this only has an effect on what is displayed. After using |
| 7 | 3546 "zc" to close a fold, which is displayed open because it's smaller |
| 3547 than 'foldminlines', a following "zc" may close a containing fold. | |
| 3548 | |
| 3549 *'foldnestmax'* *'fdn'* | |
| 3550 'foldnestmax' 'fdn' number (default: 20) | |
| 3551 local to window | |
| 3552 {not available when compiled without the |+folding| | |
| 3553 feature} | |
| 3554 Sets the maximum nesting of folds for the "indent" and "syntax" | |
| 3555 methods. This avoids that too many folds will be created. Using more | |
| 3556 than 20 doesn't work, because the internal limit is 20. | |
| 3557 | |
| 3558 *'foldopen'* *'fdo'* | |
| 3559 'foldopen' 'fdo' string (default: "block,hor,mark,percent,quickfix, | |
| 3560 search,tag,undo") | |
| 3561 global | |
| 3562 {not available when compiled without the |+folding| | |
| 3563 feature} | |
| 3564 Specifies for which type of commands folds will be opened, if the | |
| 3565 command moves the cursor into a closed fold. It is a comma separated | |
| 3566 list of items. | |
| 2625 | 3567 NOTE: When the command is part of a mapping this option is not used. |
| 3568 Add the |zv| command to the mapping to get the same effect. | |
| 3569 (rationale: the mapping may want to control opening folds itself) | |
| 3570 | |
| 7 | 3571 item commands ~ |
| 3572 all any | |
| 3573 block "(", "{", "[[", "[{", etc. | |
| 3574 hor horizontal movements: "l", "w", "fx", etc. | |
| 3575 insert any command in Insert mode | |
| 3576 jump far jumps: "G", "gg", etc. | |
| 3577 mark jumping to a mark: "'m", CTRL-O, etc. | |
| 3578 percent "%" | |
| 3579 quickfix ":cn", ":crew", ":make", etc. | |
| 3580 search search for a pattern: "/", "n", "*", "gd", etc. | |
| 3581 (not for a search pattern in a ":" command) | |
| 819 | 3582 Also for |[s| and |]s|. |
| 7 | 3583 tag jumping to a tag: ":ta", CTRL-T, etc. |
| 3584 undo undo or redo: "u" and CTRL-R | |
| 3585 When a movement command is used for an operator (e.g., "dl" or "y%") | |
| 3586 this option is not used. This means the operator will include the | |
| 3587 whole closed fold. | |
| 3588 Note that vertical movements are not here, because it would make it | |
| 3589 very difficult to move onto a closed fold. | |
| 3590 In insert mode the folds containing the cursor will always be open | |
| 3591 when text is inserted. | |
| 3592 To close folds you can re-apply 'foldlevel' with the |zx| command or | |
| 3593 set the 'foldclose' option to "all". | |
| 3594 | |
| 3595 *'foldtext'* *'fdt'* | |
| 3596 'foldtext' 'fdt' string (default: "foldtext()") | |
| 3597 local to window | |
| 3598 {not available when compiled without the |+folding| | |
| 3599 feature} | |
| 3600 An expression which is used to specify the text displayed for a closed | |
| 27321 | 3601 fold. The context is set to the script where 'foldexpr' was set, |
| 3602 script-local items can be accessed. See |fold-foldtext| for the | |
| 3603 usage. | |
| 7 | 3604 |
| 3682 | 3605 The expression will be evaluated in the |sandbox| if set from a |
| 3606 modeline, see |sandbox-option|. | |
|
16728
e55c26aaf484
patch 8.1.1366: using expressions in a modeline is unsafe
Bram Moolenaar <Bram@vim.org>
parents:
16610
diff
changeset
|
3607 This option cannot be set in a modeline when 'modelineexpr' is off. |
| 634 | 3608 |
| 3609 It is not allowed to change text or jump to another window while | |
| 3610 evaluating 'foldtext' |textlock|. | |
| 3611 | |
|
9286
64035abb986b
commit https://github.com/vim/vim/commit/c95a302a4c42ec8230473cd4a5e0064d0a143aa8
Christian Brabandt <cb@256bit.org>
parents:
9227
diff
changeset
|
3612 *'formatexpr'* *'fex'* |
|
64035abb986b
commit https://github.com/vim/vim/commit/c95a302a4c42ec8230473cd4a5e0064d0a143aa8
Christian Brabandt <cb@256bit.org>
parents:
9227
diff
changeset
|
3613 'formatexpr' 'fex' string (default "") |
|
64035abb986b
commit https://github.com/vim/vim/commit/c95a302a4c42ec8230473cd4a5e0064d0a143aa8
Christian Brabandt <cb@256bit.org>
parents:
9227
diff
changeset
|
3614 local to buffer |
|
64035abb986b
commit https://github.com/vim/vim/commit/c95a302a4c42ec8230473cd4a5e0064d0a143aa8
Christian Brabandt <cb@256bit.org>
parents:
9227
diff
changeset
|
3615 {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
|
3616 feature} |
|
64035abb986b
commit https://github.com/vim/vim/commit/c95a302a4c42ec8230473cd4a5e0064d0a143aa8
Christian Brabandt <cb@256bit.org>
parents:
9227
diff
changeset
|
3617 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
|
3618 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
|
3619 option is empty 'formatprg' is used. |
|
64035abb986b
commit https://github.com/vim/vim/commit/c95a302a4c42ec8230473cd4a5e0064d0a143aa8
Christian Brabandt <cb@256bit.org>
parents:
9227
diff
changeset
|
3620 |
|
64035abb986b
commit https://github.com/vim/vim/commit/c95a302a4c42ec8230473cd4a5e0064d0a143aa8
Christian Brabandt <cb@256bit.org>
parents:
9227
diff
changeset
|
3621 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
|
3622 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
|
3623 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
|
3624 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
|
3625 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
|
3626 it yet! |
|
64035abb986b
commit https://github.com/vim/vim/commit/c95a302a4c42ec8230473cd4a5e0064d0a143aa8
Christian Brabandt <cb@256bit.org>
parents:
9227
diff
changeset
|
3627 |
|
64035abb986b
commit https://github.com/vim/vim/commit/c95a302a4c42ec8230473cd4a5e0064d0a143aa8
Christian Brabandt <cb@256bit.org>
parents:
9227
diff
changeset
|
3628 Example: > |
|
64035abb986b
commit https://github.com/vim/vim/commit/c95a302a4c42ec8230473cd4a5e0064d0a143aa8
Christian Brabandt <cb@256bit.org>
parents:
9227
diff
changeset
|
3629 :set formatexpr=mylang#Format() |
|
64035abb986b
commit https://github.com/vim/vim/commit/c95a302a4c42ec8230473cd4a5e0064d0a143aa8
Christian Brabandt <cb@256bit.org>
parents:
9227
diff
changeset
|
3630 < 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
|
3631 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
|
3632 |
|
64035abb986b
commit https://github.com/vim/vim/commit/c95a302a4c42ec8230473cd4a5e0064d0a143aa8
Christian Brabandt <cb@256bit.org>
parents:
9227
diff
changeset
|
3633 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
|
3634 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
|
3635 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
|
3636 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
|
3637 return "i" or "R" in this situation. |
|
13341
acd7eaa13d2b
Updated runtime files.
Christian Brabandt <cb@256bit.org>
parents:
13314
diff
changeset
|
3638 |
|
9286
64035abb986b
commit https://github.com/vim/vim/commit/c95a302a4c42ec8230473cd4a5e0064d0a143aa8
Christian Brabandt <cb@256bit.org>
parents:
9227
diff
changeset
|
3639 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
|
3640 the internal format mechanism. |
|
64035abb986b
commit https://github.com/vim/vim/commit/c95a302a4c42ec8230473cd4a5e0064d0a143aa8
Christian Brabandt <cb@256bit.org>
parents:
9227
diff
changeset
|
3641 |
|
26743
c2c40cefc17b
patch 8.2.3900: it is not easy to use a script-local function for an option
Bram Moolenaar <Bram@vim.org>
parents:
26708
diff
changeset
|
3642 If the expression starts with s: or |<SID>|, then it is replaced with |
|
c2c40cefc17b
patch 8.2.3900: it is not easy to use a script-local function for an option
Bram Moolenaar <Bram@vim.org>
parents:
26708
diff
changeset
|
3643 the script ID (|local-function|). Example: > |
|
c2c40cefc17b
patch 8.2.3900: it is not easy to use a script-local function for an option
Bram Moolenaar <Bram@vim.org>
parents:
26708
diff
changeset
|
3644 set formatexpr=s:MyFormatExpr() |
|
c2c40cefc17b
patch 8.2.3900: it is not easy to use a script-local function for an option
Bram Moolenaar <Bram@vim.org>
parents:
26708
diff
changeset
|
3645 set formatexpr=<SID>SomeFormatExpr() |
| 27321 | 3646 < Otherwise, the expression is evaluated in the context of the script |
| 3647 where the option was set, thus script-local items are available. | |
| 3648 | |
|
9286
64035abb986b
commit https://github.com/vim/vim/commit/c95a302a4c42ec8230473cd4a5e0064d0a143aa8
Christian Brabandt <cb@256bit.org>
parents:
9227
diff
changeset
|
3649 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
|
3650 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
|
3651 since changing the buffer text is not allowed. |
|
16728
e55c26aaf484
patch 8.1.1366: using expressions in a modeline is unsafe
Bram Moolenaar <Bram@vim.org>
parents:
16610
diff
changeset
|
3652 This option cannot be set in a modeline when 'modelineexpr' is off. |
| 11160 | 3653 NOTE: This option is set to "" when 'compatible' is set. |
|
9286
64035abb986b
commit https://github.com/vim/vim/commit/c95a302a4c42ec8230473cd4a5e0064d0a143aa8
Christian Brabandt <cb@256bit.org>
parents:
9227
diff
changeset
|
3654 |
| 41 | 3655 *'formatlistpat'* *'flp'* |
| 3656 'formatlistpat' 'flp' string (default: "^\s*\d\+[\]:.)}\t ]\s*") | |
| 3657 local to buffer | |
| 3658 A pattern that is used to recognize a list header. This is used for | |
| 3659 the "n" flag in 'formatoptions'. | |
| 3660 The pattern must match exactly the text that will be the indent for | |
| 140 | 3661 the line below it. You can use |/\ze| to mark the end of the match |
| 41 | 3662 while still checking more characters. There must be a character |
| 3663 following the pattern, when it matches the whole line it is handled | |
| 3664 like there is no match. | |
| 3665 The default recognizes a number, followed by an optional punctuation | |
| 3666 character and white space. | |
| 3667 | |
|
16443
32a543152dc0
patch 8.1.1226: {not in Vi} remarks get in the way of useful help text
Bram Moolenaar <Bram@vim.org>
parents:
16439
diff
changeset
|
3668 *'formatoptions'* *'fo'* |
|
32a543152dc0
patch 8.1.1226: {not in Vi} remarks get in the way of useful help text
Bram Moolenaar <Bram@vim.org>
parents:
16439
diff
changeset
|
3669 'formatoptions' 'fo' string (Vim default: "tcq", Vi default: "vt") |
|
32a543152dc0
patch 8.1.1226: {not in Vi} remarks get in the way of useful help text
Bram Moolenaar <Bram@vim.org>
parents:
16439
diff
changeset
|
3670 local to buffer |
|
32a543152dc0
patch 8.1.1226: {not in Vi} remarks get in the way of useful help text
Bram Moolenaar <Bram@vim.org>
parents:
16439
diff
changeset
|
3671 This is a sequence of letters which describes how automatic |
|
32a543152dc0
patch 8.1.1226: {not in Vi} remarks get in the way of useful help text
Bram Moolenaar <Bram@vim.org>
parents:
16439
diff
changeset
|
3672 formatting is to be done. See |fo-table|. When the 'paste' option is |
|
32a543152dc0
patch 8.1.1226: {not in Vi} remarks get in the way of useful help text
Bram Moolenaar <Bram@vim.org>
parents:
16439
diff
changeset
|
3673 on, no formatting is done (like 'formatoptions' is empty). Commas can |
|
32a543152dc0
patch 8.1.1226: {not in Vi} remarks get in the way of useful help text
Bram Moolenaar <Bram@vim.org>
parents:
16439
diff
changeset
|
3674 be inserted for readability. |
|
32a543152dc0
patch 8.1.1226: {not in Vi} remarks get in the way of useful help text
Bram Moolenaar <Bram@vim.org>
parents:
16439
diff
changeset
|
3675 To avoid problems with flags that are added in the future, use the |
|
32a543152dc0
patch 8.1.1226: {not in Vi} remarks get in the way of useful help text
Bram Moolenaar <Bram@vim.org>
parents:
16439
diff
changeset
|
3676 "+=" and "-=" feature of ":set" |add-option-flags|. |
|
32a543152dc0
patch 8.1.1226: {not in Vi} remarks get in the way of useful help text
Bram Moolenaar <Bram@vim.org>
parents:
16439
diff
changeset
|
3677 NOTE: This option is set to the Vi default value when 'compatible' is |
|
32a543152dc0
patch 8.1.1226: {not in Vi} remarks get in the way of useful help text
Bram Moolenaar <Bram@vim.org>
parents:
16439
diff
changeset
|
3678 set and to the Vim default value when 'compatible' is reset. |
|
32a543152dc0
patch 8.1.1226: {not in Vi} remarks get in the way of useful help text
Bram Moolenaar <Bram@vim.org>
parents:
16439
diff
changeset
|
3679 |
| 7 | 3680 *'formatprg'* *'fp'* |
| 3681 '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
|
3682 global or local to buffer |global-local| |
| 7 | 3683 The name of an external program that will be used to format the lines |
| 667 | 3684 selected with the |gq| operator. The program must take the input on |
| 7 | 3685 stdin and produce the output on stdout. The Unix program "fmt" is |
| 557 | 3686 such a program. |
| 667 | 3687 If the 'formatexpr' option is not empty it will be used instead. |
| 3688 Otherwise, if 'formatprg' option is an empty string, the internal | |
| 3689 format function will be used |C-indenting|. | |
| 557 | 3690 Environment variables are expanded |:set_env|. See |option-backslash| |
| 3691 about including spaces and backslashes. | |
| 3682 | 3692 This option cannot be set from a |modeline| or in the |sandbox|, for |
| 3693 security reasons. | |
| 667 | 3694 |
|
7196
42717d048817
commit https://github.com/vim/vim/commit/d94464ee294a351ce7b6ba18e8bd3f24f1bef920
Christian Brabandt <cb@256bit.org>
parents:
7147
diff
changeset
|
3695 *'fsync'* *'fs'* *'nofsync'* *'nofs'* |
| 36 | 3696 'fsync' 'fs' boolean (default on) |
| 3697 global | |
| 3698 When on, the library function fsync() will be called after writing a | |
| 3699 file. This will flush a file to disk, ensuring that it is safely | |
| 3700 written even on filesystems which do metadata-only journaling. This | |
| 3701 will force the harddrive to spin up on Linux systems running in laptop | |
| 3702 mode, so it may be undesirable in some situations. Be warned that | |
| 3703 turning this off increases the chances of data loss after a crash. On | |
| 3704 systems without an fsync() implementation, this variable is always | |
| 3705 off. | |
| 3706 Also see 'swapsync' for controlling fsync() on swap files. | |
|
25951
560132056b97
patch 8.2.3509: undo file is not synced
Bram Moolenaar <Bram@vim.org>
parents:
25836
diff
changeset
|
3707 'fsync' also applies to |writefile()| (unless a flag is used to |
|
560132056b97
patch 8.2.3509: undo file is not synced
Bram Moolenaar <Bram@vim.org>
parents:
25836
diff
changeset
|
3708 overrule it) and when writing undo files (see |undo-persistence|). |
|
16728
e55c26aaf484
patch 8.1.1366: using expressions in a modeline is unsafe
Bram Moolenaar <Bram@vim.org>
parents:
16610
diff
changeset
|
3709 This option cannot be set from a |modeline| or in the |sandbox|, for |
|
e55c26aaf484
patch 8.1.1366: using expressions in a modeline is unsafe
Bram Moolenaar <Bram@vim.org>
parents:
16610
diff
changeset
|
3710 security reasons. |
| 36 | 3711 |
| 7 | 3712 *'gdefault'* *'gd'* *'nogdefault'* *'nogd'* |
| 3713 'gdefault' 'gd' boolean (default off) | |
| 3714 global | |
| 3715 When on, the ":substitute" flag 'g' is default on. This means that | |
| 3716 all matches in a line are substituted instead of one. When a 'g' flag | |
| 3717 is given to a ":substitute" command, this will toggle the substitution | |
| 3718 of all or one match. See |complex-change|. | |
| 3719 | |
| 3720 command 'gdefault' on 'gdefault' off ~ | |
| 3721 :s/// subst. all subst. one | |
| 3722 :s///g subst. one subst. all | |
| 3723 :s///gg subst. all subst. one | |
| 3724 | |
| 3725 NOTE: This option is reset when 'compatible' is set. | |
|
11516
80491a71c716
patch 8.0.0641: cannot set a separate highlighting for the quickfix line
Christian Brabandt <cb@256bit.org>
parents:
11473
diff
changeset
|
3726 DEPRECATED: Setting this option may break plugins that are not aware |
|
80491a71c716
patch 8.0.0641: cannot set a separate highlighting for the quickfix line
Christian Brabandt <cb@256bit.org>
parents:
11473
diff
changeset
|
3727 of this option. Also, many users get confused that adding the /g flag |
|
80491a71c716
patch 8.0.0641: cannot set a separate highlighting for the quickfix line
Christian Brabandt <cb@256bit.org>
parents:
11473
diff
changeset
|
3728 has the opposite effect of that it normally does. |
| 23305 | 3729 This option is not used in |Vim9| script. |
| 7 | 3730 |
| 3731 *'grepformat'* *'gfm'* | |
| 6213 | 3732 'grepformat' 'gfm' string (default "%f:%l:%m,%f:%l%m,%f %l%m") |
| 7 | 3733 global |
| 3734 Format to recognize for the ":grep" command output. | |
| 3735 This is a scanf-like string that uses the same format as the | |
| 3736 'errorformat' option: see |errorformat|. | |
| 3737 | |
| 3738 *'grepprg'* *'gp'* | |
| 3739 'grepprg' 'gp' string (default "grep -n ", | |
| 3740 Unix: "grep -n $* /dev/null", | |
| 3741 Win32: "findstr /n" or "grep -n", | |
| 3742 VMS: "SEARCH/NUMBERS ") | |
| 3743 global or local to buffer |global-local| | |
| 233 | 3744 Program to use for the |:grep| command. This option may contain '%' |
| 7 | 3745 and '#' characters, which are expanded like when used in a command- |
| 3746 line. The placeholder "$*" is allowed to specify where the arguments | |
| 3747 will be included. Environment variables are expanded |:set_env|. See | |
| 3748 |option-backslash| about including spaces and backslashes. | |
| 3749 When your "grep" accepts the "-H" argument, use this to make ":grep" | |
| 3750 also work well with a single file: > | |
| 3751 :set grepprg=grep\ -nH | |
| 161 | 3752 < Special value: When 'grepprg' is set to "internal" the |:grep| command |
| 657 | 3753 works like |:vimgrep|, |:lgrep| like |:lvimgrep|, |:grepadd| like |
| 3754 |:vimgrepadd| and |:lgrepadd| like |:lvimgrepadd|. | |
| 41 | 3755 See also the section |:make_makeprg|, since most of the comments there |
| 7 | 3756 apply equally to 'grepprg'. |
| 3757 For Win32, the default is "findstr /n" if "findstr.exe" can be found, | |
| 3758 otherwise it's "grep -n". | |
| 3759 This option cannot be set from a |modeline| or in the |sandbox|, for | |
| 3760 security reasons. | |
| 3761 | |
| 3762 *'guicursor'* *'gcr'* *E545* *E546* *E548* *E549* | |
| 3763 'guicursor' 'gcr' string (default "n-v-c:block-Cursor/lCursor, | |
| 3764 ve:ver35-Cursor, | |
| 3765 o:hor50-Cursor, | |
| 3766 i-ci:ver25-Cursor/lCursor, | |
| 3767 r-cr:hor20-Cursor/lCursor, | |
| 3768 sm:block-Cursor | |
| 3769 -blinkwait175-blinkoff150-blinkon175", | |
| 18972 | 3770 for Win32 console: |
| 7 | 3771 "n-v-c:block,o:hor50,i-ci:hor15, |
| 3772 r-cr:hor30,sm:block") | |
| 3773 global | |
| 3774 {only available when compiled with GUI enabled, and | |
| 18972 | 3775 for Win32 console} |
| 7 | 3776 This option tells Vim what the cursor should look like in different |
| 19116 | 3777 modes. It fully works in the GUI. In a Win32 console, only the |
| 18972 | 3778 height of the cursor can be changed. This can be done by specifying a |
| 3779 block cursor, or a percentage for a vertical or horizontal cursor. | |
| 6727 | 3780 For a console the 't_SI', 't_SR', and 't_EI' escape sequences are |
| 3781 used. | |
| 7 | 3782 |
| 10 | 3783 The option is a comma separated list of parts. Each part consist of a |
| 7 | 3784 mode-list and an argument-list: |
| 3785 mode-list:argument-list,mode-list:argument-list,.. | |
| 3786 The mode-list is a dash separated list of these modes: | |
| 3787 n Normal mode | |
| 3788 v Visual mode | |
| 3789 ve Visual mode with 'selection' "exclusive" (same as 'v', | |
| 3790 if not specified) | |
| 3791 o Operator-pending mode | |
| 3792 i Insert mode | |
| 3793 r Replace mode | |
| 3794 c Command-line Normal (append) mode | |
| 3795 ci Command-line Insert mode | |
| 3796 cr Command-line Replace mode | |
| 3797 sm showmatch in Insert mode | |
| 3798 a all modes | |
| 3799 The argument-list is a dash separated list of these arguments: | |
| 3800 hor{N} horizontal bar, {N} percent of the character height | |
| 3801 ver{N} vertical bar, {N} percent of the character width | |
| 3802 block block cursor, fills the whole character | |
| 3803 [only one of the above three should be present] | |
| 3804 blinkwait{N} *cursor-blinking* | |
| 3805 blinkon{N} | |
| 3806 blinkoff{N} | |
| 3807 blink times for cursor: blinkwait is the delay before | |
| 3808 the cursor starts blinking, blinkon is the time that | |
| 3809 the cursor is shown and blinkoff is the time that the | |
| 3810 cursor is not shown. The times are in msec. When one | |
| 3811 of the numbers is zero, there is no blinking. The | |
| 3812 default is: "blinkwait700-blinkon400-blinkoff250". | |
| 3813 These numbers are used for a missing entry. This | |
| 3814 means that blinking is enabled by default. To switch | |
| 3815 blinking off you can use "blinkon0". The cursor only | |
| 3816 blinks when Vim is waiting for input, not while | |
| 3817 executing a command. | |
| 3818 To make the cursor blink in an xterm, see | |
| 3819 |xterm-blink|. | |
| 3820 {group-name} | |
| 3821 a highlight group name, that sets the color and font | |
| 3822 for the cursor | |
| 3823 {group-name}/{group-name} | |
| 3824 Two highlight group names, the first is used when | |
| 3825 no language mappings are used, the other when they | |
| 3826 are. |language-mapping| | |
| 3827 | |
| 3828 Examples of parts: | |
| 3829 n-c-v:block-nCursor in Normal, Command-line and Visual mode, use a | |
| 3830 block cursor with colors from the "nCursor" | |
| 3831 highlight group | |
| 3832 i-ci:ver30-iCursor-blinkwait300-blinkon200-blinkoff150 | |
| 3833 In Insert and Command-line Insert mode, use a | |
| 3834 30% vertical bar cursor with colors from the | |
| 3835 "iCursor" highlight group. Blink a bit | |
| 3836 faster. | |
| 3837 | |
| 3838 The 'a' mode is different. It will set the given argument-list for | |
| 3839 all modes. It does not reset anything to defaults. This can be used | |
| 3840 to do a common setting for all modes. For example, to switch off | |
| 3841 blinking: "a:blinkon0" | |
| 3842 | |
| 3843 Examples of cursor highlighting: > | |
| 3844 :highlight Cursor gui=reverse guifg=NONE guibg=NONE | |
| 3845 :highlight Cursor gui=NONE guifg=bg guibg=fg | |
| 3846 < | |
| 3847 *'guifont'* *'gfn'* | |
| 2908 | 3848 *E235* *E596* |
| 7 | 3849 'guifont' 'gfn' string (default "") |
| 3850 global | |
| 3851 {only available when compiled with GUI enabled} | |
| 3852 This is a list of fonts which will be used for the GUI version of Vim. | |
|
16439
9d20e26dc13c
patch 8.1.1224: MS-Windows: cannot specify font weight
Bram Moolenaar <Bram@vim.org>
parents:
16427
diff
changeset
|
3853 In its simplest form the value is just one font name. |
|
9d20e26dc13c
patch 8.1.1224: MS-Windows: cannot specify font weight
Bram Moolenaar <Bram@vim.org>
parents:
16427
diff
changeset
|
3854 See |gui-font| for the details. |
| 7 | 3855 |
| 3856 *'guifontset'* *'gfs'* | |
| 3857 *E250* *E252* *E234* *E597* *E598* | |
| 3858 'guifontset' 'gfs' string (default "") | |
| 3859 global | |
| 3860 {only available when compiled with GUI enabled and | |
| 3861 with the |+xfontset| feature} | |
|
10895
c391bfbdb452
Updated runtime files.
Christian Brabandt <cb@256bit.org>
parents:
10734
diff
changeset
|
3862 {not available in the GTK+ GUI} |
| 7 | 3863 When not empty, specifies two (or more) fonts to be used. The first |
| 3864 one for normal English, the second one for your special language. See | |
| 3865 |xfontset|. | |
|
16439
9d20e26dc13c
patch 8.1.1224: MS-Windows: cannot specify font weight
Bram Moolenaar <Bram@vim.org>
parents:
16427
diff
changeset
|
3866 |
| 7 | 3867 *'guifontwide'* *'gfw'* *E231* *E533* *E534* |
| 3868 'guifontwide' 'gfw' string (default "") | |
| 3869 global | |
| 3870 {only available when compiled with GUI enabled} | |
| 3871 When not empty, specifies a comma-separated list of fonts to be used | |
| 3872 for double-width characters. The first font that can be loaded is | |
|
16439
9d20e26dc13c
patch 8.1.1224: MS-Windows: cannot specify font weight
Bram Moolenaar <Bram@vim.org>
parents:
16427
diff
changeset
|
3873 used. See |gui-fontwide|. |
| 4055 | 3874 |
| 7 | 3875 *'guiheadroom'* *'ghr'* |
| 3876 'guiheadroom' 'ghr' number (default 50) | |
| 3877 global | |
|
16728
e55c26aaf484
patch 8.1.1366: using expressions in a modeline is unsafe
Bram Moolenaar <Bram@vim.org>
parents:
16610
diff
changeset
|
3878 {only for GTK and X11 GUI} |
| 7 | 3879 The number of pixels subtracted from the screen height when fitting |
| 3880 the GUI window on the screen. Set this before the GUI is started, | |
| 3881 e.g., in your |gvimrc| file. When zero, the whole screen height will | |
| 10 | 3882 be used by the window. When positive, the specified number of pixel |
| 7 | 3883 lines will be left for window decorations and other items on the |
| 3884 screen. Set it to a negative value to allow windows taller than the | |
| 3885 screen. | |
| 3886 | |
|
25982
aade8ef975d5
patch 8.2.3524: GUI: ligatures are not used
Bram Moolenaar <Bram@vim.org>
parents:
25978
diff
changeset
|
3887 *'guiligatures'* *'gli'* *E1243* |
|
aade8ef975d5
patch 8.2.3524: GUI: ligatures are not used
Bram Moolenaar <Bram@vim.org>
parents:
25978
diff
changeset
|
3888 'guiligatures' 'gli' string (default "") |
|
aade8ef975d5
patch 8.2.3524: GUI: ligatures are not used
Bram Moolenaar <Bram@vim.org>
parents:
25978
diff
changeset
|
3889 global |
|
aade8ef975d5
patch 8.2.3524: GUI: ligatures are not used
Bram Moolenaar <Bram@vim.org>
parents:
25978
diff
changeset
|
3890 {only for GTK GUI} |
|
aade8ef975d5
patch 8.2.3524: GUI: ligatures are not used
Bram Moolenaar <Bram@vim.org>
parents:
25978
diff
changeset
|
3891 List of ASCII characters that, when combined together, can create more |
|
aade8ef975d5
patch 8.2.3524: GUI: ligatures are not used
Bram Moolenaar <Bram@vim.org>
parents:
25978
diff
changeset
|
3892 complex shapes. Each character must be a printable ASCII character |
|
aade8ef975d5
patch 8.2.3524: GUI: ligatures are not used
Bram Moolenaar <Bram@vim.org>
parents:
25978
diff
changeset
|
3893 with a value in the 32-127 range. |
|
aade8ef975d5
patch 8.2.3524: GUI: ligatures are not used
Bram Moolenaar <Bram@vim.org>
parents:
25978
diff
changeset
|
3894 Example: > |
|
aade8ef975d5
patch 8.2.3524: GUI: ligatures are not used
Bram Moolenaar <Bram@vim.org>
parents:
25978
diff
changeset
|
3895 :set guiligatures=!\"#$%&()*+-./:<=>?@[]^_{\|~ |
|
aade8ef975d5
patch 8.2.3524: GUI: ligatures are not used
Bram Moolenaar <Bram@vim.org>
parents:
25978
diff
changeset
|
3896 < Changing this option updates screen output immediately. Set it to an |
|
aade8ef975d5
patch 8.2.3524: GUI: ligatures are not used
Bram Moolenaar <Bram@vim.org>
parents:
25978
diff
changeset
|
3897 empty string to disable ligatures. |
|
aade8ef975d5
patch 8.2.3524: GUI: ligatures are not used
Bram Moolenaar <Bram@vim.org>
parents:
25978
diff
changeset
|
3898 |
| 7 | 3899 *'guioptions'* *'go'* |
| 14945 | 3900 'guioptions' 'go' string (default "egmrLtT" (MS-Windows, |
| 3901 "t" is removed in |defaults.vim|), | |
|
9669
284b4eb307fc
commit https://github.com/vim/vim/commit/8c08b5b569e2a9e9f63dea514591ecfa2d3bb392
Christian Brabandt <cb@256bit.org>
parents:
9665
diff
changeset
|
3902 "aegimrLtT" (GTK, Motif and Athena), |
|
284b4eb307fc
commit https://github.com/vim/vim/commit/8c08b5b569e2a9e9f63dea514591ecfa2d3bb392
Christian Brabandt <cb@256bit.org>
parents:
9665
diff
changeset
|
3903 ) |
| 7 | 3904 global |
| 3905 {only available when compiled with GUI enabled} | |
| 8 | 3906 This option only has an effect in the GUI version of Vim. It is a |
| 7 | 3907 sequence of letters which describes what components and options of the |
| 3908 GUI should be used. | |
| 3909 To avoid problems with flags that are added in the future, use the | |
| 3910 "+=" and "-=" feature of ":set" |add-option-flags|. | |
| 3911 | |
|
13470
6faef782f50b
patch 8.0.1609: shell commands in the GUI use a dumb terminal
Christian Brabandt <cb@256bit.org>
parents:
13437
diff
changeset
|
3912 Valid characters are as follows: |
|
6faef782f50b
patch 8.0.1609: shell commands in the GUI use a dumb terminal
Christian Brabandt <cb@256bit.org>
parents:
13437
diff
changeset
|
3913 *'go-!'* |
|
6faef782f50b
patch 8.0.1609: shell commands in the GUI use a dumb terminal
Christian Brabandt <cb@256bit.org>
parents:
13437
diff
changeset
|
3914 '!' External commands are executed in a terminal window. Without |
|
6faef782f50b
patch 8.0.1609: shell commands in the GUI use a dumb terminal
Christian Brabandt <cb@256bit.org>
parents:
13437
diff
changeset
|
3915 this flag the MS-Windows GUI will open a console window to |
|
6faef782f50b
patch 8.0.1609: shell commands in the GUI use a dumb terminal
Christian Brabandt <cb@256bit.org>
parents:
13437
diff
changeset
|
3916 execute the command. The Unix GUI will simulate a dumb |
|
6faef782f50b
patch 8.0.1609: shell commands in the GUI use a dumb terminal
Christian Brabandt <cb@256bit.org>
parents:
13437
diff
changeset
|
3917 terminal to list the command output. |
|
6faef782f50b
patch 8.0.1609: shell commands in the GUI use a dumb terminal
Christian Brabandt <cb@256bit.org>
parents:
13437
diff
changeset
|
3918 The terminal window will be positioned at the bottom, and grow |
|
6faef782f50b
patch 8.0.1609: shell commands in the GUI use a dumb terminal
Christian Brabandt <cb@256bit.org>
parents:
13437
diff
changeset
|
3919 upwards as needed. |
| 14999 | 3920 *'go-a'* |
| 7 | 3921 'a' Autoselect: If present, then whenever VISUAL mode is started, |
| 3922 or the Visual area extended, Vim tries to become the owner of | |
| 3923 the windowing system's global selection. This means that the | |
| 3924 Visually highlighted text is available for pasting into other | |
| 3925 applications as well as into Vim itself. When the Visual mode | |
| 3926 ends, possibly due to an operation on the text, or when an | |
| 3927 application wants to paste the selection, the highlighted text | |
| 3928 is automatically yanked into the "* selection register. | |
| 3929 Thus the selection is still available for pasting into other | |
| 3930 applications after the VISUAL mode has ended. | |
| 3931 If not present, then Vim won't become the owner of the | |
| 3932 windowing system's global selection unless explicitly told to | |
| 3933 by a yank or delete operation for the "* register. | |
| 3934 The same applies to the modeless selection. | |
| 3674 | 3935 *'go-P'* |
| 3936 '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
|
3937 register. |
| 1152 | 3938 *'go-A'* |
| 10 | 3939 'A' Autoselect for the modeless selection. Like 'a', but only |
| 7 | 3940 applies to the modeless selection. |
| 3941 | |
| 3942 'guioptions' autoselect Visual autoselect modeless ~ | |
| 3943 "" - - | |
| 3944 "a" yes yes | |
| 3945 "A" - yes | |
| 3946 "aA" yes yes | |
| 3947 | |
| 1152 | 3948 *'go-c'* |
| 7 | 3949 'c' Use console dialogs instead of popup dialogs for simple |
| 3950 choices. | |
|
18078
5ae41d0ea397
patch 8.1.2034: dark them of GTK 3 not supported
Bram Moolenaar <Bram@vim.org>
parents:
18068
diff
changeset
|
3951 *'go-d'* |
|
5ae41d0ea397
patch 8.1.2034: dark them of GTK 3 not supported
Bram Moolenaar <Bram@vim.org>
parents:
18068
diff
changeset
|
3952 'd' Use dark theme variant if available. Currently only works for |
|
5ae41d0ea397
patch 8.1.2034: dark them of GTK 3 not supported
Bram Moolenaar <Bram@vim.org>
parents:
18068
diff
changeset
|
3953 GTK+ GUI. |
| 1152 | 3954 *'go-e'* |
| 697 | 3955 'e' Add tab pages when indicated with 'showtabline'. |
| 688 | 3956 'guitablabel' can be used to change the text in the labels. |
| 3957 When 'e' is missing a non-GUI tab pages line may be used. | |
| 857 | 3958 The GUI tabs are only supported on some systems, currently |
|
19526
22f0dda71638
patch 8.2.0320: no Haiku support
Bram Moolenaar <Bram@vim.org>
parents:
19404
diff
changeset
|
3959 GTK, Motif, Mac OS/X, Haiku, and MS-Windows. |
| 1152 | 3960 *'go-f'* |
| 7 | 3961 'f' Foreground: Don't use fork() to detach the GUI from the shell |
| 3962 where it was started. Use this for programs that wait for the | |
| 3963 editor to finish (e.g., an e-mail program). Alternatively you | |
| 3964 can use "gvim -f" or ":gui -f" to start the GUI in the | |
| 3965 foreground. |gui-fork| | |
| 3966 Note: Set this option in the vimrc file. The forking may have | |
| 819 | 3967 happened already when the |gvimrc| file is read. |
| 1152 | 3968 *'go-i'* |
| 7 | 3969 'i' Use a Vim icon. For GTK with KDE it is used in the left-upper |
| 3970 corner of the window. It's black&white on non-GTK, because of | |
| 3971 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
|
3972 *'go-m'* |
| 7 | 3973 'm' Menu bar is present. |
|
2290
22529abcd646
Fixed ":s" message. Docs updates.
Bram Moolenaar <bram@vim.org>
parents:
2283
diff
changeset
|
3974 *'go-M'* |
| 10 | 3975 'M' The system menu "$VIMRUNTIME/menu.vim" is not sourced. Note |
| 7 | 3976 that this flag must be added in the .vimrc file, before |
| 819 | 3977 switching on syntax or filetype recognition (when the |gvimrc| |
| 7 | 3978 file is sourced the system menu has already been loaded; the |
|
12756
3b26420fc639
Long overdue runtime update.
Christian Brabandt <cb@256bit.org>
parents:
12744
diff
changeset
|
3979 `: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
|
3980 *'go-g'* |
| 7 | 3981 'g' Grey menu items: Make menu items that are not active grey. If |
| 3982 'g' is not included inactive menu items are not shown at all. | |
| 3983 Exception: Athena will always use grey menu items. | |
| 1152 | 3984 *'go-t'* |
| 7 | 3985 't' Include tearoff menu items. Currently only works for Win32, |
| 3986 GTK+, and Motif 1.2 GUI. | |
| 1152 | 3987 *'go-T'* |
| 236 | 3988 'T' Include Toolbar. Currently only in Win32, GTK+, Motif, Photon |
| 856 | 3989 and Athena GUIs. |
| 1152 | 3990 *'go-r'* |
| 7 | 3991 'r' Right-hand scrollbar is always present. |
|
2290
22529abcd646
Fixed ":s" message. Docs updates.
Bram Moolenaar <bram@vim.org>
parents:
2283
diff
changeset
|
3992 *'go-R'* |
| 7 | 3993 'R' Right-hand scrollbar is present when there is a vertically |
| 3994 split window. | |
|
2290
22529abcd646
Fixed ":s" message. Docs updates.
Bram Moolenaar <bram@vim.org>
parents:
2283
diff
changeset
|
3995 *'go-l'* |
| 7 | 3996 'l' Left-hand scrollbar is always present. |
|
2290
22529abcd646
Fixed ":s" message. Docs updates.
Bram Moolenaar <bram@vim.org>
parents:
2283
diff
changeset
|
3997 *'go-L'* |
| 7 | 3998 'L' Left-hand scrollbar is present when there is a vertically |
| 3999 split window. | |
| 1152 | 4000 *'go-b'* |
| 7 | 4001 'b' Bottom (horizontal) scrollbar is present. Its size depends on |
| 4002 the longest visible line, or on the cursor line if the 'h' | |
| 4003 flag is included. |gui-horiz-scroll| | |
|
2290
22529abcd646
Fixed ":s" message. Docs updates.
Bram Moolenaar <bram@vim.org>
parents:
2283
diff
changeset
|
4004 *'go-h'* |
| 7 | 4005 'h' Limit horizontal scrollbar size to the length of the cursor |
| 4006 line. Reduces computations. |gui-horiz-scroll| | |
| 4007 | |
| 4008 And yes, you may even have scrollbars on the left AND the right if | |
| 4009 you really want to :-). See |gui-scrollbars| for more information. | |
| 4010 | |
|
2290
22529abcd646
Fixed ":s" message. Docs updates.
Bram Moolenaar <bram@vim.org>
parents:
2283
diff
changeset
|
4011 *'go-v'* |
| 7 | 4012 'v' Use a vertical button layout for dialogs. When not included, |
| 4013 a horizontal layout is preferred, but when it doesn't fit a | |
| 24278 | 4014 vertical layout is used anyway. Not supported in GTK 3. |
|
2290
22529abcd646
Fixed ":s" message. Docs updates.
Bram Moolenaar <bram@vim.org>
parents:
2283
diff
changeset
|
4015 *'go-p'* |
| 7 | 4016 'p' Use Pointer callbacks for X11 GUI. This is required for some |
| 4017 window managers. If the cursor is not blinking or hollow at | |
| 4018 the right moment, try adding this flag. This must be done | |
| 819 | 4019 before starting the GUI. Set it in your |gvimrc|. Adding or |
| 7 | 4020 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
|
4021 *'go-F'* |
| 10 | 4022 'F' Add a footer. Only for Motif. See |gui-footer|. |
|
12802
29a728529f92
patch 8.0.1278: GUI window always resizes when adding scrollbar
Christian Brabandt <cb@256bit.org>
parents:
12785
diff
changeset
|
4023 *'go-k'* |
|
29a728529f92
patch 8.0.1278: GUI window always resizes when adding scrollbar
Christian Brabandt <cb@256bit.org>
parents:
12785
diff
changeset
|
4024 'k' Keep the GUI window size when adding/removing a scrollbar, or |
|
29a728529f92
patch 8.0.1278: GUI window always resizes when adding scrollbar
Christian Brabandt <cb@256bit.org>
parents:
12785
diff
changeset
|
4025 toolbar, tabline, etc. Instead, the behavior is similar to |
|
29a728529f92
patch 8.0.1278: GUI window always resizes when adding scrollbar
Christian Brabandt <cb@256bit.org>
parents:
12785
diff
changeset
|
4026 when the window is maximized and will adjust 'lines' and |
|
29a728529f92
patch 8.0.1278: GUI window always resizes when adding scrollbar
Christian Brabandt <cb@256bit.org>
parents:
12785
diff
changeset
|
4027 'columns' to fit to the window. Without the 'k' flag Vim will |
|
12865
ebb4f6c93598
patch 8.0.1309: cannot use 'balloonexpr' in a terminal
Christian Brabandt <cb@256bit.org>
parents:
12826
diff
changeset
|
4028 try to keep 'lines' and 'columns' the same when adding and |
|
12802
29a728529f92
patch 8.0.1278: GUI window always resizes when adding scrollbar
Christian Brabandt <cb@256bit.org>
parents:
12785
diff
changeset
|
4029 removing GUI components. |
| 1152 | 4030 |
| 7 | 4031 *'guipty'* *'noguipty'* |
| 4032 'guipty' boolean (default on) | |
| 4033 global | |
| 4034 {only available when compiled with GUI enabled} | |
| 4035 Only in the GUI: If on, an attempt is made to open a pseudo-tty for | |
| 4036 I/O to/from shell commands. See |gui-pty|. | |
| 4037 | |
| 688 | 4038 *'guitablabel'* *'gtl'* |
| 4039 'guitablabel' 'gtl' string (default empty) | |
| 4040 global | |
|
17771
4bd21046902b
patch 8.1.1882: cannot specify properties of the info popup window
Bram Moolenaar <Bram@vim.org>
parents:
17767
diff
changeset
|
4041 {only available when compiled with GUI enabled} |
| 27804 | 4042 When non-empty describes the text to use in a label of the GUI tab |
| 857 | 4043 pages line. When empty and when the result is empty Vim will use a |
| 4044 default label. See |setting-guitablabel| for more info. | |
| 688 | 4045 |
| 692 | 4046 The format of this option is like that of 'statusline'. |
| 839 | 4047 '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
|
4048 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
|
4049 modeline, see |sandbox-option|. |
|
16728
e55c26aaf484
patch 8.1.1366: using expressions in a modeline is unsafe
Bram Moolenaar <Bram@vim.org>
parents:
16610
diff
changeset
|
4050 This option cannot be set in a modeline when 'modelineexpr' is off. |
| 692 | 4051 |
| 688 | 4052 Only used when the GUI tab pages line is displayed. 'e' must be |
| 4053 present in 'guioptions'. For the non-GUI tab pages line 'tabline' is | |
| 4054 used. | |
| 4055 | |
| 839 | 4056 *'guitabtooltip'* *'gtt'* |
| 4057 'guitabtooltip' 'gtt' string (default empty) | |
| 4058 global | |
|
17771
4bd21046902b
patch 8.1.1882: cannot specify properties of the info popup window
Bram Moolenaar <Bram@vim.org>
parents:
17767
diff
changeset
|
4059 {only available when compiled with GUI enabled} |
| 27804 | 4060 When non-empty describes the text to use in a tooltip for the GUI tab |
| 839 | 4061 pages line. When empty Vim will use a default tooltip. |
| 4062 This option is otherwise just like 'guitablabel' above. | |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
4063 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
|
4064 :let &guitabtooltip = "line one\nline two" |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
4065 < |
| 839 | 4066 |
| 7 | 4067 *'helpfile'* *'hf'* |
| 18972 | 4068 'helpfile' 'hf' string (default (MS-Windows) "$VIMRUNTIME\doc\help.txt" |
| 7 | 4069 (others) "$VIMRUNTIME/doc/help.txt") |
| 4070 global | |
| 4071 Name of the main help file. All distributed help files should be | |
| 4072 placed together in one directory. Additionally, all "doc" directories | |
| 4073 in 'runtimepath' will be used. | |
| 4074 Environment variables are expanded |:set_env|. For example: | |
| 4075 "$VIMRUNTIME/doc/help.txt". If $VIMRUNTIME is not set, $VIM is also | |
| 10 | 4076 tried. Also see |$VIMRUNTIME| and |option-backslash| about including |
| 7 | 4077 spaces and backslashes. |
| 4078 This option cannot be set from a |modeline| or in the |sandbox|, for | |
| 4079 security reasons. | |
| 4080 | |
| 4081 *'helpheight'* *'hh'* | |
| 4082 'helpheight' 'hh' number (default 20) | |
| 4083 global | |
| 4084 Minimal initial height of the help window when it is opened with the | |
| 4085 ":help" command. The initial height of the help window is half of the | |
| 4086 current window, or (when the 'ea' option is on) the same as other | |
| 4087 windows. When the height is less than 'helpheight', the height is | |
| 4088 set to 'helpheight'. Set to zero to disable. | |
| 4089 | |
| 4090 *'helplang'* *'hlg'* | |
| 4091 'helplang' 'hlg' string (default: messages language or empty) | |
| 4092 global | |
| 4093 {only available when compiled with the |+multi_lang| | |
| 4094 feature} | |
| 4095 Comma separated list of languages. Vim will use the first language | |
| 4096 for which the desired help can be found. The English help will always | |
| 4097 be used as a last resort. You can add "en" to prefer English over | |
| 4098 another language, but that will only find tags that exist in that | |
| 4099 language and not in the English help. | |
| 4100 Example: > | |
| 4101 :set helplang=de,it | |
| 4102 < This will first search German, then Italian and finally English help | |
| 4103 files. | |
| 4104 When using |CTRL-]| and ":help!" in a non-English help file Vim will | |
| 4105 try to find the tag in the current language before using this option. | |
| 4106 See |help-translated|. | |
| 4107 | |
| 4108 *'hidden'* *'hid'* *'nohidden'* *'nohid'* | |
| 4109 'hidden' 'hid' boolean (default off) | |
| 4110 global | |
| 4111 When off a buffer is unloaded when it is |abandon|ed. When on a | |
| 4112 buffer becomes hidden when it is |abandon|ed. If the buffer is still | |
| 4113 displayed in another window, it does not become hidden, of course. | |
| 4114 The commands that move through the buffer list sometimes make a buffer | |
| 4115 hidden although the 'hidden' option is off: When the buffer is | |
| 4116 modified, 'autowrite' is off or writing is not possible, and the '!' | |
| 10 | 4117 flag was used. See also |windows.txt|. |
| 12 | 4118 To only make one buffer hidden use the 'bufhidden' option. |
| 7 | 4119 This option is set for one command with ":hide {command}" |:hide|. |
| 4120 WARNING: It's easy to forget that you have changes in hidden buffers. | |
| 4121 Think twice when using ":q!" or ":qa!". | |
| 4122 | |
| 4123 *'highlight'* *'hl'* | |
| 4124 '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
|
4125 "8:SpecialKey,~:EndOfBuffer,@:NonText, |
|
7da89d9c744b
commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents:
9860
diff
changeset
|
4126 d:Directory,e:ErrorMsg,i:IncSearch, |
|
7da89d9c744b
commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents:
9860
diff
changeset
|
4127 l:Search,m:MoreMsg,M:ModeMsg,n:LineNr, |
|
18471
b9cf60801963
patch 8.1.2229: cannot color number column above/below cursor differently
Bram Moolenaar <Bram@vim.org>
parents:
18465
diff
changeset
|
4128 a:LineNrAbove,b:LineNrBelow, |
|
9877
7da89d9c744b
commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents:
9860
diff
changeset
|
4129 N:CursorLineNr,r:Question,s:StatusLine, |
|
7da89d9c744b
commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents:
9860
diff
changeset
|
4130 S:StatusLineNC,c:VertSplit,t:Title, |
| 15194 | 4131 v:Visual,V:VisualNOS,w:WarningMsg, |
| 4132 W:WildMenu,f:Folded,F:FoldColumn, | |
| 4133 A:DiffAdd,C:DiffChange,D:DiffDelete, | |
| 4134 T:DiffText,>:SignColumn,-:Conceal, | |
| 15281 | 4135 B:SpellBad,P:SpellCap,R:SpellRare, |
| 15194 | 4136 L:SpellLocal,+:Pmenu,=:PmenuSel, |
|
11516
80491a71c716
patch 8.0.0641: cannot set a separate highlighting for the quickfix line
Christian Brabandt <cb@256bit.org>
parents:
11473
diff
changeset
|
4137 x:PmenuSbar,X:PmenuThumb,*:TabLine, |
|
80491a71c716
patch 8.0.0641: cannot set a separate highlighting for the quickfix line
Christian Brabandt <cb@256bit.org>
parents:
11473
diff
changeset
|
4138 #:TabLineSel,_:TabLineFill,!:CursorColumn, |
| 11914 | 4139 .:CursorLine,o:ColorColumn,q:QuickFixLine, |
| 12254 | 4140 z:StatusLineTerm,Z:StatusLineTermNC") |
| 7 | 4141 global |
| 4142 This option can be used to set highlighting mode for various | |
| 4143 occasions. It is a comma separated list of character pairs. The | |
| 4144 first character in a pair gives the occasion, the second the mode to | |
| 10 | 4145 use for that occasion. The occasions are: |
| 7 | 4146 |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
|
4147 |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
|
4148 |hl-NonText| @ '@' at the end of the window and |
| 7 | 4149 characters from 'showbreak' |
| 4150 |hl-Directory| d directories in CTRL-D listing and other special | |
| 4151 things in listings | |
| 4152 |hl-ErrorMsg| e error messages | |
| 4153 h (obsolete, ignored) | |
| 4154 |hl-IncSearch| i 'incsearch' highlighting | |
| 4155 |hl-Search| l last search pattern highlighting (see 'hlsearch') | |
| 4156 |hl-MoreMsg| m |more-prompt| | |
| 4157 |hl-ModeMsg| M Mode (e.g., "-- INSERT --") | |
|
2178
c6f1aa1e9f32
Add 'relativenumber' patch from Markus Heidelberg.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
4158 |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
|
4159 when 'number' or 'relativenumber' option is set. |
|
18471
b9cf60801963
patch 8.1.2229: cannot color number column above/below cursor differently
Bram Moolenaar <Bram@vim.org>
parents:
18465
diff
changeset
|
4160 |hl-LineNrAbove| a line number above the cursor for when the |
|
b9cf60801963
patch 8.1.2229: cannot color number column above/below cursor differently
Bram Moolenaar <Bram@vim.org>
parents:
18465
diff
changeset
|
4161 'relativenumber' option is set. |
|
b9cf60801963
patch 8.1.2229: cannot color number column above/below cursor differently
Bram Moolenaar <Bram@vim.org>
parents:
18465
diff
changeset
|
4162 |hl-LineNrBelow| b line number below the cursor for when the |
|
b9cf60801963
patch 8.1.2229: cannot color number column above/below cursor differently
Bram Moolenaar <Bram@vim.org>
parents:
18465
diff
changeset
|
4163 'relativenumber' option is set. |
| 4073 | 4164 |hl-CursorLineNr| N like n for when 'cursorline' or 'relativenumber' is |
| 4165 set. | |
| 7 | 4166 |hl-Question| r |hit-enter| prompt and yes/no questions |
| 4167 |hl-StatusLine| s status line of current window |status-line| | |
| 12785 | 4168 |hl-StatusLineNC| S status lines of not-current windows |
| 7 | 4169 |hl-Title| t Titles for output from ":set all", ":autocmd" etc. |
| 4170 |hl-VertSplit| c column used to separate vertically split windows | |
| 4171 |hl-Visual| v Visual mode | |
| 4172 |hl-VisualNOS| V Visual mode when Vim does is "Not Owning the | |
| 4173 Selection" Only X11 Gui's |gui-x11| and | |
| 4174 |xterm-clipboard|. | |
| 4175 |hl-WarningMsg| w warning messages | |
| 4176 |hl-WildMenu| W wildcard matches displayed for 'wildmenu' | |
| 4177 |hl-Folded| f line used for closed folds | |
| 4178 |hl-FoldColumn| F 'foldcolumn' | |
| 386 | 4179 |hl-DiffAdd| A added line in diff mode |
| 4180 |hl-DiffChange| C changed line in diff mode | |
| 4181 |hl-DiffDelete| D deleted line in diff mode | |
| 4182 |hl-DiffText| T inserted text in diff mode | |
| 7 | 4183 |hl-SignColumn| > column used for |signs| |
| 15194 | 4184 |hl-Conceal| - the placeholders used for concealed characters |
| 4185 (see 'conceallevel') | |
| 221 | 4186 |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
|
4187 |hl-SpellCap| P word that should start with capital |spell| |
| 221 | 4188 |hl-SpellRare| R rare word |spell| |
| 4189 |hl-SpellLocal| L word from other region |spell| | |
| 15194 | 4190 |hl-Pmenu| + popup menu normal line |
| 4191 |hl-PmenuSel| = popup menu selected line | |
| 4192 |hl-PmenuSbar| x popup menu scrollbar | |
| 4193 |hl-PmenuThumb| X popup menu scrollbar thumb | |
| 7 | 4194 |
| 4195 The display modes are: | |
| 4196 r reverse (termcap entry "mr" and "me") | |
| 4197 i italic (termcap entry "ZH" and "ZR") | |
| 4198 b bold (termcap entry "md" and "me") | |
| 4199 s standout (termcap entry "so" and "se") | |
| 4200 u underline (termcap entry "us" and "ue") | |
| 205 | 4201 c undercurl (termcap entry "Cs" and "Ce") |
|
12317
2a8890b80923
patch 8.0.1038: strike-through text not supported
Christian Brabandt <cb@256bit.org>
parents:
12293
diff
changeset
|
4202 t strikethrough (termcap entry "Ts" and "Te") |
| 7 | 4203 n no highlighting |
| 4204 - no highlighting | |
| 4205 : use a highlight group | |
| 4206 The default is used for occasions that are not included. | |
| 4207 If you want to change what the display modes do, see |dos-colors| | |
| 4208 for an example. | |
| 4209 When using the ':' display mode, this must be followed by the name of | |
| 4210 a highlight group. A highlight group can be used to define any type | |
| 4211 of highlighting, including using color. See |:highlight| on how to | |
| 4212 define one. The default uses a different group for each occasion. | |
| 4213 See |highlight-default| for the default highlight groups. | |
| 4214 | |
| 4215 *'history'* *'hi'* | |
|
9669
284b4eb307fc
commit https://github.com/vim/vim/commit/8c08b5b569e2a9e9f63dea514591ecfa2d3bb392
Christian Brabandt <cb@256bit.org>
parents:
9665
diff
changeset
|
4216 '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
|
4217 set to 200 in |defaults.vim|) |
| 7 | 4218 global |
| 4219 A history of ":" commands, and a history of previous search patterns | |
| 5991 | 4220 is remembered. This option decides how many entries may be stored in |
| 7 | 4221 each of these histories (see |cmdline-editing|). |
| 5991 | 4222 The maximum value is 10000. |
| 7 | 4223 NOTE: This option is set to the Vi default value when 'compatible' is |
| 4224 set and to the Vim default value when 'compatible' is reset. | |
| 4225 | |
| 4226 *'hkmap'* *'hk'* *'nohkmap'* *'nohk'* | |
| 4227 'hkmap' 'hk' boolean (default off) | |
| 4228 global | |
| 4229 {only available when compiled with the |+rightleft| | |
| 4230 feature} | |
| 4231 When on, the keyboard is mapped for the Hebrew character set. | |
| 4232 Normally you would set 'allowrevins' and use CTRL-_ in insert mode to | |
| 4233 toggle this option. See |rileft.txt|. | |
| 4234 NOTE: This option is reset when 'compatible' is set. | |
| 4235 | |
| 4236 *'hkmapp'* *'hkp'* *'nohkmapp'* *'nohkp'* | |
| 4237 'hkmapp' 'hkp' boolean (default off) | |
| 4238 global | |
| 4239 {only available when compiled with the |+rightleft| | |
| 4240 feature} | |
| 4241 When on, phonetic keyboard mapping is used. 'hkmap' must also be on. | |
| 4242 This is useful if you have a non-Hebrew keyboard. | |
| 4243 See |rileft.txt|. | |
| 4244 NOTE: This option is reset when 'compatible' is set. | |
| 4245 | |
| 11160 | 4246 *'hlsearch'* *'hls'* *'nohlsearch'* *'nohls'* |
| 4247 'hlsearch' 'hls' boolean (default off) | |
| 4248 global | |
| 4249 {not available when compiled without the | |
| 4250 |+extra_search| feature} | |
| 4251 When there is a previous search pattern, highlight all its matches. | |
| 4252 The type of highlighting used can be set with the 'l' occasion in the | |
| 4253 'highlight' option. This uses the "Search" highlight group by | |
| 4254 default. Note that only the matching text is highlighted, any offsets | |
| 4255 are not applied. | |
| 4256 See also: 'incsearch' and |:match|. | |
| 4257 When you get bored looking at the highlighted matches, you can turn it | |
| 4258 off with |:nohlsearch|. This does not change the option value, as | |
| 4259 soon as you use a search command, the highlighting comes back. | |
| 4260 'redrawtime' specifies the maximum time spent on finding matches. | |
| 4261 When the search pattern can match an end-of-line, Vim will try to | |
| 4262 highlight all of the matched text. However, this depends on where the | |
| 4263 search starts. This will be the first line in the window or the first | |
| 4264 line below a closed fold. A match in a previous line which is not | |
| 4265 drawn may not continue in a newly drawn line. | |
| 4266 You can specify whether the highlight status is restored on startup | |
| 4267 with the 'h' flag in 'viminfo' |viminfo-h|. | |
| 4268 NOTE: This option is reset when 'compatible' is set. | |
| 4269 | |
| 7 | 4270 *'icon'* *'noicon'* |
| 4271 'icon' boolean (default off, on when title can be restored) | |
| 4272 global | |
| 4273 When on, the icon text of the window will be set to the value of | |
| 4274 'iconstring' (if it is not empty), or to the name of the file | |
| 4275 currently being edited. Only the last part of the name is used. | |
| 4276 Overridden by the 'iconstring' option. | |
| 4277 Only works if the terminal supports setting window icons (currently | |
| 4278 only X11 GUI and terminals with a non-empty 't_IS' option - these are | |
| 4279 Unix xterm and iris-ansi by default, where 't_IS' is taken from the | |
| 4280 builtin termcap). | |
| 4281 When Vim was compiled with HAVE_X11 defined, the original icon will be | |
| 233 | 4282 restored if possible |X11|. See |X11-icon| for changing the icon on |
| 7 | 4283 X11. |
| 6259 | 4284 For MS-Windows the icon can be changed, see |windows-icon|. |
| 7 | 4285 |
| 4286 *'iconstring'* | |
| 4287 'iconstring' string (default "") | |
| 4288 global | |
| 4289 When this option is not empty, it will be used for the icon text of | |
| 4290 the window. This happens only when the 'icon' option is on. | |
| 4291 Only works if the terminal supports setting window icon text | |
| 4292 (currently only X11 GUI and terminals with a non-empty 't_IS' option). | |
| 24387 | 4293 Does not work for MS-Windows. |
| 7 | 4294 When Vim was compiled with HAVE_X11 defined, the original icon will be |
| 4295 restored if possible |X11|. | |
| 4296 When this option contains printf-style '%' items, they will be | |
| 10 | 4297 expanded according to the rules used for 'statusline'. See |
| 7 | 4298 'titlestring' for example settings. |
|
16728
e55c26aaf484
patch 8.1.1366: using expressions in a modeline is unsafe
Bram Moolenaar <Bram@vim.org>
parents:
16610
diff
changeset
|
4299 This option cannot be set in a modeline when 'modelineexpr' is off. |
| 7 | 4300 {not available when compiled without the |+statusline| feature} |
| 4301 | |
| 4302 *'ignorecase'* *'ic'* *'noignorecase'* *'noic'* | |
| 4303 'ignorecase' 'ic' boolean (default off) | |
| 4304 global | |
| 4305 Ignore case in search patterns. Also used when searching in the tags | |
| 4306 file. | |
|
7266
6ba7182fb7bd
commit https://github.com/vim/vim/commit/0f6562e9036f889185dff49a75c7fc5ffb28b307
Christian Brabandt <cb@256bit.org>
parents:
7245
diff
changeset
|
4307 Also see 'smartcase' and 'tagcase'. |
| 7 | 4308 Can be overruled by using "\c" or "\C" in the pattern, see |
| 4309 |/ignorecase|. | |
| 4310 | |
|
5008
3717d569027d
updated for version 7.3.1248
Bram Moolenaar <bram@vim.org>
parents:
4869
diff
changeset
|
4311 *'imactivatefunc'* *'imaf'* |
|
3717d569027d
updated for version 7.3.1248
Bram Moolenaar <bram@vim.org>
parents:
4869
diff
changeset
|
4312 'imactivatefunc' 'imaf' string (default "") |
|
3717d569027d
updated for version 7.3.1248
Bram Moolenaar <bram@vim.org>
parents:
4869
diff
changeset
|
4313 global |
|
3717d569027d
updated for version 7.3.1248
Bram Moolenaar <bram@vim.org>
parents:
4869
diff
changeset
|
4314 This option specifies a function that will be called to |
|
26408
8f17f8f327f3
patch 8.2.3735: cannot use a lambda for 'imactivatefunc'
Bram Moolenaar <Bram@vim.org>
parents:
26388
diff
changeset
|
4315 activate or deactivate the Input Method. The value can be the name of |
|
8f17f8f327f3
patch 8.2.3735: cannot use a lambda for 'imactivatefunc'
Bram Moolenaar <Bram@vim.org>
parents:
26388
diff
changeset
|
4316 a function, a |lambda| or a |Funcref|. See |option-value-function| for |
|
8f17f8f327f3
patch 8.2.3735: cannot use a lambda for 'imactivatefunc'
Bram Moolenaar <Bram@vim.org>
parents:
26388
diff
changeset
|
4317 more information. |
|
21112
2d3cd9acf853
patch 8.2.1107: 'imactivatefunc' and 'imstatusfunc' are not used in the GUI
Bram Moolenaar <Bram@vim.org>
parents:
20856
diff
changeset
|
4318 It is not used in the MS-Windows GUI version. |
|
16728
e55c26aaf484
patch 8.1.1366: using expressions in a modeline is unsafe
Bram Moolenaar <Bram@vim.org>
parents:
16610
diff
changeset
|
4319 The expression will be evaluated in the |sandbox| when set from a |
|
e55c26aaf484
patch 8.1.1366: using expressions in a modeline is unsafe
Bram Moolenaar <Bram@vim.org>
parents:
16610
diff
changeset
|
4320 modeline, see |sandbox-option|. |
|
5008
3717d569027d
updated for version 7.3.1248
Bram Moolenaar <bram@vim.org>
parents:
4869
diff
changeset
|
4321 |
|
3717d569027d
updated for version 7.3.1248
Bram Moolenaar <bram@vim.org>
parents:
4869
diff
changeset
|
4322 Example: > |
|
3717d569027d
updated for version 7.3.1248
Bram Moolenaar <bram@vim.org>
parents:
4869
diff
changeset
|
4323 function ImActivateFunc(active) |
|
3717d569027d
updated for version 7.3.1248
Bram Moolenaar <bram@vim.org>
parents:
4869
diff
changeset
|
4324 if a:active |
|
3717d569027d
updated for version 7.3.1248
Bram Moolenaar <bram@vim.org>
parents:
4869
diff
changeset
|
4325 ... do something |
|
3717d569027d
updated for version 7.3.1248
Bram Moolenaar <bram@vim.org>
parents:
4869
diff
changeset
|
4326 else |
|
3717d569027d
updated for version 7.3.1248
Bram Moolenaar <bram@vim.org>
parents:
4869
diff
changeset
|
4327 ... do something |
|
3717d569027d
updated for version 7.3.1248
Bram Moolenaar <bram@vim.org>
parents:
4869
diff
changeset
|
4328 endif |
|
3717d569027d
updated for version 7.3.1248
Bram Moolenaar <bram@vim.org>
parents:
4869
diff
changeset
|
4329 " return value is not used |
|
3717d569027d
updated for version 7.3.1248
Bram Moolenaar <bram@vim.org>
parents:
4869
diff
changeset
|
4330 endfunction |
|
3717d569027d
updated for version 7.3.1248
Bram Moolenaar <bram@vim.org>
parents:
4869
diff
changeset
|
4331 set imactivatefunc=ImActivateFunc |
|
3717d569027d
updated for version 7.3.1248
Bram Moolenaar <bram@vim.org>
parents:
4869
diff
changeset
|
4332 < |
| 7 | 4333 *'imactivatekey'* *'imak'* |
| 4334 'imactivatekey' 'imak' string (default "") | |
| 4335 global | |
| 4336 {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
|
4337 |+GUI_GTK|} *E599* |
| 7 | 4338 Specifies the key that your Input Method in X-Windows uses for |
| 4339 activation. When this is specified correctly, vim can fully control | |
| 4340 IM with 'imcmdline', 'iminsert' and 'imsearch'. | |
| 4341 You can't use this option to change the activation key, the option | |
| 4342 tells Vim what the key is. | |
| 4343 Format: | |
| 4344 [MODIFIER_FLAG-]KEY_STRING | |
| 4345 | |
| 4346 These characters can be used for MODIFIER_FLAG (case is ignored): | |
| 4347 S Shift key | |
| 4348 L Lock key | |
| 4349 C Control key | |
| 4350 1 Mod1 key | |
| 4351 2 Mod2 key | |
| 4352 3 Mod3 key | |
| 4353 4 Mod4 key | |
| 4354 5 Mod5 key | |
| 4355 Combinations are allowed, for example "S-C-space" or "SC-space" are | |
| 4356 both shift+ctrl+space. | |
| 4357 See <X11/keysymdef.h> and XStringToKeysym for KEY_STRING. | |
| 4358 | |
| 4359 Example: > | |
| 4360 :set imactivatekey=S-space | |
| 4361 < "S-space" means shift+space. This is the activation key for kinput2 + | |
| 4362 canna (Japanese), and ami (Korean). | |
| 4363 | |
| 4364 *'imcmdline'* *'imc'* *'noimcmdline'* *'noimc'* | |
| 4365 'imcmdline' 'imc' boolean (default off) | |
| 4366 global | |
| 4367 When set the Input Method is always on when starting to edit a command | |
| 4368 line, unless entering a search pattern (see 'imsearch' for that). | |
| 4369 Setting this option is useful when your input method allows entering | |
| 4370 English characters directly, e.g., when it's used to type accented | |
| 4371 characters with dead keys. | |
| 4372 | |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
4373 *'imdisable'* *'imd'* *'noimdisable'* *'noimd'* |
| 7 | 4374 'imdisable' 'imd' boolean (default off, on for some systems (SGI)) |
| 4375 global | |
| 4376 When set the Input Method is never used. This is useful to disable | |
| 4377 the IM when it doesn't work properly. | |
| 4378 Currently this option is on by default for SGI/IRIX machines. This | |
| 4379 may change in later releases. | |
| 4380 | |
| 4381 *'iminsert'* *'imi'* | |
|
12469
61d910f0999d
patch 8.0.1114: default for 'iminsert' is annoying
Christian Brabandt <cb@256bit.org>
parents:
12317
diff
changeset
|
4382 'iminsert' 'imi' number (default 0) |
| 7 | 4383 local to buffer |
| 4384 Specifies whether :lmap or an Input Method (IM) is to be used in | |
| 4385 Insert mode. Valid values: | |
| 4386 0 :lmap is off and IM is off | |
| 4387 1 :lmap is ON and IM is off | |
| 4388 2 :lmap is off and IM is ON | |
| 4389 To always reset the option to zero when leaving Insert mode with <Esc> | |
| 4390 this can be used: > | |
| 4391 :inoremap <ESC> <ESC>:set iminsert=0<CR> | |
| 4392 < This makes :lmap and IM turn off automatically when leaving Insert | |
| 4393 mode. | |
| 4394 Note that this option changes when using CTRL-^ in Insert mode | |
| 4395 |i_CTRL-^|. | |
| 4396 The value is set to 1 when setting 'keymap' to a valid keymap name. | |
| 4397 It is also used for the argument of commands like "r" and "f". | |
| 4398 The value 0 may not work correctly with Athena and Motif with some XIM | |
| 4399 methods. Use 'imdisable' to disable XIM then. | |
| 4400 | |
|
12920
327e1264b9bf
patch 8.0.1336: cannot use imactivatefunc() unless compiled with +xim
Christian Brabandt <cb@256bit.org>
parents:
12865
diff
changeset
|
4401 You can set 'imactivatefunc' and 'imstatusfunc' to handle IME/XIM |
| 14519 | 4402 via external command if Vim is not compiled with the |+xim|, |
|
12920
327e1264b9bf
patch 8.0.1336: cannot use imactivatefunc() unless compiled with +xim
Christian Brabandt <cb@256bit.org>
parents:
12865
diff
changeset
|
4403 |+multi_byte_ime| or |global-ime|. |
|
327e1264b9bf
patch 8.0.1336: cannot use imactivatefunc() unless compiled with +xim
Christian Brabandt <cb@256bit.org>
parents:
12865
diff
changeset
|
4404 |
| 7 | 4405 *'imsearch'* *'ims'* |
|
12469
61d910f0999d
patch 8.0.1114: default for 'iminsert' is annoying
Christian Brabandt <cb@256bit.org>
parents:
12317
diff
changeset
|
4406 'imsearch' 'ims' number (default -1) |
| 7 | 4407 local to buffer |
| 4408 Specifies whether :lmap or an Input Method (IM) is to be used when | |
| 4409 entering a search pattern. Valid values: | |
| 4410 -1 the value of 'iminsert' is used, makes it look like | |
| 4411 'iminsert' is also used when typing a search pattern | |
| 4412 0 :lmap is off and IM is off | |
| 4413 1 :lmap is ON and IM is off | |
| 4414 2 :lmap is off and IM is ON | |
| 4415 Note that this option changes when using CTRL-^ in Command-line mode | |
| 4416 |c_CTRL-^|. | |
| 4417 The value is set to 1 when it is not -1 and setting the 'keymap' | |
| 4418 option to a valid keymap name. | |
| 4419 The value 0 may not work correctly with Athena and Motif with some XIM | |
| 4420 methods. Use 'imdisable' to disable XIM then. | |
| 4421 | |
|
5008
3717d569027d
updated for version 7.3.1248
Bram Moolenaar <bram@vim.org>
parents:
4869
diff
changeset
|
4422 *'imstatusfunc'* *'imsf'* |
|
3717d569027d
updated for version 7.3.1248
Bram Moolenaar <bram@vim.org>
parents:
4869
diff
changeset
|
4423 'imstatusfunc' 'imsf' string (default "") |
|
3717d569027d
updated for version 7.3.1248
Bram Moolenaar <bram@vim.org>
parents:
4869
diff
changeset
|
4424 global |
|
3717d569027d
updated for version 7.3.1248
Bram Moolenaar <bram@vim.org>
parents:
4869
diff
changeset
|
4425 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
|
4426 of Input Method. It must return a positive number when IME is active. |
|
26408
8f17f8f327f3
patch 8.2.3735: cannot use a lambda for 'imactivatefunc'
Bram Moolenaar <Bram@vim.org>
parents:
26388
diff
changeset
|
4427 The value can be the name of a function, a |lambda| or a |Funcref|. |
|
8f17f8f327f3
patch 8.2.3735: cannot use a lambda for 'imactivatefunc'
Bram Moolenaar <Bram@vim.org>
parents:
26388
diff
changeset
|
4428 See |option-value-function| for more information. |
|
21112
2d3cd9acf853
patch 8.2.1107: 'imactivatefunc' and 'imstatusfunc' are not used in the GUI
Bram Moolenaar <Bram@vim.org>
parents:
20856
diff
changeset
|
4429 It is not used in the MS-Windows GUI version. |
|
5008
3717d569027d
updated for version 7.3.1248
Bram Moolenaar <bram@vim.org>
parents:
4869
diff
changeset
|
4430 |
|
3717d569027d
updated for version 7.3.1248
Bram Moolenaar <bram@vim.org>
parents:
4869
diff
changeset
|
4431 Example: > |
|
3717d569027d
updated for version 7.3.1248
Bram Moolenaar <bram@vim.org>
parents:
4869
diff
changeset
|
4432 function ImStatusFunc() |
|
3717d569027d
updated for version 7.3.1248
Bram Moolenaar <bram@vim.org>
parents:
4869
diff
changeset
|
4433 let is_active = ...do something |
|
3717d569027d
updated for version 7.3.1248
Bram Moolenaar <bram@vim.org>
parents:
4869
diff
changeset
|
4434 return is_active ? 1 : 0 |
|
3717d569027d
updated for version 7.3.1248
Bram Moolenaar <bram@vim.org>
parents:
4869
diff
changeset
|
4435 endfunction |
|
3717d569027d
updated for version 7.3.1248
Bram Moolenaar <bram@vim.org>
parents:
4869
diff
changeset
|
4436 set imstatusfunc=ImStatusFunc |
|
3717d569027d
updated for version 7.3.1248
Bram Moolenaar <bram@vim.org>
parents:
4869
diff
changeset
|
4437 < |
|
3717d569027d
updated for version 7.3.1248
Bram Moolenaar <bram@vim.org>
parents:
4869
diff
changeset
|
4438 NOTE: This function is invoked very often. Keep it fast. |
|
16728
e55c26aaf484
patch 8.1.1366: using expressions in a modeline is unsafe
Bram Moolenaar <Bram@vim.org>
parents:
16610
diff
changeset
|
4439 The expression will be evaluated in the |sandbox| when set from a |
|
e55c26aaf484
patch 8.1.1366: using expressions in a modeline is unsafe
Bram Moolenaar <Bram@vim.org>
parents:
16610
diff
changeset
|
4440 modeline, see |sandbox-option|. |
|
5008
3717d569027d
updated for version 7.3.1248
Bram Moolenaar <bram@vim.org>
parents:
4869
diff
changeset
|
4441 |
|
12293
1ff5e5dfa9b0
patch 8.0.1026: GTK on-the-spot input has problems
Christian Brabandt <cb@256bit.org>
parents:
12254
diff
changeset
|
4442 *'imstyle'* *'imst'* |
|
1ff5e5dfa9b0
patch 8.0.1026: GTK on-the-spot input has problems
Christian Brabandt <cb@256bit.org>
parents:
12254
diff
changeset
|
4443 'imstyle' 'imst' number (default 1) |
|
1ff5e5dfa9b0
patch 8.0.1026: GTK on-the-spot input has problems
Christian Brabandt <cb@256bit.org>
parents:
12254
diff
changeset
|
4444 global |
|
1ff5e5dfa9b0
patch 8.0.1026: GTK on-the-spot input has problems
Christian Brabandt <cb@256bit.org>
parents:
12254
diff
changeset
|
4445 {only available when compiled with |+xim| and |
|
1ff5e5dfa9b0
patch 8.0.1026: GTK on-the-spot input has problems
Christian Brabandt <cb@256bit.org>
parents:
12254
diff
changeset
|
4446 |+GUI_GTK|} |
| 12499 | 4447 This option specifies the input style of Input Method: |
| 4448 0 use on-the-spot style | |
| 4449 1 over-the-spot style | |
|
12293
1ff5e5dfa9b0
patch 8.0.1026: GTK on-the-spot input has problems
Christian Brabandt <cb@256bit.org>
parents:
12254
diff
changeset
|
4450 See: |xim-input-style| |
|
1ff5e5dfa9b0
patch 8.0.1026: GTK on-the-spot input has problems
Christian Brabandt <cb@256bit.org>
parents:
12254
diff
changeset
|
4451 |
| 12559 | 4452 For a long time on-the-spot style had been used in the GTK version of |
| 4453 vim, however, it is known that it causes troubles when using mappings, | |
|
12293
1ff5e5dfa9b0
patch 8.0.1026: GTK on-the-spot input has problems
Christian Brabandt <cb@256bit.org>
parents:
12254
diff
changeset
|
4454 |single-repeat|, etc. Therefore over-the-spot style becomes the |
|
1ff5e5dfa9b0
patch 8.0.1026: GTK on-the-spot input has problems
Christian Brabandt <cb@256bit.org>
parents:
12254
diff
changeset
|
4455 default now. This should work fine for most people, however if you |
|
1ff5e5dfa9b0
patch 8.0.1026: GTK on-the-spot input has problems
Christian Brabandt <cb@256bit.org>
parents:
12254
diff
changeset
|
4456 have any problem with it, try using on-the-spot style. |
|
16728
e55c26aaf484
patch 8.1.1366: using expressions in a modeline is unsafe
Bram Moolenaar <Bram@vim.org>
parents:
16610
diff
changeset
|
4457 The expression will be evaluated in the |sandbox| when set from a |
|
e55c26aaf484
patch 8.1.1366: using expressions in a modeline is unsafe
Bram Moolenaar <Bram@vim.org>
parents:
16610
diff
changeset
|
4458 modeline, see |sandbox-option|. |
|
12293
1ff5e5dfa9b0
patch 8.0.1026: GTK on-the-spot input has problems
Christian Brabandt <cb@256bit.org>
parents:
12254
diff
changeset
|
4459 |
| 7 | 4460 *'include'* *'inc'* |
| 4461 'include' 'inc' string (default "^\s*#\s*include") | |
| 4462 global or local to buffer |global-local| | |
| 4463 {not available when compiled without the | |
| 4464 |+find_in_path| feature} | |
| 10 | 4465 Pattern to be used to find an include command. It is a search |
| 7 | 4466 pattern, just like for the "/" command (See |pattern|). The default |
| 4467 value is for C programs. This option is used for the commands "[i", | |
| 532 | 4468 "]I", "[d", etc. |
| 4469 Normally the 'isfname' option is used to recognize the file name that | |
| 534 | 4470 comes after the matched pattern. But if "\zs" appears in the pattern |
| 4471 then the text matched from "\zs" to the end, or until "\ze" if it | |
| 4472 appears, is used as the file name. Use this to include characters | |
| 4473 that are not in 'isfname', such as a space. You can then use | |
| 4474 'includeexpr' to process the matched text. | |
| 532 | 4475 See |option-backslash| about including spaces and backslashes. |
| 7 | 4476 |
| 4477 *'includeexpr'* *'inex'* | |
| 4478 'includeexpr' 'inex' string (default "") | |
| 4479 local to buffer | |
| 4480 {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
|
4481 |+find_in_path| or |+eval| features} |
| 7 | 4482 Expression to be used to transform the string found with the 'include' |
| 10 | 4483 option to a file name. Mostly useful to change "." to "/" for Java: > |
| 7 | 4484 :set includeexpr=substitute(v:fname,'\\.','/','g') |
| 4485 < The "v:fname" variable will be set to the file name that was detected. | |
| 634 | 4486 |
| 7 | 4487 Also used for the |gf| command if an unmodified file name can't be |
| 10 | 4488 found. Allows doing "gf" on the name after an 'include' statement. |
| 7 | 4489 Also used for |<cfile>|. |
| 4490 | |
|
26743
c2c40cefc17b
patch 8.2.3900: it is not easy to use a script-local function for an option
Bram Moolenaar <Bram@vim.org>
parents:
26708
diff
changeset
|
4491 If the expression starts with s: or |<SID>|, then it is replaced with |
|
c2c40cefc17b
patch 8.2.3900: it is not easy to use a script-local function for an option
Bram Moolenaar <Bram@vim.org>
parents:
26708
diff
changeset
|
4492 the script ID (|local-function|). Example: > |
|
c2c40cefc17b
patch 8.2.3900: it is not easy to use a script-local function for an option
Bram Moolenaar <Bram@vim.org>
parents:
26708
diff
changeset
|
4493 set includeexpr=s:MyIncludeExpr(v:fname) |
|
c2c40cefc17b
patch 8.2.3900: it is not easy to use a script-local function for an option
Bram Moolenaar <Bram@vim.org>
parents:
26708
diff
changeset
|
4494 set includeexpr=<SID>SomeIncludeExpr(v:fname) |
| 27321 | 4495 < Otherwise, the expression is evaluated in the context of the script |
| 4496 where the option was set, thus script-local items are available. | |
| 4497 | |
| 3682 | 4498 The expression will be evaluated in the |sandbox| when set from a |
| 4499 modeline, see |sandbox-option|. | |
|
16728
e55c26aaf484
patch 8.1.1366: using expressions in a modeline is unsafe
Bram Moolenaar <Bram@vim.org>
parents:
16610
diff
changeset
|
4500 This option cannot be set in a modeline when 'modelineexpr' is off. |
| 634 | 4501 |
| 4502 It is not allowed to change text or jump to another window while | |
| 4503 evaluating 'includeexpr' |textlock|. | |
| 4504 | |
| 7 | 4505 *'incsearch'* *'is'* *'noincsearch'* *'nois'* |
|
9669
284b4eb307fc
commit https://github.com/vim/vim/commit/8c08b5b569e2a9e9f63dea514591ecfa2d3bb392
Christian Brabandt <cb@256bit.org>
parents:
9665
diff
changeset
|
4506 '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
|
4507 +reltime feature is supported) |
| 7 | 4508 global |
| 4509 {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
|
4510 |+extra_search| features} |
| 17 | 4511 While typing a search command, show where the pattern, as it was typed |
| 4512 so far, matches. The matched string is highlighted. If the pattern | |
| 4513 is invalid or not found, nothing is shown. The screen will be updated | |
| 4514 often, this is only useful on fast terminals. | |
| 14637 | 4515 Also applies to the pattern in commands: > |
| 4516 :global | |
| 4517 :lvimgrep | |
| 4518 :lvimgrepadd | |
| 4519 :smagic | |
| 4520 :snomagic | |
| 4521 :sort | |
| 4522 :substitute | |
| 4523 :vglobal | |
| 4524 :vimgrep | |
| 4525 :vimgrepadd | |
| 4526 < Note that the match will be shown, but the cursor will return to its | |
| 17 | 4527 original position when no match is found and when pressing <Esc>. You |
| 4528 still need to finish the search command with <Enter> to move the | |
| 4529 cursor to the match. | |
|
10261
bdd7fc1a38c0
commit https://github.com/vim/vim/commit/dc08328821a2c11e33dfb1980332e4923ec64fca
Christian Brabandt <cb@256bit.org>
parents:
10244
diff
changeset
|
4530 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
|
4531 previous match. |c_CTRL-G| |c_CTRL-T| |
| 1521 | 4532 When compiled with the |+reltime| feature Vim only searches for about |
| 4533 half a second. With a complicated pattern and/or a lot of text the | |
| 4534 match may not be found. This is to avoid that Vim hangs while you | |
| 4535 are typing the pattern. | |
| 17 | 4536 The highlighting can be set with the 'i' flag in 'highlight'. |
| 12968 | 4537 When 'hlsearch' is on, all matched strings are highlighted too while |
| 4538 typing a search command. See also: 'hlsearch'. | |
| 14519 | 4539 If you don't want to turn 'hlsearch' on, but want to highlight all |
| 4540 matches while searching, you can turn on and off 'hlsearch' with | |
| 4541 autocmd. Example: > | |
|
12720
37c384802df4
patch 8.0.1238: incremental search only shows one match
Christian Brabandt <cb@256bit.org>
parents:
12608
diff
changeset
|
4542 augroup vimrc-incsearch-highlight |
|
37c384802df4
patch 8.0.1238: incremental search only shows one match
Christian Brabandt <cb@256bit.org>
parents:
12608
diff
changeset
|
4543 autocmd! |
|
12744
0c704288ced4
patch 8.0.1250: 'hlsearch' highlighting not removed after incsearch
Christian Brabandt <cb@256bit.org>
parents:
12720
diff
changeset
|
4544 autocmd CmdlineEnter /,\? :set hlsearch |
|
0c704288ced4
patch 8.0.1250: 'hlsearch' highlighting not removed after incsearch
Christian Brabandt <cb@256bit.org>
parents:
12720
diff
changeset
|
4545 autocmd CmdlineLeave /,\? :set nohlsearch |
|
12720
37c384802df4
patch 8.0.1238: incremental search only shows one match
Christian Brabandt <cb@256bit.org>
parents:
12608
diff
changeset
|
4546 augroup END |
|
37c384802df4
patch 8.0.1238: incremental search only shows one match
Christian Brabandt <cb@256bit.org>
parents:
12608
diff
changeset
|
4547 < |
| 772 | 4548 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
|
4549 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
|
4550 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
|
4551 converted to lowercase. |
| 772 | 4552 CTRL-R CTRL-W can be used to add the word at the end of the current |
| 4553 match, excluding the characters that were already typed. | |
| 7 | 4554 NOTE: This option is reset when 'compatible' is set. |
| 4555 | |
| 4556 *'indentexpr'* *'inde'* | |
| 4557 'indentexpr' 'inde' string (default "") | |
| 4558 local to buffer | |
| 4559 {not available when compiled without the |+cindent| | |
| 4560 or |+eval| features} | |
| 4561 Expression which is evaluated to obtain the proper indent for a line. | |
| 4562 It is used when a new line is created, for the |=| operator and | |
| 4563 in Insert mode as specified with the 'indentkeys' option. | |
| 4564 When this option is not empty, it overrules the 'cindent' and | |
| 2833 | 4565 'smartindent' indenting. When 'lisp' is set, this option is |
| 4566 overridden by the Lisp indentation algorithm. | |
| 7 | 4567 When 'paste' is set this option is not used for indenting. |
| 4568 The expression is evaluated with |v:lnum| set to the line number for | |
| 534 | 4569 which the indent is to be computed. The cursor is also in this line |
| 7 | 4570 when the expression is evaluated (but it may be moved around). |
| 27321 | 4571 |
|
26743
c2c40cefc17b
patch 8.2.3900: it is not easy to use a script-local function for an option
Bram Moolenaar <Bram@vim.org>
parents:
26708
diff
changeset
|
4572 If the expression starts with s: or |<SID>|, then it is replaced with |
|
c2c40cefc17b
patch 8.2.3900: it is not easy to use a script-local function for an option
Bram Moolenaar <Bram@vim.org>
parents:
26708
diff
changeset
|
4573 the script ID (|local-function|). Example: > |
|
c2c40cefc17b
patch 8.2.3900: it is not easy to use a script-local function for an option
Bram Moolenaar <Bram@vim.org>
parents:
26708
diff
changeset
|
4574 set indentexpr=s:MyIndentExpr() |
|
c2c40cefc17b
patch 8.2.3900: it is not easy to use a script-local function for an option
Bram Moolenaar <Bram@vim.org>
parents:
26708
diff
changeset
|
4575 set indentexpr=<SID>SomeIndentExpr() |
| 27321 | 4576 < Otherwise, the expression is evaluated in the context of the script |
| 4577 where the option was set, thus script-local items are available. | |
| 4578 | |
| 7 | 4579 The expression must return the number of spaces worth of indent. It |
| 4580 can return "-1" to keep the current indent (this means 'autoindent' is | |
| 4581 used for the indent). | |
| 4582 Functions useful for computing the indent are |indent()|, |cindent()| | |
| 4583 and |lispindent()|. | |
| 4584 The evaluation of the expression must not have side effects! It must | |
| 4585 not change the text, jump to another window, etc. Afterwards the | |
| 4586 cursor position is always restored, thus the cursor may be moved. | |
| 4587 Normally this option would be set to call a function: > | |
| 4588 :set indentexpr=GetMyIndent() | |
| 4589 < Error messages will be suppressed, unless the 'debug' option contains | |
| 4590 "msg". | |
| 634 | 4591 See |indent-expression|. |
| 11160 | 4592 NOTE: This option is set to "" when 'compatible' is set. |
| 7 | 4593 |
| 3682 | 4594 The expression will be evaluated in the |sandbox| when set from a |
| 4595 modeline, see |sandbox-option|. | |
|
16728
e55c26aaf484
patch 8.1.1366: using expressions in a modeline is unsafe
Bram Moolenaar <Bram@vim.org>
parents:
16610
diff
changeset
|
4596 This option cannot be set in a modeline when 'modelineexpr' is off. |
| 634 | 4597 |
| 4598 It is not allowed to change text or jump to another window while | |
| 4599 evaluating 'indentexpr' |textlock|. | |
| 4600 | |
| 4601 | |
| 7 | 4602 *'indentkeys'* *'indk'* |
|
15701
9cd11f6beb70
patch 8.1.0858: 'indentkeys' and 'cinkeys' defaults are different
Bram Moolenaar <Bram@vim.org>
parents:
15512
diff
changeset
|
4603 'indentkeys' 'indk' string (default "0{,0},0),0],:,0#,!^F,o,O,e") |
| 7 | 4604 local to buffer |
| 4605 {not available when compiled without the |+cindent| | |
| 4606 feature} | |
| 4607 A list of keys that, when typed in Insert mode, cause reindenting of | |
| 4608 the current line. Only happens if 'indentexpr' isn't empty. | |
| 4609 The format is identical to 'cinkeys', see |indentkeys-format|. | |
| 4610 See |C-indenting| and |indent-expression|. | |
| 4611 | |
| 4612 *'infercase'* *'inf'* *'noinfercase'* *'noinf'* | |
| 4613 'infercase' 'inf' boolean (default off) | |
| 4614 local to buffer | |
| 4615 When doing keyword completion in insert mode |ins-completion|, and | |
| 1621 | 4616 'ignorecase' is also on, the case of the match is adjusted depending |
| 4617 on the typed text. If the typed text contains a lowercase letter | |
| 4618 where the match has an upper case letter, the completed part is made | |
| 4619 lowercase. If the typed text has no lowercase letters and the match | |
| 4620 has a lowercase letter where the typed text has an uppercase letter, | |
| 4621 and there is a letter before it, the completed part is made uppercase. | |
| 4622 With 'noinfercase' the match is used as-is. | |
| 7 | 4623 |
| 4624 *'insertmode'* *'im'* *'noinsertmode'* *'noim'* | |
| 4625 'insertmode' 'im' boolean (default off) | |
| 4626 global | |
| 4627 Makes Vim work in a way that Insert mode is the default mode. Useful | |
| 4628 if you want to use Vim as a modeless editor. Used for |evim|. | |
| 4629 These Insert mode commands will be useful: | |
| 4630 - 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
|
4631 - Use CTRL-O to execute one Normal mode command |i_CTRL-O|. When |
| 7 | 4632 this is a mapping, it is executed as if 'insertmode' was off. |
| 4633 Normal mode remains active until the mapping is finished. | |
| 4634 - Use CTRL-L to execute a number of Normal mode commands, then use | |
| 477 | 4635 <Esc> to get back to Insert mode. Note that CTRL-L moves the cursor |
| 4636 left, like <Esc> does when 'insertmode' isn't set. |i_CTRL-L| | |
| 7 | 4637 |
| 4638 These items change when 'insertmode' is set: | |
| 4639 - when starting to edit of a file, Vim goes to Insert mode. | |
| 4640 - <Esc> in Insert mode is a no-op and beeps. | |
| 4641 - <Esc> in Normal mode makes Vim go to Insert mode. | |
| 4642 - CTRL-L in Insert mode is a command, it is not inserted. | |
| 4643 - CTRL-Z in Insert mode suspends Vim, see |CTRL-Z|. *i_CTRL-Z* | |
| 4644 However, when <Esc> is used inside a mapping, it behaves like | |
| 4645 'insertmode' was not set. This was done to be able to use the same | |
| 4646 mappings with 'insertmode' set or not set. | |
| 4647 When executing commands with |:normal| 'insertmode' is not used. | |
| 4648 | |
| 4649 NOTE: This option is reset when 'compatible' is set. | |
| 4650 | |
| 4651 *'isfname'* *'isf'* | |
|
18912
ccd16426a1f9
patch 8.2.0017: OS/2 and MS-DOS are still mentioned
Bram Moolenaar <Bram@vim.org>
parents:
18879
diff
changeset
|
4652 'isfname' 'isf' string (default for Win32: |
| 7 | 4653 "@,48-57,/,\,.,-,_,+,,,#,$,%,{,},[,],:,@-@,!,~,=" |
| 4654 for AMIGA: "@,48-57,/,.,-,_,+,,,$,:" | |
| 4655 for VMS: "@,48-57,/,.,-,_,+,,,#,$,%,<,>,[,],:,;,~" | |
| 4656 for OS/390: "@,240-249,/,.,-,_,+,,,#,$,%,~,=" | |
| 4657 otherwise: "@,48-57,/,.,-,_,+,,,#,$,%,~,=") | |
| 4658 global | |
| 4659 The characters specified by this option are included in file names and | |
| 4660 path names. Filenames are used for commands like "gf", "[i" and in | |
| 10 | 4661 the tags file. It is also used for "\f" in a |pattern|. |
| 7 | 4662 Multi-byte characters 256 and above are always included, only the |
| 4663 characters up to 255 are specified with this option. | |
| 4664 For UTF-8 the characters 0xa0 to 0xff are included as well. | |
| 1621 | 4665 Think twice before adding white space to this option. Although a |
| 4666 space may appear inside a file name, the effect will be that Vim | |
| 4667 doesn't know where a file name starts or ends when doing completion. | |
| 4668 It most likely works better without a space in 'isfname'. | |
| 7 | 4669 |
| 4670 Note that on systems using a backslash as path separator, Vim tries to | |
| 4671 do its best to make it work as you would expect. That is a bit | |
| 4672 tricky, since Vi originally used the backslash to escape special | |
| 4673 characters. Vim will not remove a backslash in front of a normal file | |
| 4674 name character on these systems, but it will on Unix and alikes. The | |
| 4675 '&' and '^' are not included by default, because these are special for | |
| 4676 cmd.exe. | |
| 4677 | |
| 4678 The format of this option is a list of parts, separated with commas. | |
| 10 | 4679 Each part can be a single character number or a range. A range is two |
| 4680 character numbers with '-' in between. A character number can be a | |
| 7 | 4681 decimal number between 0 and 255 or the ASCII character itself (does |
| 4682 not work for digits). Example: | |
| 4683 "_,-,128-140,#-43" (include '_' and '-' and the range | |
| 4684 128 to 140 and '#' to 43) | |
| 4685 If a part starts with '^', the following character number or range | |
| 4686 will be excluded from the option. The option is interpreted from left | |
| 4687 to right. Put the excluded character after the range where it is | |
| 4688 included. To include '^' itself use it as the last character of the | |
| 4689 option or the end of a range. Example: | |
| 4690 "^a-z,#,^" (exclude 'a' to 'z', include '#' and '^') | |
| 4691 If the character is '@', all characters where isalpha() returns TRUE | |
| 4692 are included. Normally these are the characters a to z and A to Z, | |
| 4693 plus accented characters. To include '@' itself use "@-@". Examples: | |
| 4694 "@,^a-z" All alphabetic characters, excluding lower | |
| 1621 | 4695 case ASCII letters. |
| 7 | 4696 "a-z,A-Z,@-@" All letters plus the '@' character. |
| 4697 A comma can be included by using it where a character number is | |
| 4698 expected. Example: | |
| 4699 "48-57,,,_" Digits, comma and underscore. | |
| 4700 A comma can be excluded by prepending a '^'. Example: | |
| 4701 " -~,^,,9" All characters from space to '~', excluding | |
| 4702 comma, plus <Tab>. | |
| 4703 See |option-backslash| about including spaces and backslashes. | |
| 4704 | |
| 4705 *'isident'* *'isi'* | |
|
18912
ccd16426a1f9
patch 8.2.0017: OS/2 and MS-DOS are still mentioned
Bram Moolenaar <Bram@vim.org>
parents:
18879
diff
changeset
|
4706 'isident' 'isi' string (default for Win32: |
| 7 | 4707 "@,48-57,_,128-167,224-235" |
| 4708 otherwise: "@,48-57,_,192-255") | |
| 4709 global | |
| 4710 The characters given by this option are included in identifiers. | |
| 4711 Identifiers are used in recognizing environment variables and after a | |
| 4712 match of the 'define' option. It is also used for "\i" in a | |
| 233 | 4713 |pattern|. See 'isfname' for a description of the format of this |
| 14864 | 4714 option. For '@' only characters up to 255 are used. |
| 7 | 4715 Careful: If you change this option, it might break expanding |
| 10 | 4716 environment variables. E.g., when '/' is included and Vim tries to |
| 7 | 4717 expand "$HOME/.viminfo". Maybe you should change 'iskeyword' instead. |
| 4718 | |
| 4719 *'iskeyword'* *'isk'* | |
|
18912
ccd16426a1f9
patch 8.2.0017: OS/2 and MS-DOS are still mentioned
Bram Moolenaar <Bram@vim.org>
parents:
18879
diff
changeset
|
4720 'iskeyword' 'isk' string (Vim default for Win32: |
| 7 | 4721 "@,48-57,_,128-167,224-235" |
| 4722 otherwise: "@,48-57,_,192-255" | |
| 4723 Vi default: "@,48-57,_") | |
| 4724 local to buffer | |
| 4725 Keywords are used in searching and recognizing with many commands: | |
| 10 | 4726 "w", "*", "[i", etc. It is also used for "\k" in a |pattern|. See |
| 14864 | 4727 'isfname' for a description of the format of this option. For '@' |
| 24569 | 4728 characters above 255 check the "word" character class (any character |
| 4729 that is not white space or punctuation). | |
| 14864 | 4730 For C programs you could use "a-z,A-Z,48-57,_,.,-,>". |
| 7 | 4731 For a help file it is set to all non-blank printable characters except |
| 4732 '*', '"' and '|' (so that CTRL-] on a command finds the help for that | |
| 4733 command). | |
| 4734 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
|
4735 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
|
4736 uses |:syn-iskeyword|. |
| 7 | 4737 NOTE: This option is set to the Vi default value when 'compatible' is |
| 4738 set and to the Vim default value when 'compatible' is reset. | |
| 4739 | |
| 4740 *'isprint'* *'isp'* | |
| 21825 | 4741 'isprint' 'isp' string (default for Win32 and macOS: |
| 7 | 4742 "@,~-255"; otherwise: "@,161-255") |
| 4743 global | |
| 4744 The characters given by this option are displayed directly on the | |
| 4745 screen. It is also used for "\p" in a |pattern|. The characters from | |
| 4746 space (ASCII 32) to '~' (ASCII 126) are always displayed directly, | |
| 4747 even when they are not included in 'isprint' or excluded. See | |
| 4748 'isfname' for a description of the format of this option. | |
| 4749 | |
| 4750 Non-printable characters are displayed with two characters: | |
| 4751 0 - 31 "^@" - "^_" | |
| 4752 32 - 126 always single characters | |
| 4753 127 "^?" | |
| 4754 128 - 159 "~@" - "~_" | |
| 4755 160 - 254 "| " - "|~" | |
| 4756 255 "~?" | |
| 4757 When 'encoding' is a Unicode one, illegal bytes from 128 to 255 are | |
| 4758 displayed as <xx>, with the hexadecimal value of the byte. | |
| 4759 When 'display' contains "uhex" all unprintable characters are | |
| 4760 displayed as <xx>. | |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
4761 The SpecialKey highlighting will be used for unprintable characters. |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
4762 |hl-SpecialKey| |
| 7 | 4763 |
| 4764 Multi-byte characters 256 and above are always included, only the | |
| 4765 characters up to 255 are specified with this option. When a character | |
| 4766 is printable but it is not available in the current font, a | |
| 4767 replacement character will be shown. | |
| 4768 Unprintable and zero-width Unicode characters are displayed as <xxxx>. | |
| 4769 There is no option to specify these characters. | |
| 4770 | |
| 4771 *'joinspaces'* *'js'* *'nojoinspaces'* *'nojs'* | |
| 4772 'joinspaces' 'js' boolean (default on) | |
| 4773 global | |
| 4774 Insert two spaces after a '.', '?' and '!' with a join command. | |
| 4775 When 'cpoptions' includes the 'j' flag, only do this after a '.'. | |
| 4776 Otherwise only one space is inserted. | |
| 4777 NOTE: This option is set when 'compatible' is set. | |
| 4778 | |
| 4779 *'key'* | |
| 4780 'key' string (default "") | |
| 4781 local to buffer | |
|
2283
7e1bd501306d
Mainly documentation updates.
Bram Moolenaar <bram@vim.org>
parents:
2265
diff
changeset
|
4782 {only available when compiled with the |+cryptv| |
|
7e1bd501306d
Mainly documentation updates.
Bram Moolenaar <bram@vim.org>
parents:
2265
diff
changeset
|
4783 feature} |
| 7 | 4784 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
|
4785 See |encryption| and 'cryptmethod'. |
| 7 | 4786 Careful: Do not set the key value by hand, someone might see the typed |
| 4787 key. Use the |:X| command. But you can make 'key' empty: > | |
| 4788 :set key= | |
| 4789 < It is not possible to get the value of this option with ":set key" or | |
| 4790 "echo &key". This is to avoid showing it to someone who shouldn't | |
| 4791 know. It also means you cannot see it yourself once you have set it, | |
| 4792 be careful not to make a typing error! | |
|
2698
b6471224d2af
Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents:
2681
diff
changeset
|
4793 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
|
4794 enabled. When 'key' is set it returns "*****" (five stars). |
| 7 | 4795 |
| 4796 *'keymap'* *'kmp'* *E544* | |
| 4797 'keymap' 'kmp' string (default "") | |
| 4798 local to buffer | |
| 4799 {only available when compiled with the |+keymap| | |
| 4800 feature} | |
| 4801 Name of a keyboard mapping. See |mbyte-keymap|. | |
| 4802 Setting this option to a valid keymap name has the side effect of | |
| 4803 setting 'iminsert' to one, so that the keymap becomes effective. | |
| 4804 'imsearch' is also set to one, unless it was -1 | |
| 36 | 4805 Only normal file name characters can be used, "/\*?[|<>" are illegal. |
| 7 | 4806 |
| 4807 *'keymodel'* *'km'* | |
| 4808 'keymodel' 'km' string (default "") | |
| 4809 global | |
| 4810 List of comma separated words, which enable special things that keys | |
| 4811 can do. These values can be used: | |
| 4812 startsel Using a shifted special key starts selection (either | |
| 4813 Select mode or Visual mode, depending on "key" being | |
| 4814 present in 'selectmode'). | |
| 4815 stopsel Using a not-shifted special key stops selection. | |
| 4816 Special keys in this context are the cursor keys, <End>, <Home>, | |
| 4817 <PageUp> and <PageDown>. | |
| 4818 The 'keymodel' option is set by the |:behave| command. | |
| 4819 | |
| 4820 *'keywordprg'* *'kp'* | |
| 4821 '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
|
4822 VMS: "help") |
| 7 | 4823 global or local to buffer |global-local| |
| 4824 Program to use for the |K| command. Environment variables are | |
| 4825 expanded |:set_env|. ":help" may be used to access the Vim internal | |
| 4826 help. (Note that previously setting the global option to the empty | |
| 4827 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
|
4828 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
|
4829 Ex command prefixed with [count]. |
|
0d52ddff8db4
commit https://github.com/vim/vim/commit/2ff8b64679242e73248774a388d54931c9ce49bd
Christian Brabandt <cb@256bit.org>
parents:
9097
diff
changeset
|
4830 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
|
4831 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
|
4832 argument. For "man -s" the "-s" is removed when there is no count. |
| 7 | 4833 See |option-backslash| about including spaces and backslashes. |
| 4834 Example: > | |
| 4835 :set keywordprg=man\ -s | |
| 4836 < This option cannot be set from a |modeline| or in the |sandbox|, for | |
| 4837 security reasons. | |
| 4838 | |
| 4839 *'langmap'* *'lmap'* *E357* *E358* | |
| 4840 'langmap' 'lmap' string (default "") | |
| 4841 global | |
| 4842 {only available when compiled with the |+langmap| | |
| 4843 feature} | |
| 4844 This option allows switching your keyboard into a special language | |
| 10 | 4845 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
|
4846 inserted directly. When in Normal mode the 'langmap' option takes |
| 7 | 4847 care of translating these special characters to the original meaning |
| 4848 of the key. This means you don't have to change the keyboard mode to | |
| 4849 be able to execute Normal mode commands. | |
| 4850 This is the opposite of the 'keymap' option, where characters are | |
| 4851 mapped in Insert mode. | |
| 19646 | 4852 Also consider setting 'langremap' to off, to prevent 'langmap' from |
| 4853 applying to characters resulting from a mapping. | |
| 5908 | 4854 This option cannot be set from a |modeline| or in the |sandbox|, for |
| 4855 security reasons. | |
| 7 | 4856 |
| 699 | 4857 Example (for Greek, in UTF-8): *greek* > |
| 4858 :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 | 4859 < Example (exchanges meaning of z and y for commands): > |
| 4860 :set langmap=zy,yz,ZY,YZ | |
| 4861 < | |
| 4862 The 'langmap' option is a list of parts, separated with commas. Each | |
| 4863 part can be in one of two forms: | |
| 4864 1. A list of pairs. Each pair is a "from" character immediately | |
| 4865 followed by the "to" character. Examples: "aA", "aAbBcC". | |
| 4866 2. A list of "from" characters, a semi-colon and a list of "to" | |
| 4867 characters. Example: "abc;ABC" | |
| 4868 Example: "aA,fgh;FGH,cCdDeE" | |
| 4869 Special characters need to be preceded with a backslash. These are | |
| 22565 | 4870 ";", ',', '"', '|' and backslash itself. |
| 7 | 4871 |
| 4872 This will allow you to activate vim actions without having to switch | |
| 4873 back and forth between the languages. Your language characters will | |
| 4874 be understood as normal vim English characters (according to the | |
| 4875 langmap mappings) in the following cases: | |
| 4876 o Normal/Visual mode (commands, buffer/register names, user mappings) | |
| 4877 o Insert/Replace Mode: Register names after CTRL-R | |
| 4878 o Insert/Replace Mode: Mappings | |
| 4879 Characters entered in Command-line mode will NOT be affected by | |
| 4880 this option. Note that this option can be changed at any time | |
| 4881 allowing to switch between mappings for different languages/encodings. | |
| 4882 Use a mapping to avoid having to type it each time! | |
| 4883 | |
| 4884 *'langmenu'* *'lm'* | |
| 4885 'langmenu' 'lm' string (default "") | |
| 4886 global | |
| 4887 {only available when compiled with the |+menu| and | |
| 4888 |+multi_lang| features} | |
| 4889 Language to use for menu translation. Tells which file is loaded | |
| 4890 from the "lang" directory in 'runtimepath': > | |
| 27903 | 4891 "lang/menu_" .. &langmenu .. ".vim" |
| 7 | 4892 < (without the spaces). For example, to always use the Dutch menus, no |
| 4893 matter what $LANG is set to: > | |
| 4894 :set langmenu=nl_NL.ISO_8859-1 | |
| 4895 < When 'langmenu' is empty, |v:lang| is used. | |
| 36 | 4896 Only normal file name characters can be used, "/\*?[|<>" are illegal. |
| 7 | 4897 If your $LANG is set to a non-English language but you do want to use |
| 4898 the English menus: > | |
| 4899 :set langmenu=none | |
| 4900 < This option must be set before loading menus, switching on filetype | |
| 4901 detection or syntax highlighting. Once the menus are defined setting | |
| 4902 this option has no effect. But you could do this: > | |
| 4903 :source $VIMRUNTIME/delmenu.vim | |
| 4904 :set langmenu=de_DE.ISO_8859-1 | |
| 4905 :source $VIMRUNTIME/menu.vim | |
| 4906 < Warning: This deletes all menus that you defined yourself! | |
| 4907 | |
|
7196
42717d048817
commit https://github.com/vim/vim/commit/d94464ee294a351ce7b6ba18e8bd3f24f1bef920
Christian Brabandt <cb@256bit.org>
parents:
7147
diff
changeset
|
4908 *'langnoremap'* *'lnr'* *'nolangnoremap'* *'nolnr'* |
|
9669
284b4eb307fc
commit https://github.com/vim/vim/commit/8c08b5b569e2a9e9f63dea514591ecfa2d3bb392
Christian Brabandt <cb@256bit.org>
parents:
9665
diff
changeset
|
4909 'langnoremap' 'lnr' boolean (default off, set in |defaults.vim|) |
| 6339 | 4910 global |
| 4911 {only available when compiled with the |+langmap| | |
| 4912 feature} | |
|
9975
03fa8a51e9dc
commit https://github.com/vim/vim/commit/e4a3bcf28d92d0bde9ca227ccb40d401038185e5
Christian Brabandt <cb@256bit.org>
parents:
9913
diff
changeset
|
4913 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
|
4914 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
|
4915 '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
|
4916 |
|
03fa8a51e9dc
commit https://github.com/vim/vim/commit/e4a3bcf28d92d0bde9ca227ccb40d401038185e5
Christian Brabandt <cb@256bit.org>
parents:
9913
diff
changeset
|
4917 *'langremap'* *'lrm'* *'nolangremap'* *'nolrm'* |
| 19646 | 4918 'langremap' 'lrm' boolean (default on, set to off in |defaults.vim|) |
|
9975
03fa8a51e9dc
commit https://github.com/vim/vim/commit/e4a3bcf28d92d0bde9ca227ccb40d401038185e5
Christian Brabandt <cb@256bit.org>
parents:
9913
diff
changeset
|
4919 global |
|
03fa8a51e9dc
commit https://github.com/vim/vim/commit/e4a3bcf28d92d0bde9ca227ccb40d401038185e5
Christian Brabandt <cb@256bit.org>
parents:
9913
diff
changeset
|
4920 {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
|
4921 feature} |
|
03fa8a51e9dc
commit https://github.com/vim/vim/commit/e4a3bcf28d92d0bde9ca227ccb40d401038185e5
Christian Brabandt <cb@256bit.org>
parents:
9913
diff
changeset
|
4922 When off, setting 'langmap' does not apply to characters resulting from |
| 6339 | 4923 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
|
4924 '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
|
4925 This option defaults to on for backwards compatibility. Set it off if |
| 6339 | 4926 that works for you to avoid mappings to break. |
| 4927 | |
| 7 | 4928 *'laststatus'* *'ls'* |
| 4929 'laststatus' 'ls' number (default 1) | |
| 4930 global | |
| 4931 The value of this option influences when the last window will have a | |
| 4932 status line: | |
| 4933 0: never | |
| 4934 1: only if there are at least two windows | |
| 4935 2: always | |
| 4936 The screen looks nicer with a status line if you have several | |
| 4937 windows, but it takes another screen line. |status-line| | |
| 4938 | |
| 4939 *'lazyredraw'* *'lz'* *'nolazyredraw'* *'nolz'* | |
| 4940 'lazyredraw' 'lz' boolean (default off) | |
| 4941 global | |
| 4942 When this option is set, the screen will not be redrawn while | |
| 4943 executing macros, registers and other commands that have not been | |
| 10 | 4944 typed. Also, updating the window title is postponed. To force an |
| 7 | 4945 update use |:redraw|. |
| 4946 | |
| 4947 *'linebreak'* *'lbr'* *'nolinebreak'* *'nolbr'* | |
| 4948 'linebreak' 'lbr' boolean (default off) | |
| 4949 local to window | |
|
2570
71b56b4e7785
Make the references to features in the help more consistent. (Sylvain Hitier)
Bram Moolenaar <bram@vim.org>
parents:
2561
diff
changeset
|
4950 {not available when compiled without the |+linebreak| |
| 7 | 4951 feature} |
| 6009 | 4952 If on, Vim will wrap long lines at a character in 'breakat' rather |
| 7 | 4953 than at the last character that fits on the screen. Unlike |
| 4954 'wrapmargin' and 'textwidth', this does not insert <EOL>s in the file, | |
| 6009 | 4955 it only affects the way the file is displayed, not its contents. |
| 4956 If 'breakindent' is set, line is visually indented. Then, the value | |
| 4957 of 'showbreak' is used to put in front of wrapped lines. This option | |
| 6026 | 4958 is not used when the 'wrap' option is off. |
| 7 | 4959 Note that <Tab> characters after an <EOL> are mostly not displayed |
| 4960 with the right amount of white space. | |
| 4961 | |
| 4962 *'lines'* *E593* | |
| 4963 'lines' number (default 24 or terminal height) | |
| 4964 global | |
| 4965 Number of lines of the Vim window. | |
| 4966 Normally you don't need to set this. It is done automatically by the | |
| 161 | 4967 terminal initialization code. Also see |posix-screen-size|. |
| 7 | 4968 When Vim is running in the GUI or in a resizable window, setting this |
| 4969 option will cause the window size to be changed. When you only want | |
| 4970 to use the size for the GUI, put the command in your |gvimrc| file. | |
| 4971 Vim limits the number of lines to what fits on the screen. You can | |
| 4972 use this command to get the tallest window possible: > | |
| 4973 :set lines=999 | |
| 571 | 4974 < 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
|
4975 If you get fewer lines than expected, check the 'guiheadroom' option. |
| 7 | 4976 When you set this option and Vim is unable to change the physical |
| 4977 number of lines of the display, the display may be messed up. | |
| 4978 | |
| 4979 *'linespace'* *'lsp'* | |
| 4980 'linespace' 'lsp' number (default 0, 1 for Win32 GUI) | |
| 4981 global | |
| 4982 {only in the GUI} | |
| 4983 Number of pixel lines inserted between characters. Useful if the font | |
| 4984 uses the full character cell height, making lines touch each other. | |
| 4985 When non-zero there is room for underlining. | |
| 180 | 4986 With some fonts there can be too much room between lines (to have |
| 4987 space for ascents and descents). Then it makes sense to set | |
| 4988 'linespace' to a negative value. This may cause display problems | |
| 4989 though! | |
| 7 | 4990 |
| 4991 *'lisp'* *'nolisp'* | |
| 4992 'lisp' boolean (default off) | |
| 4993 local to buffer | |
| 4994 {not available when compiled without the |+lispindent| | |
| 4995 feature} | |
| 4996 Lisp mode: When <Enter> is typed in insert mode set the indent for | |
| 4997 the next line to Lisp standards (well, sort of). Also happens with | |
| 4998 "cc" or "S". 'autoindent' must also be on for this to work. The 'p' | |
| 4999 flag in 'cpoptions' changes the method of indenting: Vi compatible or | |
| 5000 better. Also see 'lispwords'. | |
| 5001 The '-' character is included in keyword characters. Redefines the | |
| 5002 "=" operator to use this same indentation algorithm rather than | |
| 5003 calling an external program if 'equalprg' is empty. | |
| 5004 This option is not used when 'paste' is set. | |
| 5005 | |
| 5006 *'lispwords'* *'lw'* | |
| 5007 'lispwords' 'lw' string (default is very long) | |
| 5712 | 5008 global or local to buffer |global-local| |
| 7 | 5009 {not available when compiled without the |+lispindent| |
| 5010 feature} | |
| 5011 Comma separated list of words that influence the Lisp indenting. | |
| 5012 |'lisp'| | |
| 5013 | |
| 5014 *'list'* *'nolist'* | |
| 5015 'list' boolean (default off) | |
| 5016 local to window | |
| 26100 | 5017 List mode: By default show tabs as CTRL-I is displayed, display $ |
| 5018 after end of line. Useful to see the difference between tabs and | |
| 5019 spaces and for trailing blanks. Further changed by the 'listchars' | |
| 5020 option. | |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
5021 |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
5022 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
|
5023 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
|
5024 position while displaying Tabs with spaces, use: > |
|
5161
f7add3891e95
Updated runtime files. Fix NL translations.
Bram Moolenaar <bram@vim.org>
parents:
5146
diff
changeset
|
5025 :set list lcs=tab:\ \ |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
5026 < |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
5027 Note that list mode will also affect formatting (set with 'textwidth' |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
5028 or 'wrapmargin') when 'cpoptions' includes 'L'. See 'listchars' for |
| 7 | 5029 changing the way tabs are displayed. |
| 5030 | |
| 5031 *'listchars'* *'lcs'* | |
| 5032 'listchars' 'lcs' string (default "eol:$") | |
|
23952
44be09b25619
patch 8.2.2518: 'listchars' should be window-local
Bram Moolenaar <Bram@vim.org>
parents:
23932
diff
changeset
|
5033 global or local to window |global-local| |
| 2458 | 5034 Strings to use in 'list' mode and for the |:list| command. It is a |
| 5035 comma separated list of string settings. | |
| 6777 | 5036 *lcs-eol* |
| 7 | 5037 eol:c Character to show at the end of each line. When |
| 5038 omitted, there is no extra character at the end of the | |
| 5039 line. | |
| 6777 | 5040 *lcs-tab* |
|
15502
bc17a9d37810
patch 8.1.0759: showing two characters for tab is limited
Bram Moolenaar <Bram@vim.org>
parents:
15396
diff
changeset
|
5041 tab:xy[z] Two or three characters to be used to show a tab. |
|
bc17a9d37810
patch 8.1.0759: showing two characters for tab is limited
Bram Moolenaar <Bram@vim.org>
parents:
15396
diff
changeset
|
5042 The third character is optional. |
|
bc17a9d37810
patch 8.1.0759: showing two characters for tab is limited
Bram Moolenaar <Bram@vim.org>
parents:
15396
diff
changeset
|
5043 |
|
bc17a9d37810
patch 8.1.0759: showing two characters for tab is limited
Bram Moolenaar <Bram@vim.org>
parents:
15396
diff
changeset
|
5044 tab:xy The 'x' is always used, then 'y' as many times as will |
|
bc17a9d37810
patch 8.1.0759: showing two characters for tab is limited
Bram Moolenaar <Bram@vim.org>
parents:
15396
diff
changeset
|
5045 fit. Thus "tab:>-" displays: |
|
bc17a9d37810
patch 8.1.0759: showing two characters for tab is limited
Bram Moolenaar <Bram@vim.org>
parents:
15396
diff
changeset
|
5046 > |
|
bc17a9d37810
patch 8.1.0759: showing two characters for tab is limited
Bram Moolenaar <Bram@vim.org>
parents:
15396
diff
changeset
|
5047 >- |
|
bc17a9d37810
patch 8.1.0759: showing two characters for tab is limited
Bram Moolenaar <Bram@vim.org>
parents:
15396
diff
changeset
|
5048 >-- |
|
bc17a9d37810
patch 8.1.0759: showing two characters for tab is limited
Bram Moolenaar <Bram@vim.org>
parents:
15396
diff
changeset
|
5049 etc. |
|
bc17a9d37810
patch 8.1.0759: showing two characters for tab is limited
Bram Moolenaar <Bram@vim.org>
parents:
15396
diff
changeset
|
5050 |
|
bc17a9d37810
patch 8.1.0759: showing two characters for tab is limited
Bram Moolenaar <Bram@vim.org>
parents:
15396
diff
changeset
|
5051 tab:xyz The 'z' is always used, then 'x' is prepended, and |
|
bc17a9d37810
patch 8.1.0759: showing two characters for tab is limited
Bram Moolenaar <Bram@vim.org>
parents:
15396
diff
changeset
|
5052 then 'y' is used as many times as will fit. Thus |
|
bc17a9d37810
patch 8.1.0759: showing two characters for tab is limited
Bram Moolenaar <Bram@vim.org>
parents:
15396
diff
changeset
|
5053 "tab:<->" displays: |
|
bc17a9d37810
patch 8.1.0759: showing two characters for tab is limited
Bram Moolenaar <Bram@vim.org>
parents:
15396
diff
changeset
|
5054 > |
|
bc17a9d37810
patch 8.1.0759: showing two characters for tab is limited
Bram Moolenaar <Bram@vim.org>
parents:
15396
diff
changeset
|
5055 <> |
|
bc17a9d37810
patch 8.1.0759: showing two characters for tab is limited
Bram Moolenaar <Bram@vim.org>
parents:
15396
diff
changeset
|
5056 <-> |
|
bc17a9d37810
patch 8.1.0759: showing two characters for tab is limited
Bram Moolenaar <Bram@vim.org>
parents:
15396
diff
changeset
|
5057 <--> |
|
bc17a9d37810
patch 8.1.0759: showing two characters for tab is limited
Bram Moolenaar <Bram@vim.org>
parents:
15396
diff
changeset
|
5058 etc. |
|
bc17a9d37810
patch 8.1.0759: showing two characters for tab is limited
Bram Moolenaar <Bram@vim.org>
parents:
15396
diff
changeset
|
5059 |
|
bc17a9d37810
patch 8.1.0759: showing two characters for tab is limited
Bram Moolenaar <Bram@vim.org>
parents:
15396
diff
changeset
|
5060 When "tab:" is omitted, a tab is shown as ^I. |
| 6777 | 5061 *lcs-space* |
| 5062 space:c Character to show for a space. When omitted, spaces | |
| 5063 are left blank. | |
|
25778
373278f5bd51
patch 8.2.3424: a sequence of spaces is hard to see in list mode
Bram Moolenaar <Bram@vim.org>
parents:
25773
diff
changeset
|
5064 *lcs-multispace* |
|
373278f5bd51
patch 8.2.3424: a sequence of spaces is hard to see in list mode
Bram Moolenaar <Bram@vim.org>
parents:
25773
diff
changeset
|
5065 multispace:c... |
|
373278f5bd51
patch 8.2.3424: a sequence of spaces is hard to see in list mode
Bram Moolenaar <Bram@vim.org>
parents:
25773
diff
changeset
|
5066 One or more characters to use cyclically to show for |
|
373278f5bd51
patch 8.2.3424: a sequence of spaces is hard to see in list mode
Bram Moolenaar <Bram@vim.org>
parents:
25773
diff
changeset
|
5067 multiple consecutive spaces. Overrides the "space" |
|
373278f5bd51
patch 8.2.3424: a sequence of spaces is hard to see in list mode
Bram Moolenaar <Bram@vim.org>
parents:
25773
diff
changeset
|
5068 setting, except for single spaces. When omitted, the |
|
373278f5bd51
patch 8.2.3424: a sequence of spaces is hard to see in list mode
Bram Moolenaar <Bram@vim.org>
parents:
25773
diff
changeset
|
5069 "space" setting is used. For example, |
|
373278f5bd51
patch 8.2.3424: a sequence of spaces is hard to see in list mode
Bram Moolenaar <Bram@vim.org>
parents:
25773
diff
changeset
|
5070 `:set listchars=multispace:---+` shows ten consecutive |
|
373278f5bd51
patch 8.2.3424: a sequence of spaces is hard to see in list mode
Bram Moolenaar <Bram@vim.org>
parents:
25773
diff
changeset
|
5071 spaces as: |
|
373278f5bd51
patch 8.2.3424: a sequence of spaces is hard to see in list mode
Bram Moolenaar <Bram@vim.org>
parents:
25773
diff
changeset
|
5072 ---+---+-- |
|
23825
0bd44e94dd14
patch 8.2.2454: leading space can not be made visible
Bram Moolenaar <Bram@vim.org>
parents:
23666
diff
changeset
|
5073 *lcs-lead* |
|
0bd44e94dd14
patch 8.2.2454: leading space can not be made visible
Bram Moolenaar <Bram@vim.org>
parents:
23666
diff
changeset
|
5074 lead:c Character to show for leading spaces. When omitted, |
|
25778
373278f5bd51
patch 8.2.3424: a sequence of spaces is hard to see in list mode
Bram Moolenaar <Bram@vim.org>
parents:
25773
diff
changeset
|
5075 leading spaces are blank. Overrides the "space" and |
|
373278f5bd51
patch 8.2.3424: a sequence of spaces is hard to see in list mode
Bram Moolenaar <Bram@vim.org>
parents:
25773
diff
changeset
|
5076 "multispace" settings for leading spaces. You can |
|
373278f5bd51
patch 8.2.3424: a sequence of spaces is hard to see in list mode
Bram Moolenaar <Bram@vim.org>
parents:
25773
diff
changeset
|
5077 combine it with "tab:", for example: > |
| 23931 | 5078 :set listchars+=tab:>-,lead:. |
| 5079 < *lcs-trail* | |
| 10 | 5080 trail:c Character to show for trailing spaces. When omitted, |
|
25778
373278f5bd51
patch 8.2.3424: a sequence of spaces is hard to see in list mode
Bram Moolenaar <Bram@vim.org>
parents:
25773
diff
changeset
|
5081 trailing spaces are blank. Overrides the "space" and |
|
373278f5bd51
patch 8.2.3424: a sequence of spaces is hard to see in list mode
Bram Moolenaar <Bram@vim.org>
parents:
25773
diff
changeset
|
5082 "multispace" settings for trailing spaces. |
| 6777 | 5083 *lcs-extends* |
| 7 | 5084 extends:c Character to show in the last column, when 'wrap' is |
| 5085 off and the line continues beyond the right of the | |
| 5086 screen. | |
| 6777 | 5087 *lcs-precedes* |
|
18131
851a014dfd8b
patch 8.1.2060: "precedes" in 'listchars' not used properly
Bram Moolenaar <Bram@vim.org>
parents:
18130
diff
changeset
|
5088 precedes:c Character to show in the first visible column of the |
|
851a014dfd8b
patch 8.1.2060: "precedes" in 'listchars' not used properly
Bram Moolenaar <Bram@vim.org>
parents:
18130
diff
changeset
|
5089 physical line, when there is text preceding the |
|
851a014dfd8b
patch 8.1.2060: "precedes" in 'listchars' not used properly
Bram Moolenaar <Bram@vim.org>
parents:
18130
diff
changeset
|
5090 character visible in the first column. |
| 6777 | 5091 *lcs-conceal* |
|
2250
1bac28a53fae
Add the conceal patch from Vince Negri.
Bram Moolenaar <bram@vim.org>
parents:
2249
diff
changeset
|
5092 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
|
5093 'conceallevel' is set to 1. |
| 6777 | 5094 *lcs-nbsp* |
| 6801 | 5095 nbsp:c Character to show for a non-breakable space character |
| 5096 (0xA0 (160 decimal) and U+202F). Left blank when | |
| 5097 omitted. | |
| 7 | 5098 |
| 10 | 5099 The characters ':' and ',' should not be used. UTF-8 characters can |
| 7 | 5100 be used when 'encoding' is "utf-8", otherwise only printable |
| 819 | 5101 characters are allowed. All characters must be single width. |
| 7 | 5102 |
|
25978
40b17deb294f
patch 8.2.3522: cannot use x and u when setting 'listchars'
Bram Moolenaar <Bram@vim.org>
parents:
25974
diff
changeset
|
5103 Each character can be specified as hex: > |
|
40b17deb294f
patch 8.2.3522: cannot use x and u when setting 'listchars'
Bram Moolenaar <Bram@vim.org>
parents:
25974
diff
changeset
|
5104 set listchars=eol:\\x24 |
|
40b17deb294f
patch 8.2.3522: cannot use x and u when setting 'listchars'
Bram Moolenaar <Bram@vim.org>
parents:
25974
diff
changeset
|
5105 set listchars=eol:\\u21b5 |
|
40b17deb294f
patch 8.2.3522: cannot use x and u when setting 'listchars'
Bram Moolenaar <Bram@vim.org>
parents:
25974
diff
changeset
|
5106 set listchars=eol:\\U000021b5 |
|
40b17deb294f
patch 8.2.3522: cannot use x and u when setting 'listchars'
Bram Moolenaar <Bram@vim.org>
parents:
25974
diff
changeset
|
5107 < Note that a double backslash is used. The number of hex characters |
|
40b17deb294f
patch 8.2.3522: cannot use x and u when setting 'listchars'
Bram Moolenaar <Bram@vim.org>
parents:
25974
diff
changeset
|
5108 must be exactly 2 for \\x, 4 for \\u and 8 for \\U. |
|
40b17deb294f
patch 8.2.3522: cannot use x and u when setting 'listchars'
Bram Moolenaar <Bram@vim.org>
parents:
25974
diff
changeset
|
5109 |
| 7 | 5110 Examples: > |
| 5111 :set lcs=tab:>-,trail:- | |
| 12 | 5112 :set lcs=tab:>-,eol:<,nbsp:% |
| 7 | 5113 :set lcs=extends:>,precedes:< |
| 5114 < The "NonText" highlighting will be used for "eol", "extends" and | |
| 25836 | 5115 "precedes". "SpecialKey" will be used for "tab", "nbsp", "space", |
| 5116 "multispace", "lead" and "trail". | |
| 1152 | 5117 |hl-NonText| |hl-SpecialKey| |
| 7 | 5118 |
| 5119 *'lpl'* *'nolpl'* *'loadplugins'* *'noloadplugins'* | |
| 5120 'loadplugins' 'lpl' boolean (default on) | |
| 5121 global | |
| 5122 When on the plugin scripts are loaded when starting up |load-plugins|. | |
| 5123 This option can be reset in your |vimrc| file to disable the loading | |
| 5124 of plugins. | |
|
11666
5cd9ba96561d
patch 8.0.0716: not easy to start Vim cleanly
Christian Brabandt <cb@256bit.org>
parents:
11659
diff
changeset
|
5125 Note that using the "-u NONE", "-u DEFAULTS" and "--noplugin" command |
|
5cd9ba96561d
patch 8.0.0716: not easy to start Vim cleanly
Christian Brabandt <cb@256bit.org>
parents:
11659
diff
changeset
|
5126 line arguments reset this option. See |-u| and |--noplugin|. |
| 7 | 5127 |
|
7196
42717d048817
commit https://github.com/vim/vim/commit/d94464ee294a351ce7b6ba18e8bd3f24f1bef920
Christian Brabandt <cb@256bit.org>
parents:
7147
diff
changeset
|
5128 *'luadll'* |
|
8629
54ac275e3fc4
commit https://github.com/vim/vim/commit/3848e00e0177abdb31bc600234967863ec487233
Christian Brabandt <cb@256bit.org>
parents:
8560
diff
changeset
|
5129 '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
|
5130 global |
|
7196
42717d048817
commit https://github.com/vim/vim/commit/d94464ee294a351ce7b6ba18e8bd3f24f1bef920
Christian Brabandt <cb@256bit.org>
parents:
7147
diff
changeset
|
5131 {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
|
5132 feature} |
|
7528
53163e4d9e4f
commit https://github.com/vim/vim/commit/25e4fcde767084d1a79e0926bc301c92987c0cce
Christian Brabandt <cb@256bit.org>
parents:
7477
diff
changeset
|
5133 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
|
5134 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
|
5135 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
|
5136 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
|
5137 security reasons. |
|
42717d048817
commit https://github.com/vim/vim/commit/d94464ee294a351ce7b6ba18e8bd3f24f1bef920
Christian Brabandt <cb@256bit.org>
parents:
7147
diff
changeset
|
5138 |
| 842 | 5139 *'macatsui'* *'nomacatsui'* |
| 5140 'macatsui' boolean (default on) | |
| 5141 global | |
| 21825 | 5142 {not supported} |
| 5143 No longer supported, as the Mac OS X GUI code was removed. | |
| 1152 | 5144 |
| 7 | 5145 *'magic'* *'nomagic'* |
| 5146 'magic' boolean (default on) | |
| 5147 global | |
| 5148 Changes the special characters that can be used in search patterns. | |
| 5149 See |pattern|. | |
|
10140
b11ceef7116e
commit https://github.com/vim/vim/commit/64d8e25bf6efe5f18b032563521c3ce278c316ab
Christian Brabandt <cb@256bit.org>
parents:
10027
diff
changeset
|
5150 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
|
5151 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
|
5152 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
|
5153 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
|
5154 when you want to |/\M|. |
| 23305 | 5155 In |Vim9| script the value of 'magic' is ignored, patterns behave like |
| 5156 it is always set. | |
| 7 | 5157 |
| 5158 *'makeef'* *'mef'* | |
| 5159 'makeef' 'mef' string (default: "") | |
| 5160 global | |
| 5161 {not available when compiled without the |+quickfix| | |
| 5162 feature} | |
| 5163 Name of the errorfile for the |:make| command (see |:make_makeprg|) | |
| 5164 and the |:grep| command. | |
| 5165 When it is empty, an internally generated temp file will be used. | |
| 5166 When "##" is included, it is replaced by a number to make the name | |
| 5167 unique. This makes sure that the ":make" command doesn't overwrite an | |
| 5168 existing file. | |
| 5169 NOT used for the ":cf" command. See 'errorfile' for that. | |
| 5170 Environment variables are expanded |:set_env|. | |
| 5171 See |option-backslash| about including spaces and backslashes. | |
| 5172 This option cannot be set from a |modeline| or in the |sandbox|, for | |
| 5173 security reasons. | |
| 5174 | |
|
11063
e71d3bdf3bc3
patch 8.0.0420: text garbled when the system encoding differs from 'encoding'
Christian Brabandt <cb@256bit.org>
parents:
11062
diff
changeset
|
5175 *'makeencoding'* *'menc'* |
|
e71d3bdf3bc3
patch 8.0.0420: text garbled when the system encoding differs from 'encoding'
Christian Brabandt <cb@256bit.org>
parents:
11062
diff
changeset
|
5176 'makeencoding' 'menc' string (default "") |
|
e71d3bdf3bc3
patch 8.0.0420: text garbled when the system encoding differs from 'encoding'
Christian Brabandt <cb@256bit.org>
parents:
11062
diff
changeset
|
5177 global or local to buffer |global-local| |
|
e71d3bdf3bc3
patch 8.0.0420: text garbled when the system encoding differs from 'encoding'
Christian Brabandt <cb@256bit.org>
parents:
11062
diff
changeset
|
5178 Encoding used for reading the output of external commands. When empty, |
|
e71d3bdf3bc3
patch 8.0.0420: text garbled when the system encoding differs from 'encoding'
Christian Brabandt <cb@256bit.org>
parents:
11062
diff
changeset
|
5179 encoding is not converted. |
|
e71d3bdf3bc3
patch 8.0.0420: text garbled when the system encoding differs from 'encoding'
Christian Brabandt <cb@256bit.org>
parents:
11062
diff
changeset
|
5180 This is used for `:make`, `:lmake`, `:grep`, `:lgrep`, `:grepadd`, |
|
e71d3bdf3bc3
patch 8.0.0420: text garbled when the system encoding differs from 'encoding'
Christian Brabandt <cb@256bit.org>
parents:
11062
diff
changeset
|
5181 `:lgrepadd`, `:cfile`, `:cgetfile`, `:caddfile`, `:lfile`, `:lgetfile`, |
|
e71d3bdf3bc3
patch 8.0.0420: text garbled when the system encoding differs from 'encoding'
Christian Brabandt <cb@256bit.org>
parents:
11062
diff
changeset
|
5182 and `:laddfile`. |
|
e71d3bdf3bc3
patch 8.0.0420: text garbled when the system encoding differs from 'encoding'
Christian Brabandt <cb@256bit.org>
parents:
11062
diff
changeset
|
5183 |
|
e71d3bdf3bc3
patch 8.0.0420: text garbled when the system encoding differs from 'encoding'
Christian Brabandt <cb@256bit.org>
parents:
11062
diff
changeset
|
5184 This would be mostly useful when you use MS-Windows and set 'encoding' |
|
e71d3bdf3bc3
patch 8.0.0420: text garbled when the system encoding differs from 'encoding'
Christian Brabandt <cb@256bit.org>
parents:
11062
diff
changeset
|
5185 to "utf-8". If |+iconv| is enabled and GNU libiconv is used, setting |
|
e71d3bdf3bc3
patch 8.0.0420: text garbled when the system encoding differs from 'encoding'
Christian Brabandt <cb@256bit.org>
parents:
11062
diff
changeset
|
5186 'makeencoding' to "char" has the same effect as setting to the system |
|
e71d3bdf3bc3
patch 8.0.0420: text garbled when the system encoding differs from 'encoding'
Christian Brabandt <cb@256bit.org>
parents:
11062
diff
changeset
|
5187 locale encoding. Example: > |
|
e71d3bdf3bc3
patch 8.0.0420: text garbled when the system encoding differs from 'encoding'
Christian Brabandt <cb@256bit.org>
parents:
11062
diff
changeset
|
5188 :set encoding=utf-8 |
|
e71d3bdf3bc3
patch 8.0.0420: text garbled when the system encoding differs from 'encoding'
Christian Brabandt <cb@256bit.org>
parents:
11062
diff
changeset
|
5189 :set makeencoding=char " system locale is used |
|
e71d3bdf3bc3
patch 8.0.0420: text garbled when the system encoding differs from 'encoding'
Christian Brabandt <cb@256bit.org>
parents:
11062
diff
changeset
|
5190 < |
| 7 | 5191 *'makeprg'* *'mp'* |
| 5192 'makeprg' 'mp' string (default "make", VMS: "MMS") | |
| 5193 global or local to buffer |global-local| | |
| 1152 | 5194 Program to use for the ":make" command. See |:make_makeprg|. |
|
13341
acd7eaa13d2b
Updated runtime files.
Christian Brabandt <cb@256bit.org>
parents:
13314
diff
changeset
|
5195 This option may contain '%' and '#' characters (see |:_%| and |:_#|), |
|
acd7eaa13d2b
Updated runtime files.
Christian Brabandt <cb@256bit.org>
parents:
13314
diff
changeset
|
5196 which are expanded to the current and alternate file name. Use |::S| |
| 5690 | 5197 to escape file names in case they contain special characters. |
| 1152 | 5198 Environment variables are expanded |:set_env|. See |option-backslash| |
| 5199 about including spaces and backslashes. | |
| 5200 Note that a '|' must be escaped twice: once for ":set" and once for | |
| 5201 the interpretation of a command. When you use a filter called | |
| 5202 "myfilter" do it like this: > | |
| 7 | 5203 :set makeprg=gmake\ \\\|\ myfilter |
| 5204 < The placeholder "$*" can be given (even multiple times) to specify | |
| 5205 where the arguments will be included, for example: > | |
| 5206 :set makeprg=latex\ \\\\nonstopmode\ \\\\input\\{$*} | |
| 5207 < This option cannot be set from a |modeline| or in the |sandbox|, for | |
| 5208 security reasons. | |
| 5209 | |
| 5210 *'matchpairs'* *'mps'* | |
| 5211 'matchpairs' 'mps' string (default "(:),{:},[:]") | |
| 5212 local to buffer | |
| 5213 Characters that form pairs. The |%| command jumps from one to the | |
| 4073 | 5214 other. |
| 5215 Only character pairs are allowed that are different, thus you cannot | |
| 5216 jump between two double quotes. | |
| 5217 The characters must be separated by a colon. | |
| 1152 | 5218 The pairs must be separated by a comma. Example for including '<' and |
| 24387 | 5219 '>' (for HTML): > |
| 7 | 5220 :set mps+=<:> |
| 5221 | |
| 5222 < A more exotic example, to jump between the '=' and ';' in an | |
| 5223 assignment, useful for languages like C and Java: > | |
| 5224 :au FileType c,cpp,java set mps+==:; | |
| 5225 | |
| 5226 < For a more advanced way of using "%", see the matchit.vim plugin in | |
|
12756
3b26420fc639
Long overdue runtime update.
Christian Brabandt <cb@256bit.org>
parents:
12744
diff
changeset
|
5227 the $VIMRUNTIME/pack/dist/opt/matchit directory. |add-local-help| |
| 7 | 5228 |
| 5229 *'matchtime'* *'mat'* | |
| 5230 'matchtime' 'mat' number (default 5) | |
| 5231 global | |
| 5232 Tenths of a second to show the matching paren, when 'showmatch' is | |
| 5233 set. Note that this is not in milliseconds, like other options that | |
| 5234 set a time. This is to be compatible with Nvi. | |
| 5235 | |
| 714 | 5236 *'maxcombine'* *'mco'* |
| 5237 'maxcombine' 'mco' number (default 2) | |
| 5238 global | |
| 5239 The maximum number of combining characters supported for displaying. | |
| 5240 Only used when 'encoding' is "utf-8". | |
| 5241 The default is OK for most languages. Hebrew may require 4. | |
| 5242 Maximum value is 6. | |
| 5243 Even when this option is set to 2 you can still edit text with more | |
| 5244 combining characters, you just can't see them. Use |g8| or |ga|. | |
| 5245 See |mbyte-combining|. | |
| 5246 | |
| 7 | 5247 *'maxfuncdepth'* *'mfd'* |
| 5248 'maxfuncdepth' 'mfd' number (default 100) | |
| 5249 global | |
|
2570
71b56b4e7785
Make the references to features in the help more consistent. (Sylvain Hitier)
Bram Moolenaar <bram@vim.org>
parents:
2561
diff
changeset
|
5250 {not available when compiled without the |+eval| |
| 1152 | 5251 feature} |
| 7 | 5252 Maximum depth of function calls for user functions. This normally |
| 5253 catches endless recursion. When using a recursive function with | |
| 5254 more depth, set 'maxfuncdepth' to a bigger number. But this will use | |
| 5255 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
|
5256 Increasing this limit above 200 also changes the maximum for Ex |
| 14006 | 5257 command recursion, see |E169|. |
| 7 | 5258 See also |:function|. |
| 5259 | |
| 5260 *'maxmapdepth'* *'mmd'* *E223* | |
| 5261 'maxmapdepth' 'mmd' number (default 1000) | |
| 5262 global | |
| 5263 Maximum number of times a mapping is done without resulting in a | |
| 5264 character to be used. This normally catches endless mappings, like | |
| 5265 ":map x y" with ":map y x". It still does not catch ":map g wg", | |
| 5266 because the 'w' is used before the next mapping is done. See also | |
| 5267 |key-mapping|. | |
| 5268 | |
| 5269 *'maxmem'* *'mm'* | |
| 5270 'maxmem' 'mm' number (default between 256 to 5120 (system | |
| 5271 dependent) or half the amount of memory | |
| 5272 available) | |
| 5273 global | |
| 5274 Maximum amount of memory (in Kbyte) to use for one buffer. When this | |
| 5275 limit is reached allocating extra memory for a buffer will cause | |
|
13314
65c3e8259124
patch 8.0.1531: cannot use 24 bit colors in MS-Windows console
Christian Brabandt <cb@256bit.org>
parents:
13234
diff
changeset
|
5276 other memory to be freed. |
|
65c3e8259124
patch 8.0.1531: cannot use 24 bit colors in MS-Windows console
Christian Brabandt <cb@256bit.org>
parents:
13234
diff
changeset
|
5277 The maximum usable value is about 2000000. Use this to work without a |
|
65c3e8259124
patch 8.0.1531: cannot use 24 bit colors in MS-Windows console
Christian Brabandt <cb@256bit.org>
parents:
13234
diff
changeset
|
5278 limit. |
|
65c3e8259124
patch 8.0.1531: cannot use 24 bit colors in MS-Windows console
Christian Brabandt <cb@256bit.org>
parents:
13234
diff
changeset
|
5279 The value is ignored when 'swapfile' is off. |
|
65c3e8259124
patch 8.0.1531: cannot use 24 bit colors in MS-Windows console
Christian Brabandt <cb@256bit.org>
parents:
13234
diff
changeset
|
5280 Also see 'maxmemtot'. |
| 7 | 5281 |
| 189 | 5282 *'maxmempattern'* *'mmp'* |
| 5283 'maxmempattern' 'mmp' number (default 1000) | |
| 5284 global | |
| 5285 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
|
5286 The maximum value is about 2000000. Use this to work without a limit. |
| 189 | 5287 *E363* |
| 1152 | 5288 When Vim runs into the limit it gives an error message and mostly |
| 5289 behaves like CTRL-C was typed. | |
| 189 | 5290 Running into the limit often means that the pattern is very |
| 5291 inefficient or too complex. This may already happen with the pattern | |
| 5292 "\(.\)*" on a very long line. ".*" works much better. | |
|
14298
4a588e3afd4a
Update runtime files, add Danish translations.
Christian Brabandt <cb@256bit.org>
parents:
14249
diff
changeset
|
5293 Might also happen on redraw, when syntax rules try to match a complex |
|
4a588e3afd4a
Update runtime files, add Danish translations.
Christian Brabandt <cb@256bit.org>
parents:
14249
diff
changeset
|
5294 text structure. |
|
4a588e3afd4a
Update runtime files, add Danish translations.
Christian Brabandt <cb@256bit.org>
parents:
14249
diff
changeset
|
5295 Vim may run out of memory before hitting the 'maxmempattern' limit, in |
|
4a588e3afd4a
Update runtime files, add Danish translations.
Christian Brabandt <cb@256bit.org>
parents:
14249
diff
changeset
|
5296 which case you get an "Out of memory" error instead. |
| 189 | 5297 |
| 7 | 5298 *'maxmemtot'* *'mmt'* |
| 5299 'maxmemtot' 'mmt' number (default between 2048 and 10240 (system | |
| 5300 dependent) or half the amount of memory | |
| 5301 available) | |
| 5302 global | |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
5303 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
|
5304 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
|
5305 without a limit. |
|
05cf4cc72a9f
commit https://github.com/vim/vim/commit/fa7353428f705f7a13465a1943dddeede4083023
Christian Brabandt <cb@256bit.org>
parents:
7272
diff
changeset
|
5306 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
|
5307 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
|
5308 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
|
5309 need the memory to store undo info. |
|
13314
65c3e8259124
patch 8.0.1531: cannot use 24 bit colors in MS-Windows console
Christian Brabandt <cb@256bit.org>
parents:
13234
diff
changeset
|
5310 Buffers with 'swapfile' off still count to the total amount of memory |
|
65c3e8259124
patch 8.0.1531: cannot use 24 bit colors in MS-Windows console
Christian Brabandt <cb@256bit.org>
parents:
13234
diff
changeset
|
5311 used. |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
5312 Also see 'maxmem'. |
| 7 | 5313 |
| 5314 *'menuitems'* *'mis'* | |
| 5315 'menuitems' 'mis' number (default 25) | |
| 5316 global | |
| 5317 {not available when compiled without the |+menu| | |
| 5318 feature} | |
| 5319 Maximum number of items to use in a menu. Used for menus that are | |
| 5320 generated from a list of items, e.g., the Buffers menu. Changing this | |
| 5321 option has no direct effect, the menu must be refreshed first. | |
| 5322 | |
| 484 | 5323 *'mkspellmem'* *'msm'* |
| 5324 'mkspellmem' 'msm' string (default "460000,2000,500") | |
| 5325 global | |
| 5326 {not available when compiled without the |+syntax| | |
| 5327 feature} | |
| 5328 Parameters for |:mkspell|. This tunes when to start compressing the | |
| 5329 word tree. Compression can be slow when there are many words, but | |
| 5330 it's needed to avoid running out of memory. The amount of memory used | |
| 5331 per word depends very much on how similar the words are, that's why | |
| 5332 this tuning is complicated. | |
| 5333 | |
| 5334 There are three numbers, separated by commas: | |
| 5335 {start},{inc},{added} | |
| 5336 | |
| 5337 For most languages the uncompressed word tree fits in memory. {start} | |
| 5338 gives the amount of memory in Kbyte that can be used before any | |
| 5339 compression is done. It should be a bit smaller than the amount of | |
| 5340 memory that is available to Vim. | |
| 5341 | |
| 5342 When going over the {start} limit the {inc} number specifies the | |
| 5343 amount of memory in Kbyte that can be allocated before another | |
| 5344 compression is done. A low number means compression is done after | |
| 5345 less words are added, which is slow. A high number means more memory | |
| 5346 will be allocated. | |
| 5347 | |
| 5348 After doing compression, {added} times 1024 words can be added before | |
| 5349 the {inc} limit is ignored and compression is done when any extra | |
| 5350 amount of memory is needed. A low number means there is a smaller | |
| 5351 chance of hitting the {inc} limit, less memory is used but it's | |
| 5352 slower. | |
| 5353 | |
| 5354 The languages for which these numbers are important are Italian and | |
| 5355 Hungarian. The default works for when you have about 512 Mbyte. If | |
| 5356 you have 1 Gbyte you could use: > | |
| 5357 :set mkspellmem=900000,3000,800 | |
| 5358 < If you have less than 512 Mbyte |:mkspell| may fail for some | |
| 5359 languages, no matter what you set 'mkspellmem' to. | |
| 5360 | |
|
16798
63ac51f16ea1
patch 8.1.1401: misspelled mkspellmem as makespellmem
Bram Moolenaar <Bram@vim.org>
parents:
16778
diff
changeset
|
5361 This option cannot be set from a |modeline| or in the |sandbox|. |
|
63ac51f16ea1
patch 8.1.1401: misspelled mkspellmem as makespellmem
Bram Moolenaar <Bram@vim.org>
parents:
16778
diff
changeset
|
5362 |
| 7 | 5363 *'modeline'* *'ml'* *'nomodeline'* *'noml'* |
| 1111 | 5364 'modeline' 'ml' boolean (Vim default: on (off for root), |
| 5365 Vi default: off) | |
| 7 | 5366 local to buffer |
|
16728
e55c26aaf484
patch 8.1.1366: using expressions in a modeline is unsafe
Bram Moolenaar <Bram@vim.org>
parents:
16610
diff
changeset
|
5367 If 'modeline' is on 'modelines' gives the number of lines that is |
|
e55c26aaf484
patch 8.1.1366: using expressions in a modeline is unsafe
Bram Moolenaar <Bram@vim.org>
parents:
16610
diff
changeset
|
5368 checked for set commands. If 'modeline' is off or 'modelines' is zero |
|
e55c26aaf484
patch 8.1.1366: using expressions in a modeline is unsafe
Bram Moolenaar <Bram@vim.org>
parents:
16610
diff
changeset
|
5369 no lines are checked. See |modeline|. |
|
e55c26aaf484
patch 8.1.1366: using expressions in a modeline is unsafe
Bram Moolenaar <Bram@vim.org>
parents:
16610
diff
changeset
|
5370 |
|
e55c26aaf484
patch 8.1.1366: using expressions in a modeline is unsafe
Bram Moolenaar <Bram@vim.org>
parents:
16610
diff
changeset
|
5371 *'modelineexpr'* *'mle'* *'nomodelineexpr'* *'nomle'* |
|
e55c26aaf484
patch 8.1.1366: using expressions in a modeline is unsafe
Bram Moolenaar <Bram@vim.org>
parents:
16610
diff
changeset
|
5372 'modelineexpr' 'mle' boolean (default: off) |
|
e55c26aaf484
patch 8.1.1366: using expressions in a modeline is unsafe
Bram Moolenaar <Bram@vim.org>
parents:
16610
diff
changeset
|
5373 global |
|
e55c26aaf484
patch 8.1.1366: using expressions in a modeline is unsafe
Bram Moolenaar <Bram@vim.org>
parents:
16610
diff
changeset
|
5374 When on allow some options that are an expression to be set in the |
|
e55c26aaf484
patch 8.1.1366: using expressions in a modeline is unsafe
Bram Moolenaar <Bram@vim.org>
parents:
16610
diff
changeset
|
5375 modeline. Check the option for whether it is affected by |
|
e55c26aaf484
patch 8.1.1366: using expressions in a modeline is unsafe
Bram Moolenaar <Bram@vim.org>
parents:
16610
diff
changeset
|
5376 'modelineexpr'. Also see |modeline|. |
|
16740
dc85d49349f7
patch 8.1.1372: when evaluating 'statusline' the current window is unknown
Bram Moolenaar <Bram@vim.org>
parents:
16728
diff
changeset
|
5377 This option cannot be set from a |modeline| or in the |sandbox|, for |
|
dc85d49349f7
patch 8.1.1372: when evaluating 'statusline' the current window is unknown
Bram Moolenaar <Bram@vim.org>
parents:
16728
diff
changeset
|
5378 security reasons. |
|
16728
e55c26aaf484
patch 8.1.1366: using expressions in a modeline is unsafe
Bram Moolenaar <Bram@vim.org>
parents:
16610
diff
changeset
|
5379 |
| 7 | 5380 *'modelines'* *'mls'* |
| 5381 'modelines' 'mls' number (default 5) | |
| 5382 global | |
| 5383 If 'modeline' is on 'modelines' gives the number of lines that is | |
| 5384 checked for set commands. If 'modeline' is off or 'modelines' is zero | |
| 5385 no lines are checked. See |modeline|. | |
| 5386 NOTE: 'modeline' is set to the Vi default value when 'compatible' is | |
| 5387 set and to the Vim default value when 'compatible' is reset. | |
| 5388 | |
| 5389 *'modifiable'* *'ma'* *'nomodifiable'* *'noma'* | |
|
16728
e55c26aaf484
patch 8.1.1366: using expressions in a modeline is unsafe
Bram Moolenaar <Bram@vim.org>
parents:
16610
diff
changeset
|
5390 *E21* |
| 7 | 5391 'modifiable' 'ma' boolean (default on) |
| 5392 local to buffer | |
| 5393 When off the buffer contents cannot be changed. The 'fileformat' and | |
| 5394 'fileencoding' options also can't be changed. | |
| 10617 | 5395 Can be reset on startup with the |-M| command line argument. |
| 7 | 5396 |
| 5397 *'modified'* *'mod'* *'nomodified'* *'nomod'* | |
| 5398 'modified' 'mod' boolean (default off) | |
| 5399 local to buffer | |
| 5400 When on, the buffer is considered to be modified. This option is set | |
| 5401 when: | |
| 5402 1. A change was made to the text since it was last written. Using the | |
| 5403 |undo| command to go back to the original text will reset the | |
| 5404 option. But undoing changes that were made before writing the | |
| 5405 buffer will set the option again, since the text is different from | |
| 5406 when it was written. | |
| 5407 2. 'fileformat' or 'fileencoding' is different from its original | |
| 5408 value. The original value is set when the buffer is read or | |
| 5409 written. A ":set nomodified" command also resets the original | |
| 5410 values to the current values and the 'modified' option will be | |
| 5411 reset. | |
|
8748
b1a19a2f73f0
commit https://github.com/vim/vim/commit/4f3f668c8486444e53163c29d2fc79bf47eb3c82
Christian Brabandt <cb@256bit.org>
parents:
8629
diff
changeset
|
5412 Similarly for 'eol' and 'bomb'. |
| 3082 | 5413 This option is not set when a change is made to the buffer as the |
| 5414 result of a BufNewFile, BufRead/BufReadPost, BufWritePost, | |
| 5415 FileAppendPost or VimLeave autocommand event. See |gzip-example| for | |
| 5416 an explanation. | |
| 7 | 5417 When 'buftype' is "nowrite" or "nofile" this option may be set, but |
| 5418 will be ignored. | |
| 13437 | 5419 Note that the text may actually be the same, e.g. 'modified' is set |
| 5420 when using "rA" on an "A". | |
| 7 | 5421 |
| 5422 *'more'* *'nomore'* | |
| 5423 'more' boolean (Vim default: on, Vi default: off) | |
| 5424 global | |
| 5425 When on, listings pause when the whole screen is filled. You will get | |
| 5426 the |more-prompt|. When this option is off there are no pauses, the | |
| 5427 listing continues until finished. | |
| 5428 NOTE: This option is set to the Vi default value when 'compatible' is | |
| 5429 set and to the Vim default value when 'compatible' is reset. | |
| 5430 | |
| 23666 | 5431 *'mouse'* |
| 18972 | 5432 'mouse' string (default "", "a" for GUI and Win32, |
|
18465
d7619a9874cd
patch 8.1.2226: cannot use system copy/paste in non-xterm terminals
Bram Moolenaar <Bram@vim.org>
parents:
18463
diff
changeset
|
5433 set to "a" or "nvi" in |defaults.vim|) |
|
d7619a9874cd
patch 8.1.2226: cannot use system copy/paste in non-xterm terminals
Bram Moolenaar <Bram@vim.org>
parents:
18463
diff
changeset
|
5434 global |
| 18972 | 5435 Enable the use of the mouse. Works for most terminals (xterm, Win32 |
| 5436 |win32-mouse|, QNX pterm, *BSD console with sysmouse and Linux console | |
| 5437 with gpm). For using the mouse in the GUI, see |gui-mouse|. The | |
| 5438 mouse can be enabled for different modes: | |
| 12826 | 5439 n Normal mode and Terminal modes |
| 7 | 5440 v Visual mode |
| 5441 i Insert mode | |
| 5442 c Command-line mode | |
| 5443 h all previous modes when editing a help file | |
| 5444 a all previous modes | |
| 5445 r for |hit-enter| and |more-prompt| prompt | |
| 14864 | 5446 Normally you would enable the mouse in all five modes with: > |
| 7 | 5447 :set mouse=a |
|
18465
d7619a9874cd
patch 8.1.2226: cannot use system copy/paste in non-xterm terminals
Bram Moolenaar <Bram@vim.org>
parents:
18463
diff
changeset
|
5448 < If your terminal can't overrule the mouse events going to the |
|
d7619a9874cd
patch 8.1.2226: cannot use system copy/paste in non-xterm terminals
Bram Moolenaar <Bram@vim.org>
parents:
18463
diff
changeset
|
5449 application, use: > |
|
d7619a9874cd
patch 8.1.2226: cannot use system copy/paste in non-xterm terminals
Bram Moolenaar <Bram@vim.org>
parents:
18463
diff
changeset
|
5450 :set mouse=nvi |
| 20856 | 5451 < Then you can press ":", select text for the system, and press Esc to go |
|
18465
d7619a9874cd
patch 8.1.2226: cannot use system copy/paste in non-xterm terminals
Bram Moolenaar <Bram@vim.org>
parents:
18463
diff
changeset
|
5452 back to Vim using the mouse events. |
|
d7619a9874cd
patch 8.1.2226: cannot use system copy/paste in non-xterm terminals
Bram Moolenaar <Bram@vim.org>
parents:
18463
diff
changeset
|
5453 In |defaults.vim| "nvi" is used if the 'term' option is not matching |
|
d7619a9874cd
patch 8.1.2226: cannot use system copy/paste in non-xterm terminals
Bram Moolenaar <Bram@vim.org>
parents:
18463
diff
changeset
|
5454 "xterm". |
|
d7619a9874cd
patch 8.1.2226: cannot use system copy/paste in non-xterm terminals
Bram Moolenaar <Bram@vim.org>
parents:
18463
diff
changeset
|
5455 |
|
d7619a9874cd
patch 8.1.2226: cannot use system copy/paste in non-xterm terminals
Bram Moolenaar <Bram@vim.org>
parents:
18463
diff
changeset
|
5456 When the mouse is not enabled, the GUI will still use the mouse for |
| 7 | 5457 modeless selection. This doesn't move the text cursor. |
| 5458 | |
| 5459 See |mouse-using|. Also see |'clipboard'|. | |
| 5460 | |
| 5461 Note: When enabling the mouse in a terminal, copy/paste will use the | |
| 10 | 5462 "* register if there is access to an X-server. The xterm handling of |
| 7 | 5463 the mouse buttons can still be used by keeping the shift key pressed. |
| 5464 Also see the 'clipboard' option. | |
| 5465 | |
| 5466 *'mousefocus'* *'mousef'* *'nomousefocus'* *'nomousef'* | |
| 5467 'mousefocus' 'mousef' boolean (default off) | |
| 5468 global | |
| 5469 {only works in the GUI} | |
| 5470 The window that the mouse pointer is on is automatically activated. | |
| 5471 When changing the window layout or window focus in another way, the | |
| 5472 mouse pointer is moved to the window with keyboard focus. Off is the | |
| 5473 default because it makes using the pull down menus a little goofy, as | |
| 5474 a pointer transit may activate a window unintentionally. | |
| 18594 | 5475 MS-Windows: Also see 'scrollfocus' for what window is scrolled when |
| 19180 | 5476 using the mouse scroll wheel. |
| 7 | 5477 |
| 5478 *'mousehide'* *'mh'* *'nomousehide'* *'nomh'* | |
| 5479 'mousehide' 'mh' boolean (default on) | |
| 5480 global | |
| 5481 {only works in the GUI} | |
| 5482 When on, the mouse pointer is hidden when characters are typed. | |
| 5483 The mouse pointer is restored when the mouse is moved. | |
| 5484 | |
| 5485 *'mousemodel'* *'mousem'* | |
| 18972 | 5486 'mousemodel' 'mousem' string (default "extend", "popup" for Win32) |
| 7 | 5487 global |
| 5488 Sets the model to use for the mouse. The name mostly specifies what | |
| 5489 the right mouse button is used for: | |
| 5490 extend Right mouse button extends a selection. This works | |
| 5491 like in an xterm. | |
| 5492 popup Right mouse button pops up a menu. The shifted left | |
| 5493 mouse button extends a selection. This works like | |
| 233 | 5494 with Microsoft Windows. |
| 7 | 5495 popup_setpos Like "popup", but the cursor will be moved to the |
| 5496 position where the mouse was clicked, and thus the | |
| 5497 selected operation will act upon the clicked object. | |
| 5498 If clicking inside a selection, that selection will | |
| 233 | 5499 be acted upon, i.e. no cursor move. This implies of |
| 7 | 5500 course, that right clicking outside a selection will |
| 5501 end Visual mode. | |
| 5502 Overview of what button does what for each model: | |
| 5503 mouse extend popup(_setpos) ~ | |
| 5504 left click place cursor place cursor | |
| 5505 left drag start selection start selection | |
| 5506 shift-left search word extend selection | |
| 5507 right click extend selection popup menu (place cursor) | |
| 5508 right drag extend selection - | |
| 5509 middle click paste paste | |
| 5510 | |
| 5511 In the "popup" model the right mouse button produces a pop-up menu. | |
| 5512 You need to define this first, see |popup-menu|. | |
| 5513 | |
| 5514 Note that you can further refine the meaning of buttons with mappings. | |
| 5515 See |gui-mouse-mapping|. But mappings are NOT used for modeless | |
| 5516 selection (because that's handled in the GUI code directly). | |
| 5517 | |
| 5518 The 'mousemodel' option is set by the |:behave| command. | |
| 5519 | |
|
28297
4190b932e6ca
patch 8.2.4674: cannot force getting MouseMove events
Bram Moolenaar <Bram@vim.org>
parents:
28246
diff
changeset
|
5520 *'mousemoveevent'* *'mousemev'* |
|
4190b932e6ca
patch 8.2.4674: cannot force getting MouseMove events
Bram Moolenaar <Bram@vim.org>
parents:
28246
diff
changeset
|
5521 'mousemoveevent' 'mousemev' boolean (default off) |
|
4190b932e6ca
patch 8.2.4674: cannot force getting MouseMove events
Bram Moolenaar <Bram@vim.org>
parents:
28246
diff
changeset
|
5522 global |
|
4190b932e6ca
patch 8.2.4674: cannot force getting MouseMove events
Bram Moolenaar <Bram@vim.org>
parents:
28246
diff
changeset
|
5523 {only works in the GUI} |
|
4190b932e6ca
patch 8.2.4674: cannot force getting MouseMove events
Bram Moolenaar <Bram@vim.org>
parents:
28246
diff
changeset
|
5524 When on, mouse move events are delivered to the input queue and are |
|
4190b932e6ca
patch 8.2.4674: cannot force getting MouseMove events
Bram Moolenaar <Bram@vim.org>
parents:
28246
diff
changeset
|
5525 available for mapping. The default, off, avoids the mouse movement |
|
4190b932e6ca
patch 8.2.4674: cannot force getting MouseMove events
Bram Moolenaar <Bram@vim.org>
parents:
28246
diff
changeset
|
5526 overhead except when needed. See |gui-mouse-mapping|. |
|
4190b932e6ca
patch 8.2.4674: cannot force getting MouseMove events
Bram Moolenaar <Bram@vim.org>
parents:
28246
diff
changeset
|
5527 Warning: Setting this option can make pending mappings to be aborted |
|
4190b932e6ca
patch 8.2.4674: cannot force getting MouseMove events
Bram Moolenaar <Bram@vim.org>
parents:
28246
diff
changeset
|
5528 when the mouse is moved. |
|
4190b932e6ca
patch 8.2.4674: cannot force getting MouseMove events
Bram Moolenaar <Bram@vim.org>
parents:
28246
diff
changeset
|
5529 Currently only works in the GUI, may be made to work in a terminal |
|
4190b932e6ca
patch 8.2.4674: cannot force getting MouseMove events
Bram Moolenaar <Bram@vim.org>
parents:
28246
diff
changeset
|
5530 later. |
|
4190b932e6ca
patch 8.2.4674: cannot force getting MouseMove events
Bram Moolenaar <Bram@vim.org>
parents:
28246
diff
changeset
|
5531 |
| 7 | 5532 *'mouseshape'* *'mouses'* *E547* |
| 15932 | 5533 'mouseshape' 'mouses' string (default "i-r:beam,s:updown,sd:udsizing, |
| 5534 vs:leftright,vd:lrsizing,m:no, | |
| 5535 ml:up-arrow,v:rightup-arrow") | |
| 7 | 5536 global |
| 5537 {only available when compiled with the |+mouseshape| | |
| 5538 feature} | |
| 5539 This option tells Vim what the mouse pointer should look like in | |
| 5540 different modes. The option is a comma separated list of parts, much | |
| 5541 like used for 'guicursor'. Each part consist of a mode/location-list | |
| 5542 and an argument-list: | |
| 5543 mode-list:shape,mode-list:shape,.. | |
| 5544 The mode-list is a dash separated list of these modes/locations: | |
| 5545 In a normal window: ~ | |
| 5546 n Normal mode | |
| 5547 v Visual mode | |
| 5548 ve Visual mode with 'selection' "exclusive" (same as 'v', | |
| 5549 if not specified) | |
| 5550 o Operator-pending mode | |
| 5551 i Insert mode | |
| 5552 r Replace mode | |
| 5553 | |
| 5554 Others: ~ | |
| 5555 c appending to the command-line | |
| 5556 ci inserting in the command-line | |
| 5557 cr replacing in the command-line | |
| 5558 m at the 'Hit ENTER' or 'More' prompts | |
| 5559 ml idem, but cursor in the last line | |
| 5560 e any mode, pointer below last window | |
| 5561 s any mode, pointer on a status line | |
| 5562 sd any mode, while dragging a status line | |
| 5563 vs any mode, pointer on a vertical separator line | |
| 5564 vd any mode, while dragging a vertical separator line | |
| 5565 a everywhere | |
| 5566 | |
| 5567 The shape is one of the following: | |
| 5568 avail name looks like ~ | |
| 5569 w x arrow Normal mouse pointer | |
| 5570 w x blank no pointer at all (use with care!) | |
| 5571 w x beam I-beam | |
| 5572 w x updown up-down sizing arrows | |
| 5573 w x leftright left-right sizing arrows | |
| 5574 w x busy The system's usual busy pointer | |
| 5575 w x no The system's usual 'no input' pointer | |
| 5576 x udsizing indicates up-down resizing | |
| 5577 x lrsizing indicates left-right resizing | |
| 5578 x crosshair like a big thin + | |
| 5579 x hand1 black hand | |
| 5580 x hand2 white hand | |
| 5581 x pencil what you write with | |
| 5582 x question big ? | |
| 5583 x rightup-arrow arrow pointing right-up | |
| 5584 w x up-arrow arrow pointing up | |
| 5585 x <number> any X11 pointer number (see X11/cursorfont.h) | |
| 5586 | |
| 5587 The "avail" column contains a 'w' if the shape is available for Win32, | |
| 5588 x for X11. | |
| 5589 Any modes not specified or shapes not available use the normal mouse | |
| 5590 pointer. | |
| 5591 | |
| 5592 Example: > | |
| 5593 :set mouseshape=s:udsizing,m:no | |
| 5594 < will make the mouse turn to a sizing arrow over the status lines and | |
| 5595 indicate no input when the hit-enter prompt is displayed (since | |
| 5596 clicking the mouse has no effect in this state.) | |
| 5597 | |
| 5598 *'mousetime'* *'mouset'* | |
| 5599 'mousetime' 'mouset' number (default 500) | |
| 5600 global | |
| 18972 | 5601 Only for GUI, Win32 and Unix with xterm. Defines the maximum |
| 7 | 5602 time in msec between two mouse clicks for the second click to be |
| 5603 recognized as a multi click. | |
| 5604 | |
|
12608
b390f5003e2f
patch 8.0.1182: cannot see or change mzscheme dll name
Christian Brabandt <cb@256bit.org>
parents:
12559
diff
changeset
|
5605 *'mzschemedll'* |
|
b390f5003e2f
patch 8.0.1182: cannot see or change mzscheme dll name
Christian Brabandt <cb@256bit.org>
parents:
12559
diff
changeset
|
5606 'mzschemedll' string (default depends on the build) |
|
b390f5003e2f
patch 8.0.1182: cannot see or change mzscheme dll name
Christian Brabandt <cb@256bit.org>
parents:
12559
diff
changeset
|
5607 global |
|
b390f5003e2f
patch 8.0.1182: cannot see or change mzscheme dll name
Christian Brabandt <cb@256bit.org>
parents:
12559
diff
changeset
|
5608 {only available when compiled with the |+mzscheme/dyn| |
|
b390f5003e2f
patch 8.0.1182: cannot see or change mzscheme dll name
Christian Brabandt <cb@256bit.org>
parents:
12559
diff
changeset
|
5609 feature} |
|
b390f5003e2f
patch 8.0.1182: cannot see or change mzscheme dll name
Christian Brabandt <cb@256bit.org>
parents:
12559
diff
changeset
|
5610 Specifies the name of the MzScheme shared library. The default is |
|
b390f5003e2f
patch 8.0.1182: cannot see or change mzscheme dll name
Christian Brabandt <cb@256bit.org>
parents:
12559
diff
changeset
|
5611 DYNAMIC_MZSCH_DLL which was specified at compile time. |
|
b390f5003e2f
patch 8.0.1182: cannot see or change mzscheme dll name
Christian Brabandt <cb@256bit.org>
parents:
12559
diff
changeset
|
5612 Environment variables are expanded |:set_env|. |
| 12785 | 5613 The value must be set in the |vimrc| script or earlier. In the |
|
12756
3b26420fc639
Long overdue runtime update.
Christian Brabandt <cb@256bit.org>
parents:
12744
diff
changeset
|
5614 startup, before the |load-plugins| step. |
|
12608
b390f5003e2f
patch 8.0.1182: cannot see or change mzscheme dll name
Christian Brabandt <cb@256bit.org>
parents:
12559
diff
changeset
|
5615 This option cannot be set from a |modeline| or in the |sandbox|, for |
|
b390f5003e2f
patch 8.0.1182: cannot see or change mzscheme dll name
Christian Brabandt <cb@256bit.org>
parents:
12559
diff
changeset
|
5616 security reasons. |
|
b390f5003e2f
patch 8.0.1182: cannot see or change mzscheme dll name
Christian Brabandt <cb@256bit.org>
parents:
12559
diff
changeset
|
5617 |
|
b390f5003e2f
patch 8.0.1182: cannot see or change mzscheme dll name
Christian Brabandt <cb@256bit.org>
parents:
12559
diff
changeset
|
5618 *'mzschemegcdll'* |
|
b390f5003e2f
patch 8.0.1182: cannot see or change mzscheme dll name
Christian Brabandt <cb@256bit.org>
parents:
12559
diff
changeset
|
5619 'mzschemegcdll' string (default depends on the build) |
|
b390f5003e2f
patch 8.0.1182: cannot see or change mzscheme dll name
Christian Brabandt <cb@256bit.org>
parents:
12559
diff
changeset
|
5620 global |
|
b390f5003e2f
patch 8.0.1182: cannot see or change mzscheme dll name
Christian Brabandt <cb@256bit.org>
parents:
12559
diff
changeset
|
5621 {only available when compiled with the |+mzscheme/dyn| |
|
b390f5003e2f
patch 8.0.1182: cannot see or change mzscheme dll name
Christian Brabandt <cb@256bit.org>
parents:
12559
diff
changeset
|
5622 feature} |
|
b390f5003e2f
patch 8.0.1182: cannot see or change mzscheme dll name
Christian Brabandt <cb@256bit.org>
parents:
12559
diff
changeset
|
5623 Specifies the name of the MzScheme GC shared library. The default is |
|
b390f5003e2f
patch 8.0.1182: cannot see or change mzscheme dll name
Christian Brabandt <cb@256bit.org>
parents:
12559
diff
changeset
|
5624 DYNAMIC_MZGC_DLL which was specified at compile time. |
|
b390f5003e2f
patch 8.0.1182: cannot see or change mzscheme dll name
Christian Brabandt <cb@256bit.org>
parents:
12559
diff
changeset
|
5625 The value can be equal to 'mzschemedll' if it includes the GC code. |
|
b390f5003e2f
patch 8.0.1182: cannot see or change mzscheme dll name
Christian Brabandt <cb@256bit.org>
parents:
12559
diff
changeset
|
5626 Environment variables are expanded |:set_env|. |
|
b390f5003e2f
patch 8.0.1182: cannot see or change mzscheme dll name
Christian Brabandt <cb@256bit.org>
parents:
12559
diff
changeset
|
5627 This option cannot be set from a |modeline| or in the |sandbox|, for |
|
b390f5003e2f
patch 8.0.1182: cannot see or change mzscheme dll name
Christian Brabandt <cb@256bit.org>
parents:
12559
diff
changeset
|
5628 security reasons. |
|
b390f5003e2f
patch 8.0.1182: cannot see or change mzscheme dll name
Christian Brabandt <cb@256bit.org>
parents:
12559
diff
changeset
|
5629 |
| 14 | 5630 *'mzquantum'* *'mzq'* |
| 5631 'mzquantum' 'mzq' number (default 100) | |
| 5632 global | |
| 5633 {not available when compiled without the |+mzscheme| | |
| 5634 feature} | |
| 5635 The number of milliseconds between polls for MzScheme threads. | |
| 5636 Negative or zero value means no thread scheduling. | |
| 11160 | 5637 NOTE: This option is set to the Vim default value when 'compatible' |
| 5638 is reset. | |
| 14 | 5639 |
| 7 | 5640 *'nrformats'* *'nf'* |
|
9669
284b4eb307fc
commit https://github.com/vim/vim/commit/8c08b5b569e2a9e9f63dea514591ecfa2d3bb392
Christian Brabandt <cb@256bit.org>
parents:
9665
diff
changeset
|
5641 '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
|
5642 set to "bin,hex" in |defaults.vim|) |
| 7 | 5643 local to buffer |
| 5644 This defines what bases Vim will consider for numbers when using the | |
| 5645 CTRL-A and CTRL-X commands for adding to and subtracting from a number | |
| 5646 respectively; see |CTRL-A| for more info on these commands. | |
| 625 | 5647 alpha If included, single alphabetical characters will be |
| 7 | 5648 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
|
5649 letter index a), b), etc. *octal-nrformats* |
| 625 | 5650 octal If included, numbers that start with a zero will be considered |
| 7 | 5651 to be octal. Example: Using CTRL-A on "007" results in "010". |
| 625 | 5652 hex If included, numbers starting with "0x" or "0X" will be |
| 7 | 5653 considered to be hexadecimal. Example: Using CTRL-X on |
| 5654 "0x100" results in "0x0ff". | |
|
7528
53163e4d9e4f
commit https://github.com/vim/vim/commit/25e4fcde767084d1a79e0926bc301c92987c0cce
Christian Brabandt <cb@256bit.org>
parents:
7477
diff
changeset
|
5655 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
|
5656 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
|
5657 "0b1000" subtracts one, resulting in "0b0111". |
|
20613
9edb439adbea
patch 8.2.0860: cannot use CTRL-A and CTRL-X on unsigned numbers
Bram Moolenaar <Bram@vim.org>
parents:
20575
diff
changeset
|
5658 unsigned If included, numbers are recognized as unsigned. Thus a |
|
9edb439adbea
patch 8.2.0860: cannot use CTRL-A and CTRL-X on unsigned numbers
Bram Moolenaar <Bram@vim.org>
parents:
20575
diff
changeset
|
5659 leading dash or negative sign won't be considered as part of |
|
9edb439adbea
patch 8.2.0860: cannot use CTRL-A and CTRL-X on unsigned numbers
Bram Moolenaar <Bram@vim.org>
parents:
20575
diff
changeset
|
5660 the number. Examples: |
|
9edb439adbea
patch 8.2.0860: cannot use CTRL-A and CTRL-X on unsigned numbers
Bram Moolenaar <Bram@vim.org>
parents:
20575
diff
changeset
|
5661 Using CTRL-X on "2020" in "9-2020" results in "9-2019" |
|
9edb439adbea
patch 8.2.0860: cannot use CTRL-A and CTRL-X on unsigned numbers
Bram Moolenaar <Bram@vim.org>
parents:
20575
diff
changeset
|
5662 (without "unsigned" it would become "9-2021"). |
|
9edb439adbea
patch 8.2.0860: cannot use CTRL-A and CTRL-X on unsigned numbers
Bram Moolenaar <Bram@vim.org>
parents:
20575
diff
changeset
|
5663 Using CTRL-A on "2020" in "9-2020" results in "9-2021" |
|
9edb439adbea
patch 8.2.0860: cannot use CTRL-A and CTRL-X on unsigned numbers
Bram Moolenaar <Bram@vim.org>
parents:
20575
diff
changeset
|
5664 (without "unsigned" it would become "9-2019"). |
| 20753 | 5665 Using CTRL-X on "0" or CTRL-A on "18446744073709551615" |
| 5666 (2^64 - 1) has no effect, overflow is prevented. | |
| 7 | 5667 Numbers which simply begin with a digit in the range 1-9 are always |
| 5668 considered decimal. This also happens for numbers that are not | |
| 5669 recognized as octal or hex. | |
| 5670 | |
| 5671 *'number'* *'nu'* *'nonumber'* *'nonu'* | |
| 5672 'number' 'nu' boolean (default off) | |
| 5673 local to window | |
| 5674 Print the line number in front of each line. When the 'n' option is | |
| 5675 excluded from 'cpoptions' a wrapped line will not use the column of | |
| 5676 line numbers (this is the default when 'compatible' isn't set). | |
| 13 | 5677 The 'numberwidth' option can be used to set the room used for the line |
| 5678 number. | |
| 7 | 5679 When a long, wrapped line doesn't start with the first character, '-' |
| 5680 characters are put before the number. | |
|
26690
84d60deb8f82
patch 8.2.3874: cannot highlight the number column for a sign
Bram Moolenaar <Bram@vim.org>
parents:
26670
diff
changeset
|
5681 For highlighting see |hl-LineNr|, and |hl-CursorLineNr|, and the |
|
84d60deb8f82
patch 8.2.3874: cannot highlight the number column for a sign
Bram Moolenaar <Bram@vim.org>
parents:
26670
diff
changeset
|
5682 |:sign-define| "numhl" argument. |
| 4780 | 5683 *number_relativenumber* |
| 5684 The 'relativenumber' option changes the displayed number to be | |
| 5685 relative to the cursor. Together with 'number' there are these | |
| 5686 four combinations (cursor in line 3): | |
| 5687 | |
|
8629
54ac275e3fc4
commit https://github.com/vim/vim/commit/3848e00e0177abdb31bc600234967863ec487233
Christian Brabandt <cb@256bit.org>
parents:
8560
diff
changeset
|
5688 'nonu' 'nu' 'nonu' 'nu' |
| 4780 | 5689 'nornu' 'nornu' 'rnu' 'rnu' |
| 5690 | |
| 5691 |apple | 1 apple | 2 apple | 2 apple | |
| 5692 |pear | 2 pear | 1 pear | 1 pear | |
| 5693 |nobody | 3 nobody | 0 nobody |3 nobody | |
| 5694 |there | 4 there | 1 there | 1 there | |
| 7 | 5695 |
| 13 | 5696 *'numberwidth'* *'nuw'* |
| 5697 'numberwidth' 'nuw' number (Vim default: 4 Vi default: 8) | |
| 5698 local to window | |
| 14 | 5699 {only available when compiled with the |+linebreak| |
| 5700 feature} | |
| 13 | 5701 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
|
5702 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
|
5703 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
|
5704 the text, there is one less character for the number itself. |
| 13 | 5705 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
|
5706 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
|
5707 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
|
5708 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
|
5709 up to 999. When the buffer has 1000 lines five columns will be used. |
|
17229
f1c7b7a4d9e4
patch 8.1.1614: 'numberwidth' can only go up to 10
Bram Moolenaar <Bram@vim.org>
parents:
17161
diff
changeset
|
5710 The minimum value is 1, the maximum value is 20. |
| 11160 | 5711 NOTE: This option is set to the Vi default value when 'compatible' is |
| 5712 set and to the Vim default value when 'compatible' is reset. | |
| 13 | 5713 |
| 523 | 5714 *'omnifunc'* *'ofu'* |
| 5715 'omnifunc' 'ofu' string (default: empty) | |
| 502 | 5716 local to buffer |
|
2570
71b56b4e7785
Make the references to features in the help more consistent. (Sylvain Hitier)
Bram Moolenaar <bram@vim.org>
parents:
2561
diff
changeset
|
5717 {not available when compiled without the |+eval| |
|
17809
59f8948b7590
patch 8.1.1901: the +insert_expand feature is not always available
Bram Moolenaar <Bram@vim.org>
parents:
17771
diff
changeset
|
5718 feature} |
| 623 | 5719 This option specifies a function to be used for Insert mode omni |
| 5720 completion with CTRL-X CTRL-O. |i_CTRL-X_CTRL-O| | |
| 648 | 5721 See |complete-functions| for an explanation of how the function is |
|
26388
8aba638e91eb
patch 8.2.3725: cannot use a lambda for 'completefunc' and 'omnifunc'
Bram Moolenaar <Bram@vim.org>
parents:
26362
diff
changeset
|
5722 invoked and what it should return. The value can be the name of a |
|
8aba638e91eb
patch 8.2.3725: cannot use a lambda for 'completefunc' and 'omnifunc'
Bram Moolenaar <Bram@vim.org>
parents:
26362
diff
changeset
|
5723 function, a |lambda| or a |Funcref|. See |option-value-function| for |
|
8aba638e91eb
patch 8.2.3725: cannot use a lambda for 'completefunc' and 'omnifunc'
Bram Moolenaar <Bram@vim.org>
parents:
26362
diff
changeset
|
5724 more information. |
| 1004 | 5725 This option is usually set by a filetype plugin: |
| 859 | 5726 |:filetype-plugin-on| |
| 3682 | 5727 This option cannot be set from a |modeline| or in the |sandbox|, for |
| 5728 security reasons. | |
| 502 | 5729 |
| 5730 | |
| 1152 | 5731 *'opendevice'* *'odev'* *'noopendevice'* *'noodev'* |
| 1004 | 5732 'opendevice' 'odev' boolean (default off) |
| 5733 global | |
| 27321 | 5734 {only for MS-Windows} *E796* |
| 1004 | 5735 Enable reading and writing from devices. This may get Vim stuck on a |
| 5736 device that can be opened but doesn't actually do the I/O. Therefore | |
| 5737 it is off by default. | |
| 5738 Note that on MS-Windows editing "aux.h", "lpt1.txt" and the like also | |
| 5739 result in editing a device. | |
| 5740 | |
| 5741 | |
| 593 | 5742 *'operatorfunc'* *'opfunc'* |
| 5743 'operatorfunc' 'opfunc' string (default: empty) | |
| 5744 global | |
| 5745 This option specifies a function to be called by the |g@| operator. | |
|
26175
6b4f017d7005
patch 8.2.3619: cannot use a lambda for 'operatorfunc'
Bram Moolenaar <Bram@vim.org>
parents:
26148
diff
changeset
|
5746 See |:map-operator| for more info and an example. The value can be |
|
6b4f017d7005
patch 8.2.3619: cannot use a lambda for 'operatorfunc'
Bram Moolenaar <Bram@vim.org>
parents:
26148
diff
changeset
|
5747 the name of a function, a |lambda| or a |Funcref|. See |
|
6b4f017d7005
patch 8.2.3619: cannot use a lambda for 'operatorfunc'
Bram Moolenaar <Bram@vim.org>
parents:
26148
diff
changeset
|
5748 |option-value-function| for more information. |
| 593 | 5749 |
| 5750 This option cannot be set from a |modeline| or in the |sandbox|, for | |
| 5751 security reasons. | |
| 5752 | |
| 5753 | |
| 2908 | 5754 *'osfiletype'* *'oft'* |
| 5755 'osfiletype' 'oft' string (default: "") | |
| 7 | 5756 local to buffer |
| 2908 | 5757 This option was supported on RISC OS, which has been removed. |
| 5758 | |
| 7 | 5759 |
|
8182
95d59081580f
commit https://github.com/vim/vim/commit/f6fee0e2d4341c0c2f5339c1268e5877fafd07cf
Christian Brabandt <cb@256bit.org>
parents:
8148
diff
changeset
|
5760 *'packpath'* *'pp'* |
|
95d59081580f
commit https://github.com/vim/vim/commit/f6fee0e2d4341c0c2f5339c1268e5877fafd07cf
Christian Brabandt <cb@256bit.org>
parents:
8148
diff
changeset
|
5761 'packpath' 'pp' string (default: see 'runtimepath') |
|
95d59081580f
commit https://github.com/vim/vim/commit/f6fee0e2d4341c0c2f5339c1268e5877fafd07cf
Christian Brabandt <cb@256bit.org>
parents:
8148
diff
changeset
|
5762 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
|
5763 |
|
95d59081580f
commit https://github.com/vim/vim/commit/f6fee0e2d4341c0c2f5339c1268e5877fafd07cf
Christian Brabandt <cb@256bit.org>
parents:
8148
diff
changeset
|
5764 |
| 7 | 5765 *'paragraphs'* *'para'* |
| 1564 | 5766 'paragraphs' 'para' string (default "IPLPPPQPP TPHPLIPpLpItpplpipbp") |
| 7 | 5767 global |
| 5768 Specifies the nroff macros that separate paragraphs. These are pairs | |
| 5769 of two letters (see |object-motions|). | |
| 5770 | |
| 5771 *'paste'* *'nopaste'* | |
| 5772 'paste' boolean (default off) | |
| 5773 global | |
| 10 | 5774 Put Vim in Paste mode. This is useful if you want to cut or copy |
| 5775 some text from one window and paste it in Vim. This will avoid | |
| 7 | 5776 unexpected effects. |
| 5777 Setting this option is useful when using Vim in a terminal, where Vim | |
| 10 | 5778 cannot distinguish between typed text and pasted text. In the GUI, Vim |
| 7 | 5779 knows about pasting and will mostly do the right thing without 'paste' |
| 5780 being set. The same is true for a terminal where Vim handles the | |
| 5781 mouse clicks itself. | |
| 148 | 5782 This option is reset when starting the GUI. Thus if you set it in |
| 5783 your .vimrc it will work in a terminal, but not in the GUI. Setting | |
| 5784 'paste' in the GUI has side effects: e.g., the Paste toolbar button | |
| 5785 will no longer work in Insert mode, because it uses a mapping. | |
| 7 | 5786 When the 'paste' option is switched on (also when it was already on): |
| 5787 - mapping in Insert mode and Command-line mode is disabled | |
| 5788 - abbreviations are disabled | |
| 5789 - 'autoindent' is reset | |
|
7147
c590de398af9
commit https://github.com/vim/vim/commit/ca63501fbcd1cf9c8aa9ff12c093c95b62a89ed7
Christian Brabandt <cb@256bit.org>
parents:
7080
diff
changeset
|
5790 - 'expandtab' is reset |
| 25056 | 5791 - 'hkmap' is reset |
| 7 | 5792 - 'revins' is reset |
| 5793 - 'ruler' is reset | |
| 5794 - 'showmatch' is reset | |
|
7147
c590de398af9
commit https://github.com/vim/vim/commit/ca63501fbcd1cf9c8aa9ff12c093c95b62a89ed7
Christian Brabandt <cb@256bit.org>
parents:
7080
diff
changeset
|
5795 - 'smarttab' is reset |
|
c590de398af9
commit https://github.com/vim/vim/commit/ca63501fbcd1cf9c8aa9ff12c093c95b62a89ed7
Christian Brabandt <cb@256bit.org>
parents:
7080
diff
changeset
|
5796 - 'softtabstop' is set to 0 |
|
c590de398af9
commit https://github.com/vim/vim/commit/ca63501fbcd1cf9c8aa9ff12c093c95b62a89ed7
Christian Brabandt <cb@256bit.org>
parents:
7080
diff
changeset
|
5797 - 'textwidth' is set to 0 |
|
c590de398af9
commit https://github.com/vim/vim/commit/ca63501fbcd1cf9c8aa9ff12c093c95b62a89ed7
Christian Brabandt <cb@256bit.org>
parents:
7080
diff
changeset
|
5798 - 'wrapmargin' is set to 0 |
| 25056 | 5799 - 'varsofttabstop' is made empty |
| 7 | 5800 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
|
5801 - 'cindent' |
| 25056 | 5802 - 'formatoptions' is used like it is empty |
|
7147
c590de398af9
commit https://github.com/vim/vim/commit/ca63501fbcd1cf9c8aa9ff12c093c95b62a89ed7
Christian Brabandt <cb@256bit.org>
parents:
7080
diff
changeset
|
5803 - 'indentexpr' |
| 7 | 5804 - 'lisp' |
| 25056 | 5805 - 'smartindent' |
| 7 | 5806 NOTE: When you start editing another file while the 'paste' option is |
| 5807 on, settings from the modelines or autocommands may change the | |
| 5808 settings again, causing trouble when pasting text. You might want to | |
| 5809 set the 'paste' option again. | |
| 5810 When the 'paste' option is reset the mentioned options are restored to | |
| 5811 the value before the moment 'paste' was switched from off to on. | |
| 5812 Resetting 'paste' before ever setting it does not have any effect. | |
| 5813 Since mapping doesn't work while 'paste' is active, you need to use | |
| 5814 the 'pastetoggle' option to toggle the 'paste' option with some key. | |
| 5815 | |
| 5816 *'pastetoggle'* *'pt'* | |
| 5817 'pastetoggle' 'pt' string (default "") | |
| 5818 global | |
| 5819 When non-empty, specifies the key sequence that toggles the 'paste' | |
| 5820 option. This is like specifying a mapping: > | |
| 5821 :map {keys} :set invpaste<CR> | |
| 5822 < Where {keys} is the value of 'pastetoggle'. | |
| 5823 The difference is that it will work even when 'paste' is set. | |
| 5824 'pastetoggle' works in Insert mode and Normal mode, but not in | |
| 5825 Command-line mode. | |
| 5826 Mappings are checked first, thus overrule 'pastetoggle'. However, | |
| 5827 when 'paste' is on mappings are ignored in Insert mode, thus you can do | |
| 5828 this: > | |
| 5829 :map <F10> :set paste<CR> | |
| 5830 :map <F11> :set nopaste<CR> | |
| 5831 :imap <F10> <C-O>:set paste<CR> | |
| 5832 :imap <F11> <nop> | |
| 5833 :set pastetoggle=<F11> | |
| 5834 < This will make <F10> start paste mode and <F11> stop paste mode. | |
| 5835 Note that typing <F10> in paste mode inserts "<F10>", since in paste | |
| 5836 mode everything is inserted literally, except the 'pastetoggle' key | |
| 5837 sequence. | |
| 1621 | 5838 When the value has several bytes 'ttimeoutlen' applies. |
| 7 | 5839 |
| 5840 *'pex'* *'patchexpr'* | |
| 5841 'patchexpr' 'pex' string (default "") | |
| 5842 global | |
| 5843 {not available when compiled without the |+diff| | |
| 5844 feature} | |
| 5845 Expression which is evaluated to apply a patch to a file and generate | |
| 10 | 5846 the resulting new version of the file. See |diff-patchexpr|. |
| 7 | 5847 |
|
6091
7090d7f160f7
Update runtime files. Add vroom file support.
Bram Moolenaar <bram@vim.org>
parents:
6032
diff
changeset
|
5848 *'patchmode'* *'pm'* *E205* *E206* |
| 7 | 5849 'patchmode' 'pm' string (default "") |
| 5850 global | |
| 5851 When non-empty the oldest version of a file is kept. This can be used | |
| 5852 to keep the original version of a file if you are changing files in a | |
| 5853 source distribution. Only the first time that a file is written a | |
| 5854 copy of the original file will be kept. The name of the copy is the | |
| 5855 name of the original file with the string in the 'patchmode' option | |
| 5856 appended. This option should start with a dot. Use a string like | |
|
13100
656ab57d1ddc
update a few runtime files
Christian Brabandt <cb@256bit.org>
parents:
13051
diff
changeset
|
5857 ".orig" or ".org". 'backupdir' must not be empty for this to work |
|
656ab57d1ddc
update a few runtime files
Christian Brabandt <cb@256bit.org>
parents:
13051
diff
changeset
|
5858 (Detail: The backup file is renamed to the patchmode file after the |
|
656ab57d1ddc
update a few runtime files
Christian Brabandt <cb@256bit.org>
parents:
13051
diff
changeset
|
5859 new file has been successfully written, that's why it must be possible |
|
656ab57d1ddc
update a few runtime files
Christian Brabandt <cb@256bit.org>
parents:
13051
diff
changeset
|
5860 to write a backup file). If there was no file to be backed up, an |
|
656ab57d1ddc
update a few runtime files
Christian Brabandt <cb@256bit.org>
parents:
13051
diff
changeset
|
5861 empty file is created. |
| 7 | 5862 When the 'backupskip' pattern matches, a patchmode file is not made. |
| 5863 Using 'patchmode' for compressed files appends the extension at the | |
| 5864 end (e.g., "file.gz.orig"), thus the resulting name isn't always | |
| 5865 recognized as a compressed file. | |
| 36 | 5866 Only normal file name characters can be used, "/\*?[|<>" are illegal. |
| 7 | 5867 |
| 3224 | 5868 *'path'* *'pa'* *E343* *E345* *E347* *E854* |
| 7 | 5869 'path' 'pa' string (default on Unix: ".,/usr/include,," |
| 5870 other systems: ".,,") | |
| 5871 global or local to buffer |global-local| | |
| 5872 This is a list of directories which will be searched when using the | |
| 1668 | 5873 |gf|, [f, ]f, ^Wf, |:find|, |:sfind|, |:tabfind| and other commands, |
| 5874 provided that the file being searched for has a relative path (not | |
| 5875 starting with "/", "./" or "../"). The directories in the 'path' | |
| 5876 option may be relative or absolute. | |
| 7 | 5877 - Use commas to separate directory names: > |
| 5878 :set path=.,/usr/local/include,/usr/include | |
| 5879 < - Spaces can also be used to separate directory names (for backwards | |
| 5880 compatibility with version 3.0). To have a space in a directory | |
| 5881 name, precede it with an extra backslash, and escape the space: > | |
| 5882 :set path=.,/dir/with\\\ space | |
| 5883 < - To include a comma in a directory name precede it with an extra | |
| 5884 backslash: > | |
| 5885 :set path=.,/dir/with\\,comma | |
| 5886 < - To search relative to the directory of the current file, use: > | |
| 5887 :set path=. | |
| 5888 < - To search in the current directory use an empty string between two | |
| 5889 commas: > | |
| 5890 :set path=,, | |
| 5891 < - A directory name may end in a ':' or '/'. | |
| 5892 - Environment variables are expanded |:set_env|. | |
| 5893 - When using |netrw.vim| URLs can be used. For example, adding | |
| 5894 "http://www.vim.org" will make ":find index.html" work. | |
| 1668 | 5895 - Search upwards and downwards in a directory tree using "*", "**" and |
| 5896 ";". See |file-searching| for info and syntax. | |
| 7 | 5897 {not available when compiled without the |+path_extra| feature} |
| 5898 - Careful with '\' characters, type two to get one in the option: > | |
| 5899 :set path=.,c:\\include | |
| 5900 < Or just use '/' instead: > | |
| 5901 :set path=.,c:/include | |
| 5902 < Don't forget "." or files won't even be found in the same directory as | |
| 5903 the file! | |
| 10 | 5904 The maximum length is limited. How much depends on the system, mostly |
| 7 | 5905 it is something like 256 or 1024 characters. |
| 5906 You can check if all the include files are found, using the value of | |
| 5907 'path', see |:checkpath|. | |
| 5908 The use of |:set+=| and |:set-=| is preferred when adding or removing | |
| 5909 directories from the list. This avoids problems when a future version | |
| 5910 uses another default. To remove the current directory use: > | |
| 5911 :set path-= | |
| 5912 < To add the current directory use: > | |
| 5913 :set path+= | |
| 5914 < To use an environment variable, you probably need to replace the | |
| 5915 separator. Here is an example to append $INCL, in which directory | |
| 5916 names are separated with a semi-colon: > | |
| 27903 | 5917 :let &path = &path .. "," .. substitute($INCL, ';', ',', 'g') |
| 7 | 5918 < Replace the ';' with a ':' or whatever separator is used. Note that |
| 5919 this doesn't work when $INCL contains a comma or white space. | |
| 5920 | |
| 12499 | 5921 *'perldll'* |
| 5922 'perldll' string (default depends on the build) | |
| 5923 global | |
| 5924 {only available when compiled with the |+perl/dyn| | |
| 5925 feature} | |
| 5926 Specifies the name of the Perl shared library. The default is | |
| 5927 DYNAMIC_PERL_DLL, which was specified at compile time. | |
| 5928 Environment variables are expanded |:set_env|. | |
| 5929 This option cannot be set from a |modeline| or in the |sandbox|, for | |
| 5930 security reasons. | |
| 5931 | |
| 7 | 5932 *'preserveindent'* *'pi'* *'nopreserveindent'* *'nopi'* |
| 5933 'preserveindent' 'pi' boolean (default off) | |
| 5934 local to buffer | |
| 5935 When changing the indent of the current line, preserve as much of the | |
| 5936 indent structure as possible. Normally the indent is replaced by a | |
| 5937 series of tabs followed by spaces as required (unless |'expandtab'| is | |
| 5938 enabled, in which case only spaces are used). Enabling this option | |
| 5939 means the indent will preserve as many existing characters as possible | |
| 5940 for indenting, and only add additional tabs or spaces as required. | |
| 1621 | 5941 'expandtab' does not apply to the preserved white space, a Tab remains |
| 5942 a Tab. | |
| 7 | 5943 NOTE: When using ">>" multiple times the resulting indent is a mix of |
| 5944 tabs and spaces. You might not like this. | |
| 11160 | 5945 NOTE: This option is reset when 'compatible' is set. |
| 7 | 5946 Also see 'copyindent'. |
| 5947 Use |:retab| to clean up white space. | |
| 5948 | |
| 5949 *'previewheight'* *'pvh'* | |
| 5950 'previewheight' 'pvh' number (default 12) | |
| 5951 global | |
|
17771
4bd21046902b
patch 8.1.1882: cannot specify properties of the info popup window
Bram Moolenaar <Bram@vim.org>
parents:
17767
diff
changeset
|
5952 {not available when compiled without the |+quickfix| |
|
4bd21046902b
patch 8.1.1882: cannot specify properties of the info popup window
Bram Moolenaar <Bram@vim.org>
parents:
17767
diff
changeset
|
5953 feature} |
| 7 | 5954 Default height for a preview window. Used for |:ptag| and associated |
|
17431
ce35cdbe9f74
patch 8.1.1714: cannot preview a file in a popup window
Bram Moolenaar <Bram@vim.org>
parents:
17372
diff
changeset
|
5955 commands. Used for |CTRL-W_}| when no count is given. Not used when |
|
ce35cdbe9f74
patch 8.1.1714: cannot preview a file in a popup window
Bram Moolenaar <Bram@vim.org>
parents:
17372
diff
changeset
|
5956 'previewpopup' is set. |
|
ce35cdbe9f74
patch 8.1.1714: cannot preview a file in a popup window
Bram Moolenaar <Bram@vim.org>
parents:
17372
diff
changeset
|
5957 |
|
ce35cdbe9f74
patch 8.1.1714: cannot preview a file in a popup window
Bram Moolenaar <Bram@vim.org>
parents:
17372
diff
changeset
|
5958 *'previewpopup'* *'pvp'* |
|
ce35cdbe9f74
patch 8.1.1714: cannot preview a file in a popup window
Bram Moolenaar <Bram@vim.org>
parents:
17372
diff
changeset
|
5959 'previewpopup' 'pvp' string (default empty) |
|
ce35cdbe9f74
patch 8.1.1714: cannot preview a file in a popup window
Bram Moolenaar <Bram@vim.org>
parents:
17372
diff
changeset
|
5960 global |
|
17771
4bd21046902b
patch 8.1.1882: cannot specify properties of the info popup window
Bram Moolenaar <Bram@vim.org>
parents:
17767
diff
changeset
|
5961 {not available when compiled without the |+textprop| |
|
4bd21046902b
patch 8.1.1882: cannot specify properties of the info popup window
Bram Moolenaar <Bram@vim.org>
parents:
17767
diff
changeset
|
5962 or |+quickfix| feature} |
|
17431
ce35cdbe9f74
patch 8.1.1714: cannot preview a file in a popup window
Bram Moolenaar <Bram@vim.org>
parents:
17372
diff
changeset
|
5963 When not empty a popup window is used for commands that would open a |
|
ce35cdbe9f74
patch 8.1.1714: cannot preview a file in a popup window
Bram Moolenaar <Bram@vim.org>
parents:
17372
diff
changeset
|
5964 preview window. See |preview-popup|. |
|
17767
c75da1064e33
patch 8.1.1880: cannot show extra info for completion in a popup window
Bram Moolenaar <Bram@vim.org>
parents:
17571
diff
changeset
|
5965 Not used for the insert completion info, add "popup" to |
|
c75da1064e33
patch 8.1.1880: cannot show extra info for completion in a popup window
Bram Moolenaar <Bram@vim.org>
parents:
17571
diff
changeset
|
5966 'completeopt' for that. |
| 7 | 5967 |
| 5968 *'previewwindow'* *'nopreviewwindow'* | |
| 5969 *'pvw'* *'nopvw'* *E590* | |
| 5970 'previewwindow' 'pvw' boolean (default off) | |
| 5971 local to window | |
|
17771
4bd21046902b
patch 8.1.1882: cannot specify properties of the info popup window
Bram Moolenaar <Bram@vim.org>
parents:
17767
diff
changeset
|
5972 {not available when compiled without the |+quickfix| |
|
4bd21046902b
patch 8.1.1882: cannot specify properties of the info popup window
Bram Moolenaar <Bram@vim.org>
parents:
17767
diff
changeset
|
5973 feature} |
| 10 | 5974 Identifies the preview window. Only one window can have this option |
| 7 | 5975 set. It's normally not set directly, but by using one of the commands |
| 5976 |:ptag|, |:pedit|, etc. | |
| 5977 | |
| 5978 *'printdevice'* *'pdev'* | |
| 5979 'printdevice' 'pdev' string (default empty) | |
| 5980 global | |
| 5981 {only available when compiled with the |+printer| | |
| 5982 feature} | |
| 15 | 5983 The name of the printer to be used for |:hardcopy|. |
| 5984 See |pdev-option|. | |
| 36 | 5985 This option cannot be set from a |modeline| or in the |sandbox|, for |
| 5986 security reasons. | |
| 15 | 5987 |
| 5988 *'printencoding'* *'penc'* | |
| 14864 | 5989 'printencoding' 'penc' string (default empty, except for some systems) |
| 7 | 5990 global |
| 5991 {only available when compiled with the |+printer| | |
| 5992 and |+postscript| features} | |
| 15 | 5993 Sets the character encoding used when printing. |
| 5994 See |penc-option|. | |
| 7 | 5995 |
| 5996 *'printexpr'* *'pexpr'* | |
| 14864 | 5997 'printexpr' 'pexpr' string (default: see below) |
| 7 | 5998 global |
| 5999 {only available when compiled with the |+printer| | |
| 6000 and |+postscript| features} | |
| 15 | 6001 Expression used to print the PostScript produced with |:hardcopy|. |
| 6002 See |pexpr-option|. | |
|
10449
222b1432814e
commit https://github.com/vim/vim/commit/5162822914372fc916a93f85848c0c82209e7cec
Christian Brabandt <cb@256bit.org>
parents:
10272
diff
changeset
|
6003 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
|
6004 security reasons. |
| 15 | 6005 |
| 6006 *'printfont'* *'pfn'* | |
| 7 | 6007 'printfont' 'pfn' string (default "courier") |
| 6008 global | |
| 6009 {only available when compiled with the |+printer| | |
| 6010 feature} | |
| 15 | 6011 The name of the font that will be used for |:hardcopy|. |
| 6012 See |pfn-option|. | |
| 7 | 6013 |
| 6014 *'printheader'* *'pheader'* | |
| 6015 'printheader' 'pheader' string (default "%<%f%h%m%=Page %N") | |
| 6016 global | |
| 6017 {only available when compiled with the |+printer| | |
| 6018 feature} | |
| 15 | 6019 The format of the header produced in |:hardcopy| output. |
| 6020 See |pheader-option|. | |
| 6021 | |
| 6022 *'printmbcharset'* *'pmbcs'* | |
| 6023 'printmbcharset' 'pmbcs' string (default "") | |
| 6024 global | |
| 15878 | 6025 {only available when compiled with the |+printer| |
| 6026 and |+postscript| features} | |
| 15 | 6027 The CJK character set to be used for CJK output from |:hardcopy|. |
| 6028 See |pmbcs-option|. | |
| 6029 | |
| 6030 *'printmbfont'* *'pmbfn'* | |
| 6031 'printmbfont' 'pmbfn' string (default "") | |
| 6032 global | |
| 15878 | 6033 {only available when compiled with the |+printer| |
| 6034 and |+postscript| features} | |
| 15 | 6035 List of font names to be used for CJK output from |:hardcopy|. |
| 6036 See |pmbfn-option|. | |
| 7 | 6037 |
| 6038 *'printoptions'* *'popt'* | |
| 6039 'printoptions' 'popt' string (default "") | |
| 6040 global | |
| 6041 {only available when compiled with |+printer| feature} | |
| 15 | 6042 List of items that control the format of the output of |:hardcopy|. |
| 6043 See |popt-option|. | |
| 6044 | |
| 168 | 6045 *'prompt'* *'noprompt'* |
| 6046 'prompt' boolean (default on) | |
| 6047 global | |
| 6048 When on a ":" prompt is used in Ex mode. | |
| 6049 | |
| 766 | 6050 *'pumheight'* *'ph'* |
| 6051 'pumheight' 'ph' number (default 0) | |
| 6052 global | |
| 853 | 6053 Determines the maximum number of items to show in the popup menu for |
| 6054 Insert mode completion. When zero as much space as available is used. | |
| 766 | 6055 |ins-completion-menu|. |
| 6056 | |
|
13234
6e972d830e13
patch 8.0.1491: the minimum width of the popup menu is hard coded
Christian Brabandt <cb@256bit.org>
parents:
13231
diff
changeset
|
6057 *'pumwidth'* *'pw'* |
|
13314
65c3e8259124
patch 8.0.1531: cannot use 24 bit colors in MS-Windows console
Christian Brabandt <cb@256bit.org>
parents:
13234
diff
changeset
|
6058 'pumwidth' 'pw' number (default 15) |
|
13234
6e972d830e13
patch 8.0.1491: the minimum width of the popup menu is hard coded
Christian Brabandt <cb@256bit.org>
parents:
13231
diff
changeset
|
6059 global |
|
13341
acd7eaa13d2b
Updated runtime files.
Christian Brabandt <cb@256bit.org>
parents:
13314
diff
changeset
|
6060 Determines the minimum width to use for the popup menu for Insert mode |
|
13314
65c3e8259124
patch 8.0.1531: cannot use 24 bit colors in MS-Windows console
Christian Brabandt <cb@256bit.org>
parents:
13234
diff
changeset
|
6061 completion. |ins-completion-menu|. |
|
13234
6e972d830e13
patch 8.0.1491: the minimum width of the popup menu is hard coded
Christian Brabandt <cb@256bit.org>
parents:
13231
diff
changeset
|
6062 |
|
7228
873eae260c97
commit https://github.com/vim/vim/commit/b4ff518d95aa57c2f8c0568c915035bef849581b
Christian Brabandt <cb@256bit.org>
parents:
7218
diff
changeset
|
6063 *'pythondll'* |
|
8629
54ac275e3fc4
commit https://github.com/vim/vim/commit/3848e00e0177abdb31bc600234967863ec487233
Christian Brabandt <cb@256bit.org>
parents:
8560
diff
changeset
|
6064 '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
|
6065 global |
|
7228
873eae260c97
commit https://github.com/vim/vim/commit/b4ff518d95aa57c2f8c0568c915035bef849581b
Christian Brabandt <cb@256bit.org>
parents:
7218
diff
changeset
|
6066 {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
|
6067 feature} |
|
7528
53163e4d9e4f
commit https://github.com/vim/vim/commit/25e4fcde767084d1a79e0926bc301c92987c0cce
Christian Brabandt <cb@256bit.org>
parents:
7477
diff
changeset
|
6068 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
|
6069 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
|
6070 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
|
6071 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
|
6072 security reasons. |
|
873eae260c97
commit https://github.com/vim/vim/commit/b4ff518d95aa57c2f8c0568c915035bef849581b
Christian Brabandt <cb@256bit.org>
parents:
7218
diff
changeset
|
6073 |
|
13154
53cc7ea77c54
patch 8.0.1451: difficult to set the python home directories properly
Christian Brabandt <cb@256bit.org>
parents:
13150
diff
changeset
|
6074 *'pythonhome'* |
|
53cc7ea77c54
patch 8.0.1451: difficult to set the python home directories properly
Christian Brabandt <cb@256bit.org>
parents:
13150
diff
changeset
|
6075 'pythonhome' string (default "") |
|
53cc7ea77c54
patch 8.0.1451: difficult to set the python home directories properly
Christian Brabandt <cb@256bit.org>
parents:
13150
diff
changeset
|
6076 global |
|
53cc7ea77c54
patch 8.0.1451: difficult to set the python home directories properly
Christian Brabandt <cb@256bit.org>
parents:
13150
diff
changeset
|
6077 {only available when compiled with the |+python/dyn| |
|
53cc7ea77c54
patch 8.0.1451: difficult to set the python home directories properly
Christian Brabandt <cb@256bit.org>
parents:
13150
diff
changeset
|
6078 feature} |
|
53cc7ea77c54
patch 8.0.1451: difficult to set the python home directories properly
Christian Brabandt <cb@256bit.org>
parents:
13150
diff
changeset
|
6079 Specifies the name of the Python 2.x home directory. When 'pythonhome' |
|
53cc7ea77c54
patch 8.0.1451: difficult to set the python home directories properly
Christian Brabandt <cb@256bit.org>
parents:
13150
diff
changeset
|
6080 and the PYTHONHOME environment variable are not set, PYTHON_HOME, |
|
53cc7ea77c54
patch 8.0.1451: difficult to set the python home directories properly
Christian Brabandt <cb@256bit.org>
parents:
13150
diff
changeset
|
6081 which was specified at compile time, will be used for the Python 2.x |
|
53cc7ea77c54
patch 8.0.1451: difficult to set the python home directories properly
Christian Brabandt <cb@256bit.org>
parents:
13150
diff
changeset
|
6082 home directory. |
|
53cc7ea77c54
patch 8.0.1451: difficult to set the python home directories properly
Christian Brabandt <cb@256bit.org>
parents:
13150
diff
changeset
|
6083 Environment variables are expanded |:set_env|. |
|
53cc7ea77c54
patch 8.0.1451: difficult to set the python home directories properly
Christian Brabandt <cb@256bit.org>
parents:
13150
diff
changeset
|
6084 This option cannot be set from a |modeline| or in the |sandbox|, for |
|
53cc7ea77c54
patch 8.0.1451: difficult to set the python home directories properly
Christian Brabandt <cb@256bit.org>
parents:
13150
diff
changeset
|
6085 security reasons. |
|
53cc7ea77c54
patch 8.0.1451: difficult to set the python home directories properly
Christian Brabandt <cb@256bit.org>
parents:
13150
diff
changeset
|
6086 |
|
7218
36dc8df8560f
commit https://github.com/vim/vim/commit/0796c0625fa4b9eb2f47fe8c976b78523924e1fb
Christian Brabandt <cb@256bit.org>
parents:
7196
diff
changeset
|
6087 *'pythonthreedll'* |
|
7528
53163e4d9e4f
commit https://github.com/vim/vim/commit/25e4fcde767084d1a79e0926bc301c92987c0cce
Christian Brabandt <cb@256bit.org>
parents:
7477
diff
changeset
|
6088 '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
|
6089 global |
|
7196
42717d048817
commit https://github.com/vim/vim/commit/d94464ee294a351ce7b6ba18e8bd3f24f1bef920
Christian Brabandt <cb@256bit.org>
parents:
7147
diff
changeset
|
6090 {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
|
6091 feature} |
|
7528
53163e4d9e4f
commit https://github.com/vim/vim/commit/25e4fcde767084d1a79e0926bc301c92987c0cce
Christian Brabandt <cb@256bit.org>
parents:
7477
diff
changeset
|
6092 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
|
6093 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
|
6094 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
|
6095 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
|
6096 security reasons. |
|
42717d048817
commit https://github.com/vim/vim/commit/d94464ee294a351ce7b6ba18e8bd3f24f1bef920
Christian Brabandt <cb@256bit.org>
parents:
7147
diff
changeset
|
6097 |
|
13154
53cc7ea77c54
patch 8.0.1451: difficult to set the python home directories properly
Christian Brabandt <cb@256bit.org>
parents:
13150
diff
changeset
|
6098 *'pythonthreehome'* |
|
53cc7ea77c54
patch 8.0.1451: difficult to set the python home directories properly
Christian Brabandt <cb@256bit.org>
parents:
13150
diff
changeset
|
6099 'pythonthreehome' string (default "") |
|
53cc7ea77c54
patch 8.0.1451: difficult to set the python home directories properly
Christian Brabandt <cb@256bit.org>
parents:
13150
diff
changeset
|
6100 global |
|
53cc7ea77c54
patch 8.0.1451: difficult to set the python home directories properly
Christian Brabandt <cb@256bit.org>
parents:
13150
diff
changeset
|
6101 {only available when compiled with the |+python3/dyn| |
|
53cc7ea77c54
patch 8.0.1451: difficult to set the python home directories properly
Christian Brabandt <cb@256bit.org>
parents:
13150
diff
changeset
|
6102 feature} |
|
53cc7ea77c54
patch 8.0.1451: difficult to set the python home directories properly
Christian Brabandt <cb@256bit.org>
parents:
13150
diff
changeset
|
6103 Specifies the name of the Python 3 home directory. When |
|
53cc7ea77c54
patch 8.0.1451: difficult to set the python home directories properly
Christian Brabandt <cb@256bit.org>
parents:
13150
diff
changeset
|
6104 'pythonthreehome' and the PYTHONHOME environment variable are not set, |
|
53cc7ea77c54
patch 8.0.1451: difficult to set the python home directories properly
Christian Brabandt <cb@256bit.org>
parents:
13150
diff
changeset
|
6105 PYTHON3_HOME, which was specified at compile time, will be used for |
|
53cc7ea77c54
patch 8.0.1451: difficult to set the python home directories properly
Christian Brabandt <cb@256bit.org>
parents:
13150
diff
changeset
|
6106 the Python 3 home directory. |
|
53cc7ea77c54
patch 8.0.1451: difficult to set the python home directories properly
Christian Brabandt <cb@256bit.org>
parents:
13150
diff
changeset
|
6107 Environment variables are expanded |:set_env|. |
|
53cc7ea77c54
patch 8.0.1451: difficult to set the python home directories properly
Christian Brabandt <cb@256bit.org>
parents:
13150
diff
changeset
|
6108 This option cannot be set from a |modeline| or in the |sandbox|, for |
|
53cc7ea77c54
patch 8.0.1451: difficult to set the python home directories properly
Christian Brabandt <cb@256bit.org>
parents:
13150
diff
changeset
|
6109 security reasons. |
|
53cc7ea77c54
patch 8.0.1451: difficult to set the python home directories properly
Christian Brabandt <cb@256bit.org>
parents:
13150
diff
changeset
|
6110 |
|
10722
7598ce51bf2a
patch 8.0.0251: not easy to select Python 2 or 3
Christian Brabandt <cb@256bit.org>
parents:
10617
diff
changeset
|
6111 *'pyxversion'* *'pyx'* |
|
7598ce51bf2a
patch 8.0.0251: not easy to select Python 2 or 3
Christian Brabandt <cb@256bit.org>
parents:
10617
diff
changeset
|
6112 'pyxversion' 'pyx' number (default depends on the build) |
|
7598ce51bf2a
patch 8.0.0251: not easy to select Python 2 or 3
Christian Brabandt <cb@256bit.org>
parents:
10617
diff
changeset
|
6113 global |
|
7598ce51bf2a
patch 8.0.0251: not easy to select Python 2 or 3
Christian Brabandt <cb@256bit.org>
parents:
10617
diff
changeset
|
6114 {only available when compiled with the |+python| or |
|
7598ce51bf2a
patch 8.0.0251: not easy to select Python 2 or 3
Christian Brabandt <cb@256bit.org>
parents:
10617
diff
changeset
|
6115 the |+python3| feature} |
|
7598ce51bf2a
patch 8.0.0251: not easy to select Python 2 or 3
Christian Brabandt <cb@256bit.org>
parents:
10617
diff
changeset
|
6116 Specifies the python version used for pyx* functions and commands |
|
7598ce51bf2a
patch 8.0.0251: not easy to select Python 2 or 3
Christian Brabandt <cb@256bit.org>
parents:
10617
diff
changeset
|
6117 |python_x|. The default value is as follows: |
|
7598ce51bf2a
patch 8.0.0251: not easy to select Python 2 or 3
Christian Brabandt <cb@256bit.org>
parents:
10617
diff
changeset
|
6118 |
|
7598ce51bf2a
patch 8.0.0251: not easy to select Python 2 or 3
Christian Brabandt <cb@256bit.org>
parents:
10617
diff
changeset
|
6119 Compiled with Default ~ |
|
7598ce51bf2a
patch 8.0.0251: not easy to select Python 2 or 3
Christian Brabandt <cb@256bit.org>
parents:
10617
diff
changeset
|
6120 |+python| and |+python3| 0 |
|
7598ce51bf2a
patch 8.0.0251: not easy to select Python 2 or 3
Christian Brabandt <cb@256bit.org>
parents:
10617
diff
changeset
|
6121 only |+python| 2 |
|
7598ce51bf2a
patch 8.0.0251: not easy to select Python 2 or 3
Christian Brabandt <cb@256bit.org>
parents:
10617
diff
changeset
|
6122 only |+python3| 3 |
|
7598ce51bf2a
patch 8.0.0251: not easy to select Python 2 or 3
Christian Brabandt <cb@256bit.org>
parents:
10617
diff
changeset
|
6123 |
|
7598ce51bf2a
patch 8.0.0251: not easy to select Python 2 or 3
Christian Brabandt <cb@256bit.org>
parents:
10617
diff
changeset
|
6124 Available values are 0, 2 and 3. |
|
7598ce51bf2a
patch 8.0.0251: not easy to select Python 2 or 3
Christian Brabandt <cb@256bit.org>
parents:
10617
diff
changeset
|
6125 If 'pyxversion' is 0, it is set to 2 or 3 after the first execution of |
|
7598ce51bf2a
patch 8.0.0251: not easy to select Python 2 or 3
Christian Brabandt <cb@256bit.org>
parents:
10617
diff
changeset
|
6126 any python2/3 commands or functions. E.g. `:py` sets to 2, and `:py3` |
|
7598ce51bf2a
patch 8.0.0251: not easy to select Python 2 or 3
Christian Brabandt <cb@256bit.org>
parents:
10617
diff
changeset
|
6127 sets to 3. `:pyx` sets it to 3 if Python 3 is available, otherwise sets |
|
7598ce51bf2a
patch 8.0.0251: not easy to select Python 2 or 3
Christian Brabandt <cb@256bit.org>
parents:
10617
diff
changeset
|
6128 to 2 if Python 2 is available. |
|
7598ce51bf2a
patch 8.0.0251: not easy to select Python 2 or 3
Christian Brabandt <cb@256bit.org>
parents:
10617
diff
changeset
|
6129 See also: |has-pythonx| |
|
7598ce51bf2a
patch 8.0.0251: not easy to select Python 2 or 3
Christian Brabandt <cb@256bit.org>
parents:
10617
diff
changeset
|
6130 |
|
7598ce51bf2a
patch 8.0.0251: not easy to select Python 2 or 3
Christian Brabandt <cb@256bit.org>
parents:
10617
diff
changeset
|
6131 If Vim is compiled with only |+python| or |+python3| setting |
|
7598ce51bf2a
patch 8.0.0251: not easy to select Python 2 or 3
Christian Brabandt <cb@256bit.org>
parents:
10617
diff
changeset
|
6132 'pyxversion' has no effect. The pyx* functions and commands are |
|
7598ce51bf2a
patch 8.0.0251: not easy to select Python 2 or 3
Christian Brabandt <cb@256bit.org>
parents:
10617
diff
changeset
|
6133 always the same as the compiled version. |
|
7598ce51bf2a
patch 8.0.0251: not easy to select Python 2 or 3
Christian Brabandt <cb@256bit.org>
parents:
10617
diff
changeset
|
6134 |
|
7598ce51bf2a
patch 8.0.0251: not easy to select Python 2 or 3
Christian Brabandt <cb@256bit.org>
parents:
10617
diff
changeset
|
6135 This option cannot be set from a |modeline| or in the |sandbox|, for |
|
7598ce51bf2a
patch 8.0.0251: not easy to select Python 2 or 3
Christian Brabandt <cb@256bit.org>
parents:
10617
diff
changeset
|
6136 security reasons. |
|
7598ce51bf2a
patch 8.0.0251: not easy to select Python 2 or 3
Christian Brabandt <cb@256bit.org>
parents:
10617
diff
changeset
|
6137 |
|
20631
d6827bd31d1d
patch 8.2.0869: it is not possible to customize the quickfix window contents
Bram Moolenaar <Bram@vim.org>
parents:
20613
diff
changeset
|
6138 *'quickfixtextfunc'* *'qftf'* |
|
d6827bd31d1d
patch 8.2.0869: it is not possible to customize the quickfix window contents
Bram Moolenaar <Bram@vim.org>
parents:
20613
diff
changeset
|
6139 'quickfixtextfunc' 'qftf' string (default "") |
|
d6827bd31d1d
patch 8.2.0869: it is not possible to customize the quickfix window contents
Bram Moolenaar <Bram@vim.org>
parents:
20613
diff
changeset
|
6140 global |
|
d6827bd31d1d
patch 8.2.0869: it is not possible to customize the quickfix window contents
Bram Moolenaar <Bram@vim.org>
parents:
20613
diff
changeset
|
6141 {only available when compiled with the |+quickfix| |
|
d6827bd31d1d
patch 8.2.0869: it is not possible to customize the quickfix window contents
Bram Moolenaar <Bram@vim.org>
parents:
20613
diff
changeset
|
6142 feature} |
|
d6827bd31d1d
patch 8.2.0869: it is not possible to customize the quickfix window contents
Bram Moolenaar <Bram@vim.org>
parents:
20613
diff
changeset
|
6143 This option specifies a function to be used to get the text to display |
|
d6827bd31d1d
patch 8.2.0869: it is not possible to customize the quickfix window contents
Bram Moolenaar <Bram@vim.org>
parents:
20613
diff
changeset
|
6144 in the quickfix and location list windows. This can be used to |
|
d6827bd31d1d
patch 8.2.0869: it is not possible to customize the quickfix window contents
Bram Moolenaar <Bram@vim.org>
parents:
20613
diff
changeset
|
6145 customize the information displayed in the quickfix or location window |
|
d6827bd31d1d
patch 8.2.0869: it is not possible to customize the quickfix window contents
Bram Moolenaar <Bram@vim.org>
parents:
20613
diff
changeset
|
6146 for each entry in the corresponding quickfix or location list. See |
|
d6827bd31d1d
patch 8.2.0869: it is not possible to customize the quickfix window contents
Bram Moolenaar <Bram@vim.org>
parents:
20613
diff
changeset
|
6147 |quickfix-window-function| for an explanation of how to write the |
|
26175
6b4f017d7005
patch 8.2.3619: cannot use a lambda for 'operatorfunc'
Bram Moolenaar <Bram@vim.org>
parents:
26148
diff
changeset
|
6148 function and an example. The value can be the name of a function, a |
|
6b4f017d7005
patch 8.2.3619: cannot use a lambda for 'operatorfunc'
Bram Moolenaar <Bram@vim.org>
parents:
26148
diff
changeset
|
6149 |lambda| or a |Funcref|. See |option-value-function| for more |
|
6b4f017d7005
patch 8.2.3619: cannot use a lambda for 'operatorfunc'
Bram Moolenaar <Bram@vim.org>
parents:
26148
diff
changeset
|
6150 information. |
|
20631
d6827bd31d1d
patch 8.2.0869: it is not possible to customize the quickfix window contents
Bram Moolenaar <Bram@vim.org>
parents:
20613
diff
changeset
|
6151 |
|
d6827bd31d1d
patch 8.2.0869: it is not possible to customize the quickfix window contents
Bram Moolenaar <Bram@vim.org>
parents:
20613
diff
changeset
|
6152 This option cannot be set from a |modeline| or in the |sandbox|, for |
|
d6827bd31d1d
patch 8.2.0869: it is not possible to customize the quickfix window contents
Bram Moolenaar <Bram@vim.org>
parents:
20613
diff
changeset
|
6153 security reasons. |
|
d6827bd31d1d
patch 8.2.0869: it is not possible to customize the quickfix window contents
Bram Moolenaar <Bram@vim.org>
parents:
20613
diff
changeset
|
6154 |
| 140 | 6155 *'quoteescape'* *'qe'* |
| 12 | 6156 'quoteescape' 'qe' string (default "\") |
| 6157 local to buffer | |
| 6158 The characters that are used to escape quotes in a string. Used for | |
| 6159 objects like a', a" and a` |a'|. | |
| 6160 When one of the characters in this option is found inside a string, | |
| 6161 the following character will be skipped. The default value makes the | |
| 6162 text "foo\"bar\\" considered to be one string. | |
| 6163 | |
| 7 | 6164 *'readonly'* *'ro'* *'noreadonly'* *'noro'* |
| 6165 'readonly' 'ro' boolean (default off) | |
| 6166 local to buffer | |
| 6167 If on, writes fail unless you use a '!'. Protects you from | |
| 6168 accidentally overwriting a file. Default on when Vim is started | |
| 6169 in read-only mode ("vim -R") or when the executable is called "view". | |
| 164 | 6170 When using ":w!" the 'readonly' option is reset for the current |
| 6171 buffer, unless the 'Z' flag is in 'cpoptions'. | |
|
16443
32a543152dc0
patch 8.1.1226: {not in Vi} remarks get in the way of useful help text
Bram Moolenaar <Bram@vim.org>
parents:
16439
diff
changeset
|
6172 When using the ":view" command the 'readonly' option is set for the |
|
32a543152dc0
patch 8.1.1226: {not in Vi} remarks get in the way of useful help text
Bram Moolenaar <Bram@vim.org>
parents:
16439
diff
changeset
|
6173 newly edited buffer. |
| 10617 | 6174 See 'modifiable' for disallowing changes to the buffer. |
| 7 | 6175 |
| 1521 | 6176 *'redrawtime'* *'rdt'* |
| 6177 'redrawtime' 'rdt' number (default 2000) | |
| 6178 global | |
| 6179 {only available when compiled with the |+reltime| | |
| 6180 feature} | |
| 6181 The time in milliseconds for redrawing the display. This applies to | |
|
13818
28ac7914b2b6
Update runtime files and translations
Christian Brabandt <cb@256bit.org>
parents:
13742
diff
changeset
|
6182 searching for patterns for 'hlsearch', |:match| highlighting and syntax |
|
11529
998d2cf59caa
patch 8.0.0647: syntax highlighting can make cause a freeze
Christian Brabandt <cb@256bit.org>
parents:
11516
diff
changeset
|
6183 highlighting. |
| 1521 | 6184 When redrawing takes more than this many milliseconds no further |
|
11529
998d2cf59caa
patch 8.0.0647: syntax highlighting can make cause a freeze
Christian Brabandt <cb@256bit.org>
parents:
11516
diff
changeset
|
6185 matches will be highlighted. |
|
998d2cf59caa
patch 8.0.0647: syntax highlighting can make cause a freeze
Christian Brabandt <cb@256bit.org>
parents:
11516
diff
changeset
|
6186 For syntax highlighting the time applies per window. When over the |
|
998d2cf59caa
patch 8.0.0647: syntax highlighting can make cause a freeze
Christian Brabandt <cb@256bit.org>
parents:
11516
diff
changeset
|
6187 limit syntax highlighting is disabled until |CTRL-L| is used. |
|
998d2cf59caa
patch 8.0.0647: syntax highlighting can make cause a freeze
Christian Brabandt <cb@256bit.org>
parents:
11516
diff
changeset
|
6188 This is used to avoid that Vim hangs when using a very complicated |
|
998d2cf59caa
patch 8.0.0647: syntax highlighting can make cause a freeze
Christian Brabandt <cb@256bit.org>
parents:
11516
diff
changeset
|
6189 pattern. |
| 1521 | 6190 |
|
4681
2eb30f341e8d
Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents:
4502
diff
changeset
|
6191 *'regexpengine'* *'re'* |
|
4502
605c9ce57ec3
Updated runtime files, language files and translations.
Bram Moolenaar <bram@vim.org>
parents:
4358
diff
changeset
|
6192 'regexpengine' 're' number (default 0) |
|
605c9ce57ec3
Updated runtime files, language files and translations.
Bram Moolenaar <bram@vim.org>
parents:
4358
diff
changeset
|
6193 global |
|
605c9ce57ec3
Updated runtime files, language files and translations.
Bram Moolenaar <bram@vim.org>
parents:
4358
diff
changeset
|
6194 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
|
6195 The possible values are: |
|
605c9ce57ec3
Updated runtime files, language files and translations.
Bram Moolenaar <bram@vim.org>
parents:
4358
diff
changeset
|
6196 0 automatic selection |
|
605c9ce57ec3
Updated runtime files, language files and translations.
Bram Moolenaar <bram@vim.org>
parents:
4358
diff
changeset
|
6197 1 old engine |
|
605c9ce57ec3
Updated runtime files, language files and translations.
Bram Moolenaar <bram@vim.org>
parents:
4358
diff
changeset
|
6198 2 NFA engine |
|
605c9ce57ec3
Updated runtime files, language files and translations.
Bram Moolenaar <bram@vim.org>
parents:
4358
diff
changeset
|
6199 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
|
6200 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
|
6201 for debugging the regexp engine. |
| 6328 | 6202 Using automatic selection enables Vim to switch the engine, if the |
| 6203 default engine becomes too costly. E.g., when the NFA engine uses too | |
| 6204 many states. This should prevent Vim from hanging on a combination of | |
| 6205 a complex pattern with long text. | |
|
4502
605c9ce57ec3
Updated runtime files, language files and translations.
Bram Moolenaar <bram@vim.org>
parents:
4358
diff
changeset
|
6206 |
|
2178
c6f1aa1e9f32
Add 'relativenumber' patch from Markus Heidelberg.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
6207 *'relativenumber'* *'rnu'* *'norelativenumber'* *'nornu'* |
|
c6f1aa1e9f32
Add 'relativenumber' patch from Markus Heidelberg.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
6208 'relativenumber' 'rnu' boolean (default off) |
|
c6f1aa1e9f32
Add 'relativenumber' patch from Markus Heidelberg.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
6209 local to window |
|
c6f1aa1e9f32
Add 'relativenumber' patch from Markus Heidelberg.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
6210 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
|
6211 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
|
6212 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
|
6213 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
|
6214 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
|
6215 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
|
6216 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
|
6217 'compatible' isn't set). |
|
c6f1aa1e9f32
Add 'relativenumber' patch from Markus Heidelberg.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
6218 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
|
6219 number. |
|
c6f1aa1e9f32
Add 'relativenumber' patch from Markus Heidelberg.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
6220 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
|
6221 characters are put before the number. |
| 3445 | 6222 See |hl-LineNr| and |hl-CursorLineNr| for the highlighting used for |
| 6223 the number. | |
|
13341
acd7eaa13d2b
Updated runtime files.
Christian Brabandt <cb@256bit.org>
parents:
13314
diff
changeset
|
6224 |
| 4780 | 6225 The number in front of the cursor line also depends on the value of |
| 6226 'number', see |number_relativenumber| for all combinations of the two | |
| 6227 options. | |
|
2178
c6f1aa1e9f32
Add 'relativenumber' patch from Markus Heidelberg.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
6228 |
| 7 | 6229 *'remap'* *'noremap'* |
| 6230 'remap' boolean (default on) | |
| 6231 global | |
| 6232 Allows for mappings to work recursively. If you do not want this for | |
| 6233 a single entry, use the :noremap[!] command. | |
| 717 | 6234 NOTE: To avoid portability problems with Vim scripts, always keep |
| 6235 this option at the default "on". Only switch it off when working with | |
| 6236 old Vi scripts. | |
| 7 | 6237 |
| 6110 | 6238 *'renderoptions'* *'rop'* |
| 6239 'renderoptions' 'rop' string (default: empty) | |
| 6240 global | |
| 6241 {only available when compiled with GUI and DIRECTX on | |
| 6242 MS-Windows} | |
| 6243 Select a text renderer and set its options. The options depend on the | |
| 6244 renderer. | |
| 6245 | |
| 6246 Syntax: > | |
| 6247 set rop=type:{renderer}(,{name}:{value})* | |
| 6248 < | |
| 6249 Currently, only one optional renderer is available. | |
| 6250 | |
| 6251 render behavior ~ | |
| 6252 directx Vim will draw text using DirectX (DirectWrite). It makes | |
| 6253 drawn glyphs more beautiful than default GDI. | |
| 6254 It requires 'encoding' is "utf-8", and only works on | |
| 6255 MS-Windows Vista or newer version. | |
| 6256 | |
| 6257 Options: | |
| 6258 name meaning type value ~ | |
| 6259 gamma gamma float 1.0 - 2.2 (maybe) | |
| 6260 contrast enhancedContrast float (unknown) | |
| 6261 level clearTypeLevel float (unknown) | |
| 6262 geom pixelGeometry int 0 - 2 (see below) | |
| 6263 renmode renderingMode int 0 - 6 (see below) | |
| 6264 taamode textAntialiasMode int 0 - 3 (see below) | |
|
13150
808625d4b71b
patch 8.0.1449: slow redrawing with DirectX
Christian Brabandt <cb@256bit.org>
parents:
13100
diff
changeset
|
6265 scrlines Scroll Lines int (deprecated) |
|
12986
18e6f4addce9
patch 8.0.1369: MS-Windows: drawing underline slow, mFallbackDC not updated
Christian Brabandt <cb@256bit.org>
parents:
12971
diff
changeset
|
6266 |
|
18e6f4addce9
patch 8.0.1369: MS-Windows: drawing underline slow, mFallbackDC not updated
Christian Brabandt <cb@256bit.org>
parents:
12971
diff
changeset
|
6267 See this URL for detail (except for scrlines): |
|
18e6f4addce9
patch 8.0.1369: MS-Windows: drawing underline slow, mFallbackDC not updated
Christian Brabandt <cb@256bit.org>
parents:
12971
diff
changeset
|
6268 https://msdn.microsoft.com/en-us/library/dd368190.aspx |
| 6110 | 6269 |
| 6270 For geom: structure of a device pixel. | |
| 6271 0 - DWRITE_PIXEL_GEOMETRY_FLAT | |
| 6272 1 - DWRITE_PIXEL_GEOMETRY_RGB | |
| 6273 2 - DWRITE_PIXEL_GEOMETRY_BGR | |
| 6274 | |
| 6275 See this URL for detail: | |
|
12986
18e6f4addce9
patch 8.0.1369: MS-Windows: drawing underline slow, mFallbackDC not updated
Christian Brabandt <cb@256bit.org>
parents:
12971
diff
changeset
|
6276 https://msdn.microsoft.com/en-us/library/dd368114.aspx |
| 6110 | 6277 |
| 6278 For renmode: method of rendering glyphs. | |
| 6279 0 - DWRITE_RENDERING_MODE_DEFAULT | |
| 6280 1 - DWRITE_RENDERING_MODE_ALIASED | |
| 6281 2 - DWRITE_RENDERING_MODE_GDI_CLASSIC | |
| 6282 3 - DWRITE_RENDERING_MODE_GDI_NATURAL | |
| 6283 4 - DWRITE_RENDERING_MODE_NATURAL | |
| 6284 5 - DWRITE_RENDERING_MODE_NATURAL_SYMMETRIC | |
| 6285 6 - DWRITE_RENDERING_MODE_OUTLINE | |
| 6286 | |
| 6287 See this URL for detail: | |
|
12986
18e6f4addce9
patch 8.0.1369: MS-Windows: drawing underline slow, mFallbackDC not updated
Christian Brabandt <cb@256bit.org>
parents:
12971
diff
changeset
|
6288 https://msdn.microsoft.com/en-us/library/dd368118.aspx |
| 6110 | 6289 |
| 6290 For taamode: antialiasing mode used for drawing text. | |
| 6291 0 - D2D1_TEXT_ANTIALIAS_MODE_DEFAULT | |
| 6292 1 - D2D1_TEXT_ANTIALIAS_MODE_CLEARTYPE | |
| 6293 2 - D2D1_TEXT_ANTIALIAS_MODE_GRAYSCALE | |
| 6294 3 - D2D1_TEXT_ANTIALIAS_MODE_ALIASED | |
| 6295 | |
| 6296 See this URL for detail: | |
|
12986
18e6f4addce9
patch 8.0.1369: MS-Windows: drawing underline slow, mFallbackDC not updated
Christian Brabandt <cb@256bit.org>
parents:
12971
diff
changeset
|
6297 https://msdn.microsoft.com/en-us/library/dd368170.aspx |
|
18e6f4addce9
patch 8.0.1369: MS-Windows: drawing underline slow, mFallbackDC not updated
Christian Brabandt <cb@256bit.org>
parents:
12971
diff
changeset
|
6298 |
|
13150
808625d4b71b
patch 8.0.1449: slow redrawing with DirectX
Christian Brabandt <cb@256bit.org>
parents:
13100
diff
changeset
|
6299 For scrlines: |
|
808625d4b71b
patch 8.0.1449: slow redrawing with DirectX
Christian Brabandt <cb@256bit.org>
parents:
13100
diff
changeset
|
6300 This was used for optimizing scrolling behavior, however this |
|
808625d4b71b
patch 8.0.1449: slow redrawing with DirectX
Christian Brabandt <cb@256bit.org>
parents:
13100
diff
changeset
|
6301 is now deprecated. If specified, it is simply ignored. |
| 6110 | 6302 |
| 6303 Example: > | |
| 6304 set encoding=utf-8 | |
|
12934
2ebc3df65ca2
patch 8.0.1343: MS-Windows: does not show colored emojis
Christian Brabandt <cb@256bit.org>
parents:
12930
diff
changeset
|
6305 set gfn=Ricty_Diminished:h12 |
| 6110 | 6306 set rop=type:directx |
| 6307 < | |
|
12934
2ebc3df65ca2
patch 8.0.1343: MS-Windows: does not show colored emojis
Christian Brabandt <cb@256bit.org>
parents:
12930
diff
changeset
|
6308 If select a raster font (Courier, Terminal or FixedSys which |
|
2ebc3df65ca2
patch 8.0.1343: MS-Windows: does not show colored emojis
Christian Brabandt <cb@256bit.org>
parents:
12930
diff
changeset
|
6309 have ".fon" extension in file name) to 'guifont', it will be |
|
12986
18e6f4addce9
patch 8.0.1369: MS-Windows: drawing underline slow, mFallbackDC not updated
Christian Brabandt <cb@256bit.org>
parents:
12971
diff
changeset
|
6310 drawn by GDI as a fallback. |
|
12934
2ebc3df65ca2
patch 8.0.1343: MS-Windows: does not show colored emojis
Christian Brabandt <cb@256bit.org>
parents:
12930
diff
changeset
|
6311 |
|
2ebc3df65ca2
patch 8.0.1343: MS-Windows: does not show colored emojis
Christian Brabandt <cb@256bit.org>
parents:
12930
diff
changeset
|
6312 NOTE: It is known that some fonts and options combination |
|
2ebc3df65ca2
patch 8.0.1343: MS-Windows: does not show colored emojis
Christian Brabandt <cb@256bit.org>
parents:
12930
diff
changeset
|
6313 causes trouble on drawing glyphs. |
|
2ebc3df65ca2
patch 8.0.1343: MS-Windows: does not show colored emojis
Christian Brabandt <cb@256bit.org>
parents:
12930
diff
changeset
|
6314 |
|
12986
18e6f4addce9
patch 8.0.1369: MS-Windows: drawing underline slow, mFallbackDC not updated
Christian Brabandt <cb@256bit.org>
parents:
12971
diff
changeset
|
6315 - 'renmode:5' and 'renmode:6' will not work with some |
|
12934
2ebc3df65ca2
patch 8.0.1343: MS-Windows: does not show colored emojis
Christian Brabandt <cb@256bit.org>
parents:
12930
diff
changeset
|
6316 special made fonts (True-Type fonts which includes only |
|
2ebc3df65ca2
patch 8.0.1343: MS-Windows: does not show colored emojis
Christian Brabandt <cb@256bit.org>
parents:
12930
diff
changeset
|
6317 bitmap glyphs). |
|
2ebc3df65ca2
patch 8.0.1343: MS-Windows: does not show colored emojis
Christian Brabandt <cb@256bit.org>
parents:
12930
diff
changeset
|
6318 - 'taamode:3' will not work with some vector fonts. |
|
2ebc3df65ca2
patch 8.0.1343: MS-Windows: does not show colored emojis
Christian Brabandt <cb@256bit.org>
parents:
12930
diff
changeset
|
6319 |
|
2ebc3df65ca2
patch 8.0.1343: MS-Windows: does not show colored emojis
Christian Brabandt <cb@256bit.org>
parents:
12930
diff
changeset
|
6320 NOTE: With this option, you can display colored emoji |
|
2ebc3df65ca2
patch 8.0.1343: MS-Windows: does not show colored emojis
Christian Brabandt <cb@256bit.org>
parents:
12930
diff
changeset
|
6321 (emoticon) in Windows 8.1 or later. To display colored emoji, |
|
2ebc3df65ca2
patch 8.0.1343: MS-Windows: does not show colored emojis
Christian Brabandt <cb@256bit.org>
parents:
12930
diff
changeset
|
6322 there are some conditions which you should notice. |
|
2ebc3df65ca2
patch 8.0.1343: MS-Windows: does not show colored emojis
Christian Brabandt <cb@256bit.org>
parents:
12930
diff
changeset
|
6323 |
|
2ebc3df65ca2
patch 8.0.1343: MS-Windows: does not show colored emojis
Christian Brabandt <cb@256bit.org>
parents:
12930
diff
changeset
|
6324 - If your font includes non-colored emoji already, it will |
|
2ebc3df65ca2
patch 8.0.1343: MS-Windows: does not show colored emojis
Christian Brabandt <cb@256bit.org>
parents:
12930
diff
changeset
|
6325 be used. |
|
2ebc3df65ca2
patch 8.0.1343: MS-Windows: does not show colored emojis
Christian Brabandt <cb@256bit.org>
parents:
12930
diff
changeset
|
6326 - If your font doesn't have emoji, the system chooses an |
|
2ebc3df65ca2
patch 8.0.1343: MS-Windows: does not show colored emojis
Christian Brabandt <cb@256bit.org>
parents:
12930
diff
changeset
|
6327 alternative symbol font. On Windows 10, "Segoe UI Emoji" |
|
2ebc3df65ca2
patch 8.0.1343: MS-Windows: does not show colored emojis
Christian Brabandt <cb@256bit.org>
parents:
12930
diff
changeset
|
6328 will be used. |
|
2ebc3df65ca2
patch 8.0.1343: MS-Windows: does not show colored emojis
Christian Brabandt <cb@256bit.org>
parents:
12930
diff
changeset
|
6329 - When this alternative font didn't have fixed width glyph, |
|
2ebc3df65ca2
patch 8.0.1343: MS-Windows: does not show colored emojis
Christian Brabandt <cb@256bit.org>
parents:
12930
diff
changeset
|
6330 emoji might be rendered beyond the bounding box of drawing |
|
2ebc3df65ca2
patch 8.0.1343: MS-Windows: does not show colored emojis
Christian Brabandt <cb@256bit.org>
parents:
12930
diff
changeset
|
6331 cell. |
| 6110 | 6332 |
| 6333 Other render types are currently not supported. | |
| 6334 | |
| 7 | 6335 *'report'* |
| 6336 'report' number (default 2) | |
| 6337 global | |
| 6338 Threshold for reporting number of lines changed. When the number of | |
| 6339 changed lines is more than 'report' a message will be given for most | |
| 6340 ":" commands. If you want it always, set 'report' to 0. | |
| 6341 For the ":substitute" command the number of substitutions is used | |
| 6342 instead of the number of lines. | |
| 6343 | |
| 6344 *'restorescreen'* *'rs'* *'norestorescreen'* *'nors'* | |
| 6345 'restorescreen' 'rs' boolean (default on) | |
| 6346 global | |
| 19116 | 6347 {only in MS-Windows console version} |
| 7 | 6348 When set, the screen contents is restored when exiting Vim. This also |
| 6349 happens when executing external commands. | |
| 6350 | |
| 6351 For non-Windows Vim: You can set or reset the 't_ti' and 't_te' | |
| 6352 options in your .vimrc. To disable restoring: | |
| 6353 set t_ti= t_te= | |
| 6354 To enable restoring (for an xterm): | |
| 6355 set t_ti=^[7^[[r^[[?47h t_te=^[[?47l^[8 | |
| 6356 (Where ^[ is an <Esc>, type CTRL-V <Esc> to insert it) | |
| 6357 | |
| 6358 *'revins'* *'ri'* *'norevins'* *'nori'* | |
| 6359 'revins' 'ri' boolean (default off) | |
| 6360 global | |
| 6361 {only available when compiled with the |+rightleft| | |
| 6362 feature} | |
| 6363 Inserting characters in Insert mode will work backwards. See "typing | |
| 6364 backwards" |ins-reverse|. This option can be toggled with the CTRL-_ | |
| 6365 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
|
6366 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
|
6367 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
|
6368 reset. |
| 7 | 6369 |
| 6370 *'rightleft'* *'rl'* *'norightleft'* *'norl'* | |
| 6371 'rightleft' 'rl' boolean (default off) | |
| 6372 local to window | |
| 6373 {only available when compiled with the |+rightleft| | |
| 6374 feature} | |
| 6375 When on, display orientation becomes right-to-left, i.e., characters | |
| 6376 that are stored in the file appear from the right to the left. | |
| 6377 Using this option, it is possible to edit files for languages that | |
| 6378 are written from the right to the left such as Hebrew and Arabic. | |
| 6379 This option is per window, so it is possible to edit mixed files | |
| 6380 simultaneously, or to view the same file in both ways (this is | |
| 6381 useful whenever you have a mixed text file with both right-to-left | |
| 6382 and left-to-right strings so that both sets are displayed properly | |
| 6383 in different windows). Also see |rileft.txt|. | |
| 6384 | |
| 2341 | 6385 *'rightleftcmd'* *'rlc'* |
| 7 | 6386 'rightleftcmd' 'rlc' string (default "search") |
| 6387 local to window | |
| 6388 {only available when compiled with the |+rightleft| | |
| 6389 feature} | |
| 6390 Each word in this option enables the command line editing to work in | |
| 6391 right-to-left mode for a group of commands: | |
| 6392 | |
| 6393 search "/" and "?" commands | |
| 6394 | |
| 6395 This is useful for languages such as Hebrew, Arabic and Farsi. | |
| 6396 The 'rightleft' option must be set for 'rightleftcmd' to take effect. | |
| 6397 | |
|
7196
42717d048817
commit https://github.com/vim/vim/commit/d94464ee294a351ce7b6ba18e8bd3f24f1bef920
Christian Brabandt <cb@256bit.org>
parents:
7147
diff
changeset
|
6398 *'rubydll'* |
|
8629
54ac275e3fc4
commit https://github.com/vim/vim/commit/3848e00e0177abdb31bc600234967863ec487233
Christian Brabandt <cb@256bit.org>
parents:
8560
diff
changeset
|
6399 '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
|
6400 global |
|
7196
42717d048817
commit https://github.com/vim/vim/commit/d94464ee294a351ce7b6ba18e8bd3f24f1bef920
Christian Brabandt <cb@256bit.org>
parents:
7147
diff
changeset
|
6401 {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
|
6402 feature} |
|
7528
53163e4d9e4f
commit https://github.com/vim/vim/commit/25e4fcde767084d1a79e0926bc301c92987c0cce
Christian Brabandt <cb@256bit.org>
parents:
7477
diff
changeset
|
6403 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
|
6404 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
|
6405 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
|
6406 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
|
6407 security reasons. |
|
42717d048817
commit https://github.com/vim/vim/commit/d94464ee294a351ce7b6ba18e8bd3f24f1bef920
Christian Brabandt <cb@256bit.org>
parents:
7147
diff
changeset
|
6408 |
| 7 | 6409 *'ruler'* *'ru'* *'noruler'* *'noru'* |
|
9669
284b4eb307fc
commit https://github.com/vim/vim/commit/8c08b5b569e2a9e9f63dea514591ecfa2d3bb392
Christian Brabandt <cb@256bit.org>
parents:
9665
diff
changeset
|
6410 'ruler' 'ru' boolean (default off, set in |defaults.vim|) |
| 7 | 6411 global |
| 6412 {not available when compiled without the | |
| 6413 |+cmdline_info| feature} | |
| 6414 Show the line and column number of the cursor position, separated by a | |
| 10 | 6415 comma. When there is room, the relative position of the displayed |
| 7 | 6416 text in the file is shown on the far right: |
| 6417 Top first line is visible | |
| 6418 Bot last line is visible | |
| 6419 All first and last line are visible | |
| 6420 45% relative position in the file | |
| 6421 If 'rulerformat' is set, it will determine the contents of the ruler. | |
| 10 | 6422 Each window has its own ruler. If a window has a status line, the |
| 7 | 6423 ruler is shown there. Otherwise it is shown in the last line of the |
| 233 | 6424 screen. If the statusline is given by 'statusline' (i.e. not empty), |
| 7 | 6425 this option takes precedence over 'ruler' and 'rulerformat' |
| 6426 If the number of characters displayed is different from the number of | |
| 21991 | 6427 bytes in the text (e.g., for a TAB or a multibyte character), both |
| 7 | 6428 the text column (byte number) and the screen column are shown, |
| 6429 separated with a dash. | |
| 6430 For an empty line "0-1" is shown. | |
| 6431 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
|
6432 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
|
6433 reset. |
| 7 | 6434 If you don't want to see the ruler all the time but want to know where |
| 6435 you are, use "g CTRL-G" |g_CTRL-G|. | |
| 6436 NOTE: This option is reset when 'compatible' is set. | |
| 6437 | |
| 6438 *'rulerformat'* *'ruf'* | |
| 6439 'rulerformat' 'ruf' string (default empty) | |
| 6440 global | |
| 6441 {not available when compiled without the |+statusline| | |
| 6442 feature} | |
| 6443 When this option is not empty, it determines the content of the ruler | |
| 6444 string, as displayed for the 'ruler' option. | |
| 692 | 6445 The format of this option is like that of 'statusline'. |
|
16728
e55c26aaf484
patch 8.1.1366: using expressions in a modeline is unsafe
Bram Moolenaar <Bram@vim.org>
parents:
16610
diff
changeset
|
6446 This option cannot be set in a modeline when 'modelineexpr' is off. |
|
e55c26aaf484
patch 8.1.1366: using expressions in a modeline is unsafe
Bram Moolenaar <Bram@vim.org>
parents:
16610
diff
changeset
|
6447 |
| 7 | 6448 The default ruler width is 17 characters. To make the ruler 15 |
| 6449 characters wide, put "%15(" at the start and "%)" at the end. | |
| 6450 Example: > | |
| 6451 :set rulerformat=%15(%c%V\ %p%%%) | |
| 6452 < | |
| 6453 *'runtimepath'* *'rtp'* *vimfiles* | |
| 6454 'runtimepath' 'rtp' string (default: | |
| 23931 | 6455 Unix: "$HOME/.vim, |
| 7 | 6456 $VIM/vimfiles, |
| 6457 $VIMRUNTIME, | |
| 6458 $VIM/vimfiles/after, | |
| 6459 $HOME/.vim/after" | |
| 6460 Amiga: "home:vimfiles, | |
| 6461 $VIM/vimfiles, | |
| 6462 $VIMRUNTIME, | |
| 6463 $VIM/vimfiles/after, | |
| 6464 home:vimfiles/after" | |
| 23931 | 6465 MS-Windows: "$HOME/vimfiles, |
| 7 | 6466 $VIM/vimfiles, |
| 6467 $VIMRUNTIME, | |
| 6468 $VIM/vimfiles/after, | |
| 6469 $HOME/vimfiles/after" | |
| 21825 | 6470 macOS: "$VIM:vimfiles, |
| 7 | 6471 $VIMRUNTIME, |
| 6472 $VIM:vimfiles:after" | |
|
19526
22f0dda71638
patch 8.2.0320: no Haiku support
Bram Moolenaar <Bram@vim.org>
parents:
19404
diff
changeset
|
6473 Haiku: "$BE_USER_SETTINGS/vim, |
|
22f0dda71638
patch 8.2.0320: no Haiku support
Bram Moolenaar <Bram@vim.org>
parents:
19404
diff
changeset
|
6474 $VIM/vimfiles, |
|
22f0dda71638
patch 8.2.0320: no Haiku support
Bram Moolenaar <Bram@vim.org>
parents:
19404
diff
changeset
|
6475 $VIMRUNTIME, |
|
22f0dda71638
patch 8.2.0320: no Haiku support
Bram Moolenaar <Bram@vim.org>
parents:
19404
diff
changeset
|
6476 $VIM/vimfiles/after, |
| 23931 | 6477 $BE_USER_SETTINGS/vim/after" |
| 6478 VMS: "sys$login:vimfiles, | |
| 7 | 6479 $VIM/vimfiles, |
| 6480 $VIMRUNTIME, | |
| 6481 $VIM/vimfiles/after, | |
| 233 | 6482 sys$login:vimfiles/after") |
| 7 | 6483 global |
| 6484 This is a list of directories which will be searched for runtime | |
| 6485 files: | |
| 6486 filetype.vim filetypes by file name |new-filetype| | |
| 6487 scripts.vim filetypes by file contents |new-filetype-scripts| | |
| 164 | 6488 autoload/ automatically loaded scripts |autoload-functions| |
| 7 | 6489 colors/ color scheme files |:colorscheme| |
| 6490 compiler/ compiler files |:compiler| | |
| 6491 doc/ documentation |write-local-help| | |
| 6492 ftplugin/ filetype plugins |write-filetype-plugin| | |
|
19181
94eda51ba9ba
patch 8.2.0149: maintaining a Vim9 branch separately is more work
Bram Moolenaar <Bram@vim.org>
parents:
19180
diff
changeset
|
6493 import/ files that are found by `:import` |
| 7 | 6494 indent/ indent scripts |indent-expression| |
| 6495 keymap/ key mapping files |mbyte-keymap| | |
| 6496 lang/ menu translations |:menutrans| | |
| 6497 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
|
6498 pack/ packages |:packadd| |
| 7 | 6499 plugin/ plugin scripts |write-plugin| |
| 6500 print/ files for printing |postscript-print-encoding| | |
| 650 | 6501 spell/ spell checking files |spell| |
| 7 | 6502 syntax/ syntax files |mysyntaxfile| |
| 6503 tutor/ files for vimtutor |tutor| | |
| 6504 | |
| 6505 And any other file searched for with the |:runtime| command. | |
| 6506 | |
| 6507 The defaults for most systems are setup to search five locations: | |
| 6508 1. In your home directory, for your personal preferences. | |
| 6509 2. In a system-wide Vim directory, for preferences from the system | |
| 6510 administrator. | |
| 6511 3. In $VIMRUNTIME, for files distributed with Vim. | |
| 6512 *after-directory* | |
| 6513 4. In the "after" directory in the system-wide Vim directory. This is | |
| 6514 for the system administrator to overrule or add to the distributed | |
| 6515 defaults (rarely needed) | |
| 6516 5. In the "after" directory in your home directory. This is for | |
| 6517 personal preferences to overrule or add to the distributed defaults | |
| 6518 or system-wide settings (rarely needed). | |
| 6519 | |
|
10211
b7da8d4c594c
commit https://github.com/vim/vim/commit/d07969093a9b3051511c478d71c36de6fc33c0d6
Christian Brabandt <cb@256bit.org>
parents:
10198
diff
changeset
|
6520 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
|
6521 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
|
6522 string. |
|
9116
bc38030aec7d
commit https://github.com/vim/vim/commit/26852128a2b713ef49341a0c18daba928444e7eb
Christian Brabandt <cb@256bit.org>
parents:
9098
diff
changeset
|
6523 |
| 7 | 6524 Note that, unlike 'path', no wildcards like "**" are allowed. Normal |
| 6525 wildcards are allowed, but can significantly slow down searching for | |
| 10 | 6526 runtime files. For speed, use as few items as possible and avoid |
| 7 | 6527 wildcards. |
| 6528 See |:runtime|. | |
| 6529 Example: > | |
| 6530 :set runtimepath=~/vimruntime,/mygroup/vim,$VIMRUNTIME | |
| 6531 < This will use the directory "~/vimruntime" first (containing your | |
| 6532 personal Vim runtime files), then "/mygroup/vim" (shared between a | |
| 6533 group of people) and finally "$VIMRUNTIME" (the distributed runtime | |
| 6534 files). | |
| 6535 You probably should always include $VIMRUNTIME somewhere, to use the | |
| 6536 distributed runtime files. You can put a directory before $VIMRUNTIME | |
| 6537 to find files which replace a distributed runtime files. You can put | |
| 6538 a directory after $VIMRUNTIME to find files which add to distributed | |
| 6539 runtime files. | |
| 13437 | 6540 When Vim is started with |--clean| the home directory entries are not |
| 6541 included. | |
| 7 | 6542 This option cannot be set from a |modeline| or in the |sandbox|, for |
| 6543 security reasons. | |
| 6544 | |
| 6545 *'scroll'* *'scr'* | |
| 6546 'scroll' 'scr' number (default: half the window height) | |
| 6547 local to window | |
| 6548 Number of lines to scroll with CTRL-U and CTRL-D commands. Will be | |
| 6549 set to half the number of lines in the window when the window size | |
|
23386
3105546b941f
patch 8.2.2236: 'scroll' option can change when setting the statusline
Bram Moolenaar <Bram@vim.org>
parents:
23305
diff
changeset
|
6550 changes. This may happen when enabling the |status-line| or |
|
3105546b941f
patch 8.2.2236: 'scroll' option can change when setting the statusline
Bram Moolenaar <Bram@vim.org>
parents:
23305
diff
changeset
|
6551 'tabline' option after setting the 'scroll' option. |
|
3105546b941f
patch 8.2.2236: 'scroll' option can change when setting the statusline
Bram Moolenaar <Bram@vim.org>
parents:
23305
diff
changeset
|
6552 If you give a count to the CTRL-U or CTRL-D command it will |
| 10 | 6553 be used as the new value for 'scroll'. Reset to half the window |
|
16553
0e473e9e70c2
patch 8.1.1280: remarks about functionality not in Vi clutters the help
Bram Moolenaar <Bram@vim.org>
parents:
16533
diff
changeset
|
6554 height with ":set scroll=0". |
| 7 | 6555 |
| 6556 *'scrollbind'* *'scb'* *'noscrollbind'* *'noscb'* | |
| 6557 'scrollbind' 'scb' boolean (default off) | |
| 6558 local to window | |
| 6559 See also |scroll-binding|. When this option is set, the current | |
| 6560 window scrolls as other scrollbind windows (windows that also have | |
| 6561 this option set) scroll. This option is useful for viewing the | |
| 6562 differences between two versions of a file, see 'diff'. | |
| 6563 See |'scrollopt'| for options that determine how this option should be | |
| 6564 interpreted. | |
| 6565 This option is mostly reset when splitting a window to edit another | |
| 6566 file. This means that ":split | edit file" results in two windows | |
| 6567 with scroll-binding, but ":split file" does not. | |
| 6568 | |
|
18526
334b1f897f3a
patch 8.1.2257: MS-Windows GUI: scroll wheel always uses current window
Bram Moolenaar <Bram@vim.org>
parents:
18489
diff
changeset
|
6569 *'scrollfocus'* *'scf'* *'noscrollfocus'* *'noscf'* |
|
334b1f897f3a
patch 8.1.2257: MS-Windows GUI: scroll wheel always uses current window
Bram Moolenaar <Bram@vim.org>
parents:
18489
diff
changeset
|
6570 'scrollfocus' 'scf' boolean (default off) |
|
334b1f897f3a
patch 8.1.2257: MS-Windows GUI: scroll wheel always uses current window
Bram Moolenaar <Bram@vim.org>
parents:
18489
diff
changeset
|
6571 global |
|
334b1f897f3a
patch 8.1.2257: MS-Windows GUI: scroll wheel always uses current window
Bram Moolenaar <Bram@vim.org>
parents:
18489
diff
changeset
|
6572 {only for MS-Windows GUI} |
|
334b1f897f3a
patch 8.1.2257: MS-Windows GUI: scroll wheel always uses current window
Bram Moolenaar <Bram@vim.org>
parents:
18489
diff
changeset
|
6573 When using the scroll wheel and this option is set, the window under |
|
334b1f897f3a
patch 8.1.2257: MS-Windows GUI: scroll wheel always uses current window
Bram Moolenaar <Bram@vim.org>
parents:
18489
diff
changeset
|
6574 the mouse pointer is scrolled. With this option off the current |
|
334b1f897f3a
patch 8.1.2257: MS-Windows GUI: scroll wheel always uses current window
Bram Moolenaar <Bram@vim.org>
parents:
18489
diff
changeset
|
6575 window is scrolled. |
| 18594 | 6576 Systems other than MS-Windows always behave like this option is on. |
|
18526
334b1f897f3a
patch 8.1.2257: MS-Windows GUI: scroll wheel always uses current window
Bram Moolenaar <Bram@vim.org>
parents:
18489
diff
changeset
|
6577 |
| 7 | 6578 *'scrolljump'* *'sj'* |
| 6579 'scrolljump' 'sj' number (default 1) | |
| 6580 global | |
| 6581 Minimal number of lines to scroll when the cursor gets off the | |
| 6582 screen (e.g., with "j"). Not used for scroll commands (e.g., CTRL-E, | |
| 6583 CTRL-D). Useful if your terminal scrolls very slowly. | |
| 532 | 6584 When set to a negative number from -1 to -100 this is used as the |
| 6585 percentage of the window height. Thus -50 scrolls half the window | |
| 6586 height. | |
| 7 | 6587 NOTE: This option is set to 1 when 'compatible' is set. |
| 6588 | |
| 6589 *'scrolloff'* *'so'* | |
|
10218
584c835a2de1
commit https://github.com/vim/vim/commit/50ba526fbf3e9e5e0e6b0b3086a4d5df581ebc7e
Christian Brabandt <cb@256bit.org>
parents:
10211
diff
changeset
|
6590 'scrolloff' 'so' number (default 0, set to 5 in |defaults.vim|) |
|
15713
ad8b2c109b22
patch 8.1.0864: cannot have a local value for 'scrolloff' and 'sidescrolloff'
Bram Moolenaar <Bram@vim.org>
parents:
15701
diff
changeset
|
6591 global or local to window |global-local| |
| 7 | 6592 Minimal number of screen lines to keep above and below the cursor. |
| 6593 This will make some context visible around where you are working. If | |
| 6594 you set it to a very large value (999) the cursor line will always be | |
| 6595 in the middle of the window (except at the start or end of the file or | |
| 6596 when long lines wrap). | |
|
15713
ad8b2c109b22
patch 8.1.0864: cannot have a local value for 'scrolloff' and 'sidescrolloff'
Bram Moolenaar <Bram@vim.org>
parents:
15701
diff
changeset
|
6597 After using the local value, go back the global value with one of |
|
ad8b2c109b22
patch 8.1.0864: cannot have a local value for 'scrolloff' and 'sidescrolloff'
Bram Moolenaar <Bram@vim.org>
parents:
15701
diff
changeset
|
6598 these two: > |
|
ad8b2c109b22
patch 8.1.0864: cannot have a local value for 'scrolloff' and 'sidescrolloff'
Bram Moolenaar <Bram@vim.org>
parents:
15701
diff
changeset
|
6599 setlocal scrolloff< |
|
ad8b2c109b22
patch 8.1.0864: cannot have a local value for 'scrolloff' and 'sidescrolloff'
Bram Moolenaar <Bram@vim.org>
parents:
15701
diff
changeset
|
6600 setlocal scrolloff=-1 |
|
ad8b2c109b22
patch 8.1.0864: cannot have a local value for 'scrolloff' and 'sidescrolloff'
Bram Moolenaar <Bram@vim.org>
parents:
15701
diff
changeset
|
6601 < For scrolling horizontally see 'sidescrolloff'. |
| 7 | 6602 NOTE: This option is set to 0 when 'compatible' is set. |
| 6603 | |
| 6604 *'scrollopt'* *'sbo'* | |
| 6605 'scrollopt' 'sbo' string (default "ver,jump") | |
| 6606 global | |
| 6607 This is a comma-separated list of words that specifies how | |
| 236 | 6608 'scrollbind' windows should behave. 'sbo' stands for ScrollBind |
| 6609 Options. | |
| 7 | 6610 The following words are available: |
| 6611 ver Bind vertical scrolling for 'scrollbind' windows | |
| 6612 hor Bind horizontal scrolling for 'scrollbind' windows | |
| 6613 jump Applies to the offset between two windows for vertical | |
| 6614 scrolling. This offset is the difference in the first | |
| 6615 displayed line of the bound windows. When moving | |
| 6616 around in a window, another 'scrollbind' window may | |
| 6617 reach a position before the start or after the end of | |
| 6618 the buffer. The offset is not changed though, when | |
| 6619 moving back the 'scrollbind' window will try to scroll | |
| 6620 to the desired position when possible. | |
| 6621 When now making that window the current one, two | |
| 6622 things can be done with the relative offset: | |
| 6623 1. When "jump" is not included, the relative offset is | |
| 6624 adjusted for the scroll position in the new current | |
| 6625 window. When going back to the other window, the | |
| 1152 | 6626 new relative offset will be used. |
| 7 | 6627 2. When "jump" is included, the other windows are |
| 6628 scrolled to keep the same relative offset. When | |
| 6629 going back to the other window, it still uses the | |
| 6630 same relative offset. | |
| 6631 Also see |scroll-binding|. | |
| 819 | 6632 When 'diff' mode is active there always is vertical scroll binding, |
| 6633 even when "ver" isn't there. | |
| 7 | 6634 |
| 6635 *'sections'* *'sect'* | |
| 6636 'sections' 'sect' string (default "SHNHH HUnhsh") | |
| 6637 global | |
| 6638 Specifies the nroff macros that separate sections. These are pairs of | |
| 6639 two letters (See |object-motions|). The default makes a section start | |
| 6640 at the nroff macros ".SH", ".NH", ".H", ".HU", ".nh" and ".sh". | |
| 6641 | |
| 6642 *'secure'* *'nosecure'* *E523* | |
| 6643 'secure' boolean (default off) | |
| 6644 global | |
| 6645 When on, ":autocmd", shell and write commands are not allowed in | |
| 6646 ".vimrc" and ".exrc" in the current directory and map commands are | |
| 6647 displayed. Switch it off only if you know that you will not run into | |
| 6648 problems, or when the 'exrc' option is off. On Unix this option is | |
| 6649 only used if the ".vimrc" or ".exrc" is not owned by you. This can be | |
| 10 | 6650 dangerous if the systems allows users to do a "chown". You better set |
| 7 | 6651 'secure' at the end of your ~/.vimrc then. |
| 6652 This option cannot be set from a |modeline| or in the |sandbox|, for | |
| 6653 security reasons. | |
| 6654 | |
| 6655 *'selection'* *'sel'* | |
| 6656 'selection' 'sel' string (default "inclusive") | |
| 6657 global | |
| 6658 This option defines the behavior of the selection. It is only used | |
| 6659 in Visual and Select mode. | |
| 6660 Possible values: | |
| 6661 value past line inclusive ~ | |
| 6662 old no yes | |
| 6663 inclusive yes yes | |
| 6664 exclusive yes no | |
| 6665 "past line" means that the cursor is allowed to be positioned one | |
| 6666 character past the line. | |
| 6667 "inclusive" means that the last character of the selection is included | |
| 6668 in an operation. For example, when "x" is used to delete the | |
| 6669 selection. | |
|
9975
03fa8a51e9dc
commit https://github.com/vim/vim/commit/e4a3bcf28d92d0bde9ca227ccb40d401038185e5
Christian Brabandt <cb@256bit.org>
parents:
9913
diff
changeset
|
6670 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
|
6671 the end of line the line break still isn't included. |
| 7 | 6672 Note that when "exclusive" is used and selecting from the end |
| 6673 backwards, you cannot include the last character of a line, when | |
| 6674 starting in Normal mode and 'virtualedit' empty. | |
| 6675 | |
| 6676 The 'selection' option is set by the |:behave| command. | |
| 6677 | |
| 6678 *'selectmode'* *'slm'* | |
| 6679 'selectmode' 'slm' string (default "") | |
| 6680 global | |
| 6681 This is a comma separated list of words, which specifies when to start | |
| 6682 Select mode instead of Visual mode, when a selection is started. | |
| 6683 Possible values: | |
| 6684 mouse when using the mouse | |
| 6685 key when using shifted special keys | |
| 6686 cmd when using "v", "V" or CTRL-V | |
| 6687 See |Select-mode|. | |
| 6688 The 'selectmode' option is set by the |:behave| command. | |
| 6689 | |
| 6690 *'sessionoptions'* *'ssop'* | |
| 6691 'sessionoptions' 'ssop' string (default: "blank,buffers,curdir,folds, | |
| 13437 | 6692 help,options,tabpages,winsize,terminal") |
| 7 | 6693 global |
|
2570
71b56b4e7785
Make the references to features in the help more consistent. (Sylvain Hitier)
Bram Moolenaar <bram@vim.org>
parents:
2561
diff
changeset
|
6694 {not available when compiled without the |+mksession| |
| 7 | 6695 feature} |
| 6696 Changes the effect of the |:mksession| command. It is a comma | |
| 6697 separated list of words. Each word enables saving and restoring | |
| 6698 something: | |
| 6699 word save and restore ~ | |
| 6700 blank empty windows | |
| 6701 buffers hidden and unloaded buffers, not just those in windows | |
| 6702 curdir the current directory | |
| 6703 folds manually created folds, opened/closed folds and local | |
| 6704 fold options | |
| 6705 globals global variables that start with an uppercase letter | |
| 75 | 6706 and contain at least one lowercase letter. Only |
| 6707 String and Number types are stored. | |
| 7 | 6708 help the help window |
| 6709 localoptions options and mappings local to a window or buffer (not | |
| 6710 global values for local options) | |
| 6711 options all options and mappings (also global values for local | |
| 6712 options) | |
|
24476
e79d1475fc89
patch 8.2.2778: problem restoring 'packpath' in session
Bram Moolenaar <Bram@vim.org>
parents:
24468
diff
changeset
|
6713 skiprtp exclude 'runtimepath' and 'packpath' from the options |
| 7 | 6714 resize size of the Vim window: 'lines' and 'columns' |
| 6715 sesdir the directory in which the session file is located | |
| 6716 will become the current directory (useful with | |
| 6717 projects accessed over a network from different | |
| 6718 systems) | |
| 6719 slash backslashes in file names replaced with forward | |
| 6720 slashes | |
| 827 | 6721 tabpages all tab pages; without this only the current tab page |
| 6722 is restored, so that you can make a session for each | |
| 6723 tab page separately | |
| 14519 | 6724 terminal include terminal windows where the command can be |
| 6725 restored | |
| 7 | 6726 unix with Unix end-of-line format (single <NL>), even when |
| 6727 on Windows or DOS | |
| 6728 winpos position of the whole Vim window | |
| 6729 winsize window sizes | |
| 6730 | |
| 6731 Don't include both "curdir" and "sesdir". | |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
6732 When neither "curdir" nor "sesdir" is included, file names are stored |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
6733 with absolute paths. |
| 27036 | 6734 If you leave out "options" many things won't work well after restoring |
| 6735 the session. | |
| 7 | 6736 "slash" and "unix" are useful on Windows when sharing session files |
| 6737 with Unix. The Unix version of Vim cannot source dos format scripts, | |
| 6738 but the Windows version of Vim can source unix format scripts. | |
| 6739 | |
| 6740 *'shell'* *'sh'* *E91* | |
| 18928 | 6741 'shell' 'sh' string (default $SHELL or "sh", Win32: "cmd.exe") |
| 7 | 6742 global |
| 6743 Name of the shell to use for ! and :! commands. When changing the | |
| 6744 value also check these options: 'shelltype', 'shellpipe', 'shellslash' | |
| 6745 'shellredir', 'shellquote', 'shellxquote' and 'shellcmdflag'. | |
| 10 | 6746 It is allowed to give an argument to the command, e.g. "csh -f". |
| 7 | 6747 See |option-backslash| about including spaces and backslashes. |
| 6748 Environment variables are expanded |:set_env|. | |
|
13162
51521b8a370c
patch 8.0.1455: if $SHELL contains a space then 'shell' is incorrect
Christian Brabandt <cb@256bit.org>
parents:
13154
diff
changeset
|
6749 |
| 27537 | 6750 In |restricted-mode| shell commands will not be possible. This mode |
| 6751 is used if the value of $SHELL ends in "false" or "nologin". | |
| 6752 | |
| 18489 | 6753 If the name of the shell contains a space, you need to enclose it in |
| 18594 | 6754 quotes and escape the space. Example with quotes: > |
| 7 | 6755 :set shell=\"c:\program\ files\unix\sh.exe\"\ -f |
| 6756 < Note the backslash before each quote (to avoid starting a comment) and | |
| 10 | 6757 each space (to avoid ending the option value). Also note that the |
| 7 | 6758 "-f" is not inside the quotes, because it is not part of the command |
|
13162
51521b8a370c
patch 8.0.1455: if $SHELL contains a space then 'shell' is incorrect
Christian Brabandt <cb@256bit.org>
parents:
13154
diff
changeset
|
6759 name. Vim automagically recognizes the backslashes that are path |
| 7 | 6760 separators. |
|
13162
51521b8a370c
patch 8.0.1455: if $SHELL contains a space then 'shell' is incorrect
Christian Brabandt <cb@256bit.org>
parents:
13154
diff
changeset
|
6761 Example with escaped space (Vim will do this when initializing the |
|
51521b8a370c
patch 8.0.1455: if $SHELL contains a space then 'shell' is incorrect
Christian Brabandt <cb@256bit.org>
parents:
13154
diff
changeset
|
6762 option from $SHELL): > |
|
51521b8a370c
patch 8.0.1455: if $SHELL contains a space then 'shell' is incorrect
Christian Brabandt <cb@256bit.org>
parents:
13154
diff
changeset
|
6763 :set shell=/bin/with\\\ space/sh |
| 14519 | 6764 < The resulting value of 'shell' is "/bin/with\ space/sh", two |
|
13162
51521b8a370c
patch 8.0.1455: if $SHELL contains a space then 'shell' is incorrect
Christian Brabandt <cb@256bit.org>
parents:
13154
diff
changeset
|
6765 backslashes are consumed by `:set`. |
|
51521b8a370c
patch 8.0.1455: if $SHELL contains a space then 'shell' is incorrect
Christian Brabandt <cb@256bit.org>
parents:
13154
diff
changeset
|
6766 |
| 7 | 6767 Under MS-Windows, when the executable ends in ".com" it must be |
| 6768 included. Thus setting the shell to "command.com" or "4dos.com" | |
| 6769 works, but "command" and "4dos" do not work for all commands (e.g., | |
| 6770 filtering). | |
| 6771 For unknown reasons, when using "4dos.com" the current directory is | |
| 6772 changed to "C:\". To avoid this set 'shell' like this: > | |
| 6773 :set shell=command.com\ /c\ 4dos | |
| 6774 < This option cannot be set from a |modeline| or in the |sandbox|, for | |
| 6775 security reasons. | |
| 6776 | |
| 6777 *'shellcmdflag'* *'shcf'* | |
| 3356 | 6778 'shellcmdflag' 'shcf' string (default: "-c"; |
|
25068
0ce24f734615
patch 8.2.3071: shell options are not set properly for PowerShell
Bram Moolenaar <Bram@vim.org>
parents:
25056
diff
changeset
|
6779 Win32, when 'shell' contains "powershell": |
|
0ce24f734615
patch 8.2.3071: shell options are not set properly for PowerShell
Bram Moolenaar <Bram@vim.org>
parents:
25056
diff
changeset
|
6780 "-Command", or when it does not contain "sh" |
| 18972 | 6781 somewhere: "/c") |
| 7 | 6782 global |
| 6783 Flag passed to the shell to execute "!" and ":!" commands; e.g., | |
|
25068
0ce24f734615
patch 8.2.3071: shell options are not set properly for PowerShell
Bram Moolenaar <Bram@vim.org>
parents:
25056
diff
changeset
|
6784 "bash.exe -c ls", "powershell.exe -Command dir", or "cmd.exe /c dir". |
|
0ce24f734615
patch 8.2.3071: shell options are not set properly for PowerShell
Bram Moolenaar <Bram@vim.org>
parents:
25056
diff
changeset
|
6785 For MS-Windows, the default is set according to the value of 'shell', |
|
0ce24f734615
patch 8.2.3071: shell options are not set properly for PowerShell
Bram Moolenaar <Bram@vim.org>
parents:
25056
diff
changeset
|
6786 to reduce the need to set this option by the user. |
| 3082 | 6787 On Unix it can have more than one flag. Each white space separated |
| 6788 part is passed as an argument to the shell command. | |
| 6789 See |option-backslash| about including spaces and backslashes. | |
|
25068
0ce24f734615
patch 8.2.3071: shell options are not set properly for PowerShell
Bram Moolenaar <Bram@vim.org>
parents:
25056
diff
changeset
|
6790 Also see |dos-shell| and |dos-powershell| for MS-Windows. |
| 7 | 6791 This option cannot be set from a |modeline| or in the |sandbox|, for |
| 6792 security reasons. | |
| 6793 | |
| 6794 *'shellpipe'* *'sp'* | |
|
25068
0ce24f734615
patch 8.2.3071: shell options are not set properly for PowerShell
Bram Moolenaar <Bram@vim.org>
parents:
25056
diff
changeset
|
6795 'shellpipe' 'sp' string (default ">", ">%s 2>&1", "| tee", "|& tee" |
|
0ce24f734615
patch 8.2.3071: shell options are not set properly for PowerShell
Bram Moolenaar <Bram@vim.org>
parents:
25056
diff
changeset
|
6796 "2>&1| tee", or |
|
0ce24f734615
patch 8.2.3071: shell options are not set properly for PowerShell
Bram Moolenaar <Bram@vim.org>
parents:
25056
diff
changeset
|
6797 "2>&1 | Out-File -Encoding default") |
| 7 | 6798 global |
| 6799 {not available when compiled without the |+quickfix| | |
| 6800 feature} | |
| 6801 String to be used to put the output of the ":make" command in the | |
| 10 | 6802 error file. See also |:make_makeprg|. See |option-backslash| about |
| 7 | 6803 including spaces and backslashes. |
| 6804 The name of the temporary file can be represented by "%s" if necessary | |
| 6805 (the file name is appended automatically if no %s appears in the value | |
| 6806 of this option). | |
|
25068
0ce24f734615
patch 8.2.3071: shell options are not set properly for PowerShell
Bram Moolenaar <Bram@vim.org>
parents:
25056
diff
changeset
|
6807 For the Amiga the default is ">". For MS-Windows using powershell the |
|
0ce24f734615
patch 8.2.3071: shell options are not set properly for PowerShell
Bram Moolenaar <Bram@vim.org>
parents:
25056
diff
changeset
|
6808 default is "2>&1 | Out-File -Encoding default", otherwise the default |
|
0ce24f734615
patch 8.2.3071: shell options are not set properly for PowerShell
Bram Moolenaar <Bram@vim.org>
parents:
25056
diff
changeset
|
6809 is ">%s 2>&1". The output is directly saved in a file and not echoed |
|
0ce24f734615
patch 8.2.3071: shell options are not set properly for PowerShell
Bram Moolenaar <Bram@vim.org>
parents:
25056
diff
changeset
|
6810 to the screen. |
| 22171 | 6811 For Unix the default is "| tee". The stdout of the compiler is saved |
| 7 | 6812 in a file and echoed to the screen. If the 'shell' option is "csh" or |
| 6813 "tcsh" after initializations, the default becomes "|& tee". If the | |
| 18456 | 6814 'shell' option is "sh", "ksh", "mksh", "pdksh", "zsh", "zsh-beta", |
|
24600
cb4cb3ff5736
patch 8.2.2839: default redirection missing "ash" and "dash"
Bram Moolenaar <Bram@vim.org>
parents:
24569
diff
changeset
|
6815 "bash", "fish", "ash" or "dash" the default becomes "2>&1| tee". This |
|
cb4cb3ff5736
patch 8.2.2839: default redirection missing "ash" and "dash"
Bram Moolenaar <Bram@vim.org>
parents:
24569
diff
changeset
|
6816 means that stderr is also included. Before using the 'shell' option a |
|
cb4cb3ff5736
patch 8.2.2839: default redirection missing "ash" and "dash"
Bram Moolenaar <Bram@vim.org>
parents:
24569
diff
changeset
|
6817 path is removed, thus "/bin/sh" uses "sh". |
|
25084
beff72446e2e
patch 8.2.3079: Powershell core not supported by default
Bram Moolenaar <Bram@vim.org>
parents:
25068
diff
changeset
|
6818 For Unix and MS-Windows, when the 'shell' option is "pwsh" the default |
|
beff72446e2e
patch 8.2.3079: Powershell core not supported by default
Bram Moolenaar <Bram@vim.org>
parents:
25068
diff
changeset
|
6819 becomes ">%s 2>&1" and the output is not echoed to the screen. |
| 7 | 6820 The initialization of this option is done after reading the ".vimrc" |
| 6821 and the other initializations, so that when the 'shell' option is set | |
| 6822 there, the 'shellpipe' option changes automatically, unless it was | |
| 6823 explicitly set before. | |
| 6824 When 'shellpipe' is set to an empty string, no redirection of the | |
| 6825 ":make" output will be done. This is useful if you use a 'makeprg' | |
| 6826 that writes to 'makeef' by itself. If you want no piping, but do | |
| 6827 want to include the 'makeef', set 'shellpipe' to a single space. | |
| 6828 Don't forget to precede the space with a backslash: ":set sp=\ ". | |
| 6829 In the future pipes may be used for filtering and this option will | |
| 6830 become obsolete (at least for Unix). | |
| 6831 This option cannot be set from a |modeline| or in the |sandbox|, for | |
| 6832 security reasons. | |
| 6833 | |
| 6834 *'shellquote'* *'shq'* | |
|
25084
beff72446e2e
patch 8.2.3079: Powershell core not supported by default
Bram Moolenaar <Bram@vim.org>
parents:
25068
diff
changeset
|
6835 'shellquote' 'shq' string (default: "") |
| 7 | 6836 global |
| 6837 Quoting character(s), put around the command passed to the shell, for | |
| 6838 the "!" and ":!" commands. The redirection is kept outside of the | |
| 6839 quoting. See 'shellxquote' to include the redirection. It's | |
| 6840 probably not useful to set both options. | |
| 6841 This is an empty string by default. Only known to be useful for | |
| 18972 | 6842 third-party shells on MS-Windows-like systems, such as the MKS Korn |
|
25084
beff72446e2e
patch 8.2.3079: Powershell core not supported by default
Bram Moolenaar <Bram@vim.org>
parents:
25068
diff
changeset
|
6843 Shell or bash, where it should be "\"". See |dos-shell|. |
| 7 | 6844 This option cannot be set from a |modeline| or in the |sandbox|, for |
| 6845 security reasons. | |
| 6846 | |
| 6847 *'shellredir'* *'srr'* | |
|
25068
0ce24f734615
patch 8.2.3071: shell options are not set properly for PowerShell
Bram Moolenaar <Bram@vim.org>
parents:
25056
diff
changeset
|
6848 'shellredir' 'srr' string (default ">", ">&", ">%s 2>&1", or |
|
0ce24f734615
patch 8.2.3071: shell options are not set properly for PowerShell
Bram Moolenaar <Bram@vim.org>
parents:
25056
diff
changeset
|
6849 "2>&1 | Out-File -Encoding default") |
| 7 | 6850 global |
| 6851 String to be used to put the output of a filter command in a temporary | |
| 6852 file. See also |:!|. See |option-backslash| about including spaces | |
| 6853 and backslashes. | |
| 6854 The name of the temporary file can be represented by "%s" if necessary | |
| 6855 (the file name is appended automatically if no %s appears in the value | |
| 6856 of this option). | |
| 18456 | 6857 The default is ">". For Unix, if the 'shell' option is "csh" or |
| 6858 "tcsh" during initializations, the default becomes ">&". If the | |
| 18719 | 6859 'shell' option is "sh", "ksh", "mksh", "pdksh", "zsh", "zsh-beta", |
|
25084
beff72446e2e
patch 8.2.3079: Powershell core not supported by default
Bram Moolenaar <Bram@vim.org>
parents:
25068
diff
changeset
|
6860 "bash", "fish", or "pwsh", the default becomes ">%s 2>&1". This means |
|
beff72446e2e
patch 8.2.3079: Powershell core not supported by default
Bram Moolenaar <Bram@vim.org>
parents:
25068
diff
changeset
|
6861 that stderr is also included. For Win32, the Unix checks are done and |
|
25068
0ce24f734615
patch 8.2.3071: shell options are not set properly for PowerShell
Bram Moolenaar <Bram@vim.org>
parents:
25056
diff
changeset
|
6862 additionally "cmd" is checked for, which makes the default ">%s 2>&1", |
|
0ce24f734615
patch 8.2.3071: shell options are not set properly for PowerShell
Bram Moolenaar <Bram@vim.org>
parents:
25056
diff
changeset
|
6863 and "powershell" is checked for which makes the default |
|
25084
beff72446e2e
patch 8.2.3079: Powershell core not supported by default
Bram Moolenaar <Bram@vim.org>
parents:
25068
diff
changeset
|
6864 "2>&1 | Out-File -Encoding default" (see |dos-powershell|). Also, the |
|
beff72446e2e
patch 8.2.3079: Powershell core not supported by default
Bram Moolenaar <Bram@vim.org>
parents:
25068
diff
changeset
|
6865 same names with ".exe" appended are checked for. |
| 7 | 6866 The initialization of this option is done after reading the ".vimrc" |
| 6867 and the other initializations, so that when the 'shell' option is set | |
| 6868 there, the 'shellredir' option changes automatically unless it was | |
| 6869 explicitly set before. | |
| 6870 In the future pipes may be used for filtering and this option will | |
| 6871 become obsolete (at least for Unix). | |
| 6872 This option cannot be set from a |modeline| or in the |sandbox|, for | |
| 6873 security reasons. | |
| 6874 | |
| 6875 *'shellslash'* *'ssl'* *'noshellslash'* *'nossl'* | |
| 6876 'shellslash' 'ssl' boolean (default off) | |
| 6877 global | |
|
18912
ccd16426a1f9
patch 8.2.0017: OS/2 and MS-DOS are still mentioned
Bram Moolenaar <Bram@vim.org>
parents:
18879
diff
changeset
|
6878 {only for MS-Windows} |
| 7 | 6879 When set, a forward slash is used when expanding file names. This is |
|
25084
beff72446e2e
patch 8.2.3079: Powershell core not supported by default
Bram Moolenaar <Bram@vim.org>
parents:
25068
diff
changeset
|
6880 useful when a Unix-like shell is used instead of cmd.exe, pwsh.exe, or |
|
25068
0ce24f734615
patch 8.2.3071: shell options are not set properly for PowerShell
Bram Moolenaar <Bram@vim.org>
parents:
25056
diff
changeset
|
6881 powershell.exe. Backward slashes can still be typed, but they are |
|
0ce24f734615
patch 8.2.3071: shell options are not set properly for PowerShell
Bram Moolenaar <Bram@vim.org>
parents:
25056
diff
changeset
|
6882 changed to forward slashes by Vim. |
| 7 | 6883 Note that setting or resetting this option has no effect for some |
| 6884 existing file names, thus this option needs to be set before opening | |
| 6885 any file for best results. This might change in the future. | |
| 6886 'shellslash' only works when a backslash can be used as a path | |
| 6887 separator. To test if this is so use: > | |
| 6888 if exists('+shellslash') | |
|
17543
77c3f6428b6c
patch 8.1.1769: 'shellslash' is also used for completion
Bram Moolenaar <Bram@vim.org>
parents:
17433
diff
changeset
|
6889 < Also see 'completeslash'. |
|
77c3f6428b6c
patch 8.1.1769: 'shellslash' is also used for completion
Bram Moolenaar <Bram@vim.org>
parents:
17433
diff
changeset
|
6890 |
| 168 | 6891 *'shelltemp'* *'stmp'* *'noshelltemp'* *'nostmp'* |
| 6892 'shelltemp' 'stmp' boolean (Vi default off, Vim default on) | |
| 6893 global | |
| 6894 When on, use temp files for shell commands. When off use a pipe. | |
| 6895 When using a pipe is not possible temp files are used anyway. | |
| 2965 | 6896 Currently a pipe is only supported on Unix and MS-Windows 2K and |
| 6897 later. You can check it with: > | |
| 168 | 6898 :if has("filterpipe") |
| 6899 < The advantage of using a pipe is that nobody can read the temp file | |
| 6900 and the 'shell' command does not need to support redirection. | |
| 6901 The advantage of using a temp file is that the file type and encoding | |
| 6902 can be detected. | |
| 6903 The |FilterReadPre|, |FilterReadPost| and |FilterWritePre|, | |
| 6904 |FilterWritePost| autocommands event are not triggered when | |
| 6905 'shelltemp' is off. | |
|
9533
9f921133ee90
commit https://github.com/vim/vim/commit/269f595f9eef584937e7eae70fde68cdd7da5bcf
Christian Brabandt <cb@256bit.org>
parents:
9464
diff
changeset
|
6906 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
|
6907 temp files. |
| 11160 | 6908 NOTE: This option is set to the Vim default value when 'compatible' |
| 6909 is reset. | |
| 168 | 6910 |
| 7 | 6911 *'shelltype'* *'st'* |
| 6912 'shelltype' 'st' number (default 0) | |
| 6913 global | |
|
16443
32a543152dc0
patch 8.1.1226: {not in Vi} remarks get in the way of useful help text
Bram Moolenaar <Bram@vim.org>
parents:
16439
diff
changeset
|
6914 {only for the Amiga} |
| 7 | 6915 On the Amiga this option influences the way how the commands work |
| 6916 which use a shell. | |
| 6917 0 and 1: always use the shell | |
| 6918 2 and 3: use the shell only to filter lines | |
| 6919 4 and 5: use shell only for ':sh' command | |
| 6920 When not using the shell, the command is executed directly. | |
| 6921 | |
| 6922 0 and 2: use "shell 'shellcmdflag' cmd" to start external commands | |
| 6923 1 and 3: use "shell cmd" to start external commands | |
| 6924 | |
| 3371 | 6925 *'shellxescape'* *'sxe'* |
| 6926 'shellxescape' 'sxe' string (default: ""; | |
| 18972 | 6927 for MS-Windows: "\"&|<>()@^") |
| 3371 | 6928 global |
| 6929 When 'shellxquote' is set to "(" then the characters listed in this | |
| 6930 option will be escaped with a '^' character. This makes it possible | |
| 6931 to execute most external commands with cmd.exe. | |
| 6932 | |
| 7 | 6933 *'shellxquote'* *'sxq'* |
| 6934 'shellxquote' 'sxq' string (default: ""; | |
| 3359 | 6935 for Win32, when 'shell' is cmd.exe: "(" |
|
25068
0ce24f734615
patch 8.2.3071: shell options are not set properly for PowerShell
Bram Moolenaar <Bram@vim.org>
parents:
25056
diff
changeset
|
6936 for Win32, when 'shell' is |
|
0ce24f734615
patch 8.2.3071: shell options are not set properly for PowerShell
Bram Moolenaar <Bram@vim.org>
parents:
25056
diff
changeset
|
6937 powershell.exe: "\"" |
| 3359 | 6938 for Win32, when 'shell' contains "sh" |
| 6939 somewhere: "\"" | |
| 7 | 6940 for Unix, when using system(): "\"") |
| 6941 global | |
| 6942 Quoting character(s), put around the command passed to the shell, for | |
| 6943 the "!" and ":!" commands. Includes the redirection. See | |
| 6944 'shellquote' to exclude the redirection. It's probably not useful | |
| 6945 to set both options. | |
| 3359 | 6946 When the value is '(' then ')' is appended. When the value is '"(' |
| 6947 then ')"' is appended. | |
| 6948 When the value is '(' then also see 'shellxescape'. | |
| 3352 | 6949 This is an empty string by default on most systems, but is known to be |
|
25084
beff72446e2e
patch 8.2.3079: Powershell core not supported by default
Bram Moolenaar <Bram@vim.org>
parents:
25068
diff
changeset
|
6950 useful for on Win32 version, either for cmd.exe, powershell.exe, or |
|
beff72446e2e
patch 8.2.3079: Powershell core not supported by default
Bram Moolenaar <Bram@vim.org>
parents:
25068
diff
changeset
|
6951 pwsh.exe which automatically strips off the first and last quote on a |
|
beff72446e2e
patch 8.2.3079: Powershell core not supported by default
Bram Moolenaar <Bram@vim.org>
parents:
25068
diff
changeset
|
6952 command, or 3rd-party shells such as the MKS Korn Shell or bash, where |
|
beff72446e2e
patch 8.2.3079: Powershell core not supported by default
Bram Moolenaar <Bram@vim.org>
parents:
25068
diff
changeset
|
6953 it should be "\"". The default is adjusted according the value of |
|
25068
0ce24f734615
patch 8.2.3071: shell options are not set properly for PowerShell
Bram Moolenaar <Bram@vim.org>
parents:
25056
diff
changeset
|
6954 'shell', to reduce the need to set this option by the user. See |
|
0ce24f734615
patch 8.2.3071: shell options are not set properly for PowerShell
Bram Moolenaar <Bram@vim.org>
parents:
25056
diff
changeset
|
6955 |dos-shell|. |
| 7 | 6956 This option cannot be set from a |modeline| or in the |sandbox|, for |
| 6957 security reasons. | |
| 6958 | |
| 6959 *'shiftround'* *'sr'* *'noshiftround'* *'nosr'* | |
| 6960 'shiftround' 'sr' boolean (default off) | |
| 6961 global | |
| 6962 Round indent to multiple of 'shiftwidth'. Applies to > and < | |
| 6963 commands. CTRL-T and CTRL-D in Insert mode always round the indent to | |
| 6964 a multiple of 'shiftwidth' (this is Vi compatible). | |
| 6965 NOTE: This option is reset when 'compatible' is set. | |
| 6966 | |
| 6967 *'shiftwidth'* *'sw'* | |
| 6968 'shiftwidth' 'sw' number (default 8) | |
| 6969 local to buffer | |
| 10 | 6970 Number of spaces to use for each step of (auto)indent. Used for |
| 7 | 6971 |'cindent'|, |>>|, |<<|, etc. |
| 3893 | 6972 When zero the 'ts' value will be used. Use the |shiftwidth()| |
| 6973 function to get the effective shiftwidth value. | |
| 7 | 6974 |
| 6975 *'shortmess'* *'shm'* | |
|
16533
5e25171e0e75
patch 8.1.1270: cannot see current match position
Bram Moolenaar <Bram@vim.org>
parents:
16447
diff
changeset
|
6976 'shortmess' 'shm' string (Vim default "filnxtToOS", Vi default: "S", |
|
5e25171e0e75
patch 8.1.1270: cannot see current match position
Bram Moolenaar <Bram@vim.org>
parents:
16447
diff
changeset
|
6977 POSIX default: "AS") |
| 7 | 6978 global |
| 6979 This option helps to avoid all the |hit-enter| prompts caused by file | |
| 6980 messages, for example with CTRL-G, and to avoid some other messages. | |
| 6981 It is a list of flags: | |
| 6982 flag meaning when present ~ | |
| 6983 f use "(3 of 5)" instead of "(file 3 of 5)" | |
| 6984 i use "[noeol]" instead of "[Incomplete last line]" | |
|
21154
9f9c26b3ddc5
patch 8.2.1128: the write message mentions characters, but it's bytes
Bram Moolenaar <Bram@vim.org>
parents:
21112
diff
changeset
|
6985 l use "999L, 888B" instead of "999 lines, 888 bytes" |
| 7 | 6986 m use "[+]" instead of "[Modified]" |
| 6987 n use "[New]" instead of "[New File]" | |
| 6988 r use "[RO]" instead of "[readonly]" | |
| 6989 w use "[w]" instead of "written" for file write message | |
| 6990 and "[a]" instead of "appended" for ':w >> file' command | |
| 6991 x use "[dos]" instead of "[dos format]", "[unix]" instead of | |
| 6992 "[unix format]" and "[mac]" instead of "[mac format]". | |
| 6993 a all of the above abbreviations | |
| 6994 | |
| 6995 o overwrite message for writing a file with subsequent message | |
| 6996 for reading a file (useful for ":wn" or when 'autowrite' on) | |
| 6997 O message for reading a file overwrites any previous message. | |
| 6998 Also for quickfix message (e.g., ":cn"). | |
| 6999 s don't give "search hit BOTTOM, continuing at TOP" or "search | |
| 16610 | 7000 hit TOP, continuing at BOTTOM" messages; when using the search |
| 7001 count do not show "W" after the count message (see S below) | |
| 7 | 7002 t truncate file message at the start if it is too long to fit |
| 7003 on the command-line, "<" will appear in the left most column. | |
| 7004 Ignored in Ex mode. | |
| 7005 T truncate other messages in the middle if they are too long to | |
| 233 | 7006 fit on the command line. "..." will appear in the middle. |
| 7 | 7007 Ignored in Ex mode. |
| 7008 W don't give "written" or "[w]" when writing a file | |
| 7009 A don't give the "ATTENTION" message when an existing swap file | |
| 7010 is found. | |
| 7011 I don't give the intro message when starting Vim |:intro|. | |
| 5946 | 7012 c don't give |ins-completion-menu| messages. For example, |
| 7013 "-- XXX completion (YYY)", "match 1 of 2", "The only match", | |
| 7014 "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
|
7015 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
|
7016 F don't give the file info when editing a file, like `:silent` |
|
16728
e55c26aaf484
patch 8.1.1366: using expressions in a modeline is unsafe
Bram Moolenaar <Bram@vim.org>
parents:
16610
diff
changeset
|
7017 was used for the command; note that this also affects messages |
|
e55c26aaf484
patch 8.1.1366: using expressions in a modeline is unsafe
Bram Moolenaar <Bram@vim.org>
parents:
16610
diff
changeset
|
7018 from autocommands |
|
16533
5e25171e0e75
patch 8.1.1270: cannot see current match position
Bram Moolenaar <Bram@vim.org>
parents:
16447
diff
changeset
|
7019 S do not show search count message when searching, e.g. |
|
5e25171e0e75
patch 8.1.1270: cannot see current match position
Bram Moolenaar <Bram@vim.org>
parents:
16447
diff
changeset
|
7020 "[1/5]" |
| 7 | 7021 |
| 7022 This gives you the opportunity to avoid that a change between buffers | |
| 7023 requires you to hit <Enter>, but still gives as useful a message as | |
| 7024 possible for the space available. To get the whole message that you | |
| 7025 would have got with 'shm' empty, use ":file!" | |
| 7026 Useful values: | |
| 7027 shm= No abbreviation of message. | |
| 7028 shm=a Abbreviation, but no loss of information. | |
| 7029 shm=at Abbreviation, and truncate message when necessary. | |
| 7030 | |
| 7031 NOTE: This option is set to the Vi default value when 'compatible' is | |
| 7032 set and to the Vim default value when 'compatible' is reset. | |
| 7033 | |
| 7034 *'shortname'* *'sn'* *'noshortname'* *'nosn'* | |
| 7035 'shortname' 'sn' boolean (default off) | |
| 7036 local to buffer | |
| 7037 Filenames are assumed to be 8 characters plus one extension of 3 | |
| 7038 characters. Multiple dots in file names are not allowed. When this | |
| 7039 option is on, dots in file names are replaced with underscores when | |
| 18972 | 7040 adding an extension (".~" or ".swp"). This option is useful |
| 7 | 7041 when editing files on an MS-DOS compatible filesystem, e.g., messydos |
| 19163 | 7042 or crossdos. |
| 7 | 7043 |
| 7044 *'showbreak'* *'sbr'* *E595* | |
| 7045 'showbreak' 'sbr' string (default "") | |
|
18574
8b0114ffde2b
patch 8.1.2281: 'showbreak' cannot be set for one window
Bram Moolenaar <Bram@vim.org>
parents:
18526
diff
changeset
|
7046 global or local to window |global-local| |
|
2570
71b56b4e7785
Make the references to features in the help more consistent. (Sylvain Hitier)
Bram Moolenaar <bram@vim.org>
parents:
2561
diff
changeset
|
7047 {not available when compiled without the |+linebreak| |
| 7 | 7048 feature} |
| 7049 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
|
7050 values are "> " or "+++ ": > |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
7051 :set showbreak=>\ |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
7052 < 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
|
7053 this: > |
|
2314
233eb4412f5d
Added 'colorcolumn' option. Partly by Gregor Uhlenheuer.
Bram Moolenaar <bram@vim.org>
parents:
2302
diff
changeset
|
7054 :let &showbreak = '+++ ' |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
7055 < Only printable single-cell characters are allowed, excluding <Tab> and |
| 7 | 7056 comma (in a future version the comma might be used to separate the |
| 7057 part that is shown at the end and at the start of a line). | |
| 7058 The characters are highlighted according to the '@' flag in | |
| 7059 'highlight'. | |
| 7060 Note that tabs after the showbreak will be displayed differently. | |
| 7061 If you want the 'showbreak' to appear in between line numbers, add the | |
| 7062 "n" flag to 'cpoptions'. | |
|
18574
8b0114ffde2b
patch 8.1.2281: 'showbreak' cannot be set for one window
Bram Moolenaar <Bram@vim.org>
parents:
18526
diff
changeset
|
7063 A window-local value overrules a global value. If the global value is |
|
8b0114ffde2b
patch 8.1.2281: 'showbreak' cannot be set for one window
Bram Moolenaar <Bram@vim.org>
parents:
18526
diff
changeset
|
7064 set and you want no value in the current window use NONE: > |
|
8b0114ffde2b
patch 8.1.2281: 'showbreak' cannot be set for one window
Bram Moolenaar <Bram@vim.org>
parents:
18526
diff
changeset
|
7065 :setlocal showbreak=NONE |
|
8b0114ffde2b
patch 8.1.2281: 'showbreak' cannot be set for one window
Bram Moolenaar <Bram@vim.org>
parents:
18526
diff
changeset
|
7066 < |
| 7 | 7067 *'showcmd'* *'sc'* *'noshowcmd'* *'nosc'* |
|
9669
284b4eb307fc
commit https://github.com/vim/vim/commit/8c08b5b569e2a9e9f63dea514591ecfa2d3bb392
Christian Brabandt <cb@256bit.org>
parents:
9665
diff
changeset
|
7068 '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
|
7069 Vi default: off, set in |defaults.vim|) |
| 7 | 7070 global |
| 7071 {not available when compiled without the | |
| 7072 |+cmdline_info| feature} | |
| 1152 | 7073 Show (partial) command in the last line of the screen. Set this |
| 7074 option off if your terminal is slow. | |
| 7 | 7075 In Visual mode the size of the selected area is shown: |
| 7076 - 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
|
7077 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
|
7078 means two characters and six bytes. |
| 7 | 7079 - When selecting more than one line, the number of lines. |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
7080 - When selecting a block, the size in screen characters: |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
7081 {lines}x{columns}. |
| 7 | 7082 NOTE: This option is set to the Vi default value when 'compatible' is |
| 7083 set and to the Vim default value when 'compatible' is reset. | |
| 7084 | |
| 7085 *'showfulltag'* *'sft'* *'noshowfulltag'* *'nosft'* | |
| 7086 'showfulltag' 'sft' boolean (default off) | |
| 7087 global | |
| 7088 When completing a word in insert mode (see |ins-completion|) from the | |
| 7089 tags file, show both the tag name and a tidied-up form of the search | |
| 10 | 7090 pattern (if there is one) as possible matches. Thus, if you have |
| 7 | 7091 matched a C function, you can see a template for what arguments are |
| 7092 required (coding style permitting). | |
| 1621 | 7093 Note that this doesn't work well together with having "longest" in |
| 7094 'completeopt', because the completion from the search pattern may not | |
| 7095 match the typed text. | |
| 7 | 7096 |
| 7097 *'showmatch'* *'sm'* *'noshowmatch'* *'nosm'* | |
| 7098 'showmatch' 'sm' boolean (default off) | |
| 7099 global | |
| 7100 When a bracket is inserted, briefly jump to the matching one. The | |
| 7101 jump is only done if the match can be seen on the screen. The time to | |
| 7102 show the match can be set with 'matchtime'. | |
| 7103 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
|
7104 seen or not). |
|
c590de398af9
commit https://github.com/vim/vim/commit/ca63501fbcd1cf9c8aa9ff12c093c95b62a89ed7
Christian Brabandt <cb@256bit.org>
parents:
7080
diff
changeset
|
7105 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
|
7106 reset. |
| 7 | 7107 When the 'm' flag is not included in 'cpoptions', typing a character |
| 7108 will immediately move the cursor back to where it belongs. | |
| 7109 See the "sm" field in 'guicursor' for setting the cursor shape and | |
| 7110 blinking when showing the match. | |
| 7111 The 'matchpairs' option can be used to specify the characters to show | |
| 7112 matches for. 'rightleft' and 'revins' are used to look for opposite | |
| 7113 matches. | |
| 699 | 7114 Also see the matchparen plugin for highlighting the match when moving |
| 7115 around |pi_paren.txt|. | |
| 7116 Note: Use of the short form is rated PG. | |
| 7 | 7117 |
| 7118 *'showmode'* *'smd'* *'noshowmode'* *'nosmd'* | |
| 7119 'showmode' 'smd' boolean (Vim default: on, Vi default: off) | |
| 7120 global | |
| 7121 If in Insert, Replace or Visual mode put a message on the last line. | |
| 7122 Use the 'M' flag in 'highlight' to set the type of highlighting for | |
| 7123 this message. | |
| 10 | 7124 When |XIM| may be used the message will include "XIM". But this |
| 7 | 7125 doesn't mean XIM is really active, especially when 'imactivatekey' is |
| 7126 not set. | |
| 7127 NOTE: This option is set to the Vi default value when 'compatible' is | |
| 7128 set and to the Vim default value when 'compatible' is reset. | |
| 7129 | |
| 677 | 7130 *'showtabline'* *'stal'* |
| 7131 'showtabline' 'stal' number (default 1) | |
| 7132 global | |
| 7133 The value of this option specifies when the line with tab page labels | |
| 7134 will be displayed: | |
| 7135 0: never | |
| 7136 1: only if there are at least two tab pages | |
| 7137 2: always | |
| 7138 This is both for the GUI and non-GUI implementation of the tab pages | |
| 7139 line. | |
| 7140 See |tab-page| for more information about tab pages. | |
| 7141 | |
| 7 | 7142 *'sidescroll'* *'ss'* |
| 7143 'sidescroll' 'ss' number (default 0) | |
| 7144 global | |
| 7145 The minimal number of columns to scroll horizontally. Used only when | |
| 7146 the 'wrap' option is off and the cursor is moved off of the screen. | |
| 7147 When it is zero the cursor will be put in the middle of the screen. | |
| 7148 When using a slow terminal set it to a large number or 0. When using | |
| 7149 a fast terminal use a small number or 1. Not used for "zh" and "zl" | |
| 7150 commands. | |
| 7151 | |
| 7152 *'sidescrolloff'* *'siso'* | |
| 7153 'sidescrolloff' 'siso' number (default 0) | |
|
15713
ad8b2c109b22
patch 8.1.0864: cannot have a local value for 'scrolloff' and 'sidescrolloff'
Bram Moolenaar <Bram@vim.org>
parents:
15701
diff
changeset
|
7154 global or local to window |global-local| |
| 7 | 7155 The minimal number of screen columns to keep to the left and to the |
| 534 | 7156 right of the cursor if 'nowrap' is set. Setting this option to a |
| 7157 value greater than 0 while having |'sidescroll'| also at a non-zero | |
| 7158 value makes some context visible in the line you are scrolling in | |
| 7159 horizontally (except at beginning of the line). Setting this option | |
| 7160 to a large value (like 999) has the effect of keeping the cursor | |
| 7161 horizontally centered in the window, as long as one does not come too | |
| 7162 close to the beginning of the line. | |
|
15713
ad8b2c109b22
patch 8.1.0864: cannot have a local value for 'scrolloff' and 'sidescrolloff'
Bram Moolenaar <Bram@vim.org>
parents:
15701
diff
changeset
|
7163 After using the local value, go back the global value with one of |
|
ad8b2c109b22
patch 8.1.0864: cannot have a local value for 'scrolloff' and 'sidescrolloff'
Bram Moolenaar <Bram@vim.org>
parents:
15701
diff
changeset
|
7164 these two: > |
|
ad8b2c109b22
patch 8.1.0864: cannot have a local value for 'scrolloff' and 'sidescrolloff'
Bram Moolenaar <Bram@vim.org>
parents:
15701
diff
changeset
|
7165 setlocal sidescrolloff< |
|
ad8b2c109b22
patch 8.1.0864: cannot have a local value for 'scrolloff' and 'sidescrolloff'
Bram Moolenaar <Bram@vim.org>
parents:
15701
diff
changeset
|
7166 setlocal sidescrolloff=-1 |
|
ad8b2c109b22
patch 8.1.0864: cannot have a local value for 'scrolloff' and 'sidescrolloff'
Bram Moolenaar <Bram@vim.org>
parents:
15701
diff
changeset
|
7167 < NOTE: This option is set to 0 when 'compatible' is set. |
| 7 | 7168 |
| 7169 Example: Try this together with 'sidescroll' and 'listchars' as | |
| 7170 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
|
7171 onto the "extends" character: > |
| 7 | 7172 |
| 7173 :set nowrap sidescroll=1 listchars=extends:>,precedes:< | |
| 7174 :set sidescrolloff=1 | |
|
9852
4eea48b76d03
commit https://github.com/vim/vim/commit/95ec9d6a6ab3117d60ff638670a803d43974ba51
Christian Brabandt <cb@256bit.org>
parents:
9737
diff
changeset
|
7175 < |
|
4eea48b76d03
commit https://github.com/vim/vim/commit/95ec9d6a6ab3117d60ff638670a803d43974ba51
Christian Brabandt <cb@256bit.org>
parents:
9737
diff
changeset
|
7176 *'signcolumn'* *'scl'* |
|
4eea48b76d03
commit https://github.com/vim/vim/commit/95ec9d6a6ab3117d60ff638670a803d43974ba51
Christian Brabandt <cb@256bit.org>
parents:
9737
diff
changeset
|
7177 'signcolumn' 'scl' string (default "auto") |
|
4eea48b76d03
commit https://github.com/vim/vim/commit/95ec9d6a6ab3117d60ff638670a803d43974ba51
Christian Brabandt <cb@256bit.org>
parents:
9737
diff
changeset
|
7178 local to window |
|
4eea48b76d03
commit https://github.com/vim/vim/commit/95ec9d6a6ab3117d60ff638670a803d43974ba51
Christian Brabandt <cb@256bit.org>
parents:
9737
diff
changeset
|
7179 {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
|
7180 feature} |
|
9860
9eaf8ef656e9
commit https://github.com/vim/vim/commit/0952131376a517fc12dc5ae908a97018b4ee23f0
Christian Brabandt <cb@256bit.org>
parents:
9852
diff
changeset
|
7181 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
|
7182 "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
|
7183 "no" never |
|
9eaf8ef656e9
commit https://github.com/vim/vim/commit/0952131376a517fc12dc5ae908a97018b4ee23f0
Christian Brabandt <cb@256bit.org>
parents:
9852
diff
changeset
|
7184 "yes" always |
|
17129
4fb68abc770f
patch 8.1.1564: sign column takes up space
Bram Moolenaar <Bram@vim.org>
parents:
16808
diff
changeset
|
7185 "number" display signs in the 'number' column. If the number |
| 17161 | 7186 column is not present, then behaves like "auto". |
| 7 | 7187 |
| 7188 | |
| 7189 *'smartcase'* *'scs'* *'nosmartcase'* *'noscs'* | |
| 7190 'smartcase' 'scs' boolean (default off) | |
| 7191 global | |
| 7192 Override the 'ignorecase' option if the search pattern contains upper | |
| 7193 case characters. Only used when the search pattern is typed and | |
| 7194 'ignorecase' option is on. Used for the commands "/", "?", "n", "N", | |
| 3557 | 7195 ":g" and ":s". Not used for "*", "#", "gd", tag search, etc. After |
| 7 | 7196 "*" and "#" you can make 'smartcase' used by doing a "/" command, |
| 7197 recalling the search pattern from history and hitting <Enter>. | |
| 7198 NOTE: This option is reset when 'compatible' is set. | |
| 7199 | |
| 7200 *'smartindent'* *'si'* *'nosmartindent'* *'nosi'* | |
| 7201 'smartindent' 'si' boolean (default off) | |
| 7202 local to buffer | |
| 7203 {not available when compiled without the | |
| 7204 |+smartindent| feature} | |
| 7205 Do smart autoindenting when starting a new line. Works for C-like | |
| 7206 programs, but can also be used for other languages. 'cindent' does | |
| 7207 something like this, works better in most cases, but is more strict, | |
| 2662 | 7208 see |C-indenting|. When 'cindent' is on or 'indentexpr' is set, |
| 2642 | 7209 setting 'si' has no effect. 'indentexpr' is a more advanced |
| 7210 alternative. | |
| 7 | 7211 Normally 'autoindent' should also be on when using 'smartindent'. |
| 7212 An indent is automatically inserted: | |
| 7213 - After a line ending in '{'. | |
| 7214 - After a line starting with a keyword from 'cinwords'. | |
| 7215 - Before a line starting with '}' (only with the "O" command). | |
| 7216 When typing '}' as the first character in a new line, that line is | |
| 7217 given the same indent as the matching '{'. | |
| 7218 When typing '#' as the first character in a new line, the indent for | |
| 7219 that line is removed, the '#' is put in the first column. The indent | |
| 10 | 7220 is restored for the next line. If you don't want this, use this |
| 7 | 7221 mapping: ":inoremap # X^H#", where ^H is entered with CTRL-V CTRL-H. |
| 7222 When using the ">>" command, lines starting with '#' are not shifted | |
| 7223 right. | |
| 11160 | 7224 NOTE: This option is reset when 'compatible' is set. |
|
7147
c590de398af9
commit https://github.com/vim/vim/commit/ca63501fbcd1cf9c8aa9ff12c093c95b62a89ed7
Christian Brabandt <cb@256bit.org>
parents:
7080
diff
changeset
|
7225 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
|
7226 reset. |
| 7 | 7227 |
| 7228 *'smarttab'* *'sta'* *'nosmarttab'* *'nosta'* | |
| 7229 'smarttab' 'sta' boolean (default off) | |
| 7230 global | |
| 7231 When on, a <Tab> in front of a line inserts blanks according to | |
| 648 | 7232 'shiftwidth'. 'tabstop' or 'softtabstop' is used in other places. A |
| 7233 <BS> will delete a 'shiftwidth' worth of space at the start of the | |
| 7234 line. | |
| 650 | 7235 When off, a <Tab> always inserts blanks according to 'tabstop' or |
| 648 | 7236 'softtabstop'. 'shiftwidth' is only used for shifting text left or |
| 7237 right |shift-left-right|. | |
| 1263 | 7238 What gets inserted (a <Tab> or spaces) depends on the 'expandtab' |
| 7 | 7239 option. Also see |ins-expandtab|. When 'expandtab' is not set, the |
| 11 | 7240 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
|
7241 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
|
7242 reset. |
| 7 | 7243 NOTE: This option is reset when 'compatible' is set. |
| 7244 | |
| 7245 *'softtabstop'* *'sts'* | |
| 7246 'softtabstop' 'sts' number (default 0) | |
| 7247 local to buffer | |
| 7248 Number of spaces that a <Tab> counts for while performing editing | |
| 7249 operations, like inserting a <Tab> or using <BS>. It "feels" like | |
| 7250 <Tab>s are being inserted, while in fact a mix of spaces and <Tab>s is | |
| 7251 used. This is useful to keep the 'ts' setting at its standard value | |
| 7252 of 8, while being able to edit like it is set to 'sts'. However, | |
| 7253 commands like "x" still work on the actual characters. | |
| 7254 When 'sts' is zero, this feature is off. | |
| 3893 | 7255 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
|
7256 '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
|
7257 when 'paste' is reset. |
| 7 | 7258 See also |ins-expandtab|. When 'expandtab' is not set, the number of |
| 7259 spaces is minimized by using <Tab>s. | |
| 7260 The 'L' flag in 'cpoptions' changes how tabs are used when 'list' is | |
| 7261 set. | |
| 7262 NOTE: This option is set to 0 when 'compatible' is set. | |
| 7263 | |
|
14175
2ad722003b36
patch 8.1.0105: all tab stops are the same
Christian Brabandt <cb@256bit.org>
parents:
14019
diff
changeset
|
7264 If Vim is compiled with the |+vartabs| feature then the value of |
|
2ad722003b36
patch 8.1.0105: all tab stops are the same
Christian Brabandt <cb@256bit.org>
parents:
14019
diff
changeset
|
7265 'softtabstop' will be ignored if |'varsofttabstop'| is set to |
|
2ad722003b36
patch 8.1.0105: all tab stops are the same
Christian Brabandt <cb@256bit.org>
parents:
14019
diff
changeset
|
7266 anything other than an empty string. |
|
2ad722003b36
patch 8.1.0105: all tab stops are the same
Christian Brabandt <cb@256bit.org>
parents:
14019
diff
changeset
|
7267 |
| 221 | 7268 *'spell'* *'nospell'* |
| 7269 'spell' boolean (default off) | |
| 7270 local to window | |
| 7271 {not available when compiled without the |+syntax| | |
| 7272 feature} | |
| 7273 When on spell checking will be done. See |spell|. | |
| 236 | 7274 The languages are specified with 'spelllang'. |
| 221 | 7275 |
| 386 | 7276 *'spellcapcheck'* *'spc'* |
| 389 | 7277 'spellcapcheck' 'spc' string (default "[.?!]\_[\])'" \t]\+") |
| 386 | 7278 local to buffer |
| 7279 {not available when compiled without the |+syntax| | |
| 7280 feature} | |
| 7281 Pattern to locate the end of a sentence. The following word will be | |
| 7282 checked to start with a capital letter. If not then it is highlighted | |
| 484 | 7283 with SpellCap |hl-SpellCap| (unless the word is also badly spelled). |
| 386 | 7284 When this check is not wanted make this option empty. |
| 7285 Only used when 'spell' is set. | |
| 389 | 7286 Be careful with special characters, see |option-backslash| about |
| 7287 including spaces and backslashes. | |
| 480 | 7288 To set this option automatically depending on the language, see |
| 7289 |set-spc-auto|. | |
| 386 | 7290 |
| 314 | 7291 *'spellfile'* *'spf'* |
| 7292 'spellfile' 'spf' string (default empty) | |
| 7293 local to buffer | |
| 7294 {not available when compiled without the |+syntax| | |
| 7295 feature} | |
| 7296 Name of the word list file where words are added for the |zg| and |zw| | |
| 401 | 7297 commands. It must end in ".{encoding}.add". You need to include the |
| 7298 path, otherwise the file is placed in the current directory. | |
| 386 | 7299 *E765* |
| 7300 It may also be a comma separated list of names. A count before the | |
| 7301 |zg| and |zw| commands can be used to access each. This allows using | |
| 7302 a personal word list file and a project word list file. | |
| 314 | 7303 When a word is added while this option is empty Vim will set it for |
| 819 | 7304 you: Using the first directory in 'runtimepath' that is writable. If |
| 7305 there is no "spell" directory yet it will be created. For the file | |
| 7306 name the first language name that appears in 'spelllang' is used, | |
| 353 | 7307 ignoring the region. |
| 7308 The resulting ".spl" file will be used for spell checking, it does not | |
| 7309 have to appear in 'spelllang'. | |
| 7310 Normally one file is used for all regions, but you can add the region | |
| 7311 name if you want to. However, it will then only be used when | |
| 7312 'spellfile' is set to it, for entries in 'spelllang' only files | |
| 7313 without region name will be found. | |
| 336 | 7314 This option cannot be set from a |modeline| or in the |sandbox|, for |
| 7315 security reasons. | |
| 314 | 7316 |
| 221 | 7317 *'spelllang'* *'spl'* |
| 314 | 7318 'spelllang' 'spl' string (default "en") |
| 221 | 7319 local to buffer |
| 7320 {not available when compiled without the |+syntax| | |
| 7321 feature} | |
| 353 | 7322 A comma separated list of word list names. When the 'spell' option is |
| 7323 on spellchecking will be done for these languages. Example: > | |
| 7324 set spelllang=en_us,nl,medical | |
| 7325 < This means US English, Dutch and medical words are recognized. Words | |
| 7326 that are not recognized will be highlighted. | |
| 16380 | 7327 The word list name must consist of alphanumeric characters, a dash or |
| 7328 an underscore. It should not include a comma or dot. Using a dash is | |
| 353 | 7329 recommended to separate the two letter language name from a |
| 7330 specification. Thus "en-rare" is used for rare English words. | |
| 7331 A region name must come last and have the form "_xx", where "xx" is | |
| 7332 the two-letter, lower case region name. You can use more than one | |
| 7333 region by listing them: "en_us,en_ca" supports both US and Canadian | |
| 7334 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
|
7335 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
|
7336 en_ca, en_gb and en_us). |
| 5477 | 7337 If the name "cjk" is included East Asian characters are excluded from |
| 7338 spell checking. This is useful when editing text that also has Asian | |
| 7339 words. | |
| 25773 | 7340 Note that the "medical" dictionary does not exist, it is just an |
| 7341 example of a longer name. | |
| 484 | 7342 *E757* |
| 419 | 7343 As a special case the name of a .spl file can be given as-is. The |
| 7344 first "_xx" in the name is removed and used as the region name | |
| 7345 (_xx is an underscore, two letters and followed by a non-letter). | |
| 7346 This is mainly for testing purposes. You must make sure the correct | |
| 7347 encoding is used, Vim doesn't check it. | |
| 236 | 7348 When 'encoding' is set the word lists are reloaded. Thus it's a good |
| 419 | 7349 idea to set 'spelllang' after setting 'encoding' to avoid loading the |
| 7350 files twice. | |
| 353 | 7351 How the related spell files are found is explained here: |spell-load|. |
| 221 | 7352 |
| 653 | 7353 If the |spellfile.vim| plugin is active and you use a language name |
| 7354 for which Vim cannot find the .spl file in 'runtimepath' the plugin | |
| 7355 will ask you if you want to download the file. | |
| 7356 | |
| 480 | 7357 After this option has been set successfully, Vim will source the files |
| 7358 "spell/LANG.vim" in 'runtimepath'. "LANG" is the value of 'spelllang' | |
| 15068 | 7359 up to the first character that is not an ASCII letter or number and |
| 7360 not a dash. Also see |set-spc-auto|. | |
| 480 | 7361 |
|
20802
ed00f0fbdaef
patch 8.2.0953: spell checking doesn't work for CamelCased words
Bram Moolenaar <Bram@vim.org>
parents:
20758
diff
changeset
|
7362 *'spelloptions'* *'spo'* |
|
ed00f0fbdaef
patch 8.2.0953: spell checking doesn't work for CamelCased words
Bram Moolenaar <Bram@vim.org>
parents:
20758
diff
changeset
|
7363 'spelloptions' 'spo' string (default "") |
|
ed00f0fbdaef
patch 8.2.0953: spell checking doesn't work for CamelCased words
Bram Moolenaar <Bram@vim.org>
parents:
20758
diff
changeset
|
7364 local to buffer |
|
ed00f0fbdaef
patch 8.2.0953: spell checking doesn't work for CamelCased words
Bram Moolenaar <Bram@vim.org>
parents:
20758
diff
changeset
|
7365 {not available when compiled without the |+syntax| |
|
ed00f0fbdaef
patch 8.2.0953: spell checking doesn't work for CamelCased words
Bram Moolenaar <Bram@vim.org>
parents:
20758
diff
changeset
|
7366 feature} |
|
ed00f0fbdaef
patch 8.2.0953: spell checking doesn't work for CamelCased words
Bram Moolenaar <Bram@vim.org>
parents:
20758
diff
changeset
|
7367 A comma separated list of options for spell checking: |
|
ed00f0fbdaef
patch 8.2.0953: spell checking doesn't work for CamelCased words
Bram Moolenaar <Bram@vim.org>
parents:
20758
diff
changeset
|
7368 camel When a word is CamelCased, assume "Cased" is a |
|
ed00f0fbdaef
patch 8.2.0953: spell checking doesn't work for CamelCased words
Bram Moolenaar <Bram@vim.org>
parents:
20758
diff
changeset
|
7369 separate word: every upper-case character in a word |
|
ed00f0fbdaef
patch 8.2.0953: spell checking doesn't work for CamelCased words
Bram Moolenaar <Bram@vim.org>
parents:
20758
diff
changeset
|
7370 that comes after a lower case character indicates the |
|
ed00f0fbdaef
patch 8.2.0953: spell checking doesn't work for CamelCased words
Bram Moolenaar <Bram@vim.org>
parents:
20758
diff
changeset
|
7371 start of a new word. |
| 480 | 7372 |
| 344 | 7373 *'spellsuggest'* *'sps'* |
| 7374 'spellsuggest' 'sps' string (default "best") | |
| 7375 global | |
| 7376 {not available when compiled without the |+syntax| | |
| 7377 feature} | |
| 593 | 7378 Methods used for spelling suggestions. Both for the |z=| command and |
| 374 | 7379 the |spellsuggest()| function. This is a comma-separated list of |
| 7380 items: | |
| 7381 | |
| 7382 best Internal method that works best for English. Finds | |
| 7383 changes like "fast" and uses a bit of sound-a-like | |
| 7384 scoring to improve the ordering. | |
| 7385 | |
| 7386 double Internal method that uses two methods and mixes the | |
| 7387 results. The first method is "fast", the other method | |
| 344 | 7388 computes how much the suggestion sounds like the bad |
| 374 | 7389 word. That only works when the language specifies |
| 7390 sound folding. Can be slow and doesn't always give | |
| 7391 better results. | |
| 7392 | |
| 7393 fast Internal method that only checks for simple changes: | |
| 7394 character inserts/deletes/swaps. Works well for | |
| 7395 simple typing mistakes. | |
| 7396 | |
| 593 | 7397 {number} The maximum number of suggestions listed for |z=|. |
| 484 | 7398 Not used for |spellsuggest()|. The number of |
| 7399 suggestions is never more than the value of 'lines' | |
| 7400 minus two. | |
| 7401 | |
|
27441
674240fcf6de
patch 8.2.4249: the timeout limit for spell suggestions is always 5000
Bram Moolenaar <Bram@vim.org>
parents:
27321
diff
changeset
|
7402 timeout:{millisec} Limit the time searching for suggestions to |
|
674240fcf6de
patch 8.2.4249: the timeout limit for spell suggestions is always 5000
Bram Moolenaar <Bram@vim.org>
parents:
27321
diff
changeset
|
7403 {millisec} milli seconds. Applies to the following |
|
674240fcf6de
patch 8.2.4249: the timeout limit for spell suggestions is always 5000
Bram Moolenaar <Bram@vim.org>
parents:
27321
diff
changeset
|
7404 methods. When omitted the limit is 5000. When |
|
674240fcf6de
patch 8.2.4249: the timeout limit for spell suggestions is always 5000
Bram Moolenaar <Bram@vim.org>
parents:
27321
diff
changeset
|
7405 negative there is no limit. {only works when built |
|
674240fcf6de
patch 8.2.4249: the timeout limit for spell suggestions is always 5000
Bram Moolenaar <Bram@vim.org>
parents:
27321
diff
changeset
|
7406 with the +reltime feature} |
|
674240fcf6de
patch 8.2.4249: the timeout limit for spell suggestions is always 5000
Bram Moolenaar <Bram@vim.org>
parents:
27321
diff
changeset
|
7407 |
| 374 | 7408 file:{filename} Read file {filename}, which must have two columns, |
| 7409 separated by a slash. The first column contains the | |
| 7410 bad word, the second column the suggested good word. | |
| 7411 Example: | |
| 7412 theribal/terrible ~ | |
| 7413 Use this for common mistakes that do not appear at the | |
| 7414 top of the suggestion list with the internal methods. | |
| 7415 Lines without a slash are ignored, use this for | |
| 7416 comments. | |
| 5862 | 7417 The word in the second column must be correct, |
| 7418 otherwise it will not be used. Add the word to an | |
| 7419 ".add" file if it is currently flagged as a spelling | |
| 7420 mistake. | |
| 374 | 7421 The file is used for all languages. |
| 7422 | |
| 7423 expr:{expr} Evaluate expression {expr}. Use a function to avoid | |
| 7424 trouble with spaces. |v:val| holds the badly spelled | |
| 7425 word. The expression must evaluate to a List of | |
| 7426 Lists, each with a suggestion and a score. | |
| 7427 Example: | |
| 11062 | 7428 [['the', 33], ['that', 44]] ~ |
| 593 | 7429 Set 'verbose' and use |z=| to see the scores that the |
| 374 | 7430 internal methods use. A lower score is better. |
| 7431 This may invoke |spellsuggest()| if you temporarily | |
| 7432 set 'spellsuggest' to exclude the "expr:" part. | |
| 7433 Errors are silently ignored, unless you set the | |
| 7434 'verbose' option to a non-zero value. | |
| 7435 | |
| 7436 Only one of "best", "double" or "fast" may be used. The others may | |
| 7437 appear several times in any order. Example: > | |
| 7438 :set sps=file:~/.vim/sugg,best,expr:MySuggest() | |
| 7439 < | |
| 7440 This option cannot be set from a |modeline| or in the |sandbox|, for | |
| 7441 security reasons. | |
| 344 | 7442 |
| 7443 | |
| 7 | 7444 *'splitbelow'* *'sb'* *'nosplitbelow'* *'nosb'* |
| 7445 'splitbelow' 'sb' boolean (default off) | |
| 7446 global | |
| 7447 When on, splitting a window will put the new window below the current | |
| 7448 one. |:split| | |
| 7449 | |
| 7450 *'splitright'* *'spr'* *'nosplitright'* *'nospr'* | |
| 7451 'splitright' 'spr' boolean (default off) | |
| 7452 global | |
| 7453 When on, splitting a window will put the new window right of the | |
| 7454 current one. |:vsplit| | |
| 7455 | |
| 7456 *'startofline'* *'sol'* *'nostartofline'* *'nosol'* | |
| 7457 'startofline' 'sol' boolean (default on) | |
| 7458 global | |
| 7459 When "on" the commands listed below move the cursor to the first | |
| 11 | 7460 non-blank of the line. When off the cursor is kept in the same column |
| 10 | 7461 (if possible). This applies to the commands: CTRL-D, CTRL-U, CTRL-B, |
| 11 | 7462 CTRL-F, "G", "H", "M", "L", gg, and to the commands "d", "<<" and ">>" |
| 7 | 7463 with a linewise operator, with "%" with a count and to buffer changing |
| 7464 commands (CTRL-^, :bnext, :bNext, etc.). Also for an Ex command that | |
| 7465 only has a line number, e.g., ":25" or ":+". | |
| 7466 In case of buffer changing commands the cursor is placed at the column | |
| 7467 where it was the last time the buffer was edited. | |
| 7468 NOTE: This option is set when 'compatible' is set. | |
| 7469 | |
| 2709 | 7470 *'statusline'* *'stl'* *E540* *E542* |
| 7 | 7471 'statusline' 'stl' string (default empty) |
| 40 | 7472 global or local to window |global-local| |
| 7 | 7473 {not available when compiled without the |+statusline| |
| 7474 feature} | |
| 27804 | 7475 When non-empty, this option determines the content of the status line. |
| 7 | 7476 Also see |status-line|. |
| 7477 | |
| 7478 The option consists of printf style '%' items interspersed with | |
| 7479 normal text. Each status line item is of the form: | |
| 7480 %-0{minwid}.{maxwid}{item} | |
|
7876
93f747af7b58
commit https://github.com/vim/vim/commit/5e9b2fa9bb0e6061cf18457c173cd141a5dc9c92
Christian Brabandt <cb@256bit.org>
parents:
7687
diff
changeset
|
7481 All fields except the {item} are optional. A single percent sign can |
|
22721
92a100fc5e17
patch 8.2.1909: number of status line items is limited to 80
Bram Moolenaar <Bram@vim.org>
parents:
22565
diff
changeset
|
7482 be given as "%%". |
| 7 | 7483 |
| 680 | 7484 When the option starts with "%!" then it is used as an expression, |
| 7485 evaluated and the result is used as the option value. Example: > | |
| 7486 :set statusline=%!MyStatusLine() | |
|
16740
dc85d49349f7
patch 8.1.1372: when evaluating 'statusline' the current window is unknown
Bram Moolenaar <Bram@vim.org>
parents:
16728
diff
changeset
|
7487 < The *g:statusline_winid* variable will be set to the |window-ID| of the |
|
dc85d49349f7
patch 8.1.1372: when evaluating 'statusline' the current window is unknown
Bram Moolenaar <Bram@vim.org>
parents:
16728
diff
changeset
|
7488 window that the status line belongs to. |
|
dc85d49349f7
patch 8.1.1372: when evaluating 'statusline' the current window is unknown
Bram Moolenaar <Bram@vim.org>
parents:
16728
diff
changeset
|
7489 The result can contain %{} items that will be evaluated too. |
| 3445 | 7490 Note that the "%!" expression is evaluated in the context of the |
| 7491 current window and buffer, while %{} items are evaluated in the | |
| 7492 context of the window that the statusline belongs to. | |
| 680 | 7493 |
| 7494 When there is error while evaluating the option then it will be made | |
| 7495 empty to avoid further errors. Otherwise screen updating would loop. | |
| 7496 | |
| 7 | 7497 Note that the only effect of 'ruler' when this option is set (and |
| 7498 'laststatus' is 2) is controlling the output of |CTRL-G|. | |
| 7499 | |
| 7500 field meaning ~ | |
| 233 | 7501 - Left justify the item. The default is right justified |
| 7 | 7502 when minwid is larger than the length of the item. |
| 233 | 7503 0 Leading zeroes in numeric items. Overridden by '-'. |
| 7 | 7504 minwid Minimum width of the item, padding as set by '-' & '0'. |
| 7505 Value must be 50 or less. | |
| 10 | 7506 maxwid Maximum width of the item. Truncation occurs with a '<' |
| 7 | 7507 on the left for text items. Numeric items will be |
| 7508 shifted down to maxwid-2 digits followed by '>'number | |
| 7509 where number is the amount of missing digits, much like | |
| 7510 an exponential notation. | |
| 7511 item A one letter code as described below. | |
| 7512 | |
| 7513 Following is a description of the possible statusline items. The | |
| 7514 second character in "item" is the type: | |
| 7515 N for number | |
| 7516 S for string | |
| 7517 F for flags as described below | |
| 7518 - not applicable | |
| 7519 | |
| 7520 item meaning ~ | |
| 1152 | 7521 f S Path to the file in the buffer, as typed or relative to current |
| 7522 directory. | |
| 7 | 7523 F S Full path to the file in the buffer. |
| 7524 t S File name (tail) of file in the buffer. | |
| 1698 | 7525 m F Modified flag, text is "[+]"; "[-]" if 'modifiable' is off. |
| 7 | 7526 M F Modified flag, text is ",+" or ",-". |
| 1698 | 7527 r F Readonly flag, text is "[RO]". |
| 7 | 7528 R F Readonly flag, text is ",RO". |
| 1698 | 7529 h F Help buffer flag, text is "[help]". |
| 7 | 7530 H F Help buffer flag, text is ",HLP". |
| 1698 | 7531 w F Preview window flag, text is "[Preview]". |
| 7 | 7532 W F Preview window flag, text is ",PRV". |
| 1698 | 7533 y F Type of file in the buffer, e.g., "[vim]". See 'filetype'. |
| 7 | 7534 Y F Type of file in the buffer, e.g., ",VIM". See 'filetype'. |
|
2411
68e394361ca3
Add "q" item for 'statusline'. Add w:quickfix_title. (Lech Lorens)
Bram Moolenaar <bram@vim.org>
parents:
2400
diff
changeset
|
7535 q S "[Quickfix List]", "[Location List]" or empty. |
| 7 | 7536 k S Value of "b:keymap_name" or 'keymap' when |:lmap| mappings are |
| 7537 being used: "<keymap>" | |
| 7538 n N Buffer number. | |
| 2709 | 7539 b N Value of character under cursor. |
| 7 | 7540 B N As above, in hexadecimal. |
| 7541 o N Byte number in file of byte under cursor, first byte is 1. | |
| 7542 Mnemonic: Offset from start of file (with one added) | |
| 7543 {not available when compiled without |+byte_offset| feature} | |
| 7544 O N As above, in hexadecimal. | |
| 233 | 7545 N N Printer page number. (Only works in the 'printheader' option.) |
| 7 | 7546 l N Line number. |
| 7547 L N Number of lines in buffer. | |
| 22328 | 7548 c N Column number (byte index). |
| 7549 v N Virtual column number (screen column). | |
| 10 | 7550 V N Virtual column number as -{num}. Not displayed if equal to 'c'. |
| 7 | 7551 p N Percentage through file in lines as in |CTRL-G|. |
| 7552 P S Percentage through file of displayed window. This is like the | |
| 5055 | 7553 percentage described for 'ruler'. Always 3 in length, unless |
| 7554 translated. | |
| 233 | 7555 a S Argument list status as in default title. ({current} of {max}) |
| 7 | 7556 Empty if the argument file count is zero or one. |
| 680 | 7557 { NF Evaluate expression between '%{' and '}' and substitute result. |
|
13742
a34b1323286c
patch 8.0.1743: terminal window options are named inconsistently
Christian Brabandt <cb@256bit.org>
parents:
13735
diff
changeset
|
7558 Note that there is no '%' before the closing '}'. The |
|
a34b1323286c
patch 8.0.1743: terminal window options are named inconsistently
Christian Brabandt <cb@256bit.org>
parents:
13735
diff
changeset
|
7559 expression cannot contain a '}' character, call a function to |
| 18719 | 7560 work around that. See |stl-%{| below. |
|
24630
4cf4d7a71fac
patch 8.2.2854: custom statusline cannot contain % items
Bram Moolenaar <Bram@vim.org>
parents:
24600
diff
changeset
|
7561 {% - This is almost same as { except the result of the expression is |
|
4cf4d7a71fac
patch 8.2.2854: custom statusline cannot contain % items
Bram Moolenaar <Bram@vim.org>
parents:
24600
diff
changeset
|
7562 re-evaluated as a statusline format string. Thus if the |
|
4cf4d7a71fac
patch 8.2.2854: custom statusline cannot contain % items
Bram Moolenaar <Bram@vim.org>
parents:
24600
diff
changeset
|
7563 return value of expr contains % items they will get expanded. |
|
4cf4d7a71fac
patch 8.2.2854: custom statusline cannot contain % items
Bram Moolenaar <Bram@vim.org>
parents:
24600
diff
changeset
|
7564 The expression can contain the } character, the end of |
|
4cf4d7a71fac
patch 8.2.2854: custom statusline cannot contain % items
Bram Moolenaar <Bram@vim.org>
parents:
24600
diff
changeset
|
7565 expression is denoted by %}. |
| 25973 | 7566 For example: > |
|
24630
4cf4d7a71fac
patch 8.2.2854: custom statusline cannot contain % items
Bram Moolenaar <Bram@vim.org>
parents:
24600
diff
changeset
|
7567 func! Stl_filename() abort |
|
4cf4d7a71fac
patch 8.2.2854: custom statusline cannot contain % items
Bram Moolenaar <Bram@vim.org>
parents:
24600
diff
changeset
|
7568 return "%t" |
|
4cf4d7a71fac
patch 8.2.2854: custom statusline cannot contain % items
Bram Moolenaar <Bram@vim.org>
parents:
24600
diff
changeset
|
7569 endfunc |
|
4cf4d7a71fac
patch 8.2.2854: custom statusline cannot contain % items
Bram Moolenaar <Bram@vim.org>
parents:
24600
diff
changeset
|
7570 < `stl=%{Stl_filename()}` results in `"%t"` |
|
4cf4d7a71fac
patch 8.2.2854: custom statusline cannot contain % items
Bram Moolenaar <Bram@vim.org>
parents:
24600
diff
changeset
|
7571 `stl=%{%Stl_filename()%}` results in `"Name of current file"` |
| 25973 | 7572 %} - End of `{%` expression |
| 7 | 7573 ( - Start of item group. Can be used for setting the width and |
| 7574 alignment of a section. Must be followed by %) somewhere. | |
| 7575 ) - End of item group. No width fields allowed. | |
| 681 | 7576 T N For 'tabline': start of tab page N label. Use %T after the last |
| 7577 label. This information is used for mouse clicks. | |
| 7578 X N For 'tabline': start of close tab N label. Use %X after the | |
| 7579 label, e.g.: %3Xclose%X. Use %999X for a "close current tab" | |
| 7580 mark. This information is used for mouse clicks. | |
| 7 | 7581 < - Where to truncate line if too long. Default is at the start. |
| 7582 No width fields allowed. | |
| 7583 = - Separation point between left and right aligned items. | |
| 7584 No width fields allowed. | |
| 680 | 7585 # - Set highlight group. The name must follow and then a # again. |
| 7586 Thus use %#HLname# for highlight group HLname. The same | |
| 7587 highlighting is used, also for the statusline of non-current | |
| 7588 windows. | |
| 7 | 7589 * - Set highlight group to User{N}, where {N} is taken from the |
| 233 | 7590 minwid field, e.g. %1*. Restore normal highlight with %* or %0*. |
| 7 | 7591 The difference between User{N} and StatusLine will be applied |
| 7592 to StatusLineNC for the statusline of non-current windows. | |
| 7593 The number N must be between 1 and 9. See |hl-User1..9| | |
| 7594 | |
| 1698 | 7595 When displaying a flag, Vim removes the leading comma, if any, when |
| 7596 that flag comes right after plaintext. This will make a nice display | |
| 7597 when flags are used like in the examples below. | |
| 7 | 7598 |
| 233 | 7599 When all items in a group becomes an empty string (i.e. flags that are |
| 7 | 7600 not set) and a minwid is not set for the group, the whole group will |
| 7601 become empty. This will make a group like the following disappear | |
| 7602 completely from the statusline when none of the flags are set. > | |
| 7603 :set statusline=...%(\ [%M%R%H]%)... | |
|
16740
dc85d49349f7
patch 8.1.1372: when evaluating 'statusline' the current window is unknown
Bram Moolenaar <Bram@vim.org>
parents:
16728
diff
changeset
|
7604 < Beware that an expression is evaluated each and every time the status |
|
dc85d49349f7
patch 8.1.1372: when evaluating 'statusline' the current window is unknown
Bram Moolenaar <Bram@vim.org>
parents:
16728
diff
changeset
|
7605 line is displayed. |
| 18719 | 7606 *stl-%{* *g:actual_curbuf* *g:actual_curwin* |
| 19163 | 7607 While evaluating %{} the current buffer and current window will be set |
| 7608 temporarily to that of the window (and buffer) whose statusline is | |
| 18719 | 7609 currently being drawn. The expression will evaluate in this context. |
| 7610 The variable "g:actual_curbuf" is set to the `bufnr()` number of the | |
| 7611 real current buffer and "g:actual_curwin" to the |window-ID| of the | |
| 7612 real current window. These values are strings. | |
| 634 | 7613 |
| 3682 | 7614 The 'statusline' option will be evaluated in the |sandbox| if set from |
| 7615 a modeline, see |sandbox-option|. | |
|
16728
e55c26aaf484
patch 8.1.1366: using expressions in a modeline is unsafe
Bram Moolenaar <Bram@vim.org>
parents:
16610
diff
changeset
|
7616 This option cannot be set in a modeline when 'modelineexpr' is off. |
| 634 | 7617 |
| 7618 It is not allowed to change text or jump to another window while | |
| 7619 evaluating 'statusline' |textlock|. | |
| 7 | 7620 |
| 7621 If the statusline is not updated when you want it (e.g., after setting | |
| 7622 a variable that's used in an expression), you can force an update by | |
| 7623 setting an option without changing its value. Example: > | |
| 7624 :let &ro = &ro | |
| 7625 | |
| 7626 < A result of all digits is regarded a number for display purposes. | |
| 7627 Otherwise the result is taken as flag text and applied to the rules | |
| 7628 described above. | |
| 7629 | |
| 199 | 7630 Watch out for errors in expressions. They may render Vim unusable! |
| 7 | 7631 If you are stuck, hold down ':' or 'Q' to get a prompt, then quit and |
|
11666
5cd9ba96561d
patch 8.0.0716: not easy to start Vim cleanly
Christian Brabandt <cb@256bit.org>
parents:
11659
diff
changeset
|
7632 edit your .vimrc or whatever with "vim --clean" to get it right. |
| 7 | 7633 |
| 7634 Examples: | |
| 7635 Emulate standard status line with 'ruler' set > | |
| 7636 :set statusline=%<%f\ %h%m%r%=%-14.(%l,%c%V%)\ %P | |
| 7637 < Similar, but add ASCII value of char under the cursor (like "ga") > | |
| 7638 :set statusline=%<%f%h%m%r%=%b\ 0x%B\ \ %l,%c%V\ %P | |
| 7639 < Display byte count and byte value, modified flag in red. > | |
| 7640 :set statusline=%<%f%=\ [%1*%M%*%n%R%H]\ %-19(%3l,%02c%03V%)%O'%02b' | |
| 7641 :hi User1 term=inverse,bold cterm=inverse,bold ctermfg=red | |
| 7642 < Display a ,GZ flag if a compressed file is loaded > | |
| 7643 :set statusline=...%r%{VarExists('b:gzflag','\ [GZ]')}%h... | |
| 7644 < In the |:autocmd|'s: > | |
| 7645 :let b:gzflag = 1 | |
| 7646 < And: > | |
| 7647 :unlet b:gzflag | |
| 7648 < And define this function: > | |
| 7649 :function VarExists(var, val) | |
| 7650 : if exists(a:var) | return a:val | else | return '' | endif | |
| 7651 :endfunction | |
| 7652 < | |
| 7653 *'suffixes'* *'su'* | |
| 7654 'suffixes' 'su' string (default ".bak,~,.o,.h,.info,.swp,.obj") | |
| 7655 global | |
| 7656 Files with these suffixes get a lower priority when multiple files | |
| 7657 match a wildcard. See |suffixes|. Commas can be used to separate the | |
| 10 | 7658 suffixes. Spaces after the comma are ignored. A dot is also seen as |
| 7659 the start of a suffix. To avoid a dot or comma being recognized as a | |
| 7 | 7660 separator, precede it with a backslash (see |option-backslash| about |
| 7661 including spaces and backslashes). | |
| 7662 See 'wildignore' for completely ignoring files. | |
| 7663 The use of |:set+=| and |:set-=| is preferred when adding or removing | |
| 7664 suffixes from the list. This avoids problems when a future version | |
| 7665 uses another default. | |
| 7666 | |
| 7667 *'suffixesadd'* *'sua'* | |
| 7668 'suffixesadd' 'sua' string (default "") | |
| 7669 local to buffer | |
| 7670 {not available when compiled without the | |
| 7671 |+file_in_path| feature} | |
| 7672 Comma separated list of suffixes, which are used when searching for a | |
| 7673 file for the "gf", "[I", etc. commands. Example: > | |
| 7674 :set suffixesadd=.java | |
| 7675 < | |
| 7676 *'swapfile'* *'swf'* *'noswapfile'* *'noswf'* | |
| 7677 'swapfile' 'swf' boolean (default on) | |
| 7678 local to buffer | |
| 10 | 7679 Use a swapfile for the buffer. This option can be reset when a |
| 7 | 7680 swapfile is not wanted for a specific buffer. For example, with |
| 7681 confidential information that even root must not be able to access. | |
| 7682 Careful: All text will be in memory: | |
| 7683 - Don't use this for big files. | |
| 7684 - Recovery will be impossible! | |
| 7685 A swapfile will only be present when |'updatecount'| is non-zero and | |
| 7686 'swapfile' is set. | |
| 7687 When 'swapfile' is reset, the swap file for the current buffer is | |
| 7688 immediately deleted. When 'swapfile' is set, and 'updatecount' is | |
| 7689 non-zero, a swap file is immediately created. | |
| 7690 Also see |swap-file| and |'swapsync'|. | |
| 5763 | 7691 If you want to open a new buffer without creating a swap file for it, |
| 7692 use the |:noswapfile| modifier. | |
|
13341
acd7eaa13d2b
Updated runtime files.
Christian Brabandt <cb@256bit.org>
parents:
13314
diff
changeset
|
7693 See 'directory' for where the swap file is created. |
| 7 | 7694 |
| 7695 This option is used together with 'bufhidden' and 'buftype' to | |
| 7696 specify special kinds of buffers. See |special-buffers|. | |
| 7697 | |
| 7698 *'swapsync'* *'sws'* | |
| 7699 'swapsync' 'sws' string (default "fsync") | |
| 7700 global | |
| 7701 When this option is not empty a swap file is synced to disk after | |
| 10 | 7702 writing to it. This takes some time, especially on busy unix systems. |
| 7 | 7703 When this option is empty parts of the swap file may be in memory and |
| 7704 not written to disk. When the system crashes you may lose more work. | |
| 7705 On Unix the system does a sync now and then without Vim asking for it, | |
| 7706 so the disadvantage of setting this option off is small. On some | |
| 7707 systems the swap file will not be written at all. For a unix system | |
| 7708 setting it to "sync" will use the sync() call instead of the default | |
| 7709 fsync(), which may work better on some systems. | |
| 36 | 7710 The 'fsync' option is used for the actual file. |
| 7 | 7711 |
| 7712 *'switchbuf'* *'swb'* | |
| 7713 'switchbuf' 'swb' string (default "") | |
| 7714 global | |
| 7715 This option controls the behavior when switching between buffers. | |
| 24751 | 7716 Mostly for |quickfix| commands some values are also used for other |
| 7717 commands, as mentioned below. | |
| 7 | 7718 Possible values (comma separated list): |
| 7719 useopen If included, jump to the first open window that | |
| 7720 contains the specified buffer (if there is one). | |
| 7721 Otherwise: Do not examine other windows. | |
| 7722 This setting is checked with |quickfix| commands, when | |
| 7723 jumping to errors (":cc", ":cn", "cp", etc.). It is | |
| 7724 also used in all buffer related split commands, for | |
| 7725 example ":sbuffer", ":sbnext", or ":sbrewind". | |
| 825 | 7726 usetab Like "useopen", but also consider windows in other tab |
| 856 | 7727 pages. |
| 7 | 7728 split If included, split the current window before loading |
| 3153 | 7729 a buffer for a |quickfix| command that display errors. |
| 16086 | 7730 Otherwise: do not split, use current window (when used |
| 7731 in the quickfix window: the previously used window or | |
| 7732 split if there is no other window). | |
| 6843 | 7733 vsplit Just like "split" but split vertically. |
| 1621 | 7734 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
|
7735 "split" when both are present. |
|
18646
394abd397e15
patch 8.1.2315: not always using the right window when jumping to an error
Bram Moolenaar <Bram@vim.org>
parents:
18594
diff
changeset
|
7736 uselast If included, jump to the previously used window when |
|
394abd397e15
patch 8.1.2315: not always using the right window when jumping to an error
Bram Moolenaar <Bram@vim.org>
parents:
18594
diff
changeset
|
7737 jumping to errors with |quickfix| commands. |
| 7 | 7738 |
| 410 | 7739 *'synmaxcol'* *'smc'* |
| 7740 'synmaxcol' 'smc' number (default 3000) | |
| 7741 local to buffer | |
| 7742 {not available when compiled without the |+syntax| | |
| 7743 feature} | |
| 419 | 7744 Maximum column in which to search for syntax items. In long lines the |
| 7745 text after this column is not highlighted and following lines may not | |
| 7746 be highlighted correctly, because the syntax state is cleared. | |
| 410 | 7747 This helps to avoid very slow redrawing for an XML file that is one |
| 7748 long line. | |
| 7749 Set to zero to remove the limit. | |
| 7750 | |
| 7 | 7751 *'syntax'* *'syn'* |
| 7752 'syntax' 'syn' string (default empty) | |
| 7753 local to buffer | |
| 7754 {not available when compiled without the |+syntax| | |
| 7755 feature} | |
| 7756 When this option is set, the syntax with this name is loaded, unless | |
| 7757 syntax highlighting has been switched off with ":syntax off". | |
| 7758 Otherwise this option does not always reflect the current syntax (the | |
| 7759 b:current_syntax variable does). | |
| 7760 This option is most useful in a modeline, for a file which syntax is | |
| 782 | 7761 not automatically recognized. Example, in an IDL file: |
| 7762 /* vim: set syntax=idl : */ ~ | |
| 7763 When a dot appears in the value then this separates two filetype | |
| 7764 names. Example: | |
| 7765 /* vim: set syntax=c.doxygen : */ ~ | |
| 7766 This will use the "c" syntax first, then the "doxygen" syntax. | |
| 7767 Note that the second one must be prepared to be loaded as an addition, | |
| 7768 otherwise it will be skipped. More than one dot may appear. | |
| 7769 To switch off syntax highlighting for the current file, use: > | |
| 7 | 7770 :set syntax=OFF |
| 7771 < To switch syntax highlighting on according to the current value of the | |
| 7772 'filetype' option: > | |
| 7773 :set syntax=ON | |
| 7774 < What actually happens when setting the 'syntax' option is that the | |
| 7775 Syntax autocommand event is triggered with the value as argument. | |
| 7776 This option is not copied to another buffer, independent of the 's' or | |
| 7777 'S' flag in 'cpoptions'. | |
| 36 | 7778 Only normal file name characters can be used, "/\*?[|<>" are illegal. |
| 7 | 7779 |
| 699 | 7780 *'tabline'* *'tal'* |
| 677 | 7781 'tabline' 'tal' string (default empty) |
| 674 | 7782 global |
| 27804 | 7783 When non-empty, this option determines the content of the tab pages |
| 677 | 7784 line at the top of the Vim window. When empty Vim will use a default |
| 681 | 7785 tab pages line. See |setting-tabline| for more info. |
| 677 | 7786 |
| 7787 The tab pages line only appears as specified with the 'showtabline' | |
| 688 | 7788 option and only when there is no GUI tab line. When 'e' is in |
| 7789 '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
|
7790 instead. Note that the two tab pages lines are very different. |
| 677 | 7791 |
| 7792 The value is evaluated like with 'statusline'. You can use | |
| 7793 |tabpagenr()|, |tabpagewinnr()| and |tabpagebuflist()| to figure out | |
| 681 | 7794 the text to be displayed. Use "%1T" for the first label, "%2T" for |
| 7795 the second one, etc. Use "%X" items for closing labels. | |
| 677 | 7796 |
|
15396
325e4a8ba1b6
patch 8.1.0706: tabline is not always redrawn
Bram Moolenaar <Bram@vim.org>
parents:
15281
diff
changeset
|
7797 When changing something that is used in 'tabline' that does not |
|
325e4a8ba1b6
patch 8.1.0706: tabline is not always redrawn
Bram Moolenaar <Bram@vim.org>
parents:
15281
diff
changeset
|
7798 trigger it to be updated, use |:redrawtabline|. |
|
16728
e55c26aaf484
patch 8.1.1366: using expressions in a modeline is unsafe
Bram Moolenaar <Bram@vim.org>
parents:
16610
diff
changeset
|
7799 This option cannot be set in a modeline when 'modelineexpr' is off. |
|
15396
325e4a8ba1b6
patch 8.1.0706: tabline is not always redrawn
Bram Moolenaar <Bram@vim.org>
parents:
15281
diff
changeset
|
7800 |
| 677 | 7801 Keep in mind that only one of the tab pages is the current one, others |
| 7802 are invisible and you can't jump to their windows. | |
| 7803 | |
| 674 | 7804 |
| 699 | 7805 *'tabpagemax'* *'tpm'* |
| 7806 'tabpagemax' 'tpm' number (default 10) | |
| 7807 global | |
| 7808 Maximum number of tab pages to be opened by the |-p| command line | |
| 7809 argument or the ":tab all" command. |tabpage| | |
| 7810 | |
| 7811 | |
| 7812 *'tabstop'* *'ts'* | |
| 7 | 7813 'tabstop' 'ts' number (default 8) |
| 7814 local to buffer | |
| 7815 Number of spaces that a <Tab> in the file counts for. Also see | |
| 27459 | 7816 the |:retab| command, and the 'softtabstop' option. |
| 7 | 7817 |
| 7818 Note: Setting 'tabstop' to any other value than 8 can make your file | |
| 27459 | 7819 appear wrong in many places, e.g., when printing it. |
| 7820 The value must be more than 0 and less than 10000. | |
| 7 | 7821 |
| 7822 There are four main ways to use tabs in Vim: | |
| 7823 1. Always keep 'tabstop' at 8, set 'softtabstop' and 'shiftwidth' to 4 | |
| 7824 (or 3 or whatever you prefer) and use 'noexpandtab'. Then Vim | |
| 1263 | 7825 will use a mix of tabs and spaces, but typing <Tab> and <BS> will |
| 7 | 7826 behave like a tab appears every 4 (or 3) characters. |
| 7827 2. Set 'tabstop' and 'shiftwidth' to whatever you prefer and use | |
| 7828 'expandtab'. This way you will always insert spaces. The | |
| 7829 formatting will never be messed up when 'tabstop' is changed. | |
| 7830 3. Set 'tabstop' and 'shiftwidth' to whatever you prefer and use a | |
| 10 | 7831 |modeline| to set these values when editing the file again. Only |
| 7 | 7832 works when using Vim to edit the file. |
| 7833 4. Always set 'tabstop' and 'shiftwidth' to the same value, and | |
| 7834 'noexpandtab'. This should then work (for initial indents only) | |
| 7835 for any tabstop setting that people use. It might be nice to have | |
| 7836 tabs after the first non-blank inserted as spaces if you do this | |
| 7837 though. Otherwise aligned comments will be wrong when 'tabstop' is | |
| 7838 changed. | |
| 7839 | |
|
14175
2ad722003b36
patch 8.1.0105: all tab stops are the same
Christian Brabandt <cb@256bit.org>
parents:
14019
diff
changeset
|
7840 If Vim is compiled with the |+vartabs| feature then the value of |
|
2ad722003b36
patch 8.1.0105: all tab stops are the same
Christian Brabandt <cb@256bit.org>
parents:
14019
diff
changeset
|
7841 'tabstop' will be ignored if |'vartabstop'| is set to anything other |
|
2ad722003b36
patch 8.1.0105: all tab stops are the same
Christian Brabandt <cb@256bit.org>
parents:
14019
diff
changeset
|
7842 than an empty string. |
|
2ad722003b36
patch 8.1.0105: all tab stops are the same
Christian Brabandt <cb@256bit.org>
parents:
14019
diff
changeset
|
7843 |
| 7 | 7844 *'tagbsearch'* *'tbs'* *'notagbsearch'* *'notbs'* |
| 7845 'tagbsearch' 'tbs' boolean (default on) | |
| 7846 global | |
| 7847 When searching for a tag (e.g., for the |:ta| command), Vim can either | |
| 10 | 7848 use a binary search or a linear search in a tags file. Binary |
| 7 | 7849 searching makes searching for a tag a LOT faster, but a linear search |
| 7850 will find more tags if the tags file wasn't properly sorted. | |
| 7851 Vim normally assumes that your tags files are sorted, or indicate that | |
| 7852 they are not sorted. Only when this is not the case does the | |
| 7853 'tagbsearch' option need to be switched off. | |
| 7854 | |
| 7855 When 'tagbsearch' is on, binary searching is first used in the tags | |
| 10 | 7856 files. In certain situations, Vim will do a linear search instead for |
| 7 | 7857 certain files, or retry all files with a linear search. When |
| 7858 'tagbsearch' is off, only a linear search is done. | |
| 7859 | |
| 7860 Linear searching is done anyway, for one file, when Vim finds a line | |
| 7861 at the start of the file indicating that it's not sorted: > | |
| 1621 | 7862 !_TAG_FILE_SORTED 0 /some comment/ |
| 7 | 7863 < [The whitespace before and after the '0' must be a single <Tab>] |
| 7864 | |
| 7865 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
|
7866 files listed in 'tags', and case is ignored or a pattern is used |
| 7 | 7867 instead of a normal tag name, a retry is done with a linear search. |
| 7868 Tags in unsorted tags files, and matches with different case will only | |
| 7869 be found in the retry. | |
| 7870 | |
| 22 | 7871 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
|
7872 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
|
7873 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
|
7874 sorted with the -f switch to "sort" in most unices, as in the command: |
| 28141 | 7875 "sort -f -o tags tags". For Universal ctags and Exuberant ctags |
| 7876 version 5.x or higher (at least 5.5) the --sort=foldcase switch can be | |
| 7877 used for this as well. Note that case must be folded to uppercase for | |
| 7878 this to work. | |
|
7266
6ba7182fb7bd
commit https://github.com/vim/vim/commit/0f6562e9036f889185dff49a75c7fc5ffb28b307
Christian Brabandt <cb@256bit.org>
parents:
7245
diff
changeset
|
7879 |
|
6ba7182fb7bd
commit https://github.com/vim/vim/commit/0f6562e9036f889185dff49a75c7fc5ffb28b307
Christian Brabandt <cb@256bit.org>
parents:
7245
diff
changeset
|
7880 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
|
7881 '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
|
7882 "ignore". |
|
9913
bb00c661b3a4
commit https://github.com/vim/vim/commit/66e29d7112e437b2b50efe1f82c7e892736d23e4
Christian Brabandt <cb@256bit.org>
parents:
9887
diff
changeset
|
7883 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
|
7884 '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
|
7885 characters. |
| 7 | 7886 |
| 7887 When 'tagbsearch' is off, tags searching is slower when a full match | |
| 7888 exists, but faster when no full match exists. Tags in unsorted tags | |
| 7889 files may only be found with 'tagbsearch' off. | |
| 7890 When the tags file is not sorted, or sorted in a wrong way (not on | |
| 7891 ASCII byte value), 'tagbsearch' should be off, or the line given above | |
| 7892 must be included in the tags file. | |
| 7893 This option doesn't affect commands that find all matching tags (e.g., | |
| 7894 command-line completion and ":help"). | |
| 7895 | |
|
7266
6ba7182fb7bd
commit https://github.com/vim/vim/commit/0f6562e9036f889185dff49a75c7fc5ffb28b307
Christian Brabandt <cb@256bit.org>
parents:
7245
diff
changeset
|
7896 *'tagcase'* *'tc'* |
|
6ba7182fb7bd
commit https://github.com/vim/vim/commit/0f6562e9036f889185dff49a75c7fc5ffb28b307
Christian Brabandt <cb@256bit.org>
parents:
7245
diff
changeset
|
7897 'tagcase' 'tc' string (default "followic") |
|
6ba7182fb7bd
commit https://github.com/vim/vim/commit/0f6562e9036f889185dff49a75c7fc5ffb28b307
Christian Brabandt <cb@256bit.org>
parents:
7245
diff
changeset
|
7898 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
|
7899 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
|
7900 file: |
|
6ba7182fb7bd
commit https://github.com/vim/vim/commit/0f6562e9036f889185dff49a75c7fc5ffb28b307
Christian Brabandt <cb@256bit.org>
parents:
7245
diff
changeset
|
7901 followic Follow the 'ignorecase' option |
|
9913
bb00c661b3a4
commit https://github.com/vim/vim/commit/66e29d7112e437b2b50efe1f82c7e892736d23e4
Christian Brabandt <cb@256bit.org>
parents:
9887
diff
changeset
|
7902 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
|
7903 ignore Ignore case |
|
6ba7182fb7bd
commit https://github.com/vim/vim/commit/0f6562e9036f889185dff49a75c7fc5ffb28b307
Christian Brabandt <cb@256bit.org>
parents:
7245
diff
changeset
|
7904 match Match case |
|
9913
bb00c661b3a4
commit https://github.com/vim/vim/commit/66e29d7112e437b2b50efe1f82c7e892736d23e4
Christian Brabandt <cb@256bit.org>
parents:
9887
diff
changeset
|
7905 smart Ignore case unless an upper case letter is used |
| 11160 | 7906 NOTE: This option is set to the Vi default value when 'compatible' is |
| 7907 set and to the Vim default value when 'compatible' is reset. | |
|
7266
6ba7182fb7bd
commit https://github.com/vim/vim/commit/0f6562e9036f889185dff49a75c7fc5ffb28b307
Christian Brabandt <cb@256bit.org>
parents:
7245
diff
changeset
|
7908 |
|
16447
54ffc82f38a8
patch 8.1.1228: not possible to process tags with a function
Bram Moolenaar <Bram@vim.org>
parents:
16443
diff
changeset
|
7909 *'tagfunc'* *'tfu'* |
|
54ffc82f38a8
patch 8.1.1228: not possible to process tags with a function
Bram Moolenaar <Bram@vim.org>
parents:
16443
diff
changeset
|
7910 'tagfunc' 'tfu' string (default: empty) |
|
54ffc82f38a8
patch 8.1.1228: not possible to process tags with a function
Bram Moolenaar <Bram@vim.org>
parents:
16443
diff
changeset
|
7911 local to buffer |
|
54ffc82f38a8
patch 8.1.1228: not possible to process tags with a function
Bram Moolenaar <Bram@vim.org>
parents:
16443
diff
changeset
|
7912 {not available when compiled without the |+eval| |
|
54ffc82f38a8
patch 8.1.1228: not possible to process tags with a function
Bram Moolenaar <Bram@vim.org>
parents:
16443
diff
changeset
|
7913 feature} |
|
54ffc82f38a8
patch 8.1.1228: not possible to process tags with a function
Bram Moolenaar <Bram@vim.org>
parents:
16443
diff
changeset
|
7914 This option specifies a function to be used to perform tag searches. |
|
54ffc82f38a8
patch 8.1.1228: not possible to process tags with a function
Bram Moolenaar <Bram@vim.org>
parents:
16443
diff
changeset
|
7915 The function gets the tag pattern and should return a List of matching |
|
54ffc82f38a8
patch 8.1.1228: not possible to process tags with a function
Bram Moolenaar <Bram@vim.org>
parents:
16443
diff
changeset
|
7916 tags. See |tag-function| for an explanation of how to write the |
|
26268
3aa48d4e3dc8
patch 8.2.3665: cannot use a lambda for 'tagfunc'
Bram Moolenaar <Bram@vim.org>
parents:
26219
diff
changeset
|
7917 function and an example. The value can be the name of a function, a |
|
3aa48d4e3dc8
patch 8.2.3665: cannot use a lambda for 'tagfunc'
Bram Moolenaar <Bram@vim.org>
parents:
26219
diff
changeset
|
7918 |lambda| or a |Funcref|. See |option-value-function| for more |
|
3aa48d4e3dc8
patch 8.2.3665: cannot use a lambda for 'tagfunc'
Bram Moolenaar <Bram@vim.org>
parents:
26219
diff
changeset
|
7919 information. |
|
16447
54ffc82f38a8
patch 8.1.1228: not possible to process tags with a function
Bram Moolenaar <Bram@vim.org>
parents:
16443
diff
changeset
|
7920 |
| 7 | 7921 *'taglength'* *'tl'* |
| 7922 'taglength' 'tl' number (default 0) | |
| 7923 global | |
| 7924 If non-zero, tags are significant up to this number of characters. | |
| 7925 | |
| 7926 *'tagrelative'* *'tr'* *'notagrelative'* *'notr'* | |
| 7927 'tagrelative' 'tr' boolean (Vim default: on, Vi default: off) | |
| 7928 global | |
| 824 | 7929 If on and using a tags file in another directory, file names in that |
| 7930 tags file are relative to the directory where the tags file is. | |
| 7 | 7931 NOTE: This option is set to the Vi default value when 'compatible' is |
| 7932 set and to the Vim default value when 'compatible' is reset. | |
| 7933 | |
| 7934 *'tags'* *'tag'* *E433* | |
| 7935 'tags' 'tag' string (default "./tags,tags", when compiled with | |
| 7936 |+emacs_tags|: "./tags,./TAGS,tags,TAGS") | |
| 7937 global or local to buffer |global-local| | |
| 7938 Filenames for the tag command, separated by spaces or commas. To | |
| 7939 include a space or comma in a file name, precede it with a backslash | |
| 7940 (see |option-backslash| about including spaces and backslashes). | |
| 7941 When a file name starts with "./", the '.' is replaced with the path | |
| 7942 of the current file. But only when the 'd' flag is not included in | |
| 7943 'cpoptions'. Environment variables are expanded |:set_env|. Also see | |
| 7944 |tags-option|. | |
| 7945 "*", "**" 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
|
7946 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
|
7947 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
|
7948 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
|
7949 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
|
7950 |+path_extra| feature} |
| 515 | 7951 The |tagfiles()| function can be used to get a list of the file names |
| 7952 actually used. | |
| 7 | 7953 If Vim was compiled with the |+emacs_tags| feature, Emacs-style tag |
| 7954 files are also supported. They are automatically recognized. The | |
| 7955 default value becomes "./tags,./TAGS,tags,TAGS", unless case | |
| 7956 differences are ignored (MS-Windows). |emacs-tags| | |
| 7957 The use of |:set+=| and |:set-=| is preferred when adding or removing | |
| 7958 file names from the list. This avoids problems when a future version | |
| 7959 uses another default. | |
| 7960 | |
| 7961 *'tagstack'* *'tgst'* *'notagstack'* *'notgst'* | |
| 7962 'tagstack' 'tgst' boolean (default on) | |
| 7963 global | |
| 7964 When on, the |tagstack| is used normally. When off, a ":tag" or | |
| 7965 ":tselect" command with an argument will not push the tag onto the | |
| 7966 tagstack. A following ":tag" without an argument, a ":pop" command or | |
| 7967 any other command that uses the tagstack will use the unmodified | |
| 7968 tagstack, but does change the pointer to the active entry. | |
| 7969 Resetting this option is useful when using a ":tag" command in a | |
| 7970 mapping which should not change the tagstack. | |
| 7971 | |
|
7538
c9fc24b76293
commit https://github.com/vim/vim/commit/8a5115cf18751022387af2085f374d38c60dde83
Christian Brabandt <cb@256bit.org>
parents:
7528
diff
changeset
|
7972 *'tcldll'* |
|
8629
54ac275e3fc4
commit https://github.com/vim/vim/commit/3848e00e0177abdb31bc600234967863ec487233
Christian Brabandt <cb@256bit.org>
parents:
8560
diff
changeset
|
7973 '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
|
7974 global |
|
c9fc24b76293
commit https://github.com/vim/vim/commit/8a5115cf18751022387af2085f374d38c60dde83
Christian Brabandt <cb@256bit.org>
parents:
7528
diff
changeset
|
7975 {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
|
7976 feature} |
|
c9fc24b76293
commit https://github.com/vim/vim/commit/8a5115cf18751022387af2085f374d38c60dde83
Christian Brabandt <cb@256bit.org>
parents:
7528
diff
changeset
|
7977 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
|
7978 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
|
7979 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
|
7980 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
|
7981 security reasons. |
|
c9fc24b76293
commit https://github.com/vim/vim/commit/8a5115cf18751022387af2085f374d38c60dde83
Christian Brabandt <cb@256bit.org>
parents:
7528
diff
changeset
|
7982 |
| 7 | 7983 *'term'* *E529* *E530* *E531* |
| 7984 'term' string (default is $TERM, if that fails: | |
| 7985 in the GUI: "builtin_gui" | |
| 7986 on Amiga: "amiga" | |
|
19526
22f0dda71638
patch 8.2.0320: no Haiku support
Bram Moolenaar <Bram@vim.org>
parents:
19404
diff
changeset
|
7987 on Haiku: "xterm" |
| 7 | 7988 on Mac: "mac-ansi" |
| 7989 on Unix: "ansi" | |
| 7990 on VMS: "ansi" | |
| 7991 on Win 32: "win32") | |
| 7992 global | |
| 7993 Name of the terminal. Used for choosing the terminal control | |
| 7994 characters. Environment variables are expanded |:set_env|. | |
| 7995 For example: > | |
| 7996 :set term=$TERM | |
| 7997 < See |termcap|. | |
| 7998 | |
| 7999 *'termbidi'* *'tbidi'* | |
| 8000 *'notermbidi'* *'notbidi'* | |
| 8001 'termbidi' 'tbidi' boolean (default off, on for "mlterm") | |
| 8002 global | |
| 8003 {only available when compiled with the |+arabic| | |
| 8004 feature} | |
| 8005 The terminal is in charge of Bi-directionality of text (as specified | |
| 8006 by Unicode). The terminal is also expected to do the required shaping | |
| 8007 that some languages (such as Arabic) require. | |
| 8008 Setting this option implies that 'rightleft' will not be set when | |
| 8009 'arabic' is set and the value of 'arabicshape' will be ignored. | |
| 8010 Note that setting 'termbidi' has the immediate effect that | |
| 8011 'arabicshape' is ignored, but 'rightleft' isn't changed automatically. | |
| 8012 This option is reset when the GUI is started. | |
| 8013 For further details see |arabic.txt|. | |
| 8014 | |
| 8015 *'termencoding'* *'tenc'* | |
| 21825 | 8016 'termencoding' 'tenc' string (default ""; with GTK+ GUI: "utf-8") |
| 7 | 8017 global |
| 8018 Encoding used for the terminal. This specifies what character | |
| 8019 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
|
8020 the GUI it only applies to the keyboard ('encoding' is used for the |
| 21825 | 8021 display). |
|
19027
d72b30bf3a80
patch 8.2.0074: Python 3 unicode test someitmes fails
Bram Moolenaar <Bram@vim.org>
parents:
18972
diff
changeset
|
8022 *E617* *E950* |
|
10895
c391bfbdb452
Updated runtime files.
Christian Brabandt <cb@256bit.org>
parents:
10734
diff
changeset
|
8023 Note: This does not apply to the GTK+ GUI. After the GUI has been |
| 7 | 8024 successfully initialized, 'termencoding' is forcibly set to "utf-8". |
| 8025 Any attempts to set a different value will be rejected, and an error | |
| 8026 message is shown. | |
|
7080
1a34f5272977
commit https://github.com/vim/vim/commit/ac360bf2ca293735fc7c6654dc2b3066f4c62488
Christian Brabandt <cb@256bit.org>
parents:
7051
diff
changeset
|
8027 For the Win32 GUI and console versions 'termencoding' is not used, |
| 7 | 8028 because the Win32 system always passes Unicode characters. |
| 8029 When empty, the same encoding is used as for the 'encoding' option. | |
| 8030 This is the normal value. | |
| 8031 Not all combinations for 'termencoding' and 'encoding' are valid. See | |
| 8032 |encoding-table|. | |
| 8033 The value for this option must be supported by internal conversions or | |
| 8034 iconv(). When this is not possible no conversion will be done and you | |
| 8035 will probably experience problems with non-ASCII characters. | |
| 8036 Example: You are working with the locale set to euc-jp (Japanese) and | |
| 8037 want to edit a UTF-8 file: > | |
| 8038 :let &termencoding = &encoding | |
| 8039 :set encoding=utf-8 | |
| 8040 < You need to do this when your system has no locale support for UTF-8. | |
| 8041 | |
|
13314
65c3e8259124
patch 8.0.1531: cannot use 24 bit colors in MS-Windows console
Christian Brabandt <cb@256bit.org>
parents:
13234
diff
changeset
|
8042 *'termguicolors'* *'tgc'* *E954* |
|
9027
773d627cac0b
commit https://github.com/vim/vim/commit/61be73bb0f965a895bfb064ea3e55476ac175162
Christian Brabandt <cb@256bit.org>
parents:
8969
diff
changeset
|
8043 'termguicolors' 'tgc' boolean (default off) |
|
773d627cac0b
commit https://github.com/vim/vim/commit/61be73bb0f965a895bfb064ea3e55476ac175162
Christian Brabandt <cb@256bit.org>
parents:
8969
diff
changeset
|
8044 global |
|
773d627cac0b
commit https://github.com/vim/vim/commit/61be73bb0f965a895bfb064ea3e55476ac175162
Christian Brabandt <cb@256bit.org>
parents:
8969
diff
changeset
|
8045 {not available when compiled without the |
|
773d627cac0b
commit https://github.com/vim/vim/commit/61be73bb0f965a895bfb064ea3e55476ac175162
Christian Brabandt <cb@256bit.org>
parents:
8969
diff
changeset
|
8046 |+termguicolors| feature} |
|
773d627cac0b
commit https://github.com/vim/vim/commit/61be73bb0f965a895bfb064ea3e55476ac175162
Christian Brabandt <cb@256bit.org>
parents:
8969
diff
changeset
|
8047 When on, uses |highlight-guifg| and |highlight-guibg| attributes in |
|
13314
65c3e8259124
patch 8.0.1531: cannot use 24 bit colors in MS-Windows console
Christian Brabandt <cb@256bit.org>
parents:
13234
diff
changeset
|
8048 the terminal (thus using 24-bit color). |
|
13341
acd7eaa13d2b
Updated runtime files.
Christian Brabandt <cb@256bit.org>
parents:
13314
diff
changeset
|
8049 |
|
13314
65c3e8259124
patch 8.0.1531: cannot use 24 bit colors in MS-Windows console
Christian Brabandt <cb@256bit.org>
parents:
13234
diff
changeset
|
8050 Requires a ISO-8613-3 compatible terminal. If setting this option |
|
65c3e8259124
patch 8.0.1531: cannot use 24 bit colors in MS-Windows console
Christian Brabandt <cb@256bit.org>
parents:
13234
diff
changeset
|
8051 does not work (produces a colorless UI) reading |xterm-true-color| |
|
65c3e8259124
patch 8.0.1531: cannot use 24 bit colors in MS-Windows console
Christian Brabandt <cb@256bit.org>
parents:
13234
diff
changeset
|
8052 might help. |
|
65c3e8259124
patch 8.0.1531: cannot use 24 bit colors in MS-Windows console
Christian Brabandt <cb@256bit.org>
parents:
13234
diff
changeset
|
8053 |
|
65c3e8259124
patch 8.0.1531: cannot use 24 bit colors in MS-Windows console
Christian Brabandt <cb@256bit.org>
parents:
13234
diff
changeset
|
8054 For Win32 console, Windows 10 version 1703 (Creators Update) or later |
|
65c3e8259124
patch 8.0.1531: cannot use 24 bit colors in MS-Windows console
Christian Brabandt <cb@256bit.org>
parents:
13234
diff
changeset
|
8055 is required. Use this check to find out: > |
|
65c3e8259124
patch 8.0.1531: cannot use 24 bit colors in MS-Windows console
Christian Brabandt <cb@256bit.org>
parents:
13234
diff
changeset
|
8056 if has('vcon') |
|
13341
acd7eaa13d2b
Updated runtime files.
Christian Brabandt <cb@256bit.org>
parents:
13314
diff
changeset
|
8057 < This requires Vim to be built with the |+vtp| feature. |
|
acd7eaa13d2b
Updated runtime files.
Christian Brabandt <cb@256bit.org>
parents:
13314
diff
changeset
|
8058 |
| 11473 | 8059 Note that the "cterm" attributes are still used, not the "gui" ones. |
| 11160 | 8060 NOTE: This option is reset when 'compatible' is set. |
|
9027
773d627cac0b
commit https://github.com/vim/vim/commit/61be73bb0f965a895bfb064ea3e55476ac175162
Christian Brabandt <cb@256bit.org>
parents:
8969
diff
changeset
|
8061 |
| 13735 | 8062 *'termwinkey'* *'twk'* |
| 8063 'termwinkey' 'twk' string (default "") | |
|
11659
49c12c93abf3
Updated runtime files and translations.
Christian Brabandt <cb@256bit.org>
parents:
11529
diff
changeset
|
8064 local to window |
| 11914 | 8065 The key that starts a CTRL-W command in a terminal window. Other keys |
|
11659
49c12c93abf3
Updated runtime files and translations.
Christian Brabandt <cb@256bit.org>
parents:
11529
diff
changeset
|
8066 are sent to the job running in the window. |
| 11914 | 8067 The <> notation can be used, e.g.: > |
| 13735 | 8068 :set termwinkey=<C-L> |
| 11914 | 8069 < The string must be one key stroke but can be multiple bytes. |
| 8070 When not set CTRL-W is used, so that CTRL-W : gets you to the command | |
| 13735 | 8071 line. If 'termwinkey' is set to CTRL-L then CTRL-L : gets you to the |
| 11914 | 8072 command line. |
|
11659
49c12c93abf3
Updated runtime files and translations.
Christian Brabandt <cb@256bit.org>
parents:
11529
diff
changeset
|
8073 |
|
16443
32a543152dc0
patch 8.1.1226: {not in Vi} remarks get in the way of useful help text
Bram Moolenaar <Bram@vim.org>
parents:
16439
diff
changeset
|
8074 *'termwinscroll'* *'twsl'* |
|
32a543152dc0
patch 8.1.1226: {not in Vi} remarks get in the way of useful help text
Bram Moolenaar <Bram@vim.org>
parents:
16439
diff
changeset
|
8075 'termwinscroll' 'twsl' number (default 10000) |
|
32a543152dc0
patch 8.1.1226: {not in Vi} remarks get in the way of useful help text
Bram Moolenaar <Bram@vim.org>
parents:
16439
diff
changeset
|
8076 local to buffer |
|
32a543152dc0
patch 8.1.1226: {not in Vi} remarks get in the way of useful help text
Bram Moolenaar <Bram@vim.org>
parents:
16439
diff
changeset
|
8077 {not available when compiled without the |
|
32a543152dc0
patch 8.1.1226: {not in Vi} remarks get in the way of useful help text
Bram Moolenaar <Bram@vim.org>
parents:
16439
diff
changeset
|
8078 |+terminal| feature} |
|
32a543152dc0
patch 8.1.1226: {not in Vi} remarks get in the way of useful help text
Bram Moolenaar <Bram@vim.org>
parents:
16439
diff
changeset
|
8079 Number of scrollback lines to keep. When going over this limit the |
|
32a543152dc0
patch 8.1.1226: {not in Vi} remarks get in the way of useful help text
Bram Moolenaar <Bram@vim.org>
parents:
16439
diff
changeset
|
8080 first 10% of the scrollback lines are deleted. This is just to reduce |
|
32a543152dc0
patch 8.1.1226: {not in Vi} remarks get in the way of useful help text
Bram Moolenaar <Bram@vim.org>
parents:
16439
diff
changeset
|
8081 the memory usage. See |Terminal-Normal|. |
|
26129
ddfb2b8aed67
patch 8.2.3597: Vim seems to hang when writing a long text to a terminal
Bram Moolenaar <Bram@vim.org>
parents:
26100
diff
changeset
|
8082 Also used as a limit for text sent to the terminal in one write, |
|
ddfb2b8aed67
patch 8.2.3597: Vim seems to hang when writing a long text to a terminal
Bram Moolenaar <Bram@vim.org>
parents:
26100
diff
changeset
|
8083 multiplied by the number of columns times 3 (average number of bytes |
|
ddfb2b8aed67
patch 8.2.3597: Vim seems to hang when writing a long text to a terminal
Bram Moolenaar <Bram@vim.org>
parents:
26100
diff
changeset
|
8084 per cell). |
|
16443
32a543152dc0
patch 8.1.1226: {not in Vi} remarks get in the way of useful help text
Bram Moolenaar <Bram@vim.org>
parents:
16439
diff
changeset
|
8085 |
| 13735 | 8086 *'termwinsize'* *'tws'* |
| 8087 'termwinsize' 'tws' string (default "") | |
|
11659
49c12c93abf3
Updated runtime files and translations.
Christian Brabandt <cb@256bit.org>
parents:
11529
diff
changeset
|
8088 local to window |
| 22171 | 8089 Size used when opening the |terminal| window. Format: |
| 8090 {rows}x{columns} or {rows}*{columns}. | |
|
11659
49c12c93abf3
Updated runtime files and translations.
Christian Brabandt <cb@256bit.org>
parents:
11529
diff
changeset
|
8091 - When empty the terminal gets the size from the window. |
|
13700
b28d679b1843
patch 8.0.1722: cannot specify a minimal size for a terminal window
Christian Brabandt <cb@256bit.org>
parents:
13680
diff
changeset
|
8092 - When set with a "x" (e.g., "24x80") the terminal size is not |
|
b28d679b1843
patch 8.0.1722: cannot specify a minimal size for a terminal window
Christian Brabandt <cb@256bit.org>
parents:
13680
diff
changeset
|
8093 adjusted to the window size. If the window is smaller only the |
|
b28d679b1843
patch 8.0.1722: cannot specify a minimal size for a terminal window
Christian Brabandt <cb@256bit.org>
parents:
13680
diff
changeset
|
8094 top-left part is displayed. |
|
b28d679b1843
patch 8.0.1722: cannot specify a minimal size for a terminal window
Christian Brabandt <cb@256bit.org>
parents:
13680
diff
changeset
|
8095 - When set with a "*" (e.g., "10*50") the terminal size follows the |
|
b28d679b1843
patch 8.0.1722: cannot specify a minimal size for a terminal window
Christian Brabandt <cb@256bit.org>
parents:
13680
diff
changeset
|
8096 window size, but will not be smaller than the specified rows and/or |
|
b28d679b1843
patch 8.0.1722: cannot specify a minimal size for a terminal window
Christian Brabandt <cb@256bit.org>
parents:
13680
diff
changeset
|
8097 columns. |
|
b28d679b1843
patch 8.0.1722: cannot specify a minimal size for a terminal window
Christian Brabandt <cb@256bit.org>
parents:
13680
diff
changeset
|
8098 - When rows is zero then use the height of the window. |
|
b28d679b1843
patch 8.0.1722: cannot specify a minimal size for a terminal window
Christian Brabandt <cb@256bit.org>
parents:
13680
diff
changeset
|
8099 - When columns is zero then use the width of the window. |
|
b28d679b1843
patch 8.0.1722: cannot specify a minimal size for a terminal window
Christian Brabandt <cb@256bit.org>
parents:
13680
diff
changeset
|
8100 - Using "0x0" or "0*0" is the same as empty. |
| 22171 | 8101 - Can be overruled in the |term_start()| options with "term_rows" and |
| 8102 "term_cols". | |
|
13700
b28d679b1843
patch 8.0.1722: cannot specify a minimal size for a terminal window
Christian Brabandt <cb@256bit.org>
parents:
13680
diff
changeset
|
8103 |
|
b28d679b1843
patch 8.0.1722: cannot specify a minimal size for a terminal window
Christian Brabandt <cb@256bit.org>
parents:
13680
diff
changeset
|
8104 Examples: |
|
b28d679b1843
patch 8.0.1722: cannot specify a minimal size for a terminal window
Christian Brabandt <cb@256bit.org>
parents:
13680
diff
changeset
|
8105 "30x0" uses 30 rows and the current window width. |
|
b28d679b1843
patch 8.0.1722: cannot specify a minimal size for a terminal window
Christian Brabandt <cb@256bit.org>
parents:
13680
diff
changeset
|
8106 "20*0" uses at least 20 rows and the current window width. |
|
b28d679b1843
patch 8.0.1722: cannot specify a minimal size for a terminal window
Christian Brabandt <cb@256bit.org>
parents:
13680
diff
changeset
|
8107 "0*40" uses the current window height and at least 40 columns. |
|
11757
74abb6c84984
patch 8.0.0761: options not set properly for a terminal buffer
Christian Brabandt <cb@256bit.org>
parents:
11666
diff
changeset
|
8108 Note that the command running in the terminal window may still change |
|
74abb6c84984
patch 8.0.0761: options not set properly for a terminal buffer
Christian Brabandt <cb@256bit.org>
parents:
11666
diff
changeset
|
8109 the size of the terminal. In that case the Vim window will be |
|
74abb6c84984
patch 8.0.0761: options not set properly for a terminal buffer
Christian Brabandt <cb@256bit.org>
parents:
11666
diff
changeset
|
8110 adjusted to that size, if possible. |
|
11659
49c12c93abf3
Updated runtime files and translations.
Christian Brabandt <cb@256bit.org>
parents:
11529
diff
changeset
|
8111 |
|
15746
c017195b121b
patch 8.1.0880: MS-Windows: inconsistent selection of winpty/conpty
Bram Moolenaar <Bram@vim.org>
parents:
15729
diff
changeset
|
8112 *'termwintype'* *'twt'* |
|
c017195b121b
patch 8.1.0880: MS-Windows: inconsistent selection of winpty/conpty
Bram Moolenaar <Bram@vim.org>
parents:
15729
diff
changeset
|
8113 'termwintype' 'twt' string (default "") |
|
c017195b121b
patch 8.1.0880: MS-Windows: inconsistent selection of winpty/conpty
Bram Moolenaar <Bram@vim.org>
parents:
15729
diff
changeset
|
8114 global |
|
c017195b121b
patch 8.1.0880: MS-Windows: inconsistent selection of winpty/conpty
Bram Moolenaar <Bram@vim.org>
parents:
15729
diff
changeset
|
8115 {only available when compiled with the |terminal| |
|
c017195b121b
patch 8.1.0880: MS-Windows: inconsistent selection of winpty/conpty
Bram Moolenaar <Bram@vim.org>
parents:
15729
diff
changeset
|
8116 feature on MS-Windows} |
|
c017195b121b
patch 8.1.0880: MS-Windows: inconsistent selection of winpty/conpty
Bram Moolenaar <Bram@vim.org>
parents:
15729
diff
changeset
|
8117 Specify the virtual console (pty) used when opening the terminal |
|
c017195b121b
patch 8.1.0880: MS-Windows: inconsistent selection of winpty/conpty
Bram Moolenaar <Bram@vim.org>
parents:
15729
diff
changeset
|
8118 window. |
|
c017195b121b
patch 8.1.0880: MS-Windows: inconsistent selection of winpty/conpty
Bram Moolenaar <Bram@vim.org>
parents:
15729
diff
changeset
|
8119 |
|
c017195b121b
patch 8.1.0880: MS-Windows: inconsistent selection of winpty/conpty
Bram Moolenaar <Bram@vim.org>
parents:
15729
diff
changeset
|
8120 Possible values are: |
|
15804
864ec0dd71b9
patch 8.1.0909: MS-Windows: using ConPTY even though it is not stable
Bram Moolenaar <Bram@vim.org>
parents:
15746
diff
changeset
|
8121 "" use ConPTY if it is stable, winpty otherwise |
|
15746
c017195b121b
patch 8.1.0880: MS-Windows: inconsistent selection of winpty/conpty
Bram Moolenaar <Bram@vim.org>
parents:
15729
diff
changeset
|
8122 "winpty" use winpty, fail if not supported |
|
c017195b121b
patch 8.1.0880: MS-Windows: inconsistent selection of winpty/conpty
Bram Moolenaar <Bram@vim.org>
parents:
15729
diff
changeset
|
8123 "conpty" use |ConPTY|, fail if not supported |
|
c017195b121b
patch 8.1.0880: MS-Windows: inconsistent selection of winpty/conpty
Bram Moolenaar <Bram@vim.org>
parents:
15729
diff
changeset
|
8124 |
|
15804
864ec0dd71b9
patch 8.1.0909: MS-Windows: using ConPTY even though it is not stable
Bram Moolenaar <Bram@vim.org>
parents:
15746
diff
changeset
|
8125 |ConPTY| support depends on the platform. Windows 10 October 2018 |
|
864ec0dd71b9
patch 8.1.0909: MS-Windows: using ConPTY even though it is not stable
Bram Moolenaar <Bram@vim.org>
parents:
15746
diff
changeset
|
8126 Update is the first version that supports ConPTY, however it is still |
|
864ec0dd71b9
patch 8.1.0909: MS-Windows: using ConPTY even though it is not stable
Bram Moolenaar <Bram@vim.org>
parents:
15746
diff
changeset
|
8127 considered unstable. ConPTY might become stable in the next release |
|
864ec0dd71b9
patch 8.1.0909: MS-Windows: using ConPTY even though it is not stable
Bram Moolenaar <Bram@vim.org>
parents:
15746
diff
changeset
|
8128 of Windows 10. winpty support needs to be installed. If neither is |
|
15746
c017195b121b
patch 8.1.0880: MS-Windows: inconsistent selection of winpty/conpty
Bram Moolenaar <Bram@vim.org>
parents:
15729
diff
changeset
|
8129 supported then you cannot open a terminal window. |
|
c017195b121b
patch 8.1.0880: MS-Windows: inconsistent selection of winpty/conpty
Bram Moolenaar <Bram@vim.org>
parents:
15729
diff
changeset
|
8130 |
| 7 | 8131 *'terse'* *'noterse'* |
| 8132 'terse' boolean (default off) | |
| 8133 global | |
| 8134 When set: Add 's' flag to 'shortmess' option (this makes the message | |
| 8135 for a search that hits the start or end of the file not being | |
| 8136 displayed). When reset: Remove 's' flag from 'shortmess' option. {Vi | |
| 8137 shortens a lot of messages} | |
| 8138 | |
| 8139 *'textauto'* *'ta'* *'notextauto'* *'nota'* | |
| 8140 'textauto' 'ta' boolean (Vim default: on, Vi default: off) | |
| 8141 global | |
| 8142 This option is obsolete. Use 'fileformats'. | |
| 8143 For backwards compatibility, when 'textauto' is set, 'fileformats' is | |
| 8144 set to the default value for the current system. When 'textauto' is | |
| 8145 reset, 'fileformats' is made empty. | |
| 8146 NOTE: This option is set to the Vi default value when 'compatible' is | |
| 8147 set and to the Vim default value when 'compatible' is reset. | |
| 8148 | |
| 8149 *'textmode'* *'tx'* *'notextmode'* *'notx'* | |
|
18912
ccd16426a1f9
patch 8.2.0017: OS/2 and MS-DOS are still mentioned
Bram Moolenaar <Bram@vim.org>
parents:
18879
diff
changeset
|
8150 'textmode' 'tx' boolean (Win32: default on, |
| 7 | 8151 others: default off) |
| 8152 local to buffer | |
| 8153 This option is obsolete. Use 'fileformat'. | |
| 8154 For backwards compatibility, when 'textmode' is set, 'fileformat' is | |
| 8155 set to "dos". When 'textmode' is reset, 'fileformat' is set to | |
| 8156 "unix". | |
| 8157 | |
| 8158 *'textwidth'* *'tw'* | |
| 8159 'textwidth' 'tw' number (default 0) | |
| 8160 local to buffer | |
| 8161 Maximum width of text that is being inserted. A longer line will be | |
| 8162 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
|
8163 this. |
|
c590de398af9
commit https://github.com/vim/vim/commit/ca63501fbcd1cf9c8aa9ff12c093c95b62a89ed7
Christian Brabandt <cb@256bit.org>
parents:
7080
diff
changeset
|
8164 '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
|
8165 when 'paste' is reset. |
|
c590de398af9
commit https://github.com/vim/vim/commit/ca63501fbcd1cf9c8aa9ff12c093c95b62a89ed7
Christian Brabandt <cb@256bit.org>
parents:
7080
diff
changeset
|
8166 When 'textwidth' is zero, 'wrapmargin' may be used. See also |
| 7 | 8167 'formatoptions' and |ins-textwidth|. |
| 838 | 8168 When 'formatexpr' is set it will be used to break the line. |
| 7 | 8169 NOTE: This option is set to 0 when 'compatible' is set. |
| 8170 | |
| 8171 *'thesaurus'* *'tsr'* | |
| 8172 'thesaurus' 'tsr' string (default "") | |
| 8173 global or local to buffer |global-local| | |
| 8174 List of file names, separated by commas, that are used to lookup words | |
|
25990
ac330e2fecc4
patch 8.2.3528: 'thesaurus' and 'thesaurusfunc' do not have the same scope
Bram Moolenaar <Bram@vim.org>
parents:
25982
diff
changeset
|
8175 for thesaurus completion commands |i_CTRL-X_CTRL-T|. See |
|
ac330e2fecc4
patch 8.2.3528: 'thesaurus' and 'thesaurusfunc' do not have the same scope
Bram Moolenaar <Bram@vim.org>
parents:
25982
diff
changeset
|
8176 |compl-thesaurus|. |
|
ac330e2fecc4
patch 8.2.3528: 'thesaurus' and 'thesaurusfunc' do not have the same scope
Bram Moolenaar <Bram@vim.org>
parents:
25982
diff
changeset
|
8177 |
|
ac330e2fecc4
patch 8.2.3528: 'thesaurus' and 'thesaurusfunc' do not have the same scope
Bram Moolenaar <Bram@vim.org>
parents:
25982
diff
changeset
|
8178 This option is not used if 'thesaurusfunc' is set, either for the |
|
ac330e2fecc4
patch 8.2.3528: 'thesaurus' and 'thesaurusfunc' do not have the same scope
Bram Moolenaar <Bram@vim.org>
parents:
25982
diff
changeset
|
8179 buffer or globally. |
| 15033 | 8180 |
| 10 | 8181 To include a comma in a file name precede it with a backslash. Spaces |
| 7 | 8182 after a comma are ignored, otherwise spaces are included in the file |
|
25990
ac330e2fecc4
patch 8.2.3528: 'thesaurus' and 'thesaurusfunc' do not have the same scope
Bram Moolenaar <Bram@vim.org>
parents:
25982
diff
changeset
|
8183 name. See |option-backslash| about using backslashes. The use of |
|
ac330e2fecc4
patch 8.2.3528: 'thesaurus' and 'thesaurusfunc' do not have the same scope
Bram Moolenaar <Bram@vim.org>
parents:
25982
diff
changeset
|
8184 |:set+=| and |:set-=| is preferred when adding or removing directories |
|
ac330e2fecc4
patch 8.2.3528: 'thesaurus' and 'thesaurusfunc' do not have the same scope
Bram Moolenaar <Bram@vim.org>
parents:
25982
diff
changeset
|
8185 from the list. This avoids problems when a future version uses |
|
ac330e2fecc4
patch 8.2.3528: 'thesaurus' and 'thesaurusfunc' do not have the same scope
Bram Moolenaar <Bram@vim.org>
parents:
25982
diff
changeset
|
8186 another default. Backticks cannot be used in this option for security |
|
ac330e2fecc4
patch 8.2.3528: 'thesaurus' and 'thesaurusfunc' do not have the same scope
Bram Moolenaar <Bram@vim.org>
parents:
25982
diff
changeset
|
8187 reasons. |
| 7 | 8188 |
| 27036 | 8189 *'thesaurusfunc'* *'tsrfu'* |
|
25974
416237f1de22
patch 8.2.3520: cannot define a function for thesaurus completion
Bram Moolenaar <Bram@vim.org>
parents:
25973
diff
changeset
|
8190 'thesaurusfunc' 'tsrfu' string (default: empty) |
|
25990
ac330e2fecc4
patch 8.2.3528: 'thesaurus' and 'thesaurusfunc' do not have the same scope
Bram Moolenaar <Bram@vim.org>
parents:
25982
diff
changeset
|
8191 global or local to buffer |global-local| |
|
25974
416237f1de22
patch 8.2.3520: cannot define a function for thesaurus completion
Bram Moolenaar <Bram@vim.org>
parents:
25973
diff
changeset
|
8192 {not available when compiled without the |+eval| |
|
416237f1de22
patch 8.2.3520: cannot define a function for thesaurus completion
Bram Moolenaar <Bram@vim.org>
parents:
25973
diff
changeset
|
8193 feature} |
|
416237f1de22
patch 8.2.3520: cannot define a function for thesaurus completion
Bram Moolenaar <Bram@vim.org>
parents:
25973
diff
changeset
|
8194 This option specifies a function to be used for thesaurus completion |
|
25990
ac330e2fecc4
patch 8.2.3528: 'thesaurus' and 'thesaurusfunc' do not have the same scope
Bram Moolenaar <Bram@vim.org>
parents:
25982
diff
changeset
|
8195 with CTRL-X CTRL-T. |i_CTRL-X_CTRL-T| See |compl-thesaurusfunc|. |
|
26388
8aba638e91eb
patch 8.2.3725: cannot use a lambda for 'completefunc' and 'omnifunc'
Bram Moolenaar <Bram@vim.org>
parents:
26362
diff
changeset
|
8196 The value can be the name of a function, a |lambda| or a |Funcref|. |
|
8aba638e91eb
patch 8.2.3725: cannot use a lambda for 'completefunc' and 'omnifunc'
Bram Moolenaar <Bram@vim.org>
parents:
26362
diff
changeset
|
8197 See |option-value-function| for more information. |
|
25990
ac330e2fecc4
patch 8.2.3528: 'thesaurus' and 'thesaurusfunc' do not have the same scope
Bram Moolenaar <Bram@vim.org>
parents:
25982
diff
changeset
|
8198 |
|
25974
416237f1de22
patch 8.2.3520: cannot define a function for thesaurus completion
Bram Moolenaar <Bram@vim.org>
parents:
25973
diff
changeset
|
8199 This option cannot be set from a |modeline| or in the |sandbox|, for |
|
416237f1de22
patch 8.2.3520: cannot define a function for thesaurus completion
Bram Moolenaar <Bram@vim.org>
parents:
25973
diff
changeset
|
8200 security reasons. |
|
416237f1de22
patch 8.2.3520: cannot define a function for thesaurus completion
Bram Moolenaar <Bram@vim.org>
parents:
25973
diff
changeset
|
8201 |
| 7 | 8202 *'tildeop'* *'top'* *'notildeop'* *'notop'* |
| 8203 'tildeop' 'top' boolean (default off) | |
| 8204 global | |
| 8205 When on: The tilde command "~" behaves like an operator. | |
| 8206 NOTE: This option is reset when 'compatible' is set. | |
| 8207 | |
| 8208 *'timeout'* *'to'* *'notimeout'* *'noto'* | |
| 8209 'timeout' 'to' boolean (default on) | |
| 8210 global | |
| 8211 *'ttimeout'* *'nottimeout'* | |
|
11400
0f8713fe20dc
Updated runtime files.
Christian Brabandt <cb@256bit.org>
parents:
11262
diff
changeset
|
8212 'ttimeout' boolean (default off, set in |defaults.vim|) |
| 7 | 8213 global |
| 8214 These two options together determine the behavior when part of a | |
| 8215 mapped key sequence or keyboard code has been received: | |
| 8216 | |
| 8217 'timeout' 'ttimeout' action ~ | |
| 8218 off off do not time out | |
| 8219 on on or off time out on :mappings and key codes | |
| 8220 off on time out on key codes | |
| 8221 | |
| 8222 If both options are off, Vim will wait until either the complete | |
| 8223 mapping or key sequence has been received, or it is clear that there | |
| 8224 is no mapping or key sequence for the received characters. For | |
| 8225 example: if you have mapped "vl" and Vim has received 'v', the next | |
| 8226 character is needed to see if the 'v' is followed by an 'l'. | |
| 8227 When one of the options is on, Vim will wait for about 1 second for | |
| 8228 the next character to arrive. After that the already received | |
| 8229 characters are interpreted as single characters. The waiting time can | |
| 8230 be changed with the 'timeoutlen' option. | |
| 8231 On slow terminals or very busy systems timing out may cause | |
| 8232 malfunctioning cursor keys. If both options are off, Vim waits | |
| 8233 forever after an entered <Esc> if there are key codes that start | |
| 8234 with <Esc>. You will have to type <Esc> twice. If you do not have | |
| 8235 problems with key codes, but would like to have :mapped key | |
| 8236 sequences not timing out in 1 second, set the 'ttimeout' option and | |
| 8237 reset the 'timeout' option. | |
| 8238 | |
| 8239 NOTE: 'ttimeout' is reset when 'compatible' is set. | |
| 8240 | |
| 8241 *'timeoutlen'* *'tm'* | |
| 8242 'timeoutlen' 'tm' number (default 1000) | |
| 8243 global | |
|
16553
0e473e9e70c2
patch 8.1.1280: remarks about functionality not in Vi clutters the help
Bram Moolenaar <Bram@vim.org>
parents:
16533
diff
changeset
|
8244 |
| 7 | 8245 *'ttimeoutlen'* *'ttm'* |
|
11400
0f8713fe20dc
Updated runtime files.
Christian Brabandt <cb@256bit.org>
parents:
11262
diff
changeset
|
8246 'ttimeoutlen' 'ttm' number (default -1, set to 100 in |defaults.vim|) |
| 7 | 8247 global |
| 8248 The time in milliseconds that is waited for a key code or mapped key | |
| 8249 sequence to complete. Also used for CTRL-\ CTRL-N and CTRL-\ CTRL-G | |
| 8250 when part of a command has been typed. | |
| 8251 Normally only 'timeoutlen' is used and 'ttimeoutlen' is -1. When a | |
| 8252 different timeout value for key codes is desired set 'ttimeoutlen' to | |
| 8253 a non-negative number. | |
| 8254 | |
| 8255 ttimeoutlen mapping delay key code delay ~ | |
| 8256 < 0 'timeoutlen' 'timeoutlen' | |
| 8257 >= 0 'timeoutlen' 'ttimeoutlen' | |
| 8258 | |
| 8259 The timeout only happens when the 'timeout' and 'ttimeout' options | |
| 8260 tell so. A useful setting would be > | |
| 8261 :set timeout timeoutlen=3000 ttimeoutlen=100 | |
| 8262 < (time out on mapping after three seconds, time out on key codes after | |
| 8263 a tenth of a second). | |
| 8264 | |
| 8265 *'title'* *'notitle'* | |
| 8266 'title' boolean (default off, on when title can be restored) | |
| 8267 global | |
| 8268 When on, the title of the window will be set to the value of | |
| 8269 'titlestring' (if it is not empty), or to: | |
| 8270 filename [+=-] (path) - VIM | |
| 8271 Where: | |
| 8272 filename the name of the file being edited | |
| 8273 - indicates the file cannot be modified, 'ma' off | |
| 8274 + indicates the file was modified | |
| 8275 = indicates the file is read-only | |
| 8276 =+ indicates the file is read-only and modified | |
| 8277 (path) is the path of the file being edited | |
| 8278 - VIM the server name |v:servername| or "VIM" | |
| 8279 Only works if the terminal supports setting window titles | |
| 8280 (currently Amiga console, Win32 console, all GUI versions and | |
| 19968 | 8281 terminals with a non-empty 't_ts' option - these are Unix xterm and |
| 7 | 8282 iris-ansi by default, where 't_ts' is taken from the builtin termcap). |
| 8283 *X11* | |
| 8284 When Vim was compiled with HAVE_X11 defined, the original title will | |
| 8285 be restored if possible. The output of ":version" will include "+X11" | |
| 8286 when HAVE_X11 was defined, otherwise it will be "-X11". This also | |
| 8287 works for the icon name |'icon'|. | |
| 8288 But: When Vim was started with the |-X| argument, restoring the title | |
| 8289 will not work (except in the GUI). | |
| 8290 If the title cannot be restored, it is set to the value of 'titleold'. | |
| 8291 You might want to restore the title outside of Vim then. | |
| 8292 When using an xterm from a remote machine you can use this command: | |
| 8293 rsh machine_name xterm -display $DISPLAY & | |
| 8294 then the WINDOWID environment variable should be inherited and the | |
| 8295 title of the window should change back to what it should be after | |
| 8296 exiting Vim. | |
| 8297 | |
| 8298 *'titlelen'* | |
| 8299 'titlelen' number (default 85) | |
| 8300 global | |
| 8301 Gives the percentage of 'columns' to use for the length of the window | |
| 10 | 8302 title. When the title is longer, only the end of the path name is |
| 8303 shown. A '<' character before the path name is used to indicate this. | |
| 7 | 8304 Using a percentage makes this adapt to the width of the window. But |
| 8305 it won't work perfectly, because the actual number of characters | |
| 8306 available also depends on the font used and other things in the title | |
| 8307 bar. When 'titlelen' is zero the full path is used. Otherwise, | |
| 8308 values from 1 to 30000 percent can be used. | |
| 8309 'titlelen' is also used for the 'titlestring' option. | |
| 8310 | |
| 8311 *'titleold'* | |
| 8312 'titleold' string (default "Thanks for flying Vim") | |
| 8313 global | |
| 8314 This option will be used for the window title when exiting Vim if the | |
| 8315 original title cannot be restored. Only happens if 'title' is on or | |
| 8316 'titlestring' is not empty. | |
| 36 | 8317 This option cannot be set from a |modeline| or in the |sandbox|, for |
| 8318 security reasons. | |
| 7 | 8319 *'titlestring'* |
| 8320 'titlestring' string (default "") | |
| 8321 global | |
| 8322 When this option is not empty, it will be used for the title of the | |
| 8323 window. This happens only when the 'title' option is on. | |
| 8324 Only works if the terminal supports setting window titles (currently | |
| 8325 Amiga console, Win32 console, all GUI versions and terminals with a | |
| 8326 non-empty 't_ts' option). | |
| 8327 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
|
8328 be restored if possible, see |X11|. |
|
16728
e55c26aaf484
patch 8.1.1366: using expressions in a modeline is unsafe
Bram Moolenaar <Bram@vim.org>
parents:
16610
diff
changeset
|
8329 |
| 7 | 8330 When this option contains printf-style '%' items, they will be |
| 8331 expanded according to the rules used for 'statusline'. | |
|
16728
e55c26aaf484
patch 8.1.1366: using expressions in a modeline is unsafe
Bram Moolenaar <Bram@vim.org>
parents:
16610
diff
changeset
|
8332 This option cannot be set in a modeline when 'modelineexpr' is off. |
|
e55c26aaf484
patch 8.1.1366: using expressions in a modeline is unsafe
Bram Moolenaar <Bram@vim.org>
parents:
16610
diff
changeset
|
8333 |
| 7 | 8334 Example: > |
| 27903 | 8335 :auto BufEnter * let &titlestring = hostname() .. "/" .. expand("%:p") |
| 7 | 8336 :set title titlestring=%<%F%=%l/%L-%P titlelen=70 |
| 8337 < The value of 'titlelen' is used to align items in the middle or right | |
| 8338 of the available space. | |
| 8339 Some people prefer to have the file name first: > | |
| 8340 :set titlestring=%t%(\ %M%)%(\ (%{expand(\"%:~:.:h\")})%)%(\ %a%) | |
| 8341 < Note the use of "%{ }" and an expression to get the path of the file, | |
| 10 | 8342 without the file name. The "%( %)" constructs are used to add a |
| 7 | 8343 separating space only when needed. |
| 8344 NOTE: Use of special characters in 'titlestring' may cause the display | |
| 8345 to be garbled (e.g., when it contains a CR or NL character). | |
| 8346 {not available when compiled without the |+statusline| feature} | |
| 8347 | |
| 8348 *'toolbar'* *'tb'* | |
| 8349 'toolbar' 'tb' string (default "icons,tooltips") | |
| 8350 global | |
| 8351 {only for |+GUI_GTK|, |+GUI_Athena|, |+GUI_Motif| and | |
| 8352 |+GUI_Photon|} | |
| 10 | 8353 The contents of this option controls various toolbar settings. The |
| 7 | 8354 possible values are: |
| 8355 icons Toolbar buttons are shown with icons. | |
| 8356 text Toolbar buttons shown with text. | |
| 8357 horiz Icon and text of a toolbar button are | |
| 10 | 8358 horizontally arranged. {only in GTK+ 2 GUI} |
| 7 | 8359 tooltips Tooltips are active for toolbar buttons. |
| 8360 Tooltips refer to the popup help text which appears after the mouse | |
| 8361 cursor is placed over a toolbar button for a brief moment. | |
| 8362 | |
| 8363 If you want the toolbar to be shown with icons as well as text, do the | |
| 8364 following: > | |
| 8365 :set tb=icons,text | |
| 8366 < Motif and Athena cannot display icons and text at the same time. They | |
| 8367 will show icons if both are requested. | |
| 8368 | |
| 8369 If none of the strings specified in 'toolbar' are valid or if | |
| 8370 'toolbar' is empty, this option is ignored. If you want to disable | |
| 8371 the toolbar, you need to set the 'guioptions' option. For example: > | |
| 8372 :set guioptions-=T | |
| 8373 < Also see |gui-toolbar|. | |
| 8374 | |
| 8375 *'toolbariconsize'* *'tbis'* | |
| 8376 'toolbariconsize' 'tbis' string (default "small") | |
| 8377 global | |
|
10895
c391bfbdb452
Updated runtime files.
Christian Brabandt <cb@256bit.org>
parents:
10734
diff
changeset
|
8378 {only in the GTK+ GUI} |
| 7 | 8379 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
|
8380 tiny Use tiny icons. |
|
da01d5da2cfa
commit https://github.com/vim/vim/commit/77cdfd10382e01cc51f4ba1a9177032351843151
Christian Brabandt <cb@256bit.org>
parents:
8246
diff
changeset
|
8381 small Use small icons (default). |
|
da01d5da2cfa
commit https://github.com/vim/vim/commit/77cdfd10382e01cc51f4ba1a9177032351843151
Christian Brabandt <cb@256bit.org>
parents:
8246
diff
changeset
|
8382 medium Use medium-sized icons. |
|
da01d5da2cfa
commit https://github.com/vim/vim/commit/77cdfd10382e01cc51f4ba1a9177032351843151
Christian Brabandt <cb@256bit.org>
parents:
8246
diff
changeset
|
8383 large Use large icons. |
|
da01d5da2cfa
commit https://github.com/vim/vim/commit/77cdfd10382e01cc51f4ba1a9177032351843151
Christian Brabandt <cb@256bit.org>
parents:
8246
diff
changeset
|
8384 huge Use even larger icons. |
|
da01d5da2cfa
commit https://github.com/vim/vim/commit/77cdfd10382e01cc51f4ba1a9177032351843151
Christian Brabandt <cb@256bit.org>
parents:
8246
diff
changeset
|
8385 giant Use very big icons. |
| 7 | 8386 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
|
8387 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
|
8388 large=24x24, medium=24x24, small=20x20 and tiny=16x16. |
| 7 | 8389 |
| 8390 If 'toolbariconsize' is empty, the global default size as determined | |
| 8391 by user preferences or the current theme is used. | |
| 8392 | |
| 8393 *'ttybuiltin'* *'tbi'* *'nottybuiltin'* *'notbi'* | |
| 8394 'ttybuiltin' 'tbi' boolean (default on) | |
| 8395 global | |
| 8396 When on, the builtin termcaps are searched before the external ones. | |
| 8397 When off the builtin termcaps are searched after the external ones. | |
| 8398 When this option is changed, you should set the 'term' option next for | |
| 8399 the change to take effect, for example: > | |
| 8400 :set notbi term=$TERM | |
| 8401 < See also |termcap|. | |
| 8402 Rationale: The default for this option is "on", because the builtin | |
| 8403 termcap entries are generally better (many systems contain faulty | |
| 8404 xterm entries...). | |
| 8405 | |
| 8406 *'ttyfast'* *'tf'* *'nottyfast'* *'notf'* | |
| 8407 'ttyfast' 'tf' boolean (default off, on when 'term' is xterm, hpterm, | |
| 8408 sun-cmd, screen, rxvt, dtterm or | |
| 8409 iris-ansi; also on when running Vim in | |
| 8410 a DOS console) | |
| 8411 global | |
| 8412 Indicates a fast terminal connection. More characters will be sent to | |
| 8413 the screen for redrawing, instead of using insert/delete line | |
| 8414 commands. Improves smoothness of redrawing when there are multiple | |
| 8415 windows and the terminal does not support a scrolling region. | |
| 8416 Also enables the extra writing of characters at the end of each screen | |
| 8417 line for lines that wrap. This helps when using copy/paste with the | |
| 8418 mouse in an xterm and other terminals. | |
| 8419 | |
| 8420 *'ttymouse'* *'ttym'* | |
| 8421 'ttymouse' 'ttym' string (default depends on 'term') | |
| 8422 global | |
| 8423 {only in Unix and VMS, doesn't work in the GUI; not | |
| 8424 available when compiled without |+mouse|} | |
| 8425 Name of the terminal type for which mouse codes are to be recognized. | |
| 1213 | 8426 Currently these strings are valid: |
| 7 | 8427 *xterm-mouse* |
| 8428 xterm xterm-like mouse handling. The mouse generates | |
| 8429 "<Esc>[Mscr", where "scr" is three bytes: | |
| 8430 "s" = button state | |
| 8431 "c" = column plus 33 | |
| 8432 "r" = row plus 33 | |
| 5908 | 8433 This only works up to 223 columns! See "dec", |
| 8434 "urxvt", and "sgr" for solutions. | |
| 7 | 8435 xterm2 Works like "xterm", but with the xterm reporting the |
| 8436 mouse position while the mouse is dragged. This works | |
| 8437 much faster and more precise. Your xterm must at | |
| 180 | 8438 least at patchlevel 88 / XFree 3.3.3 for this to |
| 7 | 8439 work. See below for how Vim detects this |
| 8440 automatically. | |
| 8441 *netterm-mouse* | |
|
16553
0e473e9e70c2
patch 8.1.1280: remarks about functionality not in Vi clutters the help
Bram Moolenaar <Bram@vim.org>
parents:
16533
diff
changeset
|
8442 netterm NetTerm mouse handling. A left mouse click generates |
| 7 | 8443 "<Esc>}r,c<CR>", where "r,c" are two decimal numbers |
|
16553
0e473e9e70c2
patch 8.1.1280: remarks about functionality not in Vi clutters the help
Bram Moolenaar <Bram@vim.org>
parents:
16533
diff
changeset
|
8444 for the row and column. No other mouse events are |
|
0e473e9e70c2
patch 8.1.1280: remarks about functionality not in Vi clutters the help
Bram Moolenaar <Bram@vim.org>
parents:
16533
diff
changeset
|
8445 supported. |
| 7 | 8446 *dec-mouse* |
| 8447 dec DEC terminal mouse handling. The mouse generates a | |
| 8448 rather complex sequence, starting with "<Esc>[". | |
| 189 | 8449 This is also available for an Xterm, if it was |
| 8450 configured with "--enable-dec-locator". | |
| 7 | 8451 *jsbterm-mouse* |
| 8452 jsbterm JSB term mouse handling. | |
| 8453 *pterm-mouse* | |
| 8454 pterm QNX pterm mouse handling. | |
| 3224 | 8455 *urxvt-mouse* |
| 8456 urxvt Mouse handling for the urxvt (rxvt-unicode) terminal. | |
| 5908 | 8457 The mouse works only if the terminal supports this |
| 8458 encoding style, but it does not have 223 columns limit | |
| 8459 unlike "xterm" or "xterm2". | |
| 3750 | 8460 *sgr-mouse* |
| 8461 sgr Mouse handling for the terminal that emits SGR-styled | |
| 5908 | 8462 mouse reporting. The mouse works even in columns |
| 8463 beyond 223. This option is backward compatible with | |
| 8464 "xterm2" because it can also decode "xterm2" style | |
| 8465 mouse codes. | |
| 7 | 8466 |
| 8467 The mouse handling must be enabled at compile time |+mouse_xterm| | |
| 5908 | 8468 |+mouse_dec| |+mouse_netterm| |+mouse_jsbterm| |+mouse_urxvt| |
| 8469 |+mouse_sgr|. | |
| 7 | 8470 Only "xterm"(2) is really recognized. NetTerm mouse codes are always |
| 8471 recognized, if enabled at compile time. DEC terminal mouse codes | |
| 8472 are recognized if enabled at compile time, and 'ttymouse' is not | |
| 5908 | 8473 "xterm", "xterm2", "urxvt" or "sgr" (because dec mouse codes conflict |
| 8474 with them). | |
| 7 | 8475 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
|
8476 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
|
8477 "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
|
8478 already. |
| 5908 | 8479 Additionally, if vim is compiled with the |+termresponse| feature and |
| 8480 |t_RV| is set to the escape sequence to request the xterm version | |
|
17229
f1c7b7a4d9e4
patch 8.1.1614: 'numberwidth' can only go up to 10
Bram Moolenaar <Bram@vim.org>
parents:
17161
diff
changeset
|
8481 number, more intelligent detection is done. |
| 7 | 8482 The "xterm2" value will be set if the xterm version is reported to be |
| 15131 | 8483 from 95 to 276. The "sgr" value will be set if Vim detects Mac |
| 8484 Terminal.app, iTerm2 or mintty, and when the xterm version is 277 or | |
| 8485 higher. | |
| 5908 | 8486 If you do not want 'ttymouse' to be set to "xterm2" or "sgr" |
| 8487 automatically, set t_RV to an empty string: > | |
| 7 | 8488 :set t_RV= |
| 8489 < | |
| 8490 *'ttyscroll'* *'tsl'* | |
| 8491 'ttyscroll' 'tsl' number (default 999) | |
| 8492 global | |
| 8493 Maximum number of lines to scroll the screen. If there are more lines | |
| 8494 to scroll the window is redrawn. For terminals where scrolling is | |
| 8495 very slow and redrawing is not slow this can be set to a small number, | |
| 8496 e.g., 3, to speed up displaying. | |
| 8497 | |
| 8498 *'ttytype'* *'tty'* | |
| 8499 'ttytype' 'tty' string (default from $TERM) | |
| 8500 global | |
| 8501 Alias for 'term', see above. | |
| 8502 | |
|
2214
f8222d1f9a73
Included patch for persistent undo. Lots of changes and added test.
Bram Moolenaar <bram@vim.org>
parents:
2209
diff
changeset
|
8503 *'undodir'* *'udir'* |
|
f8222d1f9a73
Included patch for persistent undo. Lots of changes and added test.
Bram Moolenaar <bram@vim.org>
parents:
2209
diff
changeset
|
8504 '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
|
8505 global |
|
2570
71b56b4e7785
Make the references to features in the help more consistent. (Sylvain Hitier)
Bram Moolenaar <bram@vim.org>
parents:
2561
diff
changeset
|
8506 {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
|
8507 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
|
8508 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
|
8509 "." 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
|
8510 "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
|
8511 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
|
8512 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
|
8513 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
|
8514 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
|
8515 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
|
8516 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
|
8517 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
|
8518 See |undo-persistence|. |
|
16728
e55c26aaf484
patch 8.1.1366: using expressions in a modeline is unsafe
Bram Moolenaar <Bram@vim.org>
parents:
16610
diff
changeset
|
8519 This option cannot be set from a |modeline| or in the |sandbox|, for |
|
e55c26aaf484
patch 8.1.1366: using expressions in a modeline is unsafe
Bram Moolenaar <Bram@vim.org>
parents:
16610
diff
changeset
|
8520 security reasons. |
|
2214
f8222d1f9a73
Included patch for persistent undo. Lots of changes and added test.
Bram Moolenaar <bram@vim.org>
parents:
2209
diff
changeset
|
8521 |
|
4681
2eb30f341e8d
Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents:
4502
diff
changeset
|
8522 *'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
|
8523 '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
|
8524 local to buffer |
|
2570
71b56b4e7785
Make the references to features in the help more consistent. (Sylvain Hitier)
Bram Moolenaar <bram@vim.org>
parents:
2561
diff
changeset
|
8525 {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
|
8526 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
|
8527 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
|
8528 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
|
8529 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
|
8530 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
|
8531 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
|
8532 before a reload to be saved for undo. |
| 3920 | 8533 When 'undofile' is turned off the undo file is NOT deleted. |
| 11160 | 8534 NOTE: This option is reset when 'compatible' is set. |
|
2214
f8222d1f9a73
Included patch for persistent undo. Lots of changes and added test.
Bram Moolenaar <bram@vim.org>
parents:
2209
diff
changeset
|
8535 |
| 7 | 8536 *'undolevels'* *'ul'* |
| 19116 | 8537 'undolevels' 'ul' number (default 100, 1000 for Unix, VMS and Win32) |
| 5446 | 8538 global or local to buffer |global-local| |
| 7 | 8539 Maximum number of changes that can be undone. Since undo information |
| 18186 | 8540 is kept in memory, higher numbers will cause more memory to be used. |
| 8541 Nevertheless, a single change can already use a large amount of memory. | |
| 7 | 8542 Set to 0 for Vi compatibility: One level of undo and "u" undoes |
| 8543 itself: > | |
| 8544 set ul=0 | |
| 8545 < But you can also get Vi compatibility by including the 'u' flag in | |
| 8546 '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
|
8547 Also see |undo-two-ways|. |
| 5446 | 8548 Set to -1 for no undo at all. You might want to do this only for the |
| 8549 current buffer: > | |
| 8550 setlocal ul=-1 | |
| 7 | 8551 < This helps when you run out of memory for a single change. |
| 6336 | 8552 |
| 8553 The local value is set to -123456 when the global value is to be used. | |
| 8554 | |
|
2249
6d3d35ff2c2b
Use full path in undofile(). Updated docs.
Bram Moolenaar <bram@vim.org>
parents:
2240
diff
changeset
|
8555 Also see |clear-undo|. |
| 7 | 8556 |
|
2394
a3aca345aafa
Add the 'undoreload' option to be able to undo a file reload.
Bram Moolenaar <bram@vim.org>
parents:
2382
diff
changeset
|
8557 *'undoreload'* *'ur'* |
|
a3aca345aafa
Add the 'undoreload' option to be able to undo a file reload.
Bram Moolenaar <bram@vim.org>
parents:
2382
diff
changeset
|
8558 '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
|
8559 global |
|
a3aca345aafa
Add the 'undoreload' option to be able to undo a file reload.
Bram Moolenaar <bram@vim.org>
parents:
2382
diff
changeset
|
8560 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
|
8561 ":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
|
8562 Vim. |FileChangedShell| |
| 12559 | 8563 The save only happens when this option is negative or when the number |
|
2394
a3aca345aafa
Add the 'undoreload' option to be able to undo a file reload.
Bram Moolenaar <bram@vim.org>
parents:
2382
diff
changeset
|
8564 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
|
8565 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
|
8566 |
|
a3aca345aafa
Add the 'undoreload' option to be able to undo a file reload.
Bram Moolenaar <bram@vim.org>
parents:
2382
diff
changeset
|
8567 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
|
8568 |
|
a3aca345aafa
Add the 'undoreload' option to be able to undo a file reload.
Bram Moolenaar <bram@vim.org>
parents:
2382
diff
changeset
|
8569 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
|
8570 this option to a lower value if you run out of memory. |
| 7 | 8571 |
| 8572 *'updatecount'* *'uc'* | |
| 8573 'updatecount' 'uc' number (default: 200) | |
| 8574 global | |
| 8575 After typing this many characters the swap file will be written to | |
| 8576 disk. When zero, no swap file will be created at all (see chapter on | |
| 8577 recovery |crash-recovery|). 'updatecount' is set to zero by starting | |
| 8578 Vim with the "-n" option, see |startup|. When editing in readonly | |
| 8579 mode this option will be initialized to 10000. | |
| 8580 The swapfile can be disabled per buffer with |'swapfile'|. | |
| 8581 When 'updatecount' is set from zero to non-zero, swap files are | |
| 8582 created for all buffers that have 'swapfile' set. When 'updatecount' | |
| 8583 is set to zero, existing swap files are not deleted. | |
| 8584 Also see |'swapsync'|. | |
| 8585 This option has no meaning in buffers where |'buftype'| is "nofile" | |
| 8586 or "nowrite". | |
| 8587 | |
| 8588 *'updatetime'* *'ut'* | |
| 8589 'updatetime' 'ut' number (default 4000) | |
| 8590 global | |
| 8591 If this many milliseconds nothing is typed the swap file will be | |
| 8592 written to disk (see |crash-recovery|). Also used for the | |
| 8593 |CursorHold| autocommand event. | |
| 8594 | |
|
14175
2ad722003b36
patch 8.1.0105: all tab stops are the same
Christian Brabandt <cb@256bit.org>
parents:
14019
diff
changeset
|
8595 *'varsofttabstop'* *'vsts'* |
|
2ad722003b36
patch 8.1.0105: all tab stops are the same
Christian Brabandt <cb@256bit.org>
parents:
14019
diff
changeset
|
8596 'varsofttabstop' 'vsts' string (default "") |
|
2ad722003b36
patch 8.1.0105: all tab stops are the same
Christian Brabandt <cb@256bit.org>
parents:
14019
diff
changeset
|
8597 local to buffer |
|
2ad722003b36
patch 8.1.0105: all tab stops are the same
Christian Brabandt <cb@256bit.org>
parents:
14019
diff
changeset
|
8598 {only available when compiled with the |+vartabs| |
|
2ad722003b36
patch 8.1.0105: all tab stops are the same
Christian Brabandt <cb@256bit.org>
parents:
14019
diff
changeset
|
8599 feature} |
|
2ad722003b36
patch 8.1.0105: all tab stops are the same
Christian Brabandt <cb@256bit.org>
parents:
14019
diff
changeset
|
8600 A list of the number of spaces that a <Tab> counts for while editing, |
|
2ad722003b36
patch 8.1.0105: all tab stops are the same
Christian Brabandt <cb@256bit.org>
parents:
14019
diff
changeset
|
8601 such as inserting a <Tab> or using <BS>. It "feels" like variable- |
|
2ad722003b36
patch 8.1.0105: all tab stops are the same
Christian Brabandt <cb@256bit.org>
parents:
14019
diff
changeset
|
8602 width <Tab>s are being inserted, while in fact a mixture of spaces |
|
2ad722003b36
patch 8.1.0105: all tab stops are the same
Christian Brabandt <cb@256bit.org>
parents:
14019
diff
changeset
|
8603 and <Tab>s is used. Tab widths are separated with commas, with the |
|
2ad722003b36
patch 8.1.0105: all tab stops are the same
Christian Brabandt <cb@256bit.org>
parents:
14019
diff
changeset
|
8604 final value applying to all subsequent tabs. |
|
2ad722003b36
patch 8.1.0105: all tab stops are the same
Christian Brabandt <cb@256bit.org>
parents:
14019
diff
changeset
|
8605 |
|
2ad722003b36
patch 8.1.0105: all tab stops are the same
Christian Brabandt <cb@256bit.org>
parents:
14019
diff
changeset
|
8606 For example, when editing assembly language files where statements |
|
14249
4543777545a3
Updated runtime and language files.
Christian Brabandt <cb@256bit.org>
parents:
14175
diff
changeset
|
8607 start in the 9th column and comments in the 41st, it may be useful |
|
14175
2ad722003b36
patch 8.1.0105: all tab stops are the same
Christian Brabandt <cb@256bit.org>
parents:
14019
diff
changeset
|
8608 to use the following: > |
|
2ad722003b36
patch 8.1.0105: all tab stops are the same
Christian Brabandt <cb@256bit.org>
parents:
14019
diff
changeset
|
8609 :set varsofttabstop=8,32,8 |
|
14249
4543777545a3
Updated runtime and language files.
Christian Brabandt <cb@256bit.org>
parents:
14175
diff
changeset
|
8610 < This will set soft tabstops with 8 and 8 + 32 spaces, and 8 more |
|
4543777545a3
Updated runtime and language files.
Christian Brabandt <cb@256bit.org>
parents:
14175
diff
changeset
|
8611 for every column thereafter. |
|
14175
2ad722003b36
patch 8.1.0105: all tab stops are the same
Christian Brabandt <cb@256bit.org>
parents:
14019
diff
changeset
|
8612 |
|
2ad722003b36
patch 8.1.0105: all tab stops are the same
Christian Brabandt <cb@256bit.org>
parents:
14019
diff
changeset
|
8613 Note that the value of |'softtabstop'| will be ignored while |
|
2ad722003b36
patch 8.1.0105: all tab stops are the same
Christian Brabandt <cb@256bit.org>
parents:
14019
diff
changeset
|
8614 'varsofttabstop' is set. |
|
2ad722003b36
patch 8.1.0105: all tab stops are the same
Christian Brabandt <cb@256bit.org>
parents:
14019
diff
changeset
|
8615 |
|
2ad722003b36
patch 8.1.0105: all tab stops are the same
Christian Brabandt <cb@256bit.org>
parents:
14019
diff
changeset
|
8616 *'vartabstop'* *'vts'* |
|
2ad722003b36
patch 8.1.0105: all tab stops are the same
Christian Brabandt <cb@256bit.org>
parents:
14019
diff
changeset
|
8617 'vartabstop' 'vts' string (default "") |
|
2ad722003b36
patch 8.1.0105: all tab stops are the same
Christian Brabandt <cb@256bit.org>
parents:
14019
diff
changeset
|
8618 local to buffer |
|
2ad722003b36
patch 8.1.0105: all tab stops are the same
Christian Brabandt <cb@256bit.org>
parents:
14019
diff
changeset
|
8619 {only available when compiled with the |+vartabs| |
|
2ad722003b36
patch 8.1.0105: all tab stops are the same
Christian Brabandt <cb@256bit.org>
parents:
14019
diff
changeset
|
8620 feature} |
|
2ad722003b36
patch 8.1.0105: all tab stops are the same
Christian Brabandt <cb@256bit.org>
parents:
14019
diff
changeset
|
8621 A list of the number of spaces that a <Tab> in the file counts for, |
|
2ad722003b36
patch 8.1.0105: all tab stops are the same
Christian Brabandt <cb@256bit.org>
parents:
14019
diff
changeset
|
8622 separated by commas. Each value corresponds to one tab, with the |
|
2ad722003b36
patch 8.1.0105: all tab stops are the same
Christian Brabandt <cb@256bit.org>
parents:
14019
diff
changeset
|
8623 final value applying to all subsequent tabs. For example: > |
|
2ad722003b36
patch 8.1.0105: all tab stops are the same
Christian Brabandt <cb@256bit.org>
parents:
14019
diff
changeset
|
8624 :set vartabstop=4,20,10,8 |
|
2ad722003b36
patch 8.1.0105: all tab stops are the same
Christian Brabandt <cb@256bit.org>
parents:
14019
diff
changeset
|
8625 < This will make the first tab 4 spaces wide, the second 20 spaces, |
|
2ad722003b36
patch 8.1.0105: all tab stops are the same
Christian Brabandt <cb@256bit.org>
parents:
14019
diff
changeset
|
8626 the third 10 spaces, and all following tabs 8 spaces. |
|
2ad722003b36
patch 8.1.0105: all tab stops are the same
Christian Brabandt <cb@256bit.org>
parents:
14019
diff
changeset
|
8627 |
|
2ad722003b36
patch 8.1.0105: all tab stops are the same
Christian Brabandt <cb@256bit.org>
parents:
14019
diff
changeset
|
8628 Note that the value of |'tabstop'| will be ignored while 'vartabstop' |
|
2ad722003b36
patch 8.1.0105: all tab stops are the same
Christian Brabandt <cb@256bit.org>
parents:
14019
diff
changeset
|
8629 is set. |
|
2ad722003b36
patch 8.1.0105: all tab stops are the same
Christian Brabandt <cb@256bit.org>
parents:
14019
diff
changeset
|
8630 |
| 7 | 8631 *'verbose'* *'vbs'* |
| 8632 'verbose' 'vbs' number (default 0) | |
| 8633 global | |
| 8634 When bigger than zero, Vim will give messages about what it is doing. | |
| 8635 Currently, these messages are given: | |
| 8636 >= 1 When the viminfo file is read or written. | |
| 8637 >= 2 When a file is ":source"'ed. | |
|
20265
d821c03b890c
patch 8.2.0688: output clobbered if setting 'verbose' to see shell commands
Bram Moolenaar <Bram@vim.org>
parents:
20069
diff
changeset
|
8638 >= 4 Shell commands. |
| 712 | 8639 >= 5 Every searched tags file and include file. |
| 7 | 8640 >= 8 Files for which a group of autocommands is executed. |
| 8641 >= 9 Every executed autocommand. | |
|
20265
d821c03b890c
patch 8.2.0688: output clobbered if setting 'verbose' to see shell commands
Bram Moolenaar <Bram@vim.org>
parents:
20069
diff
changeset
|
8642 >= 11 Finding items in a path |
| 7 | 8643 >= 12 Every executed function. |
| 8644 >= 13 When an exception is thrown, caught, finished, or discarded. | |
| 8645 >= 14 Anything pending in a ":finally" clause. | |
|
20575
501b72481d0a
patch 8.2.0841: 'verbose' value 16 causes duplicate output
Bram Moolenaar <Bram@vim.org>
parents:
20317
diff
changeset
|
8646 >= 15 Every executed Ex command from a script (truncated at 200 |
|
501b72481d0a
patch 8.2.0841: 'verbose' value 16 causes duplicate output
Bram Moolenaar <Bram@vim.org>
parents:
20317
diff
changeset
|
8647 characters). |
| 21676 | 8648 >= 16 Every executed Ex command. |
| 7 | 8649 |
| 8650 This option can also be set with the "-V" argument. See |-V|. | |
| 8651 This option is also set by the |:verbose| command. | |
| 8652 | |
| 293 | 8653 When the 'verbosefile' option is set then the verbose messages are not |
| 8654 displayed. | |
| 8655 | |
| 8656 *'verbosefile'* *'vfile'* | |
| 8657 'verbosefile' 'vfile' string (default empty) | |
| 8658 global | |
| 8659 When not empty all messages are written in a file with this name. | |
| 8660 When the file exists messages are appended. | |
| 8661 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
|
8662 empty. Writes are buffered, thus may not show up for some time. |
| 293 | 8663 Setting 'verbosefile' to a new value is like making it empty first. |
| 8664 The difference with |:redir| is that verbose messages are not | |
| 8665 displayed when 'verbosefile' is set. | |
| 8666 | |
| 7 | 8667 *'viewdir'* *'vdir'* |
|
18912
ccd16426a1f9
patch 8.2.0017: OS/2 and MS-DOS are still mentioned
Bram Moolenaar <Bram@vim.org>
parents:
18879
diff
changeset
|
8668 'viewdir' 'vdir' string (default for Amiga and Win32: |
| 7 | 8669 "$VIM/vimfiles/view", |
| 8670 for Unix: "~/.vim/view", | |
| 21825 | 8671 for macOS: "$VIM:vimfiles:view" |
| 18972 | 8672 for VMS: "sys$login:vimfiles/view") |
| 7 | 8673 global |
|
2570
71b56b4e7785
Make the references to features in the help more consistent. (Sylvain Hitier)
Bram Moolenaar <bram@vim.org>
parents:
2561
diff
changeset
|
8674 {not available when compiled without the |+mksession| |
| 7 | 8675 feature} |
| 8676 Name of the directory where to store files for |:mkview|. | |
| 8677 This option cannot be set from a |modeline| or in the |sandbox|, for | |
| 8678 security reasons. | |
| 8679 | |
| 8680 *'viewoptions'* *'vop'* | |
|
12824
79a754456110
patch 8.0.1289: mkview always includes the local directory
Christian Brabandt <cb@256bit.org>
parents:
12802
diff
changeset
|
8681 'viewoptions' 'vop' string (default: "folds,options,cursor,curdir") |
| 7 | 8682 global |
|
2570
71b56b4e7785
Make the references to features in the help more consistent. (Sylvain Hitier)
Bram Moolenaar <bram@vim.org>
parents:
2561
diff
changeset
|
8683 {not available when compiled without the |+mksession| |
| 7 | 8684 feature} |
| 8685 Changes the effect of the |:mkview| command. It is a comma separated | |
| 10 | 8686 list of words. Each word enables saving and restoring something: |
| 7 | 8687 word save and restore ~ |
| 8688 cursor cursor position in file and in window | |
| 8689 folds manually created folds, opened/closed folds and local | |
| 8690 fold options | |
| 8691 options options and mappings local to a window or buffer (not | |
| 8692 global values for local options) | |
| 6213 | 8693 localoptions same as "options" |
| 7 | 8694 slash backslashes in file names replaced with forward |
| 8695 slashes | |
| 8696 unix with Unix end-of-line format (single <NL>), even when | |
|
18912
ccd16426a1f9
patch 8.2.0017: OS/2 and MS-DOS are still mentioned
Bram Moolenaar <Bram@vim.org>
parents:
18879
diff
changeset
|
8697 on MS-Windows |
|
12824
79a754456110
patch 8.0.1289: mkview always includes the local directory
Christian Brabandt <cb@256bit.org>
parents:
12802
diff
changeset
|
8698 curdir the window-local directory, if set with `:lcd` |
| 7 | 8699 |
|
18912
ccd16426a1f9
patch 8.2.0017: OS/2 and MS-DOS are still mentioned
Bram Moolenaar <Bram@vim.org>
parents:
18879
diff
changeset
|
8700 "slash" and "unix" are useful on MS-Windows when sharing view files |
| 7 | 8701 with Unix. The Unix version of Vim cannot source dos format scripts, |
|
18912
ccd16426a1f9
patch 8.2.0017: OS/2 and MS-DOS are still mentioned
Bram Moolenaar <Bram@vim.org>
parents:
18879
diff
changeset
|
8702 but the MS-Windows version of Vim can source unix format scripts. |
| 7 | 8703 |
| 8704 *'viminfo'* *'vi'* *E526* *E527* *E528* | |
|
18912
ccd16426a1f9
patch 8.2.0017: OS/2 and MS-DOS are still mentioned
Bram Moolenaar <Bram@vim.org>
parents:
18879
diff
changeset
|
8705 'viminfo' 'vi' string (Vi default: "", Vim default for |
|
ccd16426a1f9
patch 8.2.0017: OS/2 and MS-DOS are still mentioned
Bram Moolenaar <Bram@vim.org>
parents:
18879
diff
changeset
|
8706 MS-Windows: '100,<50,s10,h,rA:,rB:, |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
8707 for Amiga: '100,<50,s10,h,rdf0:,rdf1:,rdf2: |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
8708 for others: '100,<50,s10,h) |
| 7 | 8709 global |
|
2570
71b56b4e7785
Make the references to features in the help more consistent. (Sylvain Hitier)
Bram Moolenaar <bram@vim.org>
parents:
2561
diff
changeset
|
8710 {not available when compiled without the |+viminfo| |
| 7 | 8711 feature} |
| 8712 When non-empty, the viminfo file is read upon startup and written | |
|
11666
5cd9ba96561d
patch 8.0.0716: not easy to start Vim cleanly
Christian Brabandt <cb@256bit.org>
parents:
11659
diff
changeset
|
8713 when exiting Vim (see |viminfo-file|). Except when 'viminfofile' is |
|
5cd9ba96561d
patch 8.0.0716: not easy to start Vim cleanly
Christian Brabandt <cb@256bit.org>
parents:
11659
diff
changeset
|
8714 "NONE". |
|
5cd9ba96561d
patch 8.0.0716: not easy to start Vim cleanly
Christian Brabandt <cb@256bit.org>
parents:
11659
diff
changeset
|
8715 The string should be a comma separated list of parameters, each |
|
5cd9ba96561d
patch 8.0.0716: not easy to start Vim cleanly
Christian Brabandt <cb@256bit.org>
parents:
11659
diff
changeset
|
8716 consisting of a single character identifying the particular parameter, |
|
5cd9ba96561d
patch 8.0.0716: not easy to start Vim cleanly
Christian Brabandt <cb@256bit.org>
parents:
11659
diff
changeset
|
8717 followed by a number or string which specifies the value of that |
|
5cd9ba96561d
patch 8.0.0716: not easy to start Vim cleanly
Christian Brabandt <cb@256bit.org>
parents:
11659
diff
changeset
|
8718 parameter. If a particular character is left out, then the default |
|
5cd9ba96561d
patch 8.0.0716: not easy to start Vim cleanly
Christian Brabandt <cb@256bit.org>
parents:
11659
diff
changeset
|
8719 value is used for that parameter. The following is a list of the |
|
5cd9ba96561d
patch 8.0.0716: not easy to start Vim cleanly
Christian Brabandt <cb@256bit.org>
parents:
11659
diff
changeset
|
8720 identifying characters and the effect of their value. |
| 7 | 8721 CHAR VALUE ~ |
| 3224 | 8722 *viminfo-!* |
| 7 | 8723 ! When included, save and restore global variables that start |
| 8724 with an uppercase letter, and don't contain a lowercase | |
| 8725 letter. Thus "KEEPTHIS and "K_L_M" are stored, but "KeepThis" | |
| 2607 | 8726 and "_K_L_M" are not. Nested List and Dict items may not be |
| 2642 | 8727 read back correctly, you end up with an empty item. |
| 3224 | 8728 *viminfo-quote* |
| 7 | 8729 " Maximum number of lines saved for each register. Old name of |
| 8730 the '<' item, with the disadvantage that you need to put a | |
| 8731 backslash before the ", otherwise it will be recognized as the | |
| 8732 start of a comment! | |
| 3224 | 8733 *viminfo-%* |
| 7 | 8734 % When included, save and restore the buffer list. If Vim is |
| 8735 started with a file name argument, the buffer list is not | |
| 8736 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
|
8737 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
|
8738 ('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
|
8739 removable media (|viminfo-r|) are not saved. |
| 23 | 8740 When followed by a number, the number specifies the maximum |
| 8741 number of buffers that are stored. Without a number all | |
| 8742 buffers are stored. | |
| 3224 | 8743 *viminfo-'* |
| 7 | 8744 ' Maximum number of previously edited files for which the marks |
| 8745 are remembered. This parameter must always be included when | |
| 8746 'viminfo' is non-empty. | |
| 8747 Including this item also means that the |jumplist| and the | |
| 8748 |changelist| are stored in the viminfo file. | |
| 3224 | 8749 *viminfo-/* |
| 7 | 8750 / Maximum number of items in the search pattern history to be |
| 10 | 8751 saved. If non-zero, then the previous search and substitute |
| 7 | 8752 patterns are also saved. When not included, the value of |
| 8753 'history' is used. | |
| 3224 | 8754 *viminfo-:* |
| 7 | 8755 : Maximum number of items in the command-line history to be |
| 10 | 8756 saved. When not included, the value of 'history' is used. |
| 3224 | 8757 *viminfo-<* |
| 7 | 8758 < Maximum number of lines saved for each register. If zero then |
| 8759 registers are not saved. When not included, all lines are | |
| 8760 saved. '"' is the old name for this item. | |
| 8761 Also see the 's' item below: limit specified in Kbyte. | |
| 3224 | 8762 *viminfo-@* |
| 7 | 8763 @ Maximum number of items in the input-line history to be |
| 10 | 8764 saved. When not included, the value of 'history' is used. |
| 3224 | 8765 *viminfo-c* |
| 7 | 8766 c When included, convert the text in the viminfo file from the |
| 8767 'encoding' used when writing the file to the current | |
| 233 | 8768 'encoding'. See |viminfo-encoding|. |
| 3224 | 8769 *viminfo-f* |
| 7 | 8770 f Whether file marks need to be stored. If zero, file marks ('0 |
| 8771 to '9, 'A to 'Z) are not stored. When not present or when | |
| 10 | 8772 non-zero, they are all stored. '0 is used for the current |
| 7 | 8773 cursor position (when exiting or when doing ":wviminfo"). |
| 3224 | 8774 *viminfo-h* |
| 7 | 8775 h Disable the effect of 'hlsearch' when loading the viminfo |
| 8776 file. When not included, it depends on whether ":nohlsearch" | |
| 8777 has been used since the last search command. | |
| 3224 | 8778 *viminfo-n* |
| 7 | 8779 n Name of the viminfo file. The name must immediately follow |
|
11666
5cd9ba96561d
patch 8.0.0716: not easy to start Vim cleanly
Christian Brabandt <cb@256bit.org>
parents:
11659
diff
changeset
|
8780 the 'n'. Must be at the end of the option! If the |
|
5cd9ba96561d
patch 8.0.0716: not easy to start Vim cleanly
Christian Brabandt <cb@256bit.org>
parents:
11659
diff
changeset
|
8781 'viminfofile' option is set, that file name overrides the one |
|
5cd9ba96561d
patch 8.0.0716: not easy to start Vim cleanly
Christian Brabandt <cb@256bit.org>
parents:
11659
diff
changeset
|
8782 given here with 'viminfo'. Environment variables are |
|
9464
be72f4201a1d
commit https://github.com/vim/vim/commit/063b9d15abea041a5bfff3ffc4e219e26fd1d4fa
Christian Brabandt <cb@256bit.org>
parents:
9407
diff
changeset
|
8783 expanded when opening the file, not when setting the option. |
| 3224 | 8784 *viminfo-r* |
| 7 | 8785 r Removable media. The argument is a string (up to the next |
| 8786 ','). This parameter can be given several times. Each | |
| 8787 specifies the start of a path for which no marks will be | |
| 18972 | 8788 stored. This is to avoid removable media. For MS-Windows you |
| 7 | 8789 could use "ra:,rb:", for Amiga "rdf0:,rdf1:,rdf2:". You can |
| 8790 also use it for temp files, e.g., for Unix: "r/tmp". Case is | |
| 8791 ignored. Maximum length of each 'r' argument is 50 | |
| 8792 characters. | |
| 3224 | 8793 *viminfo-s* |
| 7 | 8794 s Maximum size of an item in Kbyte. If zero then registers are |
| 8795 not saved. Currently only applies to registers. The default | |
| 8796 "s10" will exclude registers with more than 10 Kbyte of text. | |
| 8797 Also see the '<' item above: line count limit. | |
| 8798 | |
| 8799 Example: > | |
| 8800 :set viminfo='50,<1000,s100,:0,n~/vim/viminfo | |
| 8801 < | |
| 8802 '50 Marks will be remembered for the last 50 files you | |
| 8803 edited. | |
| 8804 <1000 Contents of registers (up to 1000 lines each) will be | |
| 8805 remembered. | |
| 8806 s100 Registers with more than 100 Kbyte text are skipped. | |
| 8807 :0 Command-line history will not be saved. | |
| 8808 n~/vim/viminfo The name of the file to use is "~/vim/viminfo". | |
| 8809 no / Since '/' is not specified, the default will be used, | |
| 8810 that is, save all of the search history, and also the | |
| 8811 previous search and substitute patterns. | |
| 8812 no % The buffer list will not be saved nor read back. | |
| 8813 no h 'hlsearch' highlighting will be restored. | |
| 8814 | |
| 8815 When setting 'viminfo' from an empty value you can use |:rviminfo| to | |
| 8816 load the contents of the file, this is not done automatically. | |
| 8817 | |
| 8818 This option cannot be set from a |modeline| or in the |sandbox|, for | |
| 8819 security reasons. | |
| 11160 | 8820 NOTE: This option is set to the Vim default value when 'compatible' |
| 8821 is reset. | |
| 7 | 8822 |
|
11666
5cd9ba96561d
patch 8.0.0716: not easy to start Vim cleanly
Christian Brabandt <cb@256bit.org>
parents:
11659
diff
changeset
|
8823 *'viminfofile'* *'vif'* |
|
5cd9ba96561d
patch 8.0.0716: not easy to start Vim cleanly
Christian Brabandt <cb@256bit.org>
parents:
11659
diff
changeset
|
8824 'viminfofile' 'vif' string (default: "") |
|
5cd9ba96561d
patch 8.0.0716: not easy to start Vim cleanly
Christian Brabandt <cb@256bit.org>
parents:
11659
diff
changeset
|
8825 global |
|
5cd9ba96561d
patch 8.0.0716: not easy to start Vim cleanly
Christian Brabandt <cb@256bit.org>
parents:
11659
diff
changeset
|
8826 {not available when compiled without the |+viminfo| |
|
5cd9ba96561d
patch 8.0.0716: not easy to start Vim cleanly
Christian Brabandt <cb@256bit.org>
parents:
11659
diff
changeset
|
8827 feature} |
|
5cd9ba96561d
patch 8.0.0716: not easy to start Vim cleanly
Christian Brabandt <cb@256bit.org>
parents:
11659
diff
changeset
|
8828 When non-empty, overrides the file name used for viminfo. |
|
5cd9ba96561d
patch 8.0.0716: not easy to start Vim cleanly
Christian Brabandt <cb@256bit.org>
parents:
11659
diff
changeset
|
8829 When equal to "NONE" no viminfo file will be read or written. |
|
5cd9ba96561d
patch 8.0.0716: not easy to start Vim cleanly
Christian Brabandt <cb@256bit.org>
parents:
11659
diff
changeset
|
8830 This option can be set with the |-i| command line flag. The |--clean| |
|
5cd9ba96561d
patch 8.0.0716: not easy to start Vim cleanly
Christian Brabandt <cb@256bit.org>
parents:
11659
diff
changeset
|
8831 command line flag sets it to "NONE". |
|
16728
e55c26aaf484
patch 8.1.1366: using expressions in a modeline is unsafe
Bram Moolenaar <Bram@vim.org>
parents:
16610
diff
changeset
|
8832 This option cannot be set from a |modeline| or in the |sandbox|, for |
|
e55c26aaf484
patch 8.1.1366: using expressions in a modeline is unsafe
Bram Moolenaar <Bram@vim.org>
parents:
16610
diff
changeset
|
8833 security reasons. |
|
11666
5cd9ba96561d
patch 8.0.0716: not easy to start Vim cleanly
Christian Brabandt <cb@256bit.org>
parents:
11659
diff
changeset
|
8834 |
| 7 | 8835 *'virtualedit'* *'ve'* |
| 8836 'virtualedit' 've' string (default "") | |
|
25487
c26ff3203b43
patch 8.2.3280: 'virtualedit' local to buffer is not the best solution
Bram Moolenaar <Bram@vim.org>
parents:
25402
diff
changeset
|
8837 global or local to window |global-local| |
| 7 | 8838 A comma separated list of these words: |
| 8839 block Allow virtual editing in Visual block mode. | |
| 8840 insert Allow virtual editing in Insert mode. | |
| 8841 all Allow virtual editing in all modes. | |
| 772 | 8842 onemore Allow the cursor to move just past the end of the line |
|
25380
ac88cd21ae88
patch 8.2.3227: 'virtualedit' can only be set globally
Bram Moolenaar <Bram@vim.org>
parents:
25322
diff
changeset
|
8843 none When used as the local value, do not allow virtual |
|
ac88cd21ae88
patch 8.2.3227: 'virtualedit' can only be set globally
Bram Moolenaar <Bram@vim.org>
parents:
25322
diff
changeset
|
8844 editing even when the global value is set. When used |
|
ac88cd21ae88
patch 8.2.3227: 'virtualedit' can only be set globally
Bram Moolenaar <Bram@vim.org>
parents:
25322
diff
changeset
|
8845 as the global value, "none" is the same as "". |
|
ac88cd21ae88
patch 8.2.3227: 'virtualedit' can only be set globally
Bram Moolenaar <Bram@vim.org>
parents:
25322
diff
changeset
|
8846 NONE Alternative spelling of "none". |
| 782 | 8847 |
| 7 | 8848 Virtual editing means that the cursor can be positioned where there is |
| 1263 | 8849 no actual character. This can be halfway into a tab or beyond the end |
| 7 | 8850 of the line. Useful for selecting a rectangle in Visual mode and |
| 8851 editing a table. | |
| 772 | 8852 "onemore" is not the same, it will only allow moving the cursor just |
| 8853 after the last character of the line. This makes some commands more | |
| 8854 consistent. Previously the cursor was always past the end of the line | |
| 8855 if the line was empty. But it is far from Vi compatible. It may also | |
| 782 | 8856 break some plugins or Vim scripts. For example because |l| can move |
| 8857 the cursor after the last character. Use with care! | |
| 5220 | 8858 Using the `$` command will move to the last character in the line, not |
| 782 | 8859 past it. This may actually move the cursor to the left! |
| 5220 | 8860 The `g$` command will move to the end of the screen line. |
| 772 | 8861 It doesn't make sense to combine "all" with "onemore", but you will |
| 8862 not get a warning for it. | |
| 25402 | 8863 When combined with other words, "none" is ignored. |
| 11160 | 8864 NOTE: This option is set to "" when 'compatible' is set. |
| 7 | 8865 |
| 8866 *'visualbell'* *'vb'* *'novisualbell'* *'novb'* *beep* | |
| 8867 'visualbell' 'vb' boolean (default off) | |
| 8868 global | |
|
11659
49c12c93abf3
Updated runtime files and translations.
Christian Brabandt <cb@256bit.org>
parents:
11529
diff
changeset
|
8869 Use a visual bell instead of beeping. The terminal code to display the |
| 7 | 8870 visual bell is given with 't_vb'. When no beep or flash is wanted, |
|
11659
49c12c93abf3
Updated runtime files and translations.
Christian Brabandt <cb@256bit.org>
parents:
11529
diff
changeset
|
8871 use: > |
|
49c12c93abf3
Updated runtime files and translations.
Christian Brabandt <cb@256bit.org>
parents:
11529
diff
changeset
|
8872 :set vb t_vb= |
|
49c12c93abf3
Updated runtime files and translations.
Christian Brabandt <cb@256bit.org>
parents:
11529
diff
changeset
|
8873 < If you want a short flash, you can use this on many terminals: > |
|
49c12c93abf3
Updated runtime files and translations.
Christian Brabandt <cb@256bit.org>
parents:
11529
diff
changeset
|
8874 :set vb t_vb=[?5h$<100>[?5l |
|
49c12c93abf3
Updated runtime files and translations.
Christian Brabandt <cb@256bit.org>
parents:
11529
diff
changeset
|
8875 < Here $<100> specifies the time, you can use a smaller or bigger value |
|
49c12c93abf3
Updated runtime files and translations.
Christian Brabandt <cb@256bit.org>
parents:
11529
diff
changeset
|
8876 to get a shorter or longer flash. |
|
49c12c93abf3
Updated runtime files and translations.
Christian Brabandt <cb@256bit.org>
parents:
11529
diff
changeset
|
8877 |
|
49c12c93abf3
Updated runtime files and translations.
Christian Brabandt <cb@256bit.org>
parents:
11529
diff
changeset
|
8878 Note: Vim will limit the bell to once per half a second. This avoids |
|
49c12c93abf3
Updated runtime files and translations.
Christian Brabandt <cb@256bit.org>
parents:
11529
diff
changeset
|
8879 having to wait for the flashing to finish when there are lots of |
|
49c12c93abf3
Updated runtime files and translations.
Christian Brabandt <cb@256bit.org>
parents:
11529
diff
changeset
|
8880 bells, e.g. on key repeat. This also happens without 'visualbell' |
|
49c12c93abf3
Updated runtime files and translations.
Christian Brabandt <cb@256bit.org>
parents:
11529
diff
changeset
|
8881 set. |
|
49c12c93abf3
Updated runtime files and translations.
Christian Brabandt <cb@256bit.org>
parents:
11529
diff
changeset
|
8882 |
| 7 | 8883 In the GUI, 't_vb' defaults to "<Esc>|f", which inverts the display |
| 8884 for 20 msec. If you want to use a different time, use "<Esc>|40f", | |
| 8885 where 40 is the time in msec. | |
|
11659
49c12c93abf3
Updated runtime files and translations.
Christian Brabandt <cb@256bit.org>
parents:
11529
diff
changeset
|
8886 |
|
49c12c93abf3
Updated runtime files and translations.
Christian Brabandt <cb@256bit.org>
parents:
11529
diff
changeset
|
8887 Note: When the GUI starts, 't_vb' is reset to its default value. You |
|
49c12c93abf3
Updated runtime files and translations.
Christian Brabandt <cb@256bit.org>
parents:
11529
diff
changeset
|
8888 might want to set it again in your |gvimrc|. |
|
49c12c93abf3
Updated runtime files and translations.
Christian Brabandt <cb@256bit.org>
parents:
11529
diff
changeset
|
8889 |
| 7 | 8890 Does not work on the Amiga, you always get a screen flash. |
| 8891 Also see 'errorbells'. | |
| 8892 | |
| 8893 *'warn'* *'nowarn'* | |
| 8894 'warn' boolean (default on) | |
| 8895 global | |
| 8896 Give a warning message when a shell command is used while the buffer | |
| 8897 has been changed. | |
| 8898 | |
| 8899 *'weirdinvert'* *'wiv'* *'noweirdinvert'* *'nowiv'* | |
| 8900 'weirdinvert' 'wiv' boolean (default off) | |
| 8901 global | |
| 667 | 8902 This option has the same effect as the 't_xs' terminal option. |
| 7 | 8903 It is provided for backwards compatibility with version 4.x. |
| 8904 Setting 'weirdinvert' has the effect of making 't_xs' non-empty, and | |
| 8905 vice versa. Has no effect when the GUI is running. | |
| 8906 | |
| 8907 *'whichwrap'* *'ww'* | |
| 8908 'whichwrap' 'ww' string (Vim default: "b,s", Vi default: "") | |
| 8909 global | |
| 8910 Allow specified keys that move the cursor left/right to move to the | |
| 8911 previous/next line when the cursor is on the first/last character in | |
| 8912 the line. Concatenate characters to allow this for these keys: | |
| 8913 char key mode ~ | |
| 8914 b <BS> Normal and Visual | |
| 8915 s <Space> Normal and Visual | |
| 712 | 8916 h "h" Normal and Visual (not recommended) |
| 8917 l "l" Normal and Visual (not recommended) | |
| 7 | 8918 < <Left> Normal and Visual |
| 8919 > <Right> Normal and Visual | |
| 8920 ~ "~" Normal | |
| 8921 [ <Left> Insert and Replace | |
| 8922 ] <Right> Insert and Replace | |
| 8923 For example: > | |
| 8924 :set ww=<,>,[,] | |
| 8925 < allows wrap only when cursor keys are used. | |
| 8926 When the movement keys are used in combination with a delete or change | |
| 8927 operator, the <EOL> also counts for a character. This makes "3h" | |
| 8928 different from "3dh" when the cursor crosses the end of a line. This | |
| 8929 is also true for "x" and "X", because they do the same as "dl" and | |
| 8930 "dh". If you use this, you may also want to use the mapping | |
| 8931 ":map <BS> X" to make backspace delete the character in front of the | |
| 8932 cursor. | |
| 714 | 8933 When 'l' is included and it is used after an operator at the end of a |
| 18130 | 8934 line (not an empty line) then it will not move to the next line. This |
| 8935 makes "dl", "cl", "yl" etc. work normally. | |
| 7 | 8936 NOTE: This option is set to the Vi default value when 'compatible' is |
| 8937 set and to the Vim default value when 'compatible' is reset. | |
| 8938 | |
| 8939 *'wildchar'* *'wc'* | |
| 8940 'wildchar' 'wc' number (Vim default: <Tab>, Vi default: CTRL-E) | |
| 8941 global | |
| 8942 Character you have to type to start wildcard expansion in the | |
| 8943 command-line, as specified with 'wildmode'. | |
| 1621 | 8944 More info here: |cmdline-completion|. |
| 7 | 8945 The character is not recognized when used inside a macro. See |
| 8946 'wildcharm' for that. | |
| 25836 | 8947 Some keys will not work, such as CTRL-C, <CR> and Enter. |
| 7 | 8948 Although 'wc' is a number option, you can set it to a special key: > |
| 25836 | 8949 :set wc=<Tab> |
| 7 | 8950 < NOTE: This option is set to the Vi default value when 'compatible' is |
| 8951 set and to the Vim default value when 'compatible' is reset. | |
| 8952 | |
| 8953 *'wildcharm'* *'wcm'* | |
| 8954 'wildcharm' 'wcm' number (default: none (0)) | |
| 8955 global | |
| 8956 'wildcharm' works exactly like 'wildchar', except that it is | |
| 233 | 8957 recognized when used inside a macro. You can find "spare" command-line |
| 8958 keys suitable for this option by looking at |ex-edit-index|. Normally | |
| 7 | 8959 you'll never actually type 'wildcharm', just use it in mappings that |
| 8960 automatically invoke completion mode, e.g.: > | |
| 8961 :set wcm=<C-Z> | |
| 1621 | 8962 :cnoremap ss so $vim/sessions/*.vim<C-Z> |
| 7 | 8963 < Then after typing :ss you can use CTRL-P & CTRL-N. |
| 8964 | |
| 8965 *'wildignore'* *'wig'* | |
| 8966 'wildignore' 'wig' string (default "") | |
| 8967 global | |
| 8968 {not available when compiled without the |+wildignore| | |
| 8969 feature} | |
| 8970 A list of file patterns. A file that matches with one of these | |
| 3682 | 8971 patterns is ignored when expanding |wildcards|, completing file or |
| 8972 directory names, and influences the result of |expand()|, |glob()| and | |
| 8973 |globpath()| unless a flag is passed to disable this. | |
| 7 | 8974 The pattern is used like with |:autocmd|, see |autocmd-patterns|. |
| 8975 Also see 'suffixes'. | |
| 8976 Example: > | |
| 8977 :set wildignore=*.o,*.obj | |
| 8978 < The use of |:set+=| and |:set-=| is preferred when adding or removing | |
| 8979 a pattern from the list. This avoids problems when a future version | |
| 8980 uses another default. | |
| 8981 | |
| 2652 | 8982 |
| 2662 | 8983 *'wildignorecase'* *'wic'* *'nowildignorecase'* *'nowic'* |
| 2652 | 8984 'wildignorecase' 'wic' boolean (default off) |
| 8985 global | |
| 8986 When set case is ignored when completing file names and directories. | |
| 4242 | 8987 Has no effect when 'fileignorecase' is set. |
| 2652 | 8988 Does not apply when the shell is used to expand wildcards, which |
| 8989 happens when there are special characters. | |
| 8990 | |
| 8991 | |
| 7 | 8992 *'wildmenu'* *'wmnu'* *'nowildmenu'* *'nowmnu'* |
|
9669
284b4eb307fc
commit https://github.com/vim/vim/commit/8c08b5b569e2a9e9f63dea514591ecfa2d3bb392
Christian Brabandt <cb@256bit.org>
parents:
9665
diff
changeset
|
8993 'wildmenu' 'wmnu' boolean (default off, set in |defaults.vim|) |
| 7 | 8994 global |
| 8995 {not available if compiled without the |+wildmenu| | |
| 8996 feature} | |
| 8997 When 'wildmenu' is on, command-line completion operates in an enhanced | |
| 8998 mode. On pressing 'wildchar' (usually <Tab>) to invoke completion, | |
| 8999 the possible matches are shown just above the command line, with the | |
| 9000 first match highlighted (overwriting the status line, if there is | |
|
27597
4eb2bf8b2f27
patch 8.2.4325: 'wildmenu' only shows few matches
Bram Moolenaar <Bram@vim.org>
parents:
27537
diff
changeset
|
9001 one). This is the behavior without "pum" in 'wildoptions. |
|
4eb2bf8b2f27
patch 8.2.4325: 'wildmenu' only shows few matches
Bram Moolenaar <Bram@vim.org>
parents:
27537
diff
changeset
|
9002 Keys that show the previous/next match, such as <Tab> or |
| 7 | 9003 CTRL-P/CTRL-N, cause the highlight to move to the appropriate match. |
| 9004 When 'wildmode' is used, "wildmenu" mode is used where "full" is | |
| 9005 specified. "longest" and "list" do not start "wildmenu" mode. | |
| 4159 | 9006 You can check the current mode with |wildmenumode()|. |
| 7 | 9007 If there are more matches than can fit in the line, a ">" is shown on |
| 9008 the right and/or a "<" is shown on the left. The status line scrolls | |
| 9009 as needed. | |
|
27597
4eb2bf8b2f27
patch 8.2.4325: 'wildmenu' only shows few matches
Bram Moolenaar <Bram@vim.org>
parents:
27537
diff
changeset
|
9010 When 'wildoptions' contains "pum", then the completion matches are |
|
4eb2bf8b2f27
patch 8.2.4325: 'wildmenu' only shows few matches
Bram Moolenaar <Bram@vim.org>
parents:
27537
diff
changeset
|
9011 shown in a popup menu. |
| 7 | 9012 The "wildmenu" mode is abandoned when a key is hit that is not used |
| 9013 for selecting a completion. | |
|
27597
4eb2bf8b2f27
patch 8.2.4325: 'wildmenu' only shows few matches
Bram Moolenaar <Bram@vim.org>
parents:
27537
diff
changeset
|
9014 While the "wildmenu" is active, not using the popup menu, the |
|
4eb2bf8b2f27
patch 8.2.4325: 'wildmenu' only shows few matches
Bram Moolenaar <Bram@vim.org>
parents:
27537
diff
changeset
|
9015 following keys have special meanings: |
| 7 | 9016 |
| 9017 <Left> <Right> - select previous/next match (like CTRL-P/CTRL-N) | |
| 9018 <Down> - in filename/menu name completion: move into a | |
| 9019 subdirectory or submenu. | |
| 9020 <CR> - in menu completion, when the cursor is just after a | |
| 9021 dot: move into a submenu. | |
| 9022 <Up> - in filename/menu name completion: move up into | |
| 9023 parent directory or parent menu. | |
| 9024 | |
|
27597
4eb2bf8b2f27
patch 8.2.4325: 'wildmenu' only shows few matches
Bram Moolenaar <Bram@vim.org>
parents:
27537
diff
changeset
|
9025 When using the popup menu for command line completion, the following |
|
4eb2bf8b2f27
patch 8.2.4325: 'wildmenu' only shows few matches
Bram Moolenaar <Bram@vim.org>
parents:
27537
diff
changeset
|
9026 keys have special meanings: |
|
4eb2bf8b2f27
patch 8.2.4325: 'wildmenu' only shows few matches
Bram Moolenaar <Bram@vim.org>
parents:
27537
diff
changeset
|
9027 <Down> - select next match (like CTRL-N) |
|
4eb2bf8b2f27
patch 8.2.4325: 'wildmenu' only shows few matches
Bram Moolenaar <Bram@vim.org>
parents:
27537
diff
changeset
|
9028 <Left> - in filename/menu name completion: move up into |
|
4eb2bf8b2f27
patch 8.2.4325: 'wildmenu' only shows few matches
Bram Moolenaar <Bram@vim.org>
parents:
27537
diff
changeset
|
9029 parent directory or parent menu. |
|
4eb2bf8b2f27
patch 8.2.4325: 'wildmenu' only shows few matches
Bram Moolenaar <Bram@vim.org>
parents:
27537
diff
changeset
|
9030 <Right> - in filename/menu name completion: move into a |
|
4eb2bf8b2f27
patch 8.2.4325: 'wildmenu' only shows few matches
Bram Moolenaar <Bram@vim.org>
parents:
27537
diff
changeset
|
9031 subdirectory or submenu. |
|
4eb2bf8b2f27
patch 8.2.4325: 'wildmenu' only shows few matches
Bram Moolenaar <Bram@vim.org>
parents:
27537
diff
changeset
|
9032 <Up> - select previous match (like CTRL-P) |
|
4eb2bf8b2f27
patch 8.2.4325: 'wildmenu' only shows few matches
Bram Moolenaar <Bram@vim.org>
parents:
27537
diff
changeset
|
9033 CTRL-E - end completion, go back to what was there before |
|
4eb2bf8b2f27
patch 8.2.4325: 'wildmenu' only shows few matches
Bram Moolenaar <Bram@vim.org>
parents:
27537
diff
changeset
|
9034 selecting a match. |
|
4eb2bf8b2f27
patch 8.2.4325: 'wildmenu' only shows few matches
Bram Moolenaar <Bram@vim.org>
parents:
27537
diff
changeset
|
9035 CTRL-N - go to the next entry |
|
4eb2bf8b2f27
patch 8.2.4325: 'wildmenu' only shows few matches
Bram Moolenaar <Bram@vim.org>
parents:
27537
diff
changeset
|
9036 CTRL-P - go to the previous entry |
|
4eb2bf8b2f27
patch 8.2.4325: 'wildmenu' only shows few matches
Bram Moolenaar <Bram@vim.org>
parents:
27537
diff
changeset
|
9037 CTRL-Y - accept the currently selected match and stop |
|
4eb2bf8b2f27
patch 8.2.4325: 'wildmenu' only shows few matches
Bram Moolenaar <Bram@vim.org>
parents:
27537
diff
changeset
|
9038 completion. |
|
4eb2bf8b2f27
patch 8.2.4325: 'wildmenu' only shows few matches
Bram Moolenaar <Bram@vim.org>
parents:
27537
diff
changeset
|
9039 |
| 7 | 9040 This makes the menus accessible from the console |console-menus|. |
| 9041 | |
| 9042 If you prefer the <Left> and <Right> keys to move the cursor instead | |
| 9043 of selecting a different match, use this: > | |
| 9044 :cnoremap <Left> <Space><BS><Left> | |
| 9045 :cnoremap <Right> <Space><BS><Right> | |
| 9046 < | |
| 9047 The "WildMenu" highlighting is used for displaying the current match | |
| 9048 |hl-WildMenu|. | |
| 9049 | |
| 9050 *'wildmode'* *'wim'* | |
| 9051 'wildmode' 'wim' string (Vim default: "full") | |
| 9052 global | |
| 9053 Completion mode that is used for the character specified with | |
| 10 | 9054 'wildchar'. It is a comma separated list of up to four parts. Each |
| 1152 | 9055 part specifies what to do for each consecutive use of 'wildchar'. The |
| 7 | 9056 first part specifies the behavior for the first use of 'wildchar', |
| 9057 The second part for the second use, etc. | |
| 24387 | 9058 |
| 9059 Each part consists of a colon separated list consisting of the | |
| 9060 following possible values: | |
| 7 | 9061 "" Complete only the first match. |
| 9062 "full" Complete the next full match. After the last match, | |
| 9063 the original string is used and then the first match | |
| 24387 | 9064 again. Will also start 'wildmenu' if it is enabled. |
| 7 | 9065 "longest" Complete till longest common string. If this doesn't |
| 9066 result in a longer string, use the next part. | |
| 24387 | 9067 "list" When more than one match, list all matches. |
| 9068 "lastused" When completing buffer names and more than one buffer | |
| 9069 matches, sort buffers by time last used (other than | |
| 9070 the current buffer). | |
| 9071 When there is only a single match, it is fully completed in all cases. | |
| 9072 | |
| 9073 Examples of useful colon-separated values: | |
| 7 | 9074 "longest:full" Like "longest", but also start 'wildmenu' if it is |
| 24387 | 9075 enabled. Will not complete to the next full match. |
| 7 | 9076 "list:full" When more than one match, list all matches and |
| 9077 complete first match. | |
| 9078 "list:longest" When more than one match, list all matches and | |
| 9079 complete till longest common string. | |
| 24387 | 9080 "list:lastused" When more than one buffer matches, list all matches |
| 9081 and sort buffers by time last used (other than the | |
| 9082 current buffer). | |
| 7 | 9083 |
| 9084 Examples: > | |
| 9085 :set wildmode=full | |
| 233 | 9086 < Complete first full match, next match, etc. (the default) > |
| 7 | 9087 :set wildmode=longest,full |
| 9088 < Complete longest common string, then each full match > | |
| 9089 :set wildmode=list:full | |
| 9090 < List all matches and complete each full match > | |
| 9091 :set wildmode=list,full | |
| 9092 < List all matches without completing, then each full match > | |
| 9093 :set wildmode=longest,list | |
| 9094 < Complete longest common string, then list alternatives. | |
| 1621 | 9095 More info here: |cmdline-completion|. |
| 7 | 9096 |
| 40 | 9097 *'wildoptions'* *'wop'* |
| 9098 'wildoptions' 'wop' string (default "") | |
| 9099 global | |
| 9100 {not available when compiled without the |+wildignore| | |
| 9101 feature} | |
|
27597
4eb2bf8b2f27
patch 8.2.4325: 'wildmenu' only shows few matches
Bram Moolenaar <Bram@vim.org>
parents:
27537
diff
changeset
|
9102 A list of words that change how |cmdline-completion| is done. |
|
4eb2bf8b2f27
patch 8.2.4325: 'wildmenu' only shows few matches
Bram Moolenaar <Bram@vim.org>
parents:
27537
diff
changeset
|
9103 The following values are supported: |
| 28010 | 9104 fuzzy Use |fuzzy-matching| to find completion matches. When |
|
27875
ae38d2e81fca
patch 8.2.4463: completion only uses strict matching
Bram Moolenaar <Bram@vim.org>
parents:
27804
diff
changeset
|
9105 this value is specified, wildcard expansion will not |
|
ae38d2e81fca
patch 8.2.4463: completion only uses strict matching
Bram Moolenaar <Bram@vim.org>
parents:
27804
diff
changeset
|
9106 be used for completion. The matches will be sorted by |
|
ae38d2e81fca
patch 8.2.4463: completion only uses strict matching
Bram Moolenaar <Bram@vim.org>
parents:
27804
diff
changeset
|
9107 the "best match" rather than alphabetically sorted. |
|
ae38d2e81fca
patch 8.2.4463: completion only uses strict matching
Bram Moolenaar <Bram@vim.org>
parents:
27804
diff
changeset
|
9108 This will find more matches than the wildcard |
|
ae38d2e81fca
patch 8.2.4463: completion only uses strict matching
Bram Moolenaar <Bram@vim.org>
parents:
27804
diff
changeset
|
9109 expansion. Currently fuzzy matching based completion |
|
ae38d2e81fca
patch 8.2.4463: completion only uses strict matching
Bram Moolenaar <Bram@vim.org>
parents:
27804
diff
changeset
|
9110 is not supported for file and directory names and |
|
ae38d2e81fca
patch 8.2.4463: completion only uses strict matching
Bram Moolenaar <Bram@vim.org>
parents:
27804
diff
changeset
|
9111 instead wildcard expansion is used. |
|
27597
4eb2bf8b2f27
patch 8.2.4325: 'wildmenu' only shows few matches
Bram Moolenaar <Bram@vim.org>
parents:
27537
diff
changeset
|
9112 pum Display the completion matches using the popupmenu |
|
4eb2bf8b2f27
patch 8.2.4325: 'wildmenu' only shows few matches
Bram Moolenaar <Bram@vim.org>
parents:
27537
diff
changeset
|
9113 in the same style as the |ins-completion-menu|. |
| 40 | 9114 tagfile When using CTRL-D to list matching tags, the kind of |
| 856 | 9115 tag and the file of the tag is listed. Only one match |
| 40 | 9116 is displayed per line. Often used tag kinds are: |
| 9117 d #define | |
| 9118 f function | |
| 9119 | |
| 7 | 9120 *'winaltkeys'* *'wak'* |
| 9121 'winaltkeys' 'wak' string (default "menu") | |
| 9122 global | |
| 9123 {only used in Win32, Motif, GTK and Photon GUI} | |
| 9124 Some GUI versions allow the access to menu entries by using the ALT | |
| 9125 key in combination with a character that appears underlined in the | |
| 9126 menu. This conflicts with the use of the ALT key for mappings and | |
| 9127 entering special characters. This option tells what to do: | |
| 9128 no Don't use ALT keys for menus. ALT key combinations can be | |
| 9129 mapped, but there is no automatic handling. This can then be | |
| 9130 done with the |:simalt| command. | |
| 9131 yes ALT key handling is done by the windowing system. ALT key | |
| 9132 combinations cannot be mapped. | |
| 9133 menu Using ALT in combination with a character that is a menu | |
| 10 | 9134 shortcut key, will be handled by the windowing system. Other |
| 7 | 9135 keys can be mapped. |
| 9136 If the menu is disabled by excluding 'm' from 'guioptions', the ALT | |
| 9137 key is never used for the menu. | |
| 36 | 9138 This option is not used for <F10>; on Win32 and with GTK <F10> will |
| 9139 select the menu, unless it has been mapped. | |
| 7 | 9140 |
|
16778
eda4d65f232c
patch 8.1.1391: no popup window support
Bram Moolenaar <Bram@vim.org>
parents:
16740
diff
changeset
|
9141 *'wincolor'* *'wcr'* |
|
eda4d65f232c
patch 8.1.1391: no popup window support
Bram Moolenaar <Bram@vim.org>
parents:
16740
diff
changeset
|
9142 'wincolor' 'wcr' string (default empty) |
|
eda4d65f232c
patch 8.1.1391: no popup window support
Bram Moolenaar <Bram@vim.org>
parents:
16740
diff
changeset
|
9143 local to window |
|
eda4d65f232c
patch 8.1.1391: no popup window support
Bram Moolenaar <Bram@vim.org>
parents:
16740
diff
changeset
|
9144 Highlight group name to use for this window instead of the Normal |
|
eda4d65f232c
patch 8.1.1391: no popup window support
Bram Moolenaar <Bram@vim.org>
parents:
16740
diff
changeset
|
9145 color |hl-Normal|. |
|
eda4d65f232c
patch 8.1.1391: no popup window support
Bram Moolenaar <Bram@vim.org>
parents:
16740
diff
changeset
|
9146 |
| 164 | 9147 *'window'* *'wi'* |
| 9148 'window' 'wi' number (default screen height - 1) | |
| 9149 global | |
| 24278 | 9150 Window height used for |CTRL-F| and |CTRL-B| when there is only one |
| 9151 window and the value is smaller than 'lines' minus one. The screen | |
| 9152 will scroll 'window' minus two lines, with a minimum of one. | |
| 164 | 9153 When 'window' is equal to 'lines' minus one CTRL-F and CTRL-B scroll |
| 9154 in a much smarter way, taking care of wrapping lines. | |
| 9155 When resizing the Vim window, the value is smaller than 1 or more than | |
| 9156 or equal to 'lines' it will be set to 'lines' minus 1. | |
| 24278 | 9157 Note: Do not confuse this with the height of the Vim window, use |
| 9158 'lines' for that. | |
| 164 | 9159 |
| 7 | 9160 *'winheight'* *'wh'* *E591* |
| 9161 'winheight' 'wh' number (default 1) | |
| 9162 global | |
| 9163 Minimal number of lines for the current window. This is not a hard | |
| 10 | 9164 minimum, Vim will use fewer lines if there is not enough room. If the |
| 1621 | 9165 focus goes to a window that is smaller, its size is increased, at the |
| 9166 cost of the height of other windows. | |
| 9167 Set 'winheight' to a small number for normal editing. | |
| 9168 Set it to 999 to make the current window fill most of the screen. | |
| 9169 Other windows will be only 'winminheight' high. This has the drawback | |
| 9170 that ":all" will create only two windows. To avoid "vim -o 1 2 3 4" | |
| 9171 to create only two windows, set the option after startup is done, | |
| 9172 using the |VimEnter| event: > | |
| 9173 au VimEnter * set winheight=999 | |
| 9174 < Minimum value is 1. | |
| 9175 The height is not adjusted after one of the commands that change the | |
| 7 | 9176 height of the current window. |
| 9177 'winheight' applies to the current window. Use 'winminheight' to set | |
| 9178 the minimal height for other windows. | |
| 9179 | |
| 9180 *'winfixheight'* *'wfh'* *'nowinfixheight'* *'nowfh'* | |
| 9181 'winfixheight' 'wfh' boolean (default off) | |
| 9182 local to window | |
| 9183 Keep the window height when windows are opened or closed and | |
| 1152 | 9184 'equalalways' is set. Also for |CTRL-W_=|. Set by default for the |
| 9185 |preview-window| and |quickfix-window|. | |
| 7 | 9186 The height may be changed anyway when running out of room. |
| 9187 | |
| 782 | 9188 *'winfixwidth'* *'wfw'* *'nowinfixwidth'* *'nowfw'* |
| 9189 'winfixwidth' 'wfw' boolean (default off) | |
| 9190 local to window | |
| 9191 Keep the window width when windows are opened or closed and | |
| 1152 | 9192 'equalalways' is set. Also for |CTRL-W_=|. |
| 782 | 9193 The width may be changed anyway when running out of room. |
| 9194 | |
| 7 | 9195 *'winminheight'* *'wmh'* |
| 9196 'winminheight' 'wmh' number (default 1) | |
| 9197 global | |
| 9198 The minimal height of a window, when it's not the current window. | |
| 9199 This is a hard minimum, windows will never become smaller. | |
| 9200 When set to zero, windows may be "squashed" to zero lines (i.e. just a | |
| 9201 status bar) if necessary. They will return to at least one line when | |
| 9202 they become active (since the cursor has to have somewhere to go.) | |
| 9203 Use 'winheight' to set the minimal height of the current window. | |
| 9204 This option is only checked when making a window smaller. Don't use a | |
| 9205 large number, it will cause errors when opening more than a few | |
| 9206 windows. A value of 0 to 3 is reasonable. | |
| 9207 | |
| 9208 *'winminwidth'* *'wmw'* | |
| 9209 'winminwidth' 'wmw' number (default 1) | |
| 9210 global | |
| 9211 The minimal width of a window, when it's not the current window. | |
| 9212 This is a hard minimum, windows will never become smaller. | |
| 9213 When set to zero, windows may be "squashed" to zero columns (i.e. just | |
| 9214 a vertical separator) if necessary. They will return to at least one | |
| 9215 line when they become active (since the cursor has to have somewhere | |
| 9216 to go.) | |
| 9217 Use 'winwidth' to set the minimal width of the current window. | |
| 9218 This option is only checked when making a window smaller. Don't use a | |
| 9219 large number, it will cause errors when opening more than a few | |
| 9220 windows. A value of 0 to 12 is reasonable. | |
| 9221 | |
|
12138
bee3751f3d4e
patch 8.0.0949: winpty.dll name is fixed
Christian Brabandt <cb@256bit.org>
parents:
11914
diff
changeset
|
9222 *'winptydll'* |
|
bee3751f3d4e
patch 8.0.0949: winpty.dll name is fixed
Christian Brabandt <cb@256bit.org>
parents:
11914
diff
changeset
|
9223 'winptydll' string (default "winpty32.dll" or "winpty64.dll") |
|
bee3751f3d4e
patch 8.0.0949: winpty.dll name is fixed
Christian Brabandt <cb@256bit.org>
parents:
11914
diff
changeset
|
9224 global |
|
bee3751f3d4e
patch 8.0.0949: winpty.dll name is fixed
Christian Brabandt <cb@256bit.org>
parents:
11914
diff
changeset
|
9225 {only available when compiled with the |terminal| |
|
bee3751f3d4e
patch 8.0.0949: winpty.dll name is fixed
Christian Brabandt <cb@256bit.org>
parents:
11914
diff
changeset
|
9226 feature on MS-Windows} |
|
bee3751f3d4e
patch 8.0.0949: winpty.dll name is fixed
Christian Brabandt <cb@256bit.org>
parents:
11914
diff
changeset
|
9227 Specifies the name of the winpty shared library, used for the |
| 21676 | 9228 |:terminal| command. The default depends on whether Vim was built as a |
| 12254 | 9229 32-bit or 64-bit executable. If not found, "winpty.dll" is tried as |
|
12138
bee3751f3d4e
patch 8.0.0949: winpty.dll name is fixed
Christian Brabandt <cb@256bit.org>
parents:
11914
diff
changeset
|
9230 a fallback. |
|
bee3751f3d4e
patch 8.0.0949: winpty.dll name is fixed
Christian Brabandt <cb@256bit.org>
parents:
11914
diff
changeset
|
9231 Environment variables are expanded |:set_env|. |
|
bee3751f3d4e
patch 8.0.0949: winpty.dll name is fixed
Christian Brabandt <cb@256bit.org>
parents:
11914
diff
changeset
|
9232 This option cannot be set from a |modeline| or in the |sandbox|, for |
|
bee3751f3d4e
patch 8.0.0949: winpty.dll name is fixed
Christian Brabandt <cb@256bit.org>
parents:
11914
diff
changeset
|
9233 security reasons. |
|
bee3751f3d4e
patch 8.0.0949: winpty.dll name is fixed
Christian Brabandt <cb@256bit.org>
parents:
11914
diff
changeset
|
9234 |
| 7 | 9235 *'winwidth'* *'wiw'* *E592* |
| 9236 'winwidth' 'wiw' number (default 20) | |
| 9237 global | |
| 9238 Minimal number of columns for the current window. This is not a hard | |
| 9239 minimum, Vim will use fewer columns if there is not enough room. If | |
| 9240 the current window is smaller, its size is increased, at the cost of | |
| 9241 the width of other windows. Set it to 999 to make the current window | |
| 9242 always fill the screen. Set it to a small number for normal editing. | |
| 9243 The width is not adjusted after one of the commands to change the | |
| 9244 width of the current window. | |
| 9245 'winwidth' applies to the current window. Use 'winminwidth' to set | |
| 9246 the minimal width for other windows. | |
| 9247 | |
| 9248 *'wrap'* *'nowrap'* | |
| 9249 'wrap' boolean (default on) | |
| 9250 local to window | |
| 9251 This option changes how text is displayed. It doesn't change the text | |
| 9252 in the buffer, see 'textwidth' for that. | |
| 9253 When on, lines longer than the width of the window will wrap and | |
| 10 | 9254 displaying continues on the next line. When off lines will not wrap |
| 9255 and only part of long lines will be displayed. When the cursor is | |
| 7 | 9256 moved to a part that is not shown, the screen will scroll |
| 9257 horizontally. | |
| 9258 The line will be broken in the middle of a word if necessary. See | |
| 9259 'linebreak' to get the break at a word boundary. | |
| 9260 To make scrolling horizontally a bit more useful, try this: > | |
| 9261 :set sidescroll=5 | |
| 9262 :set listchars+=precedes:<,extends:> | |
| 9263 < See 'sidescroll', 'listchars' and |wrap-off|. | |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
9264 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
|
9265 on. |
| 7 | 9266 |
| 9267 *'wrapmargin'* *'wm'* | |
| 9268 'wrapmargin' 'wm' number (default 0) | |
| 9269 local to buffer | |
| 9270 Number of characters from the right window border where wrapping | |
| 9271 starts. When typing text beyond this limit, an <EOL> will be inserted | |
| 9272 and inserting continues on the next line. | |
| 9273 Options that add a margin, such as 'number' and 'foldcolumn', cause | |
| 9274 the text width to be further reduced. This is Vi compatible. | |
| 9275 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
|
9276 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
|
9277 is reset. |
| 16610 | 9278 See also 'formatoptions' and |ins-textwidth|. |
| 7 | 9279 |
| 9280 *'wrapscan'* *'ws'* *'nowrapscan'* *'nows'* | |
| 9281 'wrapscan' 'ws' boolean (default on) *E384* *E385* | |
| 9282 global | |
| 500 | 9283 Searches wrap around the end of the file. Also applies to |]s| and |
| 9284 |[s|, searching for spelling mistakes. | |
| 7 | 9285 |
| 9286 *'write'* *'nowrite'* | |
| 9287 'write' boolean (default on) | |
| 9288 global | |
| 9289 Allows writing files. When not set, writing a file is not allowed. | |
| 9290 Can be used for a view-only mode, where modifications to the text are | |
| 10 | 9291 still allowed. Can be reset with the |-m| or |-M| command line |
| 7 | 9292 argument. Filtering text is still possible, even though this requires |
| 9293 writing a temporary file. | |
| 9294 | |
| 9295 *'writeany'* *'wa'* *'nowriteany'* *'nowa'* | |
| 9296 'writeany' 'wa' boolean (default off) | |
| 9297 global | |
| 9298 Allows writing to any file with no need for "!" override. | |
| 9299 | |
| 9300 *'writebackup'* *'wb'* *'nowritebackup'* *'nowb'* | |
| 9301 'writebackup' 'wb' boolean (default on with |+writebackup| feature, off | |
| 9302 otherwise) | |
| 9303 global | |
| 9304 Make a backup before overwriting a file. The backup is removed after | |
| 9305 the file was successfully written, unless the 'backup' option is | |
| 3513 | 9306 also on. |
| 9307 WARNING: Switching this option off means that when Vim fails to write | |
| 9308 your buffer correctly and then, for whatever reason, Vim exits, you | |
| 9309 lose both the original file and what you were writing. Only reset | |
| 9310 this option if your file system is almost full and it makes the write | |
| 9311 fail (and make sure not to exit Vim until the write was successful). | |
| 9312 See |backup-table| for another explanation. | |
| 7 | 9313 When the 'backupskip' pattern matches, a backup is not made anyway. |
| 18719 | 9314 Depending on 'backupcopy' the backup is a new file or the original |
| 9315 file renamed (and a new file is written). | |
| 7 | 9316 NOTE: This option is set to the default value when 'compatible' is |
| 9317 set. | |
| 9318 | |
| 9319 *'writedelay'* *'wd'* | |
| 9320 'writedelay' 'wd' number (default 0) | |
| 9321 global | |
|
9344
33c1b85d408c
commit https://github.com/vim/vim/commit/802a0d902fca423acb15f835d7b09183883d79a0
Christian Brabandt <cb@256bit.org>
parents:
9286
diff
changeset
|
9322 The number of milliseconds to wait for each character sent to the |
| 7 | 9323 screen. When non-zero, characters are sent to the terminal one by |
| 18972 | 9324 one. For debugging purposes. |
| 7 | 9325 |
|
26670
a77b661439f9
patch 8.2.3864: cannot disable requesting key codes from xterm
Bram Moolenaar <Bram@vim.org>
parents:
26508
diff
changeset
|
9326 *'xtermcodes'* *'noxtermcodes'* |
|
a77b661439f9
patch 8.2.3864: cannot disable requesting key codes from xterm
Bram Moolenaar <Bram@vim.org>
parents:
26508
diff
changeset
|
9327 'xtermcodes' boolean (default on) |
|
a77b661439f9
patch 8.2.3864: cannot disable requesting key codes from xterm
Bram Moolenaar <Bram@vim.org>
parents:
26508
diff
changeset
|
9328 global |
|
a77b661439f9
patch 8.2.3864: cannot disable requesting key codes from xterm
Bram Moolenaar <Bram@vim.org>
parents:
26508
diff
changeset
|
9329 When detecting xterm patchlevel 141 or higher with the termresponse |
| 26708 | 9330 mechanism and this option is set, Vim will request the actual terminal |
|
26670
a77b661439f9
patch 8.2.3864: cannot disable requesting key codes from xterm
Bram Moolenaar <Bram@vim.org>
parents:
26508
diff
changeset
|
9331 key codes and number of colors from the terminal. This takes care of |
|
a77b661439f9
patch 8.2.3864: cannot disable requesting key codes from xterm
Bram Moolenaar <Bram@vim.org>
parents:
26508
diff
changeset
|
9332 various configuration options of the terminal that cannot be obtained |
|
a77b661439f9
patch 8.2.3864: cannot disable requesting key codes from xterm
Bram Moolenaar <Bram@vim.org>
parents:
26508
diff
changeset
|
9333 from the termlib/terminfo entry, see |xterm-codes|. |
|
a77b661439f9
patch 8.2.3864: cannot disable requesting key codes from xterm
Bram Moolenaar <Bram@vim.org>
parents:
26508
diff
changeset
|
9334 A side effect may be that t_Co changes and Vim will redraw the |
|
a77b661439f9
patch 8.2.3864: cannot disable requesting key codes from xterm
Bram Moolenaar <Bram@vim.org>
parents:
26508
diff
changeset
|
9335 display. |
|
a77b661439f9
patch 8.2.3864: cannot disable requesting key codes from xterm
Bram Moolenaar <Bram@vim.org>
parents:
26508
diff
changeset
|
9336 |
|
a77b661439f9
patch 8.2.3864: cannot disable requesting key codes from xterm
Bram Moolenaar <Bram@vim.org>
parents:
26508
diff
changeset
|
9337 |
| 14421 | 9338 vim:tw=78:ts=8:noet:ft=help:norl: |