Mercurial > vim
annotate runtime/doc/options.txt @ 32132:059e89bf9316 v9.0.1397
patch 9.0.1397: highlight for popupmenu kind and extra cannot be set
Commit: https://github.com/vim/vim/commit/6a7c7749204b256e779c245b1e999bf852ad7b64
Author: Gianmaria Bajo <mg1979.git@gmail.com>
Date: Fri Mar 10 16:35:53 2023 +0000
patch 9.0.1397: highlight for popupmenu kind and extra cannot be set
Problem: Highlight for popupmenu kind and extra cannot be set.
Solution: Add PmenuKind, PmenuKindSel, PmenuExtra and PmenuExtraSel
highlight groups and use them. (Gianmaria Bajo, closes #12114)
| author | Bram Moolenaar <Bram@vim.org> |
|---|---|
| date | Fri, 10 Mar 2023 17:45:05 +0100 |
| parents | a9b5ffbc0428 |
| children | b2e8663e6dcc |
| rev | line source |
|---|---|
| 32004 | 1 *options.txt* For Vim version 9.0. Last change: 2023 Feb 17 |
| 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... | |
| 31579 | 37 The options have the form t_AB, see |
| 38 |terminal-options|. | |
| 7 | 39 |
| 26438 | 40 :se[t]! termcap Idem, but don't use multiple columns. |
| 41 | |
| 7 | 42 *E518* *E519* |
| 43 :se[t] {option}? Show value of {option}. | |
| 44 | |
| 45 :se[t] {option} Toggle option: set, switch it on. | |
| 46 Number option: show value. | |
| 47 String option: show value. | |
| 48 | |
| 49 :se[t] no{option} Toggle option: Reset, switch it off. | |
| 50 | |
| 2152 | 51 *:set-!* *:set-inv* |
| 7 | 52 :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
|
53 :se[t] inv{option} Toggle option: Invert value. |
| 7 | 54 |
| 55 *:set-default* *:set-&* *:set-&vi* *:set-&vim* | |
| 56 :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
|
57 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
|
58 :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
|
59 :se[t] {option}&vim Reset option to its Vim default value. |
| 7 | 60 |
|
13341
acd7eaa13d2b
Updated runtime files.
Christian Brabandt <cb@256bit.org>
parents:
13314
diff
changeset
|
61 :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
|
62 these options are not changed: |
|
eff26a8620ce
commit https://github.com/vim/vim/commit/88774fdd23f08355297bb8cda78856859051d3c7
Christian Brabandt <cb@256bit.org>
parents:
6949
diff
changeset
|
63 all terminal options, starting with t_ |
|
eff26a8620ce
commit https://github.com/vim/vim/commit/88774fdd23f08355297bb8cda78856859051d3c7
Christian Brabandt <cb@256bit.org>
parents:
6949
diff
changeset
|
64 'columns' |
|
eff26a8620ce
commit https://github.com/vim/vim/commit/88774fdd23f08355297bb8cda78856859051d3c7
Christian Brabandt <cb@256bit.org>
parents:
6949
diff
changeset
|
65 'cryptmethod' |
|
eff26a8620ce
commit https://github.com/vim/vim/commit/88774fdd23f08355297bb8cda78856859051d3c7
Christian Brabandt <cb@256bit.org>
parents:
6949
diff
changeset
|
66 'encoding' |
|
eff26a8620ce
commit https://github.com/vim/vim/commit/88774fdd23f08355297bb8cda78856859051d3c7
Christian Brabandt <cb@256bit.org>
parents:
6949
diff
changeset
|
67 'key' |
|
eff26a8620ce
commit https://github.com/vim/vim/commit/88774fdd23f08355297bb8cda78856859051d3c7
Christian Brabandt <cb@256bit.org>
parents:
6949
diff
changeset
|
68 'lines' |
|
eff26a8620ce
commit https://github.com/vim/vim/commit/88774fdd23f08355297bb8cda78856859051d3c7
Christian Brabandt <cb@256bit.org>
parents:
6949
diff
changeset
|
69 'term' |
|
eff26a8620ce
commit https://github.com/vim/vim/commit/88774fdd23f08355297bb8cda78856859051d3c7
Christian Brabandt <cb@256bit.org>
parents:
6949
diff
changeset
|
70 'ttymouse' |
|
eff26a8620ce
commit https://github.com/vim/vim/commit/88774fdd23f08355297bb8cda78856859051d3c7
Christian Brabandt <cb@256bit.org>
parents:
6949
diff
changeset
|
71 'ttytype' |
|
eff26a8620ce
commit https://github.com/vim/vim/commit/88774fdd23f08355297bb8cda78856859051d3c7
Christian Brabandt <cb@256bit.org>
parents:
6949
diff
changeset
|
72 Warning: This may have a lot of side effects. |
| 7 | 73 |
| 74 *:set-args* *E487* *E521* | |
| 75 :se[t] {option}={value} or | |
| 76 :se[t] {option}:{value} | |
| 77 Set string or number option to {value}. | |
| 78 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
|
79 hex (preceded with 0x) or octal (preceded with '0'). |
| 7 | 80 The old value can be inserted by typing 'wildchar' (by |
| 81 default this is a <Tab> or CTRL-E if 'compatible' is | |
| 82 set). See |cmdline-completion|. | |
| 83 White space between {option} and '=' is allowed and | |
| 84 will be ignored. White space between '=' and {value} | |
| 85 is not allowed. | |
| 86 See |option-backslash| for using white space and | |
| 87 backslashes in {value}. | |
| 88 | |
| 89 :se[t] {option}+={value} *:set+=* | |
| 90 Add the {value} to a number option, or append the | |
| 91 {value} to a string option. When the option is a | |
| 28379 | 92 comma-separated list, a comma is added, unless the |
| 7 | 93 value was empty. |
| 94 If the option is a list of flags, superfluous flags | |
| 557 | 95 are removed. When adding a flag that was already |
| 96 present the option value doesn't change. | |
| 809 | 97 Also see |:set-args| above. |
| 7 | 98 |
| 99 :se[t] {option}^={value} *:set^=* | |
| 100 Multiply the {value} to a number option, or prepend | |
| 101 the {value} to a string option. When the option is a | |
| 28379 | 102 comma-separated list, a comma is added, unless the |
| 7 | 103 value was empty. |
| 104 Also see |:set-args| above. | |
| 105 | |
| 106 :se[t] {option}-={value} *:set-=* | |
| 107 Subtract the {value} from a number option, or remove | |
| 108 the {value} from a string option, if it is there. | |
| 109 If the {value} is not found in a string option, there | |
| 110 is no error or warning. When the option is a comma | |
| 111 separated list, a comma is deleted, unless the option | |
| 112 becomes empty. | |
| 113 When the option is a list of flags, {value} must be | |
| 114 exactly as they appear in the option. Remove flags | |
| 115 one by one to avoid problems. | |
| 116 Also see |:set-args| above. | |
| 117 | |
| 118 The {option} arguments to ":set" may be repeated. For example: > | |
| 119 :set ai nosi sw=3 ts=3 | |
| 120 If you make an error in one of the arguments, an error message will be given | |
| 121 and the following arguments will be ignored. | |
| 122 | |
| 123 *:set-verbose* | |
| 124 When 'verbose' is non-zero, displaying an option value will also tell where it | |
| 125 was last set. Example: > | |
| 126 :verbose set shiftwidth cindent? | |
| 14864 | 127 < shiftwidth=4 ~ |
| 128 Last set from modeline line 1 ~ | |
| 129 cindent ~ | |
| 130 Last set from /usr/local/share/vim/vim60/ftplugin/c.vim line 30 ~ | |
| 1621 | 131 This is only done when specific option values are requested, not for ":verbose |
| 132 set all" or ":verbose set" without an argument. | |
| 133 When the option was set by hand there is no "Last set" message. | |
| 7 | 134 When the option was set while executing a function, user command or |
| 135 autocommand, the script in which it was defined is reported. | |
| 136 Note that an option may also have been set as a side effect of setting | |
| 137 'compatible'. | |
| 1621 | 138 A few special texts: |
| 14864 | 139 Last set from modeline line 1 ~ |
| 1621 | 140 Option was set in a |modeline|. |
| 141 Last set from --cmd argument ~ | |
| 142 Option was set with command line argument |--cmd| or +. | |
| 143 Last set from -c argument ~ | |
| 144 Option was set with command line argument |-c|, +, |-S| or | |
| 145 |-q|. | |
| 146 Last set from environment variable ~ | |
| 147 Option was set from an environment variable, $VIMINIT, | |
| 148 $GVIMINIT or $EXINIT. | |
| 149 Last set from error handler ~ | |
| 150 Option was cleared when evaluating it resulted in an error. | |
| 151 | |
|
2570
71b56b4e7785
Make the references to features in the help more consistent. (Sylvain Hitier)
Bram Moolenaar <bram@vim.org>
parents:
2561
diff
changeset
|
152 {not available when compiled without the |+eval| feature} |
| 7 | 153 |
| 154 *:set-termcap* *E522* | |
| 667 | 155 For {option} the form "t_xx" may be used to set a terminal option. This will |
| 7 | 156 override the value from the termcap. You can then use it in a mapping. If |
| 157 the "xx" part contains special characters, use the <t_xx> form: > | |
| 158 :set <t_#4>=^[Ot | |
| 159 This can also be used to translate a special code for a normal key. For | |
| 160 example, if Alt-b produces <Esc>b, use this: > | |
| 161 :set <M-b>=^[b | |
| 162 (the ^[ is a real <Esc> here, use CTRL-V <Esc> to enter it) | |
| 163 The advantage over a mapping is that it works in all situations. | |
| 164 | |
| 2726 | 165 You can define any key codes, e.g.: > |
| 166 :set t_xy=^[foo; | |
| 167 There is no warning for using a name that isn't recognized. You can map these | |
| 168 codes as you like: > | |
| 169 :map <t_xy> something | |
| 170 < *E846* | |
| 171 When a key code is not set, it's like it does not exist. Trying to get its | |
| 172 value will result in an error: > | |
| 173 :set t_kb= | |
| 174 :set t_kb | |
| 27321 | 175 < E846: Key code not set: t_kb ~ |
| 2726 | 176 |
| 36 | 177 The t_xx options cannot be set from a |modeline| or in the |sandbox|, for |
| 178 security reasons. | |
| 179 | |
| 7 | 180 The listing from ":set" looks different from Vi. Long string options are put |
| 10 | 181 at the end of the list. The number of options is quite large. The output of |
| 7 | 182 "set all" probably does not fit on the screen, causing Vim to give the |
| 183 |more-prompt|. | |
| 184 | |
| 185 *option-backslash* | |
| 186 To include white space in a string option value it has to be preceded with a | |
| 187 backslash. To include a backslash you have to use two. Effectively this | |
| 188 means that the number of backslashes in an option value is halved (rounded | |
| 189 down). | |
| 190 A few examples: > | |
| 191 :set tags=tags\ /usr/tags results in "tags /usr/tags" | |
| 192 :set tags=tags\\,file results in "tags\,file" | |
| 193 :set tags=tags\\\ file results in "tags\ file" | |
| 194 | |
| 10 | 195 The "|" character separates a ":set" command from a following command. To |
| 196 include the "|" in the option value, use "\|" instead. This example sets the | |
| 7 | 197 'titlestring' option to "hi|there": > |
| 198 :set titlestring=hi\|there | |
| 199 This sets the 'titlestring' option to "hi" and 'iconstring' to "there": > | |
| 200 :set titlestring=hi|set iconstring=there | |
| 201 | |
| 25700 | 202 Similarly, in legacy script the double quote character starts a comment. To |
| 203 include the '"' in the option value, use '\"' instead. This example sets the | |
| 204 'titlestring' option to 'hi "there"': > | |
| 642 | 205 :set titlestring=hi\ \"there\" |
| 206 | |
| 25700 | 207 In |Vim9| script it's simpler, comments start with a '#' character, and only |
| 208 when preceded by white space. A backslash is needed less often: > | |
| 209 vim9script | |
| 210 set titlestring=hi\ "there" | |
| 211 set titlestring=hi#there# | |
| 212 set titlestring=hi\ \#there# | |
| 213 | |
| 18972 | 214 For Win32 backslashes in file names are mostly not removed. More precise: For |
| 215 options that expect a file name (those where environment variables are | |
| 216 expanded) a backslash before a normal file name character is not removed. But | |
| 217 a backslash before a special character (space, backslash, comma, etc.) is used | |
| 218 like explained above. | |
| 7 | 219 There is one special situation, when the value starts with "\\": > |
| 220 :set dir=\\machine\path results in "\\machine\path" | |
| 221 :set dir=\\\\machine\\path results in "\\machine\path" | |
| 222 :set dir=\\path\\file results in "\\path\file" (wrong!) | |
| 223 For the first one the start is kept, but for the second one the backslashes | |
| 224 are halved. This makes sure it works both when you expect backslashes to be | |
| 10 | 225 halved and when you expect the backslashes to be kept. The third gives a |
| 7 | 226 result which is probably not what you want. Avoid it. |
| 227 | |
| 228 *add-option-flags* *remove-option-flags* | |
| 229 *E539* *E550* *E551* *E552* | |
| 230 Some options are a list of flags. When you want to add a flag to such an | |
| 231 option, without changing the existing ones, you can do it like this: > | |
| 232 :set guioptions+=a | |
| 233 Remove a flag from an option like this: > | |
| 234 :set guioptions-=a | |
| 235 This removes the 'a' flag from 'guioptions'. | |
| 10 | 236 Note that you should add or remove one flag at a time. If 'guioptions' has |
| 7 | 237 the value "ab", using "set guioptions-=ba" won't work, because the string "ba" |
| 238 doesn't appear. | |
| 239 | |
| 240 *:set_env* *expand-env* *expand-environment-var* | |
| 22 | 241 Environment variables in specific string options will be expanded. If the |
| 7 | 242 environment variable exists the '$' and the following environment variable |
| 243 name is replaced with its value. If it does not exist the '$' and the name | |
| 244 are not modified. Any non-id character (not a letter, digit or '_') may | |
| 245 follow the environment variable name. That character and what follows is | |
| 246 appended to the value of the environment variable. Examples: > | |
| 247 :set term=$TERM.new | |
| 248 :set path=/usr/$INCLUDE,$HOME/include,. | |
| 249 When adding or removing a string from an option with ":set opt-=val" or ":set | |
| 250 opt+=val" the expansion is done before the adding or removing. | |
| 251 | |
| 252 | |
| 253 Handling of local options *local-options* | |
| 254 | |
| 255 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
|
256 has its own copy of this option, thus each can have its own value. This |
| 7 | 257 allows you to set 'list' in one window but not in another. And set |
| 258 'shiftwidth' to 3 in one buffer and 4 in another. | |
| 259 | |
| 260 The following explains what happens to these local options in specific | |
| 261 situations. You don't really need to know all of this, since Vim mostly uses | |
| 262 the option values you would expect. Unfortunately, doing what the user | |
| 263 expects is a bit complicated... | |
| 264 | |
| 265 When splitting a window, the local options are copied to the new window. Thus | |
| 266 right after the split the contents of the two windows look the same. | |
| 267 | |
| 268 When editing a new buffer, its local option values must be initialized. Since | |
| 269 the local options of the current buffer might be specifically for that buffer, | |
| 270 these are not used. Instead, for each buffer-local option there also is a | |
| 271 global value, which is used for new buffers. With ":set" both the local and | |
| 272 global value is changed. With "setlocal" only the local value is changed, | |
| 273 thus this value is not used when editing a new buffer. | |
| 274 | |
|
9852
4eea48b76d03
commit https://github.com/vim/vim/commit/95ec9d6a6ab3117d60ff638670a803d43974ba51
Christian Brabandt <cb@256bit.org>
parents:
9737
diff
changeset
|
275 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
|
276 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
|
277 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
|
278 last closed window where the buffer was edited last are used. |
| 7 | 279 |
| 280 It's possible to set a local window option specifically for a type of buffer. | |
| 281 When you edit another buffer in the same window, you don't want to keep | |
| 282 using these local window options. Therefore Vim keeps a global value of the | |
| 283 local window options, which is used when editing another buffer. Each window | |
| 284 has its own copy of these values. Thus these are local to the window, but | |
| 285 global to all buffers in the window. With this you can do: > | |
| 286 :e one | |
| 287 :set list | |
| 288 :e two | |
| 289 Now the 'list' option will also be set in "two", since with the ":set list" | |
| 290 command you have also set the global value. > | |
| 291 :set nolist | |
| 292 :e one | |
| 293 :setlocal list | |
| 294 :e two | |
| 295 Now the 'list' option is not set, because ":set nolist" resets the global | |
| 296 value, ":setlocal list" only changes the local value and ":e two" gets the | |
| 297 global value. Note that if you do this next: > | |
| 298 :e one | |
| 4358 | 299 You will get back the 'list' value as it was the last time you edited "one". |
| 300 The options local to a window are remembered for each buffer. This also | |
| 301 happens when the buffer is not loaded, but they are lost when the buffer is | |
| 302 wiped out |:bwipe|. | |
| 7 | 303 |
| 304 *:setl* *:setlocal* | |
|
19137
69f0e9b5c107
patch 8.2.0128: cannot list options one per line
Bram Moolenaar <Bram@vim.org>
parents:
19116
diff
changeset
|
305 :setl[ocal][!] ... Like ":set" but set only the value local to the |
| 7 | 306 current buffer or window. Not all options have a |
| 307 local value. If the option does not have a local | |
| 308 value the global value is set. | |
| 2413 | 309 With the "all" argument: display local values for all |
| 310 local options. | |
| 311 Without argument: Display local values for all local | |
| 312 options which are different from the default. | |
| 7 | 313 When displaying a specific local option, show the |
| 1621 | 314 local value. For a global/local boolean option, when |
| 315 the global value is being used, "--" is displayed | |
| 316 before the option name. | |
| 317 For a global option the global value is | |
| 7 | 318 shown (but that might change in the future). |
| 319 | |
| 809 | 320 :setl[ocal] {option}< Set the local value of {option} to its global value by |
| 321 copying the value. | |
| 322 | |
| 3281 | 323 :se[t] {option}< For |global-local| options: Remove the local value of |
| 324 {option}, so that the global value will be used. | |
| 7 | 325 |
| 326 *:setg* *:setglobal* | |
|
19137
69f0e9b5c107
patch 8.2.0128: cannot list options one per line
Bram Moolenaar <Bram@vim.org>
parents:
19116
diff
changeset
|
327 :setg[lobal][!] ... Like ":set" but set only the global value for a local |
| 7 | 328 option without changing the local value. |
| 329 When displaying an option, the global value is shown. | |
| 2413 | 330 With the "all" argument: display global values for all |
| 331 local options. | |
| 332 Without argument: display global values for all local | |
| 333 options which are different from the default. | |
| 7 | 334 |
| 335 For buffer-local and window-local options: | |
| 336 Command global value local value ~ | |
| 337 :set option=value set set | |
| 338 :setlocal option=value - set | |
| 339 :setglobal option=value set - | |
| 340 :set option? - display | |
| 341 :setlocal option? - display | |
| 342 :setglobal option? display - | |
| 343 | |
| 344 | |
| 345 Global options with a local value *global-local* | |
| 346 | |
| 40 | 347 Options are global when you mostly use one value for all buffers and windows. |
| 348 For some global options it's useful to sometimes have a different local value. | |
| 349 You can set the local value with ":setlocal". That buffer or window will then | |
| 350 use the local value, while other buffers and windows continue using the global | |
| 351 value. | |
| 7 | 352 |
| 353 For example, you have two windows, both on C source code. They use the global | |
| 354 'makeprg' option. If you do this in one of the two windows: > | |
| 355 :set makeprg=gmake | |
| 356 then the other window will switch to the same value. There is no need to set | |
| 357 the 'makeprg' option in the other C source window too. | |
| 358 However, if you start editing a Perl file in a new window, you want to use | |
| 1152 | 359 another 'makeprg' for it, without changing the value used for the C source |
| 10 | 360 files. You use this command: > |
| 7 | 361 :setlocal makeprg=perlmake |
| 362 You can switch back to using the global value by making the local value empty: > | |
| 363 :setlocal makeprg= | |
| 15729 | 364 This only works for a string option. For a number or boolean option you need |
| 365 to use the "<" flag, like this: > | |
| 7 | 366 :setlocal autoread< |
| 15729 | 367 Note that for non-boolean and non-number options using "<" copies the global |
| 368 value to the local value, it doesn't switch back to using the global value | |
| 369 (that matters when the global value changes later). You can also use: > | |
| 809 | 370 :set path< |
| 371 This will make the local value of 'path' empty, so that the global value is | |
| 372 used. Thus it does the same as: > | |
| 373 :setlocal path= | |
| 27036 | 374 Note: In the future more global options can be made |global-local|. Using |
| 7 | 375 ":setlocal" on a global option might work differently then. |
| 376 | |
| 377 | |
|
26175
6b4f017d7005
patch 8.2.3619: cannot use a lambda for 'operatorfunc'
Bram Moolenaar <Bram@vim.org>
parents:
26148
diff
changeset
|
378 *option-value-function* |
|
6b4f017d7005
patch 8.2.3619: cannot use a lambda for 'operatorfunc'
Bram Moolenaar <Bram@vim.org>
parents:
26148
diff
changeset
|
379 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
|
380 '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
|
381 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
|
382 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
|
383 > |
|
6b4f017d7005
patch 8.2.3619: cannot use a lambda for 'operatorfunc'
Bram Moolenaar <Bram@vim.org>
parents:
26148
diff
changeset
|
384 set opfunc=MyOpFunc |
|
26268
3aa48d4e3dc8
patch 8.2.3665: cannot use a lambda for 'tagfunc'
Bram Moolenaar <Bram@vim.org>
parents:
26219
diff
changeset
|
385 set opfunc=function('MyOpFunc') |
|
3aa48d4e3dc8
patch 8.2.3665: cannot use a lambda for 'tagfunc'
Bram Moolenaar <Bram@vim.org>
parents:
26219
diff
changeset
|
386 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
|
387 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
|
388 |
|
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 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
|
390 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
|
391 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
|
392 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
|
393 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
|
394 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
|
395 |
|
f1d5822ca0d7
patch 8.2.4416: Vim9: using a script-local function requires using "s:"
Bram Moolenaar <Bram@vim.org>
parents:
27623
diff
changeset
|
396 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
|
397 let Fn = function('MyTagFunc') |
| 26708 | 398 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
|
399 |
|
f1d5822ca0d7
patch 8.2.4416: Vim9: using a script-local function requires using "s:"
Bram Moolenaar <Bram@vim.org>
parents:
27623
diff
changeset
|
400 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
|
401 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
|
402 |
|
f1d5822ca0d7
patch 8.2.4416: Vim9: using a script-local function requires using "s:"
Bram Moolenaar <Bram@vim.org>
parents:
27623
diff
changeset
|
403 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
|
404 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
|
405 let &tagfunc = L |
|
26508
a0bc10e83cf8
patch 8.2.3784: the help for options is outdated
Bram Moolenaar <Bram@vim.org>
parents:
26441
diff
changeset
|
406 |
|
a0bc10e83cf8
patch 8.2.3784: the help for options is outdated
Bram Moolenaar <Bram@vim.org>
parents:
26441
diff
changeset
|
407 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
|
408 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
|
409 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
|
410 |
|
26175
6b4f017d7005
patch 8.2.3619: cannot use a lambda for 'operatorfunc'
Bram Moolenaar <Bram@vim.org>
parents:
26148
diff
changeset
|
411 |
| 7 | 412 Setting the filetype |
| 413 | |
| 11473 | 414 :setf[iletype] [FALLBACK] {filetype} *:setf* *:setfiletype* |
| 7 | 415 Set the 'filetype' option to {filetype}, but only if |
| 416 not done yet in a sequence of (nested) autocommands. | |
| 417 This is short for: > | |
| 418 :if !did_filetype() | |
| 419 : setlocal filetype={filetype} | |
| 420 :endif | |
| 421 < This command is used in a filetype.vim file to avoid | |
| 422 setting the 'filetype' option twice, causing different | |
| 423 settings and syntax files to be loaded. | |
| 11473 | 424 |
| 425 When the optional FALLBACK argument is present, a | |
| 426 later :setfiletype command will override the | |
| 16023 | 427 'filetype'. This is to be used for filetype |
| 428 detections that are just a guess. |did_filetype()| | |
| 429 will return false after this command. | |
| 11473 | 430 |
|
2698
b6471224d2af
Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents:
2681
diff
changeset
|
431 *option-window* *optwin* |
| 7 | 432 :bro[wse] se[t] *:set-browse* *:browse-set* *:opt* *:options* |
| 433 :opt[ions] Open a window for viewing and setting all options. | |
| 434 Options are grouped by function. | |
| 435 Offers short help for each option. Hit <CR> on the | |
| 436 short help to open a help window with more help for | |
| 437 the option. | |
| 438 Modify the value of the option and hit <CR> on the | |
| 439 "set" line to set the new value. For window and | |
| 440 buffer specific options, the last accessed window is | |
| 441 used to set the option value in, unless this is a help | |
| 442 window, in which case the window below help window is | |
| 443 used (skipping the option-window). | |
| 13437 | 444 {not available when compiled without the |+eval| |
| 445 feature} | |
| 7 | 446 |
| 447 *$HOME* | |
| 448 Using "~" is like using "$HOME", but it is only recognized at the start of an | |
| 449 option and after a space or comma. | |
| 450 | |
| 451 On Unix systems "~user" can be used too. It is replaced by the home directory | |
| 452 of user "user". Example: > | |
| 453 :set path=~mool/include,/usr/include,. | |
| 454 | |
| 455 On Unix systems the form "${HOME}" can be used too. The name between {} can | |
| 456 contain non-id characters then. Note that if you want to use this for the | |
| 457 "gf" command, you need to add the '{' and '}' characters to 'isfname'. | |
| 458 | |
| 12254 | 459 NOTE: expanding environment variables and "~/" is only done with the ":set" |
| 460 command, not when assigning a value to an option with ":let". | |
| 461 | |
| 462 *$HOME-windows* | |
| 3224 | 463 On MS-Windows, if $HOME is not defined as an environment variable, then |
| 464 at runtime Vim will set it to the expansion of $HOMEDRIVE$HOMEPATH. | |
| 12499 | 465 If $HOMEDRIVE is not set then $USERPROFILE is used. |
| 466 | |
| 467 This expanded value is not exported to the environment, this matters when | |
| 468 running an external command: > | |
| 469 :echo system('set | findstr ^HOME=') | |
| 470 and > | |
| 471 :echo luaeval('os.getenv("HOME")') | |
| 472 should echo nothing (an empty string) despite exists('$HOME') being true. | |
| 473 When setting $HOME to a non-empty string it will be exported to the | |
| 474 subprocesses. | |
| 3224 | 475 |
| 7 | 476 |
| 477 Note the maximum length of an expanded option is limited. How much depends on | |
| 478 the system, mostly it is something like 256 or 1024 characters. | |
| 479 | |
| 480 *:fix* *:fixdel* | |
| 481 :fix[del] Set the value of 't_kD': | |
| 482 't_kb' is 't_kD' becomes ~ | |
| 483 CTRL-? CTRL-H | |
| 484 not CTRL-? CTRL-? | |
| 485 | |
| 23573 | 486 (CTRL-? is 0o177 octal, 0x7f hex) |
| 7 | 487 |
| 488 If your delete key terminal code is wrong, but the | |
| 489 code for backspace is alright, you can put this in | |
| 490 your .vimrc: > | |
| 491 :fixdel | |
| 492 < This works no matter what the actual code for | |
| 493 backspace is. | |
| 494 | |
| 495 If the backspace key terminal code is wrong you can | |
| 496 use this: > | |
| 497 :if &term == "termname" | |
| 498 : set t_kb=^V<BS> | |
| 499 : fixdel | |
| 500 :endif | |
| 501 < Where "^V" is CTRL-V and "<BS>" is the backspace key | |
| 10 | 502 (don't type four characters!). Replace "termname" |
| 7 | 503 with your terminal name. |
| 504 | |
| 505 If your <Delete> key sends a strange key sequence (not | |
| 506 CTRL-? or CTRL-H) you cannot use ":fixdel". Then use: > | |
| 507 :if &term == "termname" | |
| 508 : set t_kD=^V<Delete> | |
| 509 :endif | |
| 510 < Where "^V" is CTRL-V and "<Delete>" is the delete key | |
| 511 (don't type eight characters!). Replace "termname" | |
| 512 with your terminal name. | |
| 513 | |
| 514 *Linux-backspace* | |
| 515 Note about Linux: By default the backspace key | |
| 516 produces CTRL-?, which is wrong. You can fix it by | |
| 517 putting this line in your rc.local: > | |
| 518 echo "keycode 14 = BackSpace" | loadkeys | |
| 519 < | |
| 520 *NetBSD-backspace* | |
| 521 Note about NetBSD: If your backspace doesn't produce | |
| 522 the right code, try this: > | |
| 523 xmodmap -e "keycode 22 = BackSpace" | |
| 524 < If this works, add this in your .Xmodmap file: > | |
| 525 keysym 22 = BackSpace | |
| 526 < You need to restart for this to take effect. | |
| 527 | |
| 528 ============================================================================== | |
| 529 2. Automatically setting options *auto-setting* | |
| 530 | |
| 531 Besides changing options with the ":set" command, there are three alternatives | |
| 532 to set options automatically for one or more files: | |
| 533 | |
| 534 1. When starting Vim initializations are read from various places. See | |
| 535 |initialization|. Most of them are performed for all editing sessions, | |
| 536 and some of them depend on the directory where Vim is started. | |
| 537 You can create an initialization file with |:mkvimrc|, |:mkview| and | |
| 538 |:mksession|. | |
| 539 2. If you start editing a new file, the automatic commands are executed. | |
| 540 This can be used to set options for files matching a particular pattern and | |
| 541 many other things. See |autocommand|. | |
| 542 3. If you start editing a new file, and the 'modeline' option is on, a | |
| 543 number of lines at the beginning and end of the file are checked for | |
| 544 modelines. This is explained here. | |
| 545 | |
| 546 *modeline* *vim:* *vi:* *ex:* *E520* | |
| 547 There are two forms of modelines. The first form: | |
| 18831 | 548 [text{white}]{vi:|vim:|ex:}[white]{options} |
| 549 | |
| 550 [text{white}] empty or any text followed by at least one blank | |
| 551 character (<Space> or <Tab>); "ex:" always requires at | |
| 552 least one blank character | |
| 5055 | 553 {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
|
554 [white] optional white space |
|
7a2ffd685c0e
Update runtime files. Remove duplicate tags in help.
Bram Moolenaar <bram@vim.org>
parents:
5008
diff
changeset
|
555 {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
|
556 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
|
557 for a ":set" command (can be empty) |
| 7 | 558 |
| 5055 | 559 Examples: |
| 782 | 560 vi:noai:sw=3 ts=6 ~ |
| 5055 | 561 vim: tw=77 ~ |
| 7 | 562 |
| 563 The second form (this is compatible with some versions of Vi): | |
| 564 | |
| 19163 | 565 [text{white}]{vi:|vim:|Vim:|ex:}[white]se[t] {options}:[text] |
| 566 | |
| 567 [text{white}] empty or any text followed by at least one blank | |
| 568 character (<Space> or <Tab>); "ex:" always requires at | |
| 569 least one blank character | |
|
5024
7a2ffd685c0e
Update runtime files. Remove duplicate tags in help.
Bram Moolenaar <bram@vim.org>
parents:
5008
diff
changeset
|
570 {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
|
571 [white] optional white space |
| 5055 | 572 se[t] the string "set " or "se " (note the space); When |
| 573 "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
|
574 {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
|
575 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
|
576 : a colon |
|
7a2ffd685c0e
Update runtime files. Remove duplicate tags in help.
Bram Moolenaar <bram@vim.org>
parents:
5008
diff
changeset
|
577 [text] any text or empty |
| 7 | 578 |
| 5055 | 579 Examples: |
| 782 | 580 /* vim: set ai tw=75: */ ~ |
| 5055 | 581 /* Vim: set ai tw=75: */ ~ |
| 7 | 582 |
|
5024
7a2ffd685c0e
Update runtime files. Remove duplicate tags in help.
Bram Moolenaar <bram@vim.org>
parents:
5008
diff
changeset
|
583 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
|
584 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
|
585 "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
|
586 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
|
587 could be short for "example:"). |
| 7 | 588 |
|
25696
64fa341cc33b
patch 8.2.3384: cannot disable modeline for an individual file
Bram Moolenaar <Bram@vim.org>
parents:
25487
diff
changeset
|
589 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
|
590 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
|
591 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
|
592 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
|
593 # vim: nomodeline ~ |
|
64fa341cc33b
patch 8.2.3384: cannot disable modeline for an individual file
Bram Moolenaar <Bram@vim.org>
parents:
25487
diff
changeset
|
594 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
|
595 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
|
596 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
|
597 |
| 7 | 598 *modeline-local* |
| 599 The options are set like with ":setlocal": The new value only applies to the | |
| 11 | 600 buffer and window that contain the file. Although it's possible to set global |
| 601 options from a modeline, this is unusual. If you have two windows open and | |
| 602 the files in it set the same global option to a different value, the result | |
| 603 depends on which one was opened last. | |
| 7 | 604 |
| 23 | 605 When editing a file that was already loaded, only the window-local options |
| 606 from the modeline are used. Thus if you manually changed a buffer-local | |
| 607 option after opening the file, it won't be changed if you edit the same buffer | |
| 608 in another window. But window-local options will be set. | |
| 609 | |
| 7 | 610 *modeline-version* |
| 611 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
|
612 number can be specified where "vim:" or "Vim:" is used: |
| 7 | 613 vim{vers}: version {vers} or later |
| 614 vim<{vers}: version before {vers} | |
| 615 vim={vers}: version {vers} | |
| 616 vim>{vers}: version after {vers} | |
| 6647 | 617 {vers} is 700 for Vim 7.0 (hundred times the major version plus minor). |
| 618 For example, to use a modeline only for Vim 7.0: | |
| 619 /* vim700: set foldmethod=marker */ ~ | |
| 620 To use a modeline for Vim after version 7.2: | |
| 621 /* vim>702: set cole=2: */ ~ | |
| 7 | 622 There can be no blanks between "vim" and the ":". |
| 623 | |
| 624 | |
| 625 The number of lines that are checked can be set with the 'modelines' option. | |
| 626 If 'modeline' is off or 'modelines' is 0 no lines are checked. | |
| 627 | |
| 628 Note that for the first form all of the rest of the line is used, thus a line | |
| 782 | 629 like: |
| 630 /* vi:ts=4: */ ~ | |
| 631 will give an error message for the trailing "*/". This line is OK: | |
| 632 /* vi:set ts=4: */ ~ | |
| 7 | 633 |
| 634 If an error is detected the rest of the line is skipped. | |
| 635 | |
| 636 If you want to include a ':' in a set command precede it with a '\'. The | |
| 782 | 637 backslash in front of the ':' will be removed. Example: |
| 18928 | 638 /* vi:set fillchars=stl\:^,vert\:\|: */ ~ |
| 639 This sets the 'fillchars' option to "stl:^,vert:\|". Only a single backslash | |
| 640 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
|
641 *E992* |
| 7 | 642 No other commands than "set" are supported, for security reasons (somebody |
| 1111 | 643 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
|
644 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
|
645 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
|
646 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
|
647 |
|
e55c26aaf484
patch 8.1.1366: using expressions in a modeline is unsafe
Bram Moolenaar <Bram@vim.org>
parents:
16610
diff
changeset
|
648 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
|
649 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
|
650 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
|
651 this, for example. |
| 7 | 652 |
| 653 Hint: If you would like to do something else than setting an option, you could | |
| 654 define an autocommand that checks the file for a specific string. For | |
| 655 example: > | |
| 656 au BufReadPost * if getline(1) =~ "VAR" | call SetVar() | endif | |
| 657 And define a function SetVar() that does something with the line containing | |
| 658 "VAR". | |
| 659 | |
| 660 ============================================================================== | |
| 661 3. Options summary *option-summary* | |
| 662 | |
| 663 In the list below all the options are mentioned with their full name and with | |
| 664 an abbreviation if there is one. Both forms may be used. | |
| 665 | |
| 666 In this document when a boolean option is "set" that means that ":set option" | |
| 667 is entered. When an option is "reset", ":set nooption" is used. | |
| 668 | |
| 669 For some options there are two default values: The "Vim default", which is | |
| 670 used when 'compatible' is not set, and the "Vi default", which is used when | |
| 671 'compatible' is set. | |
| 672 | |
| 673 Most options are the same in all windows and buffers. There are a few that | |
| 10 | 674 are specific to how the text is presented in a window. These can be set to a |
| 7 | 675 different value in each window. For example the 'list' option can be set in |
| 676 one window and reset in another for the same text, giving both types of view | |
| 677 at the same time. There are a few options that are specific to a certain | |
| 678 file. These can have a different value for each file or buffer. For example | |
| 679 the 'textwidth' option can be 78 for a normal text file and 0 for a C | |
| 680 program. | |
| 681 | |
| 682 global one option for all buffers and windows | |
| 683 local to window each window has its own copy of this option | |
| 684 local to buffer each buffer has its own copy of this option | |
| 685 | |
| 686 When creating a new window the option values from the currently active window | |
| 687 are used as a default value for the window-specific options. For the | |
| 688 buffer-specific options this depends on the 's' and 'S' flags in the | |
| 689 'cpoptions' option. If 's' is included (which is the default) the values for | |
| 690 buffer options are copied from the currently active buffer when a buffer is | |
| 10 | 691 first entered. If 'S' is present the options are copied each time the buffer |
| 692 is entered, this is almost like having global options. If 's' and 'S' are not | |
| 7 | 693 present, the options are copied from the currently active buffer when the |
| 694 buffer is created. | |
| 695 | |
| 519 | 696 Hidden options *hidden-options* |
| 697 | |
| 698 Not all options are supported in all versions. This depends on the supported | |
| 699 features and sometimes on the system. A remark about this is in curly braces | |
| 700 below. When an option is not supported it may still be set without getting an | |
| 701 error, this is called a hidden option. You can't get the value of a hidden | |
| 702 option though, it is not stored. | |
| 703 | |
| 704 To test if option "foo" can be used with ":set" use something like this: > | |
| 705 if exists('&foo') | |
| 706 This also returns true for a hidden option. To test if option "foo" is really | |
| 707 supported use something like this: > | |
| 708 if exists('+foo') | |
| 709 < | |
| 7 | 710 *E355* |
| 711 A jump table for the options with a short description can be found at |Q_op|. | |
| 712 | |
| 713 *'aleph'* *'al'* *aleph* *Aleph* | |
| 18972 | 714 'aleph' 'al' number (default 128 for MS-Windows, 224 otherwise) |
| 7 | 715 global |
| 716 {only available when compiled with the |+rightleft| | |
| 717 feature} | |
| 718 The ASCII code for the first letter of the Hebrew alphabet. The | |
| 719 routine that maps the keyboard in Hebrew mode, both in Insert mode | |
| 720 (when hkmap is set) and on the command-line (when hitting CTRL-_) | |
| 721 outputs the Hebrew characters in the range [aleph..aleph+26]. | |
| 722 aleph=128 applies to PC code, and aleph=224 applies to ISO 8859-8. | |
| 723 See |rileft.txt|. | |
| 724 | |
| 725 *'allowrevins'* *'ari'* *'noallowrevins'* *'noari'* | |
| 726 'allowrevins' 'ari' boolean (default off) | |
| 727 global | |
| 728 {only available when compiled with the |+rightleft| | |
| 729 feature} | |
| 730 Allow CTRL-_ in Insert and Command-line mode. This is default off, to | |
| 731 avoid that users that accidentally type CTRL-_ instead of SHIFT-_ get | |
| 732 into reverse Insert mode, and don't know how to get out. See | |
| 733 'revins'. | |
| 734 NOTE: This option is reset when 'compatible' is set. | |
| 735 | |
| 736 *'altkeymap'* *'akm'* *'noaltkeymap'* *'noakm'* | |
| 737 'altkeymap' 'akm' boolean (default off) | |
| 738 global | |
| 739 {only available when compiled with the |+farsi| | |
| 740 feature} | |
|
15850
a6ca8cf07a98
patch 8.1.0932: Farsi support is outdated and unused
Bram Moolenaar <Bram@vim.org>
parents:
15840
diff
changeset
|
741 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
|
742 |farsi.txt|. |
| 7 | 743 |
| 744 *'ambiwidth'* *'ambw'* | |
| 745 'ambiwidth' 'ambw' string (default: "single") | |
| 746 global | |
| 747 Only effective when 'encoding' is "utf-8" or another Unicode encoding. | |
| 748 Tells Vim what to do with characters with East Asian Width Class | |
| 749 Ambiguous (such as Euro, Registered Sign, Copyright Sign, Greek | |
| 750 letters, Cyrillic letters). | |
| 751 | |
| 752 There are currently two possible values: | |
| 233 | 753 "single": Use the same width as characters in US-ASCII. This is |
| 7 | 754 expected by most users. |
| 755 "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
|
756 *E834* *E835* |
|
c945fdb34ce3
Disallow setting 'ambiwidth' to "double" when 'listchars' or 'fillchars'
Bram Moolenaar <bram@vim.org>
parents:
2490
diff
changeset
|
757 The value "double" cannot be used if 'listchars' or 'fillchars' |
| 26050 | 758 contains a character that would be double width. These errors may |
| 759 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
|
760 |
|
0bc43a704f56
patch 8.2.1535: it is not possible to specify cell widths of characters
Bram Moolenaar <Bram@vim.org>
parents:
21825
diff
changeset
|
761 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
|
762 |setcellwidths()|. |
| 7 | 763 |
| 764 There are a number of CJK fonts for which the width of glyphs for | |
| 765 those characters are solely based on how many octets they take in | |
| 766 legacy/traditional CJK encodings. In those encodings, Euro, | |
| 767 Registered sign, Greek/Cyrillic letters are represented by two octets, | |
| 233 | 768 therefore those fonts have "wide" glyphs for them. This is also |
| 7 | 769 true of some line drawing characters used to make tables in text |
| 233 | 770 file. Therefore, when a CJK font is used for GUI Vim or |
| 7 | 771 Vim is running inside a terminal (emulators) that uses a CJK font |
| 772 (or Vim is run inside an xterm invoked with "-cjkwidth" option.), | |
| 773 this option should be set to "double" to match the width perceived | |
| 774 by Vim with the width of glyphs in the font. Perhaps it also has | |
| 19116 | 775 to be set to "double" under CJK MS-Windows when the system locale is |
| 776 set to one of CJK locales. See Unicode Standard Annex #11 | |
| 777 (http://www.unicode.org/reports/tr11). | |
| 7 | 778 |
| 4229 | 779 Vim may set this option automatically at startup time when Vim is |
| 780 compiled with the |+termresponse| feature and if |t_u7| is set to the | |
| 12499 | 781 escape sequence to request cursor position report. The response can |
| 782 be found in |v:termu7resp|. | |
| 4229 | 783 |
| 7 | 784 *'antialias'* *'anti'* *'noantialias'* *'noanti'* |
| 785 'antialias' 'anti' boolean (default: off) | |
| 786 global | |
| 787 {only available when compiled with GUI enabled | |
| 21825 | 788 on macOS} |
| 789 This option only has an effect in the GUI version of Vim on macOS | |
| 7 | 790 v10.2 or later. When on, Vim will use smooth ("antialiased") fonts, |
| 791 which can be easier to read at certain sizes on certain displays. | |
| 792 Setting this option can sometimes cause problems if 'guifont' is set | |
| 793 to its default (empty string). | |
| 11160 | 794 NOTE: This option is reset when 'compatible' is set. |
| 7 | 795 |
| 796 *'autochdir'* *'acd'* *'noautochdir'* *'noacd'* | |
| 797 'autochdir' 'acd' boolean (default off) | |
| 798 global | |
| 2152 | 799 {only available when compiled with it, use |
| 800 exists("+autochdir") to check} | |
| 438 | 801 When on, Vim will change the current working directory whenever you |
| 802 open a file, switch buffers, delete a buffer or open/close a window. | |
| 803 It will change to the directory containing the file which was opened | |
| 29779 | 804 or selected. When a buffer has no name it also has no directory, thus |
| 805 the current directory won't change when navigating to it. | |
| 819 | 806 Note: When this option is on some plugins may not work. |
| 7 | 807 |
|
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
|
808 *'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
|
809 '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
|
810 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
|
811 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
|
812 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
|
813 need proper setting-up, so whenever the shell's pwd changes an OSC 7 |
| 29659 | 814 escape sequence will be emitted. For example, on Linux, you can |
| 815 source /etc/profile.d/vte.sh in your shell profile if you use bash or | |
| 816 zsh. For bash this should work (put it in a bash init file): > | |
| 817 if [[ -n "$VIM_TERMINAL" ]]; then | |
| 818 PROMPT_COMMAND='_vim_sync_PWD' | |
| 819 function _vim_sync_PWD() { | |
| 29756 | 820 printf '\033]7;file://%s\033\\' "$PWD" |
| 29659 | 821 } |
| 822 fi | |
| 823 < | |
| 824 Or, in a zsh init file: > | |
| 825 if [[ -n "$VIM_TERMINAL" ]]; then | |
| 826 autoload -Uz add-zsh-hook | |
| 827 add-zsh-hook -Uz chpwd _vim_sync_PWD | |
| 828 function _vim_sync_PWD() { | |
| 29756 | 829 printf '\033]7;file://%s\033\\' "$PWD" |
| 29659 | 830 } |
| 831 fi | |
| 832 < | |
| 833 In a fish init file: > | |
| 834 if test -n "$VIM_TERMINAL" | |
| 835 function _vim_sync_PWD --on-variable=PWD | |
| 29756 | 836 printf '\033]7;file://%s\033\\' "$PWD" |
| 29659 | 837 end |
| 838 end | |
| 839 < | |
| 840 You can find an alternative method at |terminal-autoshelldir|. | |
| 27537 | 841 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
|
842 |
| 7 | 843 *'arabic'* *'arab'* *'noarabic'* *'noarab'* |
| 844 'arabic' 'arab' boolean (default off) | |
| 845 local to window | |
| 846 {only available when compiled with the |+arabic| | |
| 847 feature} | |
| 848 This option can be set to start editing Arabic text. | |
| 849 Setting this option will: | |
| 850 - Set the 'rightleft' option, unless 'termbidi' is set. | |
| 851 - Set the 'arabicshape' option, unless 'termbidi' is set. | |
| 852 - Set the 'keymap' option to "arabic"; in Insert mode CTRL-^ toggles | |
| 853 between typing English and Arabic key mapping. | |
| 854 - Set the 'delcombine' option | |
| 855 Note that 'encoding' must be "utf-8" for working with Arabic text. | |
| 856 | |
| 857 Resetting this option will: | |
| 858 - Reset the 'rightleft' option. | |
| 859 - Disable the use of 'keymap' (without changing its value). | |
| 860 Note that 'arabicshape' and 'delcombine' are not reset (it is a global | |
| 3557 | 861 option). |
| 11160 | 862 NOTE: This option is reset when 'compatible' is set. |
| 7 | 863 Also see |arabic.txt|. |
| 864 | |
| 865 *'arabicshape'* *'arshape'* | |
| 866 *'noarabicshape'* *'noarshape'* | |
| 867 'arabicshape' 'arshape' boolean (default on) | |
| 868 global | |
| 869 {only available when compiled with the |+arabic| | |
| 870 feature} | |
| 871 When on and 'termbidi' is off, the required visual character | |
| 872 corrections that need to take place for displaying the Arabic language | |
| 3893 | 873 take effect. Shaping, in essence, gets enabled; the term is a broad |
| 7 | 874 one which encompasses: |
| 875 a) the changing/morphing of characters based on their location | |
| 876 within a word (initial, medial, final and stand-alone). | |
| 877 b) the enabling of the ability to compose characters | |
| 878 c) the enabling of the required combining of some characters | |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
879 When disabled the display shows each character's true stand-alone |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
880 form. |
| 7 | 881 Arabic is a complex language which requires other settings, for |
| 882 further details see |arabic.txt|. | |
| 11160 | 883 NOTE: This option is set when 'compatible' is set. |
| 7 | 884 |
| 885 *'autoindent'* *'ai'* *'noautoindent'* *'noai'* | |
| 886 'autoindent' 'ai' boolean (default off) | |
| 887 local to buffer | |
| 888 Copy indent from current line when starting a new line (typing <CR> | |
| 889 in Insert mode or when using the "o" or "O" command). If you do not | |
| 890 type anything on the new line except <BS> or CTRL-D and then type | |
| 1152 | 891 <Esc>, CTRL-O or <CR>, the indent is deleted again. Moving the cursor |
| 892 to another line has the same effect, unless the 'I' flag is included | |
| 893 in 'cpoptions'. | |
| 10 | 894 When autoindent is on, formatting (with the "gq" command or when you |
| 895 reach 'textwidth' in Insert mode) uses the indentation of the first | |
| 896 line. | |
| 7 | 897 When 'smartindent' or 'cindent' is on the indent is changed in |
| 898 a different way. | |
|
7147
c590de398af9
commit https://github.com/vim/vim/commit/ca63501fbcd1cf9c8aa9ff12c093c95b62a89ed7
Christian Brabandt <cb@256bit.org>
parents:
7080
diff
changeset
|
899 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
|
900 restored when 'paste' is reset. |
| 7 | 901 |
| 902 *'autoread'* *'ar'* *'noautoread'* *'noar'* | |
| 903 'autoread' 'ar' boolean (default off) | |
| 904 global or local to buffer |global-local| | |
| 905 When a file has been detected to have been changed outside of Vim and | |
| 906 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
|
907 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
|
908 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
|
909 |timestamp| |
| 7 | 910 If this option has a local value, use this command to switch back to |
| 911 using the global value: > | |
| 912 :set autoread< | |
| 913 < | |
| 914 *'autowrite'* *'aw'* *'noautowrite'* *'noaw'* | |
| 915 'autowrite' 'aw' boolean (default off) | |
| 916 global | |
| 917 Write the contents of the file, if it has been modified, on each | |
| 26438 | 918 `:next`, `:rewind`, `:last`, `:first`, `:previous`, `:stop`, |
| 27036 | 919 `:suspend`, `:tag`, `:!`, `:make`, CTRL-] and CTRL-^ command; and when |
| 920 a `:buffer`, CTRL-O, CTRL-I, '{A-Z0-9}, or `{A-Z0-9} command takes one | |
| 26438 | 921 to another file. |
| 922 A buffer is not written if it becomes hidden, e.g. when 'bufhidden' is | |
| 27036 | 923 set to "hide" and `:next` is used. |
| 7 | 924 Note that for some commands the 'autowrite' option is not used, see |
| 925 'autowriteall' for that. | |
| 14695 | 926 Some buffers will not be written, specifically when 'buftype' is |
| 14668 | 927 "nowrite", "nofile", "terminal" or "prompt". |
| 7 | 928 |
| 929 *'autowriteall'* *'awa'* *'noautowriteall'* *'noawa'* | |
| 930 'autowriteall' 'awa' boolean (default off) | |
| 931 global | |
| 932 Like 'autowrite', but also used for commands ":edit", ":enew", ":quit", | |
| 933 ":qall", ":exit", ":xit", ":recover" and closing the Vim window. | |
| 934 Setting this option also implies that Vim behaves like 'autowrite' has | |
| 935 been set. | |
| 936 | |
| 937 *'background'* *'bg'* | |
| 2826 | 938 'background' 'bg' string (default "dark" or "light", see below) |
| 7 | 939 global |
| 940 When set to "dark", Vim will try to use colors that look good on a | |
| 941 dark background. When set to "light", Vim will try to use colors that | |
| 942 look good on a light background. Any other value is illegal. | |
| 943 Vim tries to set the default value according to the terminal used. | |
| 944 This will not always be correct. | |
| 945 Setting this option does not change the background color, it tells Vim | |
| 946 what the background color looks like. For changing the background | |
| 947 color, see |:hi-normal|. | |
| 948 | |
| 949 When 'background' is set Vim will adjust the default color groups for | |
| 10 | 950 the new value. But the colors used for syntax highlighting will not |
| 1621 | 951 change. *g:colors_name* |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
952 When a color scheme is loaded (the "g:colors_name" variable is set) |
| 7 | 953 setting 'background' will cause the color scheme to be reloaded. If |
| 954 the color scheme adjusts to the value of 'background' this will work. | |
| 955 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
|
956 be undone. First delete the "g:colors_name" variable when needed. |
| 7 | 957 |
| 958 When setting 'background' to the default value with: > | |
| 959 :set background& | |
| 960 < Vim will guess the value. In the GUI this should work correctly, | |
| 961 in other cases Vim might not be able to guess the right value. | |
| 18343 | 962 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
|
963 'guioptions', see 'go-d'. |
| 7 | 964 |
| 12499 | 965 When the |t_RB| option is set, Vim will use it to request the background |
| 11442 | 966 color from the terminal. If the returned RGB value is dark/light and |
| 967 'background' is not dark/light, 'background' will be set and the | |
| 968 screen is redrawn. This may have side effects, make t_BG empty in | |
| 12499 | 969 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
|
970 be found in |v:termrbgresp|. |
| 11442 | 971 |
| 7 | 972 When starting the GUI, the default value for 'background' will be |
| 973 "light". When the value is not set in the .gvimrc, and Vim detects | |
| 974 that the background is actually quite dark, 'background' is set to | |
| 975 "dark". But this happens only AFTER the .gvimrc file has been read | |
| 976 (because the window needs to be opened to find the actual background | |
| 977 color). To get around this, force the GUI window to be opened by | |
| 978 putting a ":gui" command in the .gvimrc file, before where the value | |
| 979 of 'background' is used (e.g., before ":syntax on"). | |
| 2826 | 980 |
|
18912
ccd16426a1f9
patch 8.2.0017: OS/2 and MS-DOS are still mentioned
Bram Moolenaar <Bram@vim.org>
parents:
18879
diff
changeset
|
981 For MS-Windows the default is "dark". |
| 2826 | 982 For other systems "dark" is used when 'term' is "linux", |
| 983 "screen.linux", "cygwin" or "putty", or $COLORFGBG suggests a dark | |
| 984 background. Otherwise the default is "light". | |
| 985 | |
| 12254 | 986 The |:terminal| command and the |term_start()| function use the |
| 987 'background' value to decide whether the terminal window will start | |
| 988 with a white or black background. | |
| 989 | |
| 7 | 990 Normally this option would be set in the .vimrc file. Possibly |
| 991 depending on the terminal name. Example: > | |
| 992 :if &term == "pcterm" | |
| 993 : set background=dark | |
| 994 :endif | |
| 995 < When this option is set, the default settings for the highlight groups | |
| 996 will change. To use other settings, place ":highlight" commands AFTER | |
| 997 the setting of the 'background' option. | |
| 998 This option is also used in the "$VIMRUNTIME/syntax/syntax.vim" file | |
| 999 to select the colors for syntax highlighting. After changing this | |
| 1000 option, you must load syntax.vim again to see the result. This can be | |
| 1001 done with ":syntax on". | |
| 1002 | |
| 1003 *'backspace'* *'bs'* | |
|
9669
284b4eb307fc
commit https://github.com/vim/vim/commit/8c08b5b569e2a9e9f63dea514591ecfa2d3bb392
Christian Brabandt <cb@256bit.org>
parents:
9665
diff
changeset
|
1004 '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
|
1005 in |defaults.vim|) |
| 7 | 1006 global |
| 1007 Influences the working of <BS>, <Del>, CTRL-W and CTRL-U in Insert | |
| 1008 mode. This is a list of items, separated by commas. Each item allows | |
| 1009 a way to backspace over something: | |
| 1010 value effect ~ | |
| 1011 indent allow backspacing over autoindent | |
| 1012 eol allow backspacing over line breaks (join lines) | |
| 1013 start allow backspacing over the start of insert; CTRL-W and CTRL-U | |
| 1014 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
|
1015 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
|
1016 insert. |
| 7 | 1017 |
| 28246 | 1018 When the value is empty, Vi compatible backspacing is used, none of |
| 1019 the ways mentioned for the items above are possible. | |
| 7 | 1020 |
| 1021 For backwards compatibility with version 5.4 and earlier: | |
| 1022 value effect ~ | |
| 1023 0 same as ":set backspace=" (Vi compatible) | |
| 1024 1 same as ":set backspace=indent,eol" | |
| 1025 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
|
1026 3 same as ":set backspace=indent,eol,nostop" |
| 7 | 1027 |
| 1028 See |:fixdel| if your <BS> or <Del> key does not do what you want. | |
| 1029 NOTE: This option is set to "" when 'compatible' is set. | |
| 1030 | |
| 1031 *'backup'* *'bk'* *'nobackup'* *'nobk'* | |
| 1032 'backup' 'bk' boolean (default off) | |
| 1033 global | |
| 1034 Make a backup before overwriting a file. Leave it around after the | |
| 1035 file has been successfully written. If you do not want to keep the | |
| 1036 backup file, but you do want a backup while the file is being | |
| 1037 written, reset this option and set the 'writebackup' option (this is | |
| 1038 the default). If you do not want a backup file at all reset both | |
| 10 | 1039 options (use this if your file system is almost full). See the |
| 7 | 1040 |backup-table| for more explanations. |
| 1041 When the 'backupskip' pattern matches, a backup is not made anyway. | |
| 1042 When 'patchmode' is set, the backup may be renamed to become the | |
| 1043 oldest version of a file. | |
| 1044 NOTE: This option is reset when 'compatible' is set. | |
| 1045 | |
| 1046 *'backupcopy'* *'bkc'* | |
| 1047 'backupcopy' 'bkc' string (Vi default for Unix: "yes", otherwise: "auto") | |
| 6243 | 1048 global or local to buffer |global-local| |
| 7 | 1049 When writing a file and a backup is made, this option tells how it's |
| 28379 | 1050 done. This is a comma-separated list of words. |
| 7 | 1051 |
| 1052 The main values are: | |
| 1053 "yes" make a copy of the file and overwrite the original one | |
| 1054 "no" rename the file and write a new one | |
| 1055 "auto" one of the previous, what works best | |
| 1056 | |
| 1057 Extra values that can be combined with the ones above are: | |
| 1058 "breaksymlink" always break symlinks when writing | |
| 1059 "breakhardlink" always break hardlinks when writing | |
| 1060 | |
| 1061 Making a copy and overwriting the original file: | |
| 1062 - Takes extra time to copy the file. | |
| 1063 + When the file has special attributes, is a (hard/symbolic) link or | |
| 1064 has a resource fork, all this is preserved. | |
| 1065 - When the file is a link the backup will have the name of the link, | |
| 1066 not of the real file. | |
| 1067 | |
| 1068 Renaming the file and writing a new one: | |
| 1069 + It's fast. | |
| 1070 - Sometimes not all attributes of the file can be copied to the new | |
| 1071 file. | |
| 1072 - When the file is a link the new file will not be a link. | |
| 1073 | |
| 28379 | 1074 The "auto" value is the middle way: When Vim sees that renaming the |
| 1075 file is possible without side effects (the attributes can be passed on | |
| 1076 and the file is not a link) that is used. When problems are expected, | |
| 1077 a copy will be made. | |
| 7 | 1078 |
| 1079 The "breaksymlink" and "breakhardlink" values can be used in | |
| 1080 combination with any of "yes", "no" and "auto". When included, they | |
| 1081 force Vim to always break either symbolic or hard links by doing | |
| 1082 exactly what the "no" option does, renaming the original file to | |
| 1083 become the backup and writing a new file in its place. This can be | |
| 1084 useful for example in source trees where all the files are symbolic or | |
| 1085 hard links and any changes should stay in the local source tree, not | |
| 1086 be propagated back to the original source. | |
| 1087 *crontab* | |
| 1088 One situation where "no" and "auto" will cause problems: A program | |
| 1089 that opens a file, invokes Vim to edit that file, and then tests if | |
| 1090 the open file was changed (through the file descriptor) will check the | |
| 10 | 1091 backup file instead of the newly created file. "crontab -e" is an |
| 7 | 1092 example. |
| 1093 | |
| 1094 When a copy is made, the original file is truncated and then filled | |
| 1095 with the new text. This means that protection bits, owner and | |
| 28379 | 1096 symbolic links of the original file are unmodified. The backup file, |
| 10 | 1097 however, is a new file, owned by the user who edited the file. The |
| 7 | 1098 group of the backup is set to the group of the original file. If this |
| 1099 fails, the protection bits for the group are made the same as for | |
| 1100 others. | |
| 1101 | |
| 28379 | 1102 When the file is renamed, this is the other way around: The backup has |
| 7 | 1103 the same attributes of the original file, and the newly written file |
| 1104 is owned by the current user. When the file was a (hard/symbolic) | |
| 1105 link, the new file will not! That's why the "auto" value doesn't | |
| 1106 rename when the file is a link. The owner and group of the newly | |
| 1107 written file will be set to the same ones as the original file, but | |
| 1108 the system may refuse to do this. In that case the "auto" value will | |
| 1109 again not rename the file. | |
| 1110 | |
| 11160 | 1111 NOTE: This option is set to the Vi default value when 'compatible' is |
| 1112 set and to the Vim default value when 'compatible' is reset. | |
| 1113 | |
| 7 | 1114 *'backupdir'* *'bdir'* |
| 1115 'backupdir' 'bdir' string (default for Amiga: ".,t:", | |
| 18972 | 1116 for Win32: ".,$TEMP,c:/tmp,c:/temp" |
| 7 | 1117 for Unix: ".,~/tmp,~/") |
| 1118 global | |
| 1119 List of directories for the backup file, separated with commas. | |
| 1120 - 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
|
1121 where this is possible. The directory must exist, Vim will not |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
1122 create it for you. |
|
8629
54ac275e3fc4
commit https://github.com/vim/vim/commit/3848e00e0177abdb31bc600234967863ec487233
Christian Brabandt <cb@256bit.org>
parents:
8560
diff
changeset
|
1123 - Empty means that no backup file will be created ('patchmode' is |
| 7 | 1124 impossible!). Writing may fail because of this. |
| 1125 - A directory "." means to put the backup file in the same directory | |
| 1126 as the edited file. | |
| 19116 | 1127 - A directory starting with "./" (or ".\" for MS-Windows) means to put |
| 1128 the backup file relative to where the edited file is. The leading | |
| 1129 "." is replaced with the path name of the edited file. | |
| 7 | 1130 ("." inside a directory name has no special meaning). |
| 1131 - Spaces after the comma are ignored, other spaces are considered part | |
| 1132 of the directory name. To have a space at the start of a directory | |
| 1133 name, precede it with a backslash. | |
| 1134 - To include a comma in a directory name precede it with a backslash. | |
| 1135 - 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
|
1136 - For Unix and Win32, if a directory ends in two path separators "//", |
| 15033 | 1137 the backup file name will be built from the complete path to the |
| 1138 file with all path separators changed to percent '%' signs. This | |
| 1139 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
|
1140 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
|
1141 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
|
1142 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
|
1143 use '//', instead of '\\'. |
| 7 | 1144 - Environment variables are expanded |:set_env|. |
| 1145 - Careful with '\' characters, type one before a space, type two to | |
| 1146 get one in the option (see |option-backslash|), for example: > | |
| 1147 :set bdir=c:\\tmp,\ dir\\,with\\,commas,\\\ dir\ with\ spaces | |
| 1148 < - For backwards compatibility with Vim version 3.0 a '>' at the start | |
| 1149 of the option is removed. | |
| 1150 See also 'backup' and 'writebackup' options. | |
| 1151 If you want to hide your backup files on Unix, consider this value: > | |
| 1152 :set backupdir=./.backup,~/.backup,.,/tmp | |
| 1153 < You must create a ".backup" directory in each directory and in your | |
| 1154 home directory for this to work properly. | |
| 1155 The use of |:set+=| and |:set-=| is preferred when adding or removing | |
| 1156 directories from the list. This avoids problems when a future version | |
| 1157 uses another default. | |
| 1158 This option cannot be set from a |modeline| or in the |sandbox|, for | |
| 1159 security reasons. | |
| 1160 | |
| 1161 *'backupext'* *'bex'* *E589* | |
| 1162 'backupext' 'bex' string (default "~", for VMS: "_") | |
| 1163 global | |
| 1164 String which is appended to a file name to make the name of the | |
| 1165 backup file. The default is quite unusual, because this avoids | |
| 1166 accidentally overwriting existing files with a backup file. You might | |
| 1167 prefer using ".bak", but make sure that you don't have files with | |
| 1168 ".bak" that you want to keep. | |
| 28379 | 1169 Only normal file name characters can be used; "/\*?[|<>" are illegal. |
| 7 | 1170 |
| 26 | 1171 If you like to keep a lot of backups, you could use a BufWritePre |
| 1172 autocommand to change 'backupext' just before writing the file to | |
| 1173 include a timestamp. > | |
| 27903 | 1174 :au BufWritePre * let &bex = '-' .. strftime("%Y%b%d%X") .. '~' |
| 26 | 1175 < Use 'backupdir' to put the backup in a different directory. |
| 1176 | |
| 7 | 1177 *'backupskip'* *'bsk'* |
|
13664
f64c5e636c9f
patch 8.0.1704: 'backupskip' default doesn't work for Mac
Christian Brabandt <cb@256bit.org>
parents:
13482
diff
changeset
|
1178 '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
|
1179 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
|
1180 Mac: "/private/tmp/*,$TMPDIR/*,$TMP/*,$TEMP/*") |
| 7 | 1181 global |
| 1182 A list of file patterns. When one of the patterns matches with the | |
| 1183 name of the file which is written, no backup file is created. Both | |
| 1184 the specified file name and the full path name of the file are used. | |
| 1185 The pattern is used like with |:autocmd|, see |autocmd-patterns|. | |
| 1186 Watch out for special characters, see |option-backslash|. | |
| 1187 When $TMPDIR, $TMP or $TEMP is not defined, it is not used for the | |
| 233 | 1188 default value. "/tmp/*" is only used for Unix. |
| 1152 | 1189 |
| 3513 | 1190 WARNING: Not having a backup file means that when Vim fails to write |
| 1191 your buffer correctly and then, for whatever reason, Vim exits, you | |
| 1192 lose both the original file and what you were writing. Only disable | |
| 1193 backups if you don't care about losing the file. | |
| 1194 | |
| 1152 | 1195 Note that environment variables are not expanded. If you want to use |
| 1196 $HOME you must expand it explicitly, e.g.: > | |
| 27903 | 1197 :let &backupskip = escape(expand('$HOME'), '\') .. '/tmp/*' |
| 1152 | 1198 |
| 1199 < Note that the default also makes sure that "crontab -e" works (when a | |
| 557 | 1200 backup would be made by renaming the original file crontab won't see |
| 1201 the newly created file). Also see 'backupcopy' and |crontab|. | |
| 7 | 1202 |
| 1203 *'balloondelay'* *'bdlay'* | |
| 1204 'balloondelay' 'bdlay' number (default: 600) | |
| 1205 global | |
| 1206 {only available when compiled with the |+balloon_eval| | |
| 1207 feature} | |
| 1208 Delay in milliseconds before a balloon may pop up. See |balloon-eval|. | |
| 1209 | |
| 1210 *'ballooneval'* *'beval'* *'noballooneval'* *'nobeval'* | |
| 1211 'ballooneval' 'beval' boolean (default off) | |
| 1212 global | |
| 1213 {only available when compiled with the |+balloon_eval| | |
| 189 | 1214 feature} |
|
12865
ebb4f6c93598
patch 8.0.1309: cannot use 'balloonexpr' in a terminal
Christian Brabandt <cb@256bit.org>
parents:
12826
diff
changeset
|
1215 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
|
1216 |
|
ebb4f6c93598
patch 8.0.1309: cannot use 'balloonexpr' in a terminal
Christian Brabandt <cb@256bit.org>
parents:
12826
diff
changeset
|
1217 *'balloonevalterm'* *'bevalterm'* *'noballoonevalterm'* |
|
ebb4f6c93598
patch 8.0.1309: cannot use 'balloonexpr' in a terminal
Christian Brabandt <cb@256bit.org>
parents:
12826
diff
changeset
|
1218 *'nobevalterm'* |
|
ebb4f6c93598
patch 8.0.1309: cannot use 'balloonexpr' in a terminal
Christian Brabandt <cb@256bit.org>
parents:
12826
diff
changeset
|
1219 '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
|
1220 global |
|
ebb4f6c93598
patch 8.0.1309: cannot use 'balloonexpr' in a terminal
Christian Brabandt <cb@256bit.org>
parents:
12826
diff
changeset
|
1221 {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
|
1222 |+balloon_eval_term| feature} |
|
ebb4f6c93598
patch 8.0.1309: cannot use 'balloonexpr' in a terminal
Christian Brabandt <cb@256bit.org>
parents:
12826
diff
changeset
|
1223 Switch on the |balloon-eval| functionality for the terminal. |
| 7 | 1224 |
| 189 | 1225 *'balloonexpr'* *'bexpr'* |
| 1226 'balloonexpr' 'bexpr' string (default "") | |
| 790 | 1227 global or local to buffer |global-local| |
| 189 | 1228 {only available when compiled with the |+balloon_eval| |
| 1229 feature} | |
| 782 | 1230 Expression for text to show in evaluation balloon. It is only used |
| 16610 | 1231 when 'ballooneval' or 'balloonevalterm' is on. These variables can be |
| 1232 used: | |
| 189 | 1233 |
| 1234 v:beval_bufnr number of the buffer in which balloon is going to show | |
| 1235 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
|
1236 v:beval_winid ID of the window |
| 189 | 1237 v:beval_lnum line number |
| 1238 v:beval_col column number (byte index) | |
| 1239 v:beval_text word under or after the mouse pointer | |
| 1240 | |
| 17571 | 1241 Instead of showing a balloon, which is limited to plain text, consider |
| 1242 using a popup window, see |popup_beval_example|. A popup window can | |
| 1243 use highlighting and show a border. | |
| 1244 | |
| 189 | 1245 The evaluation of the expression must not have side effects! |
| 1246 Example: > | |
| 16610 | 1247 function MyBalloonExpr() |
| 27903 | 1248 return 'Cursor is at line ' .. v:beval_lnum .. |
| 1249 \ ', column ' .. v:beval_col .. | |
| 1250 \ ' of file ' .. bufname(v:beval_bufnr) .. | |
| 1251 \ ' on word "' .. v:beval_text .. '"' | |
| 189 | 1252 endfunction |
| 1253 set bexpr=MyBalloonExpr() | |
| 31579 | 1254 set ballooneval balloonevalterm |
| 189 | 1255 < |
| 17372 | 1256 Also see |balloon_show()|, it can be used if the content of the balloon |
| 1257 is to be fetched asynchronously. In that case evaluating | |
| 1258 'balloonexpr' should result in an empty string. If you get a balloon | |
| 1259 with only "0" you probably didn't return anything from your function. | |
| 11062 | 1260 |
| 189 | 1261 NOTE: The balloon is displayed only if the cursor is on a text |
| 1262 character. If the result of evaluating 'balloonexpr' is not empty, | |
| 1263 Vim does not try to send a message to an external debugger (Netbeans | |
| 1264 or Sun Workshop). | |
| 1265 | |
|
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
|
1266 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
|
1267 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
|
1268 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
|
1269 set bexpr=<SID>SomeBalloonExpr() |
| 27321 | 1270 < Otherwise, the expression is evaluated in the context of the script |
| 1271 where the option was set, thus script-local items are available. | |
| 1272 | |
| 3682 | 1273 The expression will be evaluated in the |sandbox| when set from a |
| 1274 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
|
1275 This option cannot be set in a modeline when 'modelineexpr' is off. |
| 634 | 1276 |
| 1277 It is not allowed to change text or jump to another window while | |
| 17372 | 1278 evaluating 'balloonexpr', see |textlock|. |
| 634 | 1279 |
| 446 | 1280 To check whether line breaks in the balloon text work use this check: > |
| 435 | 1281 if has("balloon_multiline") |
| 714 | 1282 < When they are supported "\n" characters will start a new line. If the |
| 1283 expression evaluates to a |List| this is equal to using each List item | |
| 1284 as a string and putting "\n" in between them. | |
| 11160 | 1285 NOTE: This option is set to "" when 'compatible' is set. |
| 714 | 1286 |
| 6949 | 1287 *'belloff'* *'bo'* |
| 1288 'belloff' 'bo' string (default "") | |
| 1289 global | |
| 1290 Specifies for which events the bell will not be rung. It is a comma | |
| 1291 separated list of items. For each item that is present, the bell | |
| 1292 will be silenced. This is most useful to specify specific events in | |
| 1293 insert mode to be silenced. | |
|
28439
16bd027b039e
patch 8.2.4744: a terminal window can't use the bell
Bram Moolenaar <Bram@vim.org>
parents:
28399
diff
changeset
|
1294 You can also make it flash by using 'visualbell'. |
| 6949 | 1295 |
| 1296 item meaning when present ~ | |
| 1297 all All events. | |
| 1298 backspace When hitting <BS> or <Del> and deleting results in an | |
| 1299 error. | |
| 1300 cursor Fail to move around using the cursor keys or | |
| 1301 <PageUp>/<PageDown> in |Insert-mode|. | |
| 1302 complete Error occurred when using |i_CTRL-X_CTRL-K| or | |
| 1303 |i_CTRL-X_CTRL-T|. | |
| 1304 copy Cannot copy char from insert mode using |i_CTRL-Y| or | |
| 1305 |i_CTRL-E|. | |
| 1306 ctrlg Unknown Char after <C-G> in Insert mode. | |
| 1307 error Other Error occurred (e.g. try to join last line) | |
| 1308 (mostly used in |Normal-mode| or |Cmdline-mode|). | |
| 1309 esc hitting <Esc> in |Normal-mode|. | |
| 1310 ex In |Visual-mode|, hitting |Q| results in an error. | |
| 18719 | 1311 hangul Ignored. |
| 6949 | 1312 insertmode Pressing <Esc> in 'insertmode'. |
| 1313 lang Calling the beep module for Lua/Mzscheme/TCL. | |
| 1314 mess No output available for |g<|. | |
| 1315 showmatch Error occurred for 'showmatch' function. | |
| 1316 operator Empty region error |cpo-E|. | |
| 1317 register Unknown register after <C-R> in |Insert-mode|. | |
| 1318 shell Bell from shell output |:!|. | |
| 1319 spell Error happened on spell suggest. | |
|
28439
16bd027b039e
patch 8.2.4744: a terminal window can't use the bell
Bram Moolenaar <Bram@vim.org>
parents:
28399
diff
changeset
|
1320 term Bell from |:terminal| output. |
| 6949 | 1321 wildmode More matches in |cmdline-completion| available |
| 1322 (depends on the 'wildmode' setting). | |
| 1323 | |
| 11160 | 1324 This is most useful to fine tune when in Insert mode the bell should |
| 1325 be rung. For Normal mode and Ex commands, the bell is often rung to | |
| 6949 | 1326 indicate that an error occurred. It can be silenced by adding the |
| 1327 "error" keyword. | |
| 1328 | |
| 7 | 1329 *'binary'* *'bin'* *'nobinary'* *'nobin'* |
| 1330 'binary' 'bin' boolean (default off) | |
| 1331 local to buffer | |
| 1332 This option should be set before editing a binary file. You can also | |
| 1333 use the |-b| Vim argument. When this option is switched on a few | |
| 1334 options will be changed (also when it already was on): | |
| 1335 'textwidth' will be set to 0 | |
| 1336 'wrapmargin' will be set to 0 | |
| 1337 'modeline' will be off | |
| 1338 'expandtab' will be off | |
| 1339 Also, 'fileformat' and 'fileformats' options will not be used, the | |
| 1340 file is read and written like 'fileformat' was "unix" (a single <NL> | |
| 1341 separates lines). | |
| 1342 The 'fileencoding' and 'fileencodings' options will not be used, the | |
| 1343 file is read without conversion. | |
| 1344 NOTE: When you start editing a(nother) file while the 'bin' option is | |
| 1345 on, settings from autocommands may change the settings again (e.g., | |
| 1346 'textwidth'), causing trouble when editing. You might want to set | |
| 1347 'bin' again when the file has been loaded. | |
| 1348 The previous values of these options are remembered and restored when | |
| 1349 'bin' is switched from on to off. Each buffer has its own set of | |
| 1350 saved option values. | |
| 1351 To edit a file with 'binary' set you can use the |++bin| argument. | |
| 1352 This avoids you have to do ":set bin", which would have effect for all | |
| 1353 files you edit. | |
| 1354 When writing a file the <EOL> for the last line is only written if | |
| 1355 there was one in the original file (normally Vim appends an <EOL> to | |
| 1356 the last line if there is none; this would make the file longer). See | |
| 1357 the 'endofline' option. | |
| 1358 | |
| 1359 *'bioskey'* *'biosk'* *'nobioskey'* *'nobiosk'* | |
| 1360 'bioskey' 'biosk' boolean (default on) | |
| 1361 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
|
1362 {only for MS-DOS} |
|
8246
f16bfe02cef1
commit https://github.com/vim/vim/commit/f391327adbbffb11180cf6038a92af1ed144e907
Christian Brabandt <cb@256bit.org>
parents:
8182
diff
changeset
|
1363 This was for MS-DOS and is no longer supported. |
| 7 | 1364 |
| 1365 *'bomb'* *'nobomb'* | |
| 1366 'bomb' boolean (default off) | |
| 1367 local to buffer | |
| 1368 When writing a file and the following conditions are met, a BOM (Byte | |
| 1369 Order Mark) is prepended to the file: | |
| 1370 - this option is on | |
| 1371 - the 'binary' option is off | |
| 1372 - 'fileencoding' is "utf-8", "ucs-2", "ucs-4" or one of the little/big | |
| 1373 endian variants. | |
| 1374 Some applications use the BOM to recognize the encoding of the file. | |
| 1375 Often used for UCS-2 files on MS-Windows. For other applications it | |
| 1376 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
|
1377 appear halfway the resulting file. Gcc doesn't accept a BOM. |
| 7 | 1378 When Vim reads a file and 'fileencodings' starts with "ucs-bom", a |
| 1379 check for the presence of the BOM is done and 'bomb' set accordingly. | |
| 1380 Unless 'binary' is set, it is removed from the first line, so that you | |
| 1381 don't see it when editing. When you don't change the options, the BOM | |
| 1382 will be restored when writing the file. | |
| 1383 | |
| 1384 *'breakat'* *'brk'* | |
| 1385 'breakat' 'brk' string (default " ^I!@*-+;:,./?") | |
| 1386 global | |
|
2570
71b56b4e7785
Make the references to features in the help more consistent. (Sylvain Hitier)
Bram Moolenaar <bram@vim.org>
parents:
2561
diff
changeset
|
1387 {not available when compiled without the |+linebreak| |
| 7 | 1388 feature} |
| 1389 This option lets you choose which characters might cause a line | |
| 500 | 1390 break if 'linebreak' is on. Only works for ASCII and also for 8-bit |
| 1391 characters when 'encoding' is an 8-bit encoding. | |
| 7 | 1392 |
|
8835
c1a5623cfc86
commit https://github.com/vim/vim/commit/7c1c6dbb6817640fd3956a0d5417da23fde336d8
Christian Brabandt <cb@256bit.org>
parents:
8748
diff
changeset
|
1393 *'breakindent'* *'bri'* *'nobreakindent'* *'nobri'* |
| 6009 | 1394 'breakindent' 'bri' boolean (default off) |
| 1395 local to window | |
| 1396 {not available when compiled without the |+linebreak| | |
| 1397 feature} | |
| 1398 Every wrapped line will continue visually indented (same amount of | |
| 1399 space as the beginning of that line), thus preserving horizontal blocks | |
| 1400 of text. | |
| 11160 | 1401 NOTE: This option is reset when 'compatible' is set. |
| 6009 | 1402 |
| 1403 *'breakindentopt'* *'briopt'* | |
| 1404 'breakindentopt' 'briopt' string (default empty) | |
| 1405 local to window | |
| 1406 {not available when compiled without the |+linebreak| | |
| 1407 feature} | |
| 1408 Settings for 'breakindent'. It can consist of the following optional | |
| 6026 | 1409 items and must be separated by a comma: |
| 6009 | 1410 min:{n} Minimum text width that will be kept after |
| 1411 applying 'breakindent', even if the resulting | |
| 1412 text should normally be narrower. This prevents | |
| 1413 text indented almost to the right window border | |
| 1414 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
|
1415 (default: 20) |
| 6026 | 1416 shift:{n} After applying 'breakindent', the wrapped line's |
| 1417 beginning will be shifted by the given number of | |
| 1418 characters. It permits dynamic French paragraph | |
| 6009 | 1419 indentation (negative) or emphasizing the line |
| 1420 continuation (positive). | |
|
28716
2bd5cb054180
patch 8.2.4882: cannot make 'breakindent' use a specific column
Bram Moolenaar <Bram@vim.org>
parents:
28517
diff
changeset
|
1421 (default: 0) |
|
13341
acd7eaa13d2b
Updated runtime files.
Christian Brabandt <cb@256bit.org>
parents:
13314
diff
changeset
|
1422 sbr Display the 'showbreak' value before applying the |
| 6009 | 1423 additional indent. |
|
28716
2bd5cb054180
patch 8.2.4882: cannot make 'breakindent' use a specific column
Bram Moolenaar <Bram@vim.org>
parents:
28517
diff
changeset
|
1424 (default: off) |
|
25322
b3d7becabe99
patch 8.2.3198: cannot use 'formatlistpat' for breakindent
Bram Moolenaar <Bram@vim.org>
parents:
25248
diff
changeset
|
1425 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
|
1426 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
|
1427 'formatlistpat' setting). |
|
25322
b3d7becabe99
patch 8.2.3198: cannot use 'formatlistpat' for breakindent
Bram Moolenaar <Bram@vim.org>
parents:
25248
diff
changeset
|
1428 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
|
1429 for indentation. |
|
28716
2bd5cb054180
patch 8.2.4882: cannot make 'breakindent' use a specific column
Bram Moolenaar <Bram@vim.org>
parents:
28517
diff
changeset
|
1430 (default: 0) |
|
2bd5cb054180
patch 8.2.4882: cannot make 'breakindent' use a specific column
Bram Moolenaar <Bram@vim.org>
parents:
28517
diff
changeset
|
1431 column:{n} Indent at column {n}. Will overrule the other |
|
2bd5cb054180
patch 8.2.4882: cannot make 'breakindent' use a specific column
Bram Moolenaar <Bram@vim.org>
parents:
28517
diff
changeset
|
1432 sub-options. Note: an additional indent may be |
|
2bd5cb054180
patch 8.2.4882: cannot make 'breakindent' use a specific column
Bram Moolenaar <Bram@vim.org>
parents:
28517
diff
changeset
|
1433 added for the 'showbreak' setting. |
|
2bd5cb054180
patch 8.2.4882: cannot make 'breakindent' use a specific column
Bram Moolenaar <Bram@vim.org>
parents:
28517
diff
changeset
|
1434 (default: off) |
| 6009 | 1435 |
| 7 | 1436 *'browsedir'* *'bsdir'* |
| 29 | 1437 'browsedir' 'bsdir' string (default: "last") |
| 7 | 1438 global |
| 28379 | 1439 {only for Motif, GTK, Mac and Win32 GUI} |
| 7 | 1440 Which directory to use for the file browser: |
| 1621 | 1441 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
|
1442 file was opened or saved. |
| 7 | 1443 buffer Use the directory of the related buffer. |
| 1444 current Use the current directory. | |
| 1445 {path} Use the specified directory | |
| 1446 | |
| 1447 *'bufhidden'* *'bh'* | |
| 1448 'bufhidden' 'bh' string (default: "") | |
| 1449 local to buffer | |
| 1450 This option specifies what happens when a buffer is no longer | |
| 1451 displayed in a window: | |
| 1452 <empty> follow the global 'hidden' option | |
| 28379 | 1453 hide hide the buffer (don't unload it), even if 'hidden' is |
| 1454 not set | |
| 1455 unload unload the buffer, even if 'hidden' is set; the | |
| 29290 | 1456 |:hide| command will also unload the buffer |
| 28379 | 1457 delete delete the buffer from the buffer list, even if |
| 1458 'hidden' is set; the |:hide| command will also delete | |
| 1459 the buffer, making it behave like |:bdelete| | |
| 1460 wipe wipe the buffer from the buffer list, even if | |
| 1461 'hidden' is set; the |:hide| command will also wipe | |
| 1462 out the buffer, making it behave like |:bwipeout| | |
| 7 | 1463 |
| 82 | 1464 CAREFUL: when "unload", "delete" or "wipe" is used changes in a buffer |
| 3224 | 1465 are lost without a warning. Also, these values may break autocommands |
| 1466 that switch between buffers temporarily. | |
| 7 | 1467 This option is used together with 'buftype' and 'swapfile' to specify |
| 1468 special kinds of buffers. See |special-buffers|. | |
| 1469 | |
| 1470 *'buflisted'* *'bl'* *'nobuflisted'* *'nobl'* *E85* | |
| 1471 'buflisted' 'bl' boolean (default: on) | |
| 1472 local to buffer | |
| 1473 When this option is set, the buffer shows up in the buffer list. If | |
| 1474 it is reset it is not used for ":bnext", "ls", the Buffers menu, etc. | |
| 1475 This option is reset by Vim for buffers that are only used to remember | |
| 1476 a file name or marks. Vim sets it when starting to edit a buffer. | |
| 1477 But not when moving to a buffer with ":buffer". | |
| 1478 | |
| 1479 *'buftype'* *'bt'* *E382* | |
| 1480 'buftype' 'bt' string (default: "") | |
| 1481 local to buffer | |
| 1482 The value of this option specifies the type of a buffer: | |
| 1483 <empty> normal buffer | |
| 1484 nofile buffer which is not related to a file and will not be | |
| 1485 written | |
| 1486 nowrite buffer which will not be written | |
| 17 | 1487 acwrite buffer which will always be written with BufWriteCmd |
| 13437 | 1488 autocommands. |
| 7 | 1489 quickfix quickfix buffer, contains list of errors |:cwindow| |
| 648 | 1490 or list of locations |:lwindow| |
| 7 | 1491 help help buffer (you are not supposed to set this |
| 1492 manually) | |
|
11757
74abb6c84984
patch 8.0.0761: options not set properly for a terminal buffer
Christian Brabandt <cb@256bit.org>
parents:
11666
diff
changeset
|
1493 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
|
1494 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
|
1495 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
|
1496 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
|
1497 {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
|
1498 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
|
1499 {only when compiled with the |+textprop| feature} |
| 7 | 1500 |
| 1501 This option is used together with 'bufhidden' and 'swapfile' to | |
| 1502 specify special kinds of buffers. See |special-buffers|. | |
| 19404 | 1503 Also see |win_gettype()|, which returns the type of the window. |
| 7 | 1504 |
| 1505 Be careful with changing this option, it can have many side effects! | |
| 26100 | 1506 One such effect is that Vim will not check the timestamp of the file, |
| 1507 if the file is changed by another program this will not be noticed. | |
| 7 | 1508 |
| 648 | 1509 A "quickfix" buffer is only used for the error list and the location |
| 1510 list. This value is set by the |:cwindow| and |:lwindow| commands and | |
| 1511 you are not supposed to change it. | |
| 7 | 1512 |
| 1513 "nofile" and "nowrite" buffers are similar: | |
| 1514 both: The buffer is not to be written to disk, ":w" doesn't | |
| 1515 work (":w filename" does work though). | |
| 1516 both: The buffer is never considered to be |'modified'|. | |
| 1517 There is no warning when the changes will be lost, for | |
| 1518 example when you quit Vim. | |
| 1519 both: A swap file is only created when using too much memory | |
| 1520 (when 'swapfile' has been reset there is never a swap | |
| 1521 file). | |
| 1522 nofile only: The buffer name is fixed, it is not handled like a | |
| 1523 file name. It is not modified in response to a |:cd| | |
| 1524 command. | |
| 6647 | 1525 both: When using ":e bufname" and already editing "bufname" |
| 1526 the buffer is made empty and autocommands are | |
| 1527 triggered as usual for |:edit|. | |
| 17 | 1528 *E676* |
| 1529 "acwrite" implies that the buffer name is not related to a file, like | |
| 1530 "nofile", but it will be written. Thus, in contrast to "nofile" and | |
| 1531 "nowrite", ":w" does work and a modified buffer can't be abandoned | |
| 1532 without saving. For writing there must be matching |BufWriteCmd|, | |
| 1533 |FileWriteCmd| or |FileAppendCmd| autocommands. | |
| 7 | 1534 |
| 1535 *'casemap'* *'cmp'* | |
| 1536 'casemap' 'cmp' string (default: "internal,keepascii") | |
| 1537 global | |
| 1538 Specifies details about changing the case of letters. It may contain | |
| 1539 these words, separated by a comma: | |
| 1540 internal Use internal case mapping functions, the current | |
| 1541 locale does not change the case mapping. This only | |
| 493 | 1542 matters when 'encoding' is a Unicode encoding, |
| 1543 "latin1" or "iso-8859-15". When "internal" is | |
| 1544 omitted, the towupper() and towlower() system library | |
| 1545 functions are used when available. | |
| 7 | 1546 keepascii For the ASCII characters (0x00 to 0x7f) use the US |
| 1547 case mapping, the current locale is not effective. | |
| 1548 This probably only matters for Turkish. | |
| 1549 | |
| 32004 | 1550 *'cdhome'* *'cdh'* *'nocdhome'* *'nocdh'* |
|
26508
a0bc10e83cf8
patch 8.2.3784: the help for options is outdated
Bram Moolenaar <Bram@vim.org>
parents:
26441
diff
changeset
|
1551 '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
|
1552 global |
|
a0bc10e83cf8
patch 8.2.3784: the help for options is outdated
Bram Moolenaar <Bram@vim.org>
parents:
26441
diff
changeset
|
1553 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
|
1554 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
|
1555 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
|
1556 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
|
1557 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
|
1558 |
| 7 | 1559 *'cdpath'* *'cd'* *E344* *E346* |
| 1560 'cdpath' 'cd' string (default: equivalent to $CDPATH or ",,") | |
| 1561 global | |
| 1562 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
|
1563 |: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
|
1564 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
|
1565 "/", "./" or "../", the 'cdpath' option is not used then. |
| 7 | 1566 The 'cdpath' option's value has the same form and semantics as |
| 1567 |'path'|. Also see |file-searching|. | |
| 1568 The default value is taken from $CDPATH, with a "," prepended to look | |
| 1569 in the current directory first. | |
| 1570 If the default value taken from $CDPATH is not what you want, include | |
| 1571 a modified version of the following command in your vimrc file to | |
| 1572 override it: > | |
| 27903 | 1573 :let &cdpath = ',' .. substitute(substitute($CDPATH, '[, ]', '\\\0', 'g'), ':', ',', 'g') |
| 7 | 1574 < This option cannot be set from a |modeline| or in the |sandbox|, for |
| 1575 security reasons. | |
| 1576 (parts of 'cdpath' can be passed to the shell to expand file names). | |
| 1577 | |
| 1578 *'cedit'* | |
| 1579 'cedit' string (Vi default: "", Vim default: CTRL-F) | |
| 1580 global | |
| 1581 The key used in Command-line Mode to open the command-line window. | |
| 1582 The default is CTRL-F when 'compatible' is off. | |
| 1583 Only non-printable keys are allowed. | |
| 1584 The key can be specified as a single character, but it is difficult to | |
| 1585 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
|
1586 :exe "set cedit=\<C-Y>" |
|
619a98a67f67
commit https://github.com/vim/vim/commit/e18dbe865d190e74fb5d43ac8bc6ac22507d0223
Christian Brabandt <cb@256bit.org>
parents:
9344
diff
changeset
|
1587 :exe "set cedit=\<Esc>" |
| 7 | 1588 < |Nvi| also has this option, but it only uses the first character. |
| 1589 See |cmdwin|. | |
| 11160 | 1590 NOTE: This option is set to the Vim default value when 'compatible' |
| 1591 is reset. | |
| 7 | 1592 |
| 1593 *'charconvert'* *'ccv'* *E202* *E214* *E513* | |
| 1594 'charconvert' 'ccv' string (default "") | |
| 1595 global | |
| 15878 | 1596 {only available when compiled with the |+eval| feature} |
| 7 | 1597 An expression that is used for character encoding conversion. It is |
| 1598 evaluated when a file that is to be read or has been written has a | |
| 1599 different encoding from what is desired. | |
| 1600 'charconvert' is not used when the internal iconv() function is | |
| 1601 supported and is able to do the conversion. Using iconv() is | |
| 1602 preferred, because it is much faster. | |
| 1603 'charconvert' is not used when reading stdin |--|, because there is no | |
| 1604 file to convert from. You will have to save the text in a file first. | |
| 27459 | 1605 The expression must return zero, false or an empty string for success, |
| 1606 non-zero or true for failure. | |
| 7 | 1607 The possible encoding names encountered are in 'encoding'. |
| 1608 Additionally, names given in 'fileencodings' and 'fileencoding' are | |
| 1609 used. | |
| 1610 Conversion between "latin1", "unicode", "ucs-2", "ucs-4" and "utf-8" | |
| 1611 is done internally by Vim, 'charconvert' is not used for this. | |
| 1612 'charconvert' is also used to convert the viminfo file, if the 'c' | |
| 1613 flag is present in 'viminfo'. Also used for Unicode conversion. | |
| 1614 Example: > | |
| 1615 set charconvert=CharConvert() | |
| 1616 fun CharConvert() | |
| 1617 system("recode " | |
| 27903 | 1618 \ .. v:charconvert_from .. ".." .. v:charconvert_to |
| 1619 \ .. " <" .. v:fname_in .. " >" .. v:fname_out) | |
| 7 | 1620 return v:shell_error |
| 1621 endfun | |
| 1622 < The related Vim variables are: | |
| 1623 v:charconvert_from name of the current encoding | |
| 1624 v:charconvert_to name of the desired encoding | |
| 1625 v:fname_in name of the input file | |
| 1626 v:fname_out name of the output file | |
| 1627 Note that v:fname_in and v:fname_out will never be the same. | |
| 1628 Note that v:charconvert_from and v:charconvert_to may be different | |
| 1629 from 'encoding'. Vim internally uses UTF-8 instead of UCS-2 or UCS-4. | |
| 27459 | 1630 |
|
30598
37aa9fd2ed72
patch 9.0.0634: evaluating "expr" options has more overhead than needed
Bram Moolenaar <Bram@vim.org>
parents:
30547
diff
changeset
|
1631 The advantage of using a function call without arguments is that it is |
|
37aa9fd2ed72
patch 9.0.0634: evaluating "expr" options has more overhead than needed
Bram Moolenaar <Bram@vim.org>
parents:
30547
diff
changeset
|
1632 faster, see |expr-option-function|. |
|
37aa9fd2ed72
patch 9.0.0634: evaluating "expr" options has more overhead than needed
Bram Moolenaar <Bram@vim.org>
parents:
30547
diff
changeset
|
1633 |
| 7 | 1634 Encryption is not done by Vim when using 'charconvert'. If you want |
| 1635 to encrypt the file after conversion, 'charconvert' should take care | |
| 1636 of this. | |
| 27459 | 1637 |
| 1638 If the 'charconvert' expression starts with s: or |<SID>|, then it is | |
| 1639 replaced with the script ID (|local-function|). Example: > | |
| 1640 set charconvert=s:MyConvert() | |
| 1641 set charconvert=<SID>SomeConvert() | |
| 1642 < Otherwise the expression is evaluated in the context of the script | |
| 1643 where the option was set, thus script-local items are available. | |
| 1644 | |
| 7 | 1645 This option cannot be set from a |modeline| or in the |sandbox|, for |
| 1646 security reasons. | |
| 1647 | |
| 1648 *'cindent'* *'cin'* *'nocindent'* *'nocin'* | |
| 1649 'cindent' 'cin' boolean (default off) | |
| 1650 local to buffer | |
| 1621 | 1651 Enables automatic C program indenting. See 'cinkeys' to set the keys |
| 7 | 1652 that trigger reindenting in insert mode and 'cinoptions' to set your |
| 1653 preferred indent style. | |
| 1654 If 'indentexpr' is not empty, it overrules 'cindent'. | |
| 1655 If 'lisp' is not on and both 'indentexpr' and 'equalprg' are empty, | |
| 1656 the "=" operator indents using this algorithm rather than calling an | |
| 1657 external program. | |
| 1658 See |C-indenting|. | |
| 1659 When you don't like the way 'cindent' works, try the 'smartindent' | |
| 1660 option or 'indentexpr'. | |
| 1661 This option is not used when 'paste' is set. | |
| 1662 NOTE: This option is reset when 'compatible' is set. | |
| 1663 | |
| 1664 *'cinkeys'* *'cink'* | |
|
15701
9cd11f6beb70
patch 8.1.0858: 'indentkeys' and 'cinkeys' defaults are different
Bram Moolenaar <Bram@vim.org>
parents:
15512
diff
changeset
|
1665 'cinkeys' 'cink' string (default "0{,0},0),0],:,0#,!^F,o,O,e") |
| 7 | 1666 local to buffer |
| 1667 A list of keys that, when typed in Insert mode, cause reindenting of | |
| 1668 the current line. Only used if 'cindent' is on and 'indentexpr' is | |
| 1669 empty. | |
| 1670 For the format of this option see |cinkeys-format|. | |
| 1671 See |C-indenting|. | |
| 1672 | |
| 1673 *'cinoptions'* *'cino'* | |
| 1674 'cinoptions' 'cino' string (default "") | |
| 1675 local to buffer | |
| 1676 The 'cinoptions' affect the way 'cindent' reindents lines in a C | |
| 1677 program. See |cinoptions-values| for the values of this option, and | |
| 1678 |C-indenting| for info on C indenting in general. | |
| 1679 | |
| 1680 | |
| 1681 *'cinwords'* *'cinw'* | |
| 1682 'cinwords' 'cinw' string (default "if,else,while,do,for,switch") | |
| 1683 local to buffer | |
| 1684 These keywords start an extra indent in the next line when | |
| 1685 'smartindent' or 'cindent' is set. For 'cindent' this is only done at | |
| 1686 an appropriate place (inside {}). | |
| 1687 Note that 'ignorecase' isn't used for 'cinwords'. If case doesn't | |
| 1688 matter, include the keyword both the uppercase and lowercase: | |
| 1689 "if,If,IF". | |
| 1690 | |
|
28353
8bc8071928ed
patch 8.2.4702: C++ scope labels are hard-coded
Bram Moolenaar <Bram@vim.org>
parents:
28297
diff
changeset
|
1691 *'cinscopedecls'* *'cinsd'* |
|
8bc8071928ed
patch 8.2.4702: C++ scope labels are hard-coded
Bram Moolenaar <Bram@vim.org>
parents:
28297
diff
changeset
|
1692 'cinscopedecls' 'cinsd' string (default "public,protected,private") |
|
8bc8071928ed
patch 8.2.4702: C++ scope labels are hard-coded
Bram Moolenaar <Bram@vim.org>
parents:
28297
diff
changeset
|
1693 local to buffer |
|
8bc8071928ed
patch 8.2.4702: C++ scope labels are hard-coded
Bram Moolenaar <Bram@vim.org>
parents:
28297
diff
changeset
|
1694 Keywords that are interpreted as a C++ scope declaration by |cino-g|. |
|
8bc8071928ed
patch 8.2.4702: C++ scope labels are hard-coded
Bram Moolenaar <Bram@vim.org>
parents:
28297
diff
changeset
|
1695 Useful e.g. for working with the Qt framework that defines additional |
|
8bc8071928ed
patch 8.2.4702: C++ scope labels are hard-coded
Bram Moolenaar <Bram@vim.org>
parents:
28297
diff
changeset
|
1696 scope declarations "signals", "public slots" and "private slots": > |
|
8bc8071928ed
patch 8.2.4702: C++ scope labels are hard-coded
Bram Moolenaar <Bram@vim.org>
parents:
28297
diff
changeset
|
1697 set cinscopedecls+=signals,public\ slots,private\ slots |
|
8bc8071928ed
patch 8.2.4702: C++ scope labels are hard-coded
Bram Moolenaar <Bram@vim.org>
parents:
28297
diff
changeset
|
1698 |
|
8bc8071928ed
patch 8.2.4702: C++ scope labels are hard-coded
Bram Moolenaar <Bram@vim.org>
parents:
28297
diff
changeset
|
1699 < *'clipboard'* *'cb'* |
| 7 | 1700 'clipboard' 'cb' string (default "autoselect,exclude:cons\|linux" |
| 1701 for X-windows, "" otherwise) | |
| 1702 global | |
| 1703 {only in GUI versions or when the |+xterm_clipboard| | |
| 1704 feature is included} | |
|
28353
8bc8071928ed
patch 8.2.4702: C++ scope labels are hard-coded
Bram Moolenaar <Bram@vim.org>
parents:
28297
diff
changeset
|
1705 This option is a list of comma-separated names. |
| 23931 | 1706 Note: if one of the items is "exclude:", then you can't add an item |
| 29403 | 1707 after that. Therefore do not append an item with += but use ^= to |
| 23931 | 1708 prepend, e.g.: > |
| 1709 set clipboard^=unnamed | |
| 30547 | 1710 < When using the GUI see |'go-A'|. |
| 1711 These names are recognized: | |
| 7 | 1712 |
| 3674 | 1713 *clipboard-unnamed* |
| 7 | 1714 unnamed When included, Vim will use the clipboard register '*' |
| 1715 for all yank, delete, change and put operations which | |
| 1716 would normally go to the unnamed register. When a | |
| 1717 register is explicitly specified, it will always be | |
| 1718 used regardless of whether "unnamed" is in 'clipboard' | |
| 1719 or not. The clipboard register can always be | |
| 1720 explicitly accessed using the "* notation. Also see | |
| 1721 |gui-clipboard|. | |
| 1722 | |
| 3682 | 1723 *clipboard-unnamedplus* |
| 4119 | 1724 unnamedplus A variant of the "unnamed" flag which uses the |
| 1725 clipboard register '+' (|quoteplus|) instead of | |
| 1726 register '*' for all yank, delete, change and put | |
| 1727 operations which would normally go to the unnamed | |
| 1728 register. When "unnamed" is also included to the | |
| 1729 option, yank operations (but not delete, change or | |
| 1730 put) will additionally copy the text into register | |
| 1731 '*'. | |
| 2662 | 1732 Only available with the |+X11| feature. |
| 2654 | 1733 Availability can be checked with: > |
| 1734 if has('unnamedplus') | |
| 1735 < | |
| 3682 | 1736 *clipboard-autoselect* |
| 7 | 1737 autoselect Works like the 'a' flag in 'guioptions': If present, |
| 1738 then whenever Visual mode is started, or the Visual | |
| 1739 area extended, Vim tries to become the owner of the | |
| 1740 windowing system's global selection or put the | |
| 1741 selected text on the clipboard used by the selection | |
| 14999 | 1742 register "*. See |'go-a'| and |quotestar| for details. |
| 1743 When the GUI is active, the 'a' flag in 'guioptions' | |
| 1744 is used, when the GUI is not active, this "autoselect" | |
| 1745 flag is used. | |
| 7 | 1746 Also applies to the modeless selection. |
| 1747 | |
| 3674 | 1748 *clipboard-autoselectplus* |
| 1749 autoselectplus Like "autoselect" but using the + register instead of | |
| 1750 the * register. Compare to the 'P' flag in | |
| 1751 'guioptions'. | |
| 1752 | |
| 1753 *clipboard-autoselectml* | |
| 7 | 1754 autoselectml Like "autoselect", but for the modeless selection |
| 1755 only. Compare to the 'A' flag in 'guioptions'. | |
| 1756 | |
| 3674 | 1757 *clipboard-html* |
| 1904 | 1758 html When the clipboard contains HTML, use this when |
| 1759 pasting. When putting text on the clipboard, mark it | |
| 1760 as HTML. This works to copy rendered HTML from | |
| 1761 Firefox, paste it as raw HTML in Vim, select the HTML | |
| 1762 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
|
1763 You probably want to add this only temporarily, |
|
6b4879aea261
Add test for gettabvar() and settabvar().
Bram Moolenaar <bram@vim.org>
parents:
2220
diff
changeset
|
1764 possibly use BufEnter autocommands. |
| 1904 | 1765 Only supported for GTK version 2 and later. |
| 1766 | |
| 3674 | 1767 *clipboard-exclude* |
| 7 | 1768 exclude:{pattern} |
| 1769 Defines a pattern that is matched against the name of | |
| 1770 the terminal 'term'. If there is a match, no | |
| 1771 connection will be made to the X server. This is | |
| 1772 useful in this situation: | |
| 1773 - Running Vim in a console. | |
| 1774 - $DISPLAY is set to start applications on another | |
| 1775 display. | |
| 1776 - You do not want to connect to the X server in the | |
| 1777 console, but do want this in a terminal emulator. | |
| 1778 To never connect to the X server use: > | |
| 1779 exclude:.* | |
| 1780 < This has the same effect as using the |-X| argument. | |
| 1781 Note that when there is no connection to the X server | |
| 1782 the window title won't be restored and the clipboard | |
| 1783 cannot be accessed. | |
| 1784 The value of 'magic' is ignored, {pattern} is | |
| 1785 interpreted as if 'magic' was on. | |
| 1786 The rest of the option value will be used for | |
| 1787 {pattern}, this must be the last entry. | |
| 1788 | |
| 1789 *'cmdheight'* *'ch'* | |
| 1790 'cmdheight' 'ch' number (default 1) | |
|
29546
8a243ecfe2dd
patch 9.0.0114: the command line takes up space even when not used
Bram Moolenaar <Bram@vim.org>
parents:
29450
diff
changeset
|
1791 global or local to tab page |
|
30005
bb0e525e1393
patch 9.0.0340: the 'cmdheight' zero support causes too much trouble
Bram Moolenaar <Bram@vim.org>
parents:
29900
diff
changeset
|
1792 Number of screen lines to use for the command-line. A larger value |
|
bb0e525e1393
patch 9.0.0340: the 'cmdheight' zero support causes too much trouble
Bram Moolenaar <Bram@vim.org>
parents:
29900
diff
changeset
|
1793 helps avoiding |hit-enter| prompts. |
| 824 | 1794 The value of this option is stored with the tab page, so that each tab |
| 1795 page can have a different value. | |
| 7 | 1796 |
| 1797 *'cmdwinheight'* *'cwh'* | |
| 1798 'cmdwinheight' 'cwh' number (default 7) | |
| 1799 global | |
| 1800 Number of screen lines to use for the command-line window. |cmdwin| | |
| 1801 | |
|
2608
7d8af31066c8
Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents:
2607
diff
changeset
|
1802 *'colorcolumn'* *'cc'* |
|
7d8af31066c8
Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents:
2607
diff
changeset
|
1803 'colorcolumn' 'cc' string (default "") |
|
7d8af31066c8
Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents:
2607
diff
changeset
|
1804 local to window |
|
7d8af31066c8
Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents:
2607
diff
changeset
|
1805 {not available when compiled without the |+syntax| |
|
7d8af31066c8
Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents:
2607
diff
changeset
|
1806 feature} |
| 28379 | 1807 'colorcolumn' is a comma-separated list of screen columns that are |
|
2608
7d8af31066c8
Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents:
2607
diff
changeset
|
1808 highlighted with ColorColumn |hl-ColorColumn|. Useful to align |
|
7d8af31066c8
Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents:
2607
diff
changeset
|
1809 text. Will make screen redrawing slower. |
|
7d8af31066c8
Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents:
2607
diff
changeset
|
1810 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
|
1811 '+' or '-', which is added to or subtracted from 'textwidth'. > |
|
7d8af31066c8
Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents:
2607
diff
changeset
|
1812 |
|
7d8af31066c8
Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents:
2607
diff
changeset
|
1813 :set cc=+1 " highlight column after 'textwidth' |
|
7d8af31066c8
Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents:
2607
diff
changeset
|
1814 :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
|
1815 :hi ColorColumn ctermbg=lightgrey guibg=lightgrey |
|
7d8af31066c8
Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents:
2607
diff
changeset
|
1816 < |
|
7d8af31066c8
Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents:
2607
diff
changeset
|
1817 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
|
1818 A maximum of 256 columns are highlighted. |
|
7d8af31066c8
Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents:
2607
diff
changeset
|
1819 |
| 7 | 1820 *'columns'* *'co'* *E594* |
| 1821 'columns' 'co' number (default 80 or terminal width) | |
| 1822 global | |
| 1823 Number of columns of the screen. Normally this is set by the terminal | |
| 161 | 1824 initialization and does not have to be set by hand. Also see |
| 1825 |posix-screen-size|. | |
| 7 | 1826 When Vim is running in the GUI or in a resizable window, setting this |
| 1827 option will cause the window size to be changed. When you only want | |
| 1828 to use the size for the GUI, put the command in your |gvimrc| file. | |
| 1829 When you set this option and Vim is unable to change the physical | |
| 1152 | 1830 number of columns of the display, the display may be messed up. For |
| 1831 the GUI it is always possible and Vim limits the number of columns to | |
| 1832 what fits on the screen. You can use this command to get the widest | |
| 1833 window possible: > | |
| 1834 :set columns=9999 | |
| 1835 < Minimum value is 12, maximum value is 10000. | |
| 7 | 1836 |
| 1837 *'comments'* *'com'* *E524* *E525* | |
| 1838 'comments' 'com' string (default | |
| 1839 "s1:/*,mb:*,ex:*/,://,b:#,:%,:XCOMM,n:>,fb:-") | |
| 1840 local to buffer | |
| 28379 | 1841 A comma-separated list of strings that can start a comment line. See |
| 7 | 1842 |format-comments|. See |option-backslash| about using backslashes to |
| 1843 insert a space. | |
| 1844 | |
| 1845 *'commentstring'* *'cms'* *E537* | |
| 1846 'commentstring' 'cms' string (default "/*%s*/") | |
| 1847 local to buffer | |
| 1848 {not available when compiled without the |+folding| | |
| 1849 feature} | |
| 1850 A template for a comment. The "%s" in the value is replaced with the | |
| 1851 comment text. Currently only used to add markers for folding, see | |
| 1852 |fold-marker|. | |
| 1853 | |
| 1854 *'compatible'* *'cp'* *'nocompatible'* *'nocp'* | |
| 819 | 1855 '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
|
1856 file is found, reset in |defaults.vim|) |
| 7 | 1857 global |
| 1858 This option has the effect of making Vim either more Vi-compatible, or | |
| 1859 make Vim behave in a more useful way. | |
| 11062 | 1860 |
| 7 | 1861 This is a special kind of option, because when it's set or reset, |
| 11062 | 1862 other options are also changed as a side effect. |
| 1863 NOTE: Setting or resetting this option can have a lot of unexpected | |
| 1864 effects: Mappings are interpreted in another way, undo behaves | |
| 1865 differently, etc. If you set this option in your vimrc file, you | |
| 1866 should probably put it at the very start. | |
| 1867 | |
| 7 | 1868 By default this option is on and the Vi defaults are used for the |
| 1869 options. This default was chosen for those people who want to use Vim | |
| 1870 just like Vi, and don't even (want to) know about the 'compatible' | |
| 1871 option. | |
| 819 | 1872 When a |vimrc| or |gvimrc| file is found while Vim is starting up, |
| 378 | 1873 this option is switched off, and all options that have not been |
| 1874 modified will be set to the Vim defaults. Effectively, this means | |
| 819 | 1875 that when a |vimrc| or |gvimrc| file exists, Vim will use the Vim |
| 378 | 1876 defaults, otherwise it will use the Vi defaults. (Note: This doesn't |
| 1152 | 1877 happen for the system-wide vimrc or gvimrc file, nor for a file given |
| 1878 with the |-u| argument). Also see |compatible-default| and | |
| 1879 |posix-compliance|. | |
| 7 | 1880 You can also set this option with the "-C" argument, and reset it with |
| 1881 "-N". See |-C| and |-N|. | |
| 11062 | 1882 See 'cpoptions' for more fine tuning of Vi compatibility. |
| 1883 | |
| 1884 When this option is set, numerous other options are set to make Vim as | |
| 1885 Vi-compatible as possible. When this option is unset, various options | |
| 1886 are set to make Vim more useful. The table below lists all the | |
| 1887 options affected. | |
| 1888 The {?} column indicates when the options are affected: | |
| 1889 + Means that the option is set to the value given in {set value} when | |
| 1890 'compatible' is set. | |
| 1891 & Means that the option is set to the value given in {set value} when | |
| 1892 'compatible' is set AND is set to its Vim default value when | |
| 1893 'compatible' is unset. | |
| 1894 - Means the option is NOT changed when setting 'compatible' but IS | |
| 1895 set to its Vim default when 'compatible' is unset. | |
| 1896 The {effect} column summarises the change when 'compatible' is set. | |
| 1897 | |
| 11160 | 1898 option ? set value effect ~ |
| 11062 | 1899 |
| 1900 'allowrevins' + off no CTRL-_ command | |
| 1901 'antialias' + off don't use antialiased fonts | |
| 31885 | 1902 'arabic' + off reset arabic-related options |
| 11062 | 1903 'arabicshape' + on correct character shapes |
| 1904 'backspace' + "" normal backspace | |
| 1905 'backup' + off no backup file | |
| 1906 'backupcopy' & Unix: "yes" backup file is a copy | |
| 1907 else: "auto" copy or rename backup file | |
| 1908 'balloonexpr' + "" text to show in evaluation balloon | |
| 1909 'breakindent' + off don't indent when wrapping lines | |
| 1910 '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
|
1911 'cdhome' + off ":cd" don't chdir to home on non-Unix |
| 11062 | 1912 'cindent' + off no C code indentation |
| 1913 'compatible' - {unchanged} {set vim default only on resetting 'cp'} | |
| 1914 'copyindent' + off don't copy indent structure | |
| 1915 'cpoptions' & (all flags) Vi-compatible flags | |
| 1916 'cscopepathcomp'+ 0 don't show directories in tags list | |
|
13341
acd7eaa13d2b
Updated runtime files.
Christian Brabandt <cb@256bit.org>
parents:
13314
diff
changeset
|
1917 'cscoperelative'+ off don't use basename of path as prefix |
| 11062 | 1918 'cscopetag' + off don't use cscope for ":tag" |
| 11160 | 1919 'cscopetagorder'+ 0 see |cscopetagorder| |
| 11062 | 1920 'cscopeverbose' + off see |cscopeverbose| |
| 1921 'delcombine' + off unicode: delete whole char combination | |
| 1922 'digraph' + off no digraphs | |
| 1923 'esckeys' & off no <Esc>-keys in Insert mode | |
| 1924 'expandtab' + off tabs not expanded to spaces | |
| 1925 '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
|
1926 "dos,unix" except for MS-Windows |
| 11062 | 1927 'formatexpr' + "" use 'formatprg' for auto-formatting |
| 1928 'formatoptions' & "vt" Vi compatible formatting | |
| 1929 'gdefault' + off no default 'g' flag for ":s" | |
| 1930 'history' & 0 no commandline history | |
| 1931 'hkmap' + off no Hebrew keyboard mapping | |
| 1932 'hkmapp' + off no phonetic Hebrew keyboard mapping | |
| 1933 'hlsearch' + off no highlighting of search matches | |
| 1934 'incsearch' + off no incremental searching | |
| 1935 'indentexpr' + "" no indenting by expression | |
| 1936 'insertmode' + off do not start in Insert mode | |
| 1937 'iskeyword' & "@,48-57,_" keywords contain alphanumeric | |
| 7 | 1938 characters and '_' |
| 11062 | 1939 'joinspaces' + on insert 2 spaces after period |
| 1940 'modeline' & off no modelines | |
| 1941 'more' & off no pauses in listings | |
| 1942 'mzquantum' - {unchanged} {set vim default only on resetting 'cp'} | |
| 1943 'numberwidth' & 8 min number of columns for line number | |
| 1944 'preserveindent'+ off don't preserve current indent structure | |
| 1945 when changing it | |
| 1946 'revins' + off no reverse insert | |
| 1947 'ruler' + off no ruler | |
| 1948 'scrolljump' + 1 no jump scroll | |
| 1949 'scrolloff' + 0 no scroll offset | |
| 1950 'shelltemp' - {unchanged} {set vim default only on resetting 'cp'} | |
| 1951 '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
|
1952 'shortmess' & "S" no shortening of messages |
| 11062 | 1953 'showcmd' & off command characters not shown |
| 1954 'showmode' & off current mode not shown | |
| 1955 'sidescrolloff' + 0 cursor moves to edge of screen in scroll | |
| 1956 'smartcase' + off no automatic ignore case switch | |
| 1957 'smartindent' + off no smart indentation | |
| 1958 'smarttab' + off no smart tab size | |
| 1959 'softtabstop' + 0 tabs are always 'tabstop' positions | |
| 1960 'startofline' + on goto startofline with some commands | |
| 1961 'tagcase' & "followic" 'ignorecase' when searching tags file | |
| 1962 'tagrelative' & off tag file names are not relative | |
| 1963 'termguicolors' + off don't use highlight-(guifg|guibg) | |
| 1964 'textauto' & off no automatic textmode detection | |
| 1965 'textwidth' + 0 no automatic line wrap | |
| 1966 'tildeop' + off tilde is not an operator | |
| 1967 'ttimeout' + off no terminal timeout | |
| 1968 'undofile' + off don't use an undo file | |
| 11160 | 1969 'viminfo' - {unchanged} {set Vim default only on resetting 'cp'} |
| 11062 | 1970 'virtualedit' + "" cursor can only be placed on characters |
| 1971 'whichwrap' & "" left-right movements don't wrap | |
| 1972 'wildchar' & CTRL-E only when the current value is <Tab> | |
| 7 | 1973 use CTRL-E for cmdline completion |
| 11062 | 1974 'writebackup' + on or off depends on the |+writebackup| feature |
| 7 | 1975 |
| 1976 *'complete'* *'cpt'* *E535* | |
| 1977 'complete' 'cpt' string (default: ".,w,b,u,t,i") | |
| 1978 local to buffer | |
| 1979 This option specifies how keyword completion |ins-completion| works | |
| 1980 when CTRL-P or CTRL-N are used. It is also used for whole-line | |
| 1981 completion |i_CTRL-X_CTRL-L|. It indicates the type of completion | |
| 28379 | 1982 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
|
1983 . scan the current buffer ('wrapscan' is ignored) |
| 7 | 1984 w scan buffers from other windows |
| 1985 b scan other loaded buffers that are in the buffer list | |
| 1986 u scan the unloaded buffers that are in the buffer list | |
| 1987 U scan the buffers that are not in the buffer list | |
| 1988 k scan the files given with the 'dictionary' option | |
| 703 | 1989 kspell use the currently active spell checking |spell| |
| 7 | 1990 k{dict} scan the file {dict}. Several "k" flags can be given, |
| 1991 patterns are valid too. For example: > | |
| 1992 :set cpt=k/usr/dict/*,k~/spanish | |
| 1993 < s scan the files given with the 'thesaurus' option | |
| 1994 s{tsr} scan the file {tsr}. Several "s" flags can be given, patterns | |
| 1995 are valid too. | |
| 1996 i scan current and included files | |
| 1997 d scan current and included files for defined name or macro | |
| 1998 |i_CTRL-X_CTRL-D| | |
| 1999 ] tag completion | |
| 2000 t same as "]" | |
| 2001 | |
| 2002 Unloaded buffers are not loaded, thus their autocmds |:autocmd| are | |
| 2003 not executed, this may lead to unexpected completions from some files | |
| 2004 (gzipped files for example). Unloaded buffers are not scanned for | |
| 2005 whole-line completion. | |
| 2006 | |
| 2007 The default is ".,w,b,u,t,i", which means to scan: | |
| 2008 1. the current buffer | |
| 2009 2. buffers in other windows | |
| 2010 3. other loaded buffers | |
| 2011 4. unloaded buffers | |
| 2012 5. tags | |
| 2013 6. included files | |
| 2014 | |
| 2015 As you can see, CTRL-N and CTRL-P can be used to do any 'iskeyword'- | |
| 233 | 2016 based expansion (e.g., dictionary |i_CTRL-X_CTRL-K|, included patterns |
| 2017 |i_CTRL-X_CTRL-I|, tags |i_CTRL-X_CTRL-]| and normal expansions). | |
| 7 | 2018 |
| 12 | 2019 *'completefunc'* *'cfu'* |
| 2020 'completefunc' 'cfu' string (default: empty) | |
| 2021 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
|
2022 {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
|
2023 feature} |
| 623 | 2024 This option specifies a function to be used for Insert mode completion |
| 2025 with CTRL-X CTRL-U. |i_CTRL-X_CTRL-U| | |
| 648 | 2026 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
|
2027 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
|
2028 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
|
2029 more information. |
| 2642 | 2030 This option cannot be set from a |modeline| or in the |sandbox|, for |
| 2031 security reasons. | |
| 14 | 2032 |
|
17543
77c3f6428b6c
patch 8.1.1769: 'shellslash' is also used for completion
Bram Moolenaar <Bram@vim.org>
parents:
17433
diff
changeset
|
2033 *'completeslash'* *'csl'* |
|
77c3f6428b6c
patch 8.1.1769: 'shellslash' is also used for completion
Bram Moolenaar <Bram@vim.org>
parents:
17433
diff
changeset
|
2034 'completeslash' 'csl' string (default: "") |
|
77c3f6428b6c
patch 8.1.1769: 'shellslash' is also used for completion
Bram Moolenaar <Bram@vim.org>
parents:
17433
diff
changeset
|
2035 local to buffer |
| 18343 | 2036 {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
|
2037 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
|
2038 - 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
|
2039 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
|
2040 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
|
2041 - 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
|
2042 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
|
2043 - 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
|
2044 'shellslash'. |
|
77c3f6428b6c
patch 8.1.1769: 'shellslash' is also used for completion
Bram Moolenaar <Bram@vim.org>
parents:
17433
diff
changeset
|
2045 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
|
2046 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
|
2047 |
| 540 | 2048 *'completeopt'* *'cot'* |
| 730 | 2049 'completeopt' 'cot' string (default: "menu,preview") |
| 540 | 2050 global |
| 28379 | 2051 A comma-separated list of options for Insert mode completion |
| 665 | 2052 |ins-completion|. The supported values are: |
| 540 | 2053 |
| 2054 menu Use a popup menu to show the possible completions. The | |
| 2055 menu is only shown when there is more than one match and | |
| 2056 sufficient colors are available. |ins-completion-menu| | |
| 2057 | |
| 707 | 2058 menuone Use the popup menu also when there is only one match. |
| 856 | 2059 Useful when there is additional information about the |
| 707 | 2060 match, e.g., what file it comes from. |
| 2061 | |
| 836 | 2062 longest Only insert the longest common text of the matches. If |
| 2063 the menu is displayed you can use CTRL-L to add more | |
| 2064 characters. Whether case is ignored depends on the kind | |
| 2065 of completion. For buffer text the 'ignorecase' option is | |
| 2066 used. | |
| 665 | 2067 |
| 730 | 2068 preview Show extra information about the currently selected |
| 1152 | 2069 completion in the preview window. Only works in |
| 2070 combination with "menu" or "menuone". | |
| 2071 | |
|
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
|
2072 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
|
2073 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
|
2074 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
|
2075 See |'completepopup'| for specifying properties. |
| 18343 | 2076 {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
|
2077 |
|
18396
ba5d8c5d77d7
patch 8.1.2192: cannot easily fill the info popup asynchronously
Bram Moolenaar <Bram@vim.org>
parents:
18372
diff
changeset
|
2078 popuphidden |
| 18719 | 2079 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
|
2080 |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
|
2081 |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
|
2082 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
|
2083 {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
|
2084 |
| 6911 | 2085 noinsert Do not insert any text for a match until the user selects |
| 2086 a match from the menu. Only works in combination with | |
| 2087 "menu" or "menuone". No effect if "longest" is present. | |
| 2088 | |
| 2089 noselect Do not select a match in the menu, force the user to | |
| 2090 select one from the menu. Only works in combination with | |
| 2091 "menu" or "menuone". | |
| 2092 | |
| 730 | 2093 |
|
17771
4bd21046902b
patch 8.1.1882: cannot specify properties of the info popup window
Bram Moolenaar <Bram@vim.org>
parents:
17767
diff
changeset
|
2094 *'completepopup'* *'cpp'* |
|
4bd21046902b
patch 8.1.1882: cannot specify properties of the info popup window
Bram Moolenaar <Bram@vim.org>
parents:
17767
diff
changeset
|
2095 '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
|
2096 global |
|
4bd21046902b
patch 8.1.1882: cannot specify properties of the info popup window
Bram Moolenaar <Bram@vim.org>
parents:
17767
diff
changeset
|
2097 {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
|
2098 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
|
2099 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
|
2100 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
|
2101 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
|
2102 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
|
2103 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
|
2104 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
|
2105 |
|
4bd21046902b
patch 8.1.1882: cannot specify properties of the info popup window
Bram Moolenaar <Bram@vim.org>
parents:
17767
diff
changeset
|
2106 |
|
2378
85b7dc8da5eb
Add the 'concealcursor' option to decide when the cursor line is to be
Bram Moolenaar <bram@vim.org>
parents:
2365
diff
changeset
|
2107 *'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
|
2108 '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
|
2109 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
|
2110 {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
|
2111 feature} |
|
85b7dc8da5eb
Add the 'concealcursor' option to decide when the cursor line is to be
Bram Moolenaar <bram@vim.org>
parents:
2365
diff
changeset
|
2112 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
|
2113 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
|
2114 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
|
2115 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
|
2116 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
|
2117 i Insert mode |
|
2382
3a5ededa240a
Add the 'c' flag to 'concealcursor'.
Bram Moolenaar <bram@vim.org>
parents:
2380
diff
changeset
|
2118 c Command line editing, for 'incsearch' |
|
3a5ededa240a
Add the 'c' flag to 'concealcursor'.
Bram Moolenaar <bram@vim.org>
parents:
2380
diff
changeset
|
2119 |
|
2400
e6f1424dd66a
Let 'v' flag in 'concealcursor' apply to all lines in the Visual area.
Bram Moolenaar <bram@vim.org>
parents:
2394
diff
changeset
|
2120 '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
|
2121 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
|
2122 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
|
2123 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
|
2124 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
|
2125 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
|
2126 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
|
2127 |
|
85b7dc8da5eb
Add the 'concealcursor' option to decide when the cursor line is to be
Bram Moolenaar <bram@vim.org>
parents:
2365
diff
changeset
|
2128 |
| 14864 | 2129 *'conceallevel'* *'cole'* |
| 2130 'conceallevel' 'cole' number (default 0) | |
|
2250
1bac28a53fae
Add the conceal patch from Vince Negri.
Bram Moolenaar <bram@vim.org>
parents:
2249
diff
changeset
|
2131 local to window |
|
1bac28a53fae
Add the conceal patch from Vince Negri.
Bram Moolenaar <bram@vim.org>
parents:
2249
diff
changeset
|
2132 {not available when compiled without the |+conceal| |
|
1bac28a53fae
Add the conceal patch from Vince Negri.
Bram Moolenaar <bram@vim.org>
parents:
2249
diff
changeset
|
2133 feature} |
|
2340
99c1eba60b2d
Make automatic prototype generation work with more interfaces.
Bram Moolenaar <bram@vim.org>
parents:
2337
diff
changeset
|
2134 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
|
2135 is shown: |
|
99c1eba60b2d
Make automatic prototype generation work with more interfaces.
Bram Moolenaar <bram@vim.org>
parents:
2337
diff
changeset
|
2136 |
|
99c1eba60b2d
Make automatic prototype generation work with more interfaces.
Bram Moolenaar <bram@vim.org>
parents:
2337
diff
changeset
|
2137 Value Effect ~ |
|
2250
1bac28a53fae
Add the conceal patch from Vince Negri.
Bram Moolenaar <bram@vim.org>
parents:
2249
diff
changeset
|
2138 0 Text is shown normally |
| 2426 | 2139 1 Each block of concealed text is replaced with one |
| 2140 character. If the syntax item does not have a custom | |
| 2141 replacement character defined (see |:syn-cchar|) the | |
| 2142 character defined in 'listchars' is used (default is a | |
| 2143 space). | |
| 2144 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
|
2145 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
|
2146 custom replacement character defined (see |
| 2426 | 2147 |: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
|
2148 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
|
2149 |
|
586a459f3980
Never hide text for conceal in cursor line. Do hide when there is
Bram Moolenaar <bram@vim.org>
parents:
2348
diff
changeset
|
2150 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
|
2151 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
|
2152 option. |
|
2250
1bac28a53fae
Add the conceal patch from Vince Negri.
Bram Moolenaar <bram@vim.org>
parents:
2249
diff
changeset
|
2153 |
| 7 | 2154 *'confirm'* *'cf'* *'noconfirm'* *'nocf'* |
| 2155 'confirm' 'cf' boolean (default off) | |
| 2156 global | |
| 2157 When 'confirm' is on, certain operations that would normally | |
| 2158 fail because of unsaved changes to a buffer, e.g. ":q" and ":e", | |
| 2159 instead raise a |dialog| asking if you wish to save the current | |
| 2160 file(s). You can still use a ! to unconditionally |abandon| a buffer. | |
| 2161 If 'confirm' is off you can still activate confirmation for one | |
| 2162 command only (this is most useful in mappings) with the |:confirm| | |
| 2163 command. | |
| 2164 Also see the |confirm()| function and the 'v' flag in 'guioptions'. | |
| 2165 | |
| 2166 *'conskey'* *'consk'* *'noconskey'* *'noconsk'* | |
| 2167 'conskey' 'consk' boolean (default off) | |
| 2168 global | |
|
8246
f16bfe02cef1
commit https://github.com/vim/vim/commit/f391327adbbffb11180cf6038a92af1ed144e907
Christian Brabandt <cb@256bit.org>
parents:
8182
diff
changeset
|
2169 This was for MS-DOS and is no longer supported. |
| 7 | 2170 |
| 2171 *'copyindent'* *'ci'* *'nocopyindent'* *'noci'* | |
| 2172 'copyindent' 'ci' boolean (default off) | |
| 2173 local to buffer | |
| 2174 Copy the structure of the existing lines indent when autoindenting a | |
| 2175 new line. Normally the new indent is reconstructed by a series of | |
| 2176 tabs followed by spaces as required (unless |'expandtab'| is enabled, | |
| 2177 in which case only spaces are used). Enabling this option makes the | |
| 2178 new line copy whatever characters were used for indenting on the | |
| 1621 | 2179 existing line. 'expandtab' has no effect on these characters, a Tab |
| 2180 remains a Tab. If the new indent is greater than on the existing | |
| 7 | 2181 line, the remaining space is filled in the normal manner. |
| 11160 | 2182 NOTE: This option is reset when 'compatible' is set. |
| 7 | 2183 Also see 'preserveindent'. |
| 2184 | |
|
8148
f5da459c5698
commit https://github.com/vim/vim/commit/e0fa3742ead676a3074a10edadbc955e1a89153d
Christian Brabandt <cb@256bit.org>
parents:
8061
diff
changeset
|
2185 *'cpoptions'* *'cpo'* *cpo* |
| 7 | 2186 'cpoptions' 'cpo' string (Vim default: "aABceFs", |
| 2187 Vi default: all flags) | |
| 2188 global | |
| 2189 A sequence of single character flags. When a character is present | |
| 5340 | 2190 this indicates Vi-compatible behavior. This is used for things where |
| 2191 not being Vi-compatible is mostly or sometimes preferred. | |
| 7 | 2192 'cpoptions' stands for "compatible-options". |
| 2193 Commas can be added for readability. | |
| 2194 To avoid problems with flags that are added in the future, use the | |
| 2195 "+=" 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
|
2196 |
| 7 | 2197 NOTE: This option is set to the Vi default value when 'compatible' is |
| 2198 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
|
2199 |
|
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
|
2200 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
|
2201 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
|
2202 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
|
2203 '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
|
2204 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
|
2205 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
|
2206 `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
|
2207 |
| 164 | 2208 NOTE: This option is set to the POSIX default value at startup when |
| 2209 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
|
2210 variable exists |posix|. This means Vim tries to behave like the |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
2211 POSIX specification. |
| 7 | 2212 |
| 2213 contains behavior ~ | |
| 2214 *cpo-a* | |
| 2215 a When included, a ":read" command with a file name | |
| 2216 argument will set the alternate file name for the | |
| 2217 current window. | |
| 2218 *cpo-A* | |
| 2219 A When included, a ":write" command with a file name | |
| 2220 argument will set the alternate file name for the | |
| 2221 current window. | |
| 2222 *cpo-b* | |
| 2223 b "\|" in a ":map" command is recognized as the end of | |
| 2224 the map command. The '\' is included in the mapping, | |
| 2225 the text after the '|' is interpreted as the next | |
| 2226 command. Use a CTRL-V instead of a backslash to | |
| 2227 include the '|' in the mapping. Applies to all | |
| 2228 mapping, abbreviation, menu and autocmd commands. | |
| 2229 See also |map_bar|. | |
| 2230 *cpo-B* | |
| 2231 B A backslash has no special meaning in mappings, | |
| 14372 | 2232 abbreviations, user commands and the "to" part of the |
| 2233 menu commands. Remove this flag to be able to use a | |
| 2234 backslash like a CTRL-V. For example, the command | |
| 2235 ":map X \<Esc>" results in X being mapped to: | |
| 7 | 2236 'B' included: "\^[" (^[ is a real <Esc>) |
| 2237 'B' excluded: "<Esc>" (5 characters) | |
| 2238 ('<' excluded in both cases) | |
| 2239 *cpo-c* | |
| 2240 c Searching continues at the end of any match at the | |
| 2241 cursor position, but not further than the start of the | |
| 2242 next line. When not present searching continues | |
| 2243 one character from the cursor position. With 'c' | |
| 2244 "abababababab" only gets three matches when repeating | |
| 2245 "/abab", without 'c' there are five matches. | |
| 2246 *cpo-C* | |
| 2247 C Do not concatenate sourced lines that start with a | |
| 2248 backslash. See |line-continuation|. | |
| 2249 *cpo-d* | |
| 2250 d Using "./" in the 'tags' option doesn't mean to use | |
| 2251 the tags file relative to the current file, but the | |
| 2252 tags file in the current directory. | |
| 2253 *cpo-D* | |
| 2254 D Can't use CTRL-K to enter a digraph after Normal mode | |
| 2255 commands with a character argument, like |r|, |f| and | |
| 2256 |t|. | |
| 2257 *cpo-e* | |
| 2258 e When executing a register with ":@r", always add a | |
| 2259 <CR> to the last line, also when the register is not | |
| 2260 linewise. If this flag is not present, the register | |
| 2261 is not linewise and the last line does not end in a | |
| 2262 <CR>, then the last line is put on the command-line | |
| 2263 and can be edited before hitting <CR>. | |
| 2264 *cpo-E* | |
| 2265 E It is an error when using "y", "d", "c", "g~", "gu" or | |
| 2266 "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
|
2267 at least one character is to be operated on. Example: |
| 7 | 2268 This makes "y0" fail in the first column. |
| 2269 *cpo-f* | |
| 2270 f When included, a ":read" command with a file name | |
| 2271 argument will set the file name for the current buffer, | |
| 2272 if the current buffer doesn't have a file name yet. | |
| 2273 *cpo-F* | |
| 2274 F When included, a ":write" command with a file name | |
| 2275 argument will set the file name for the current | |
| 2276 buffer, if the current buffer doesn't have a file name | |
| 590 | 2277 yet. Also see |cpo-P|. |
| 7 | 2278 *cpo-g* |
| 2279 g Goto line 1 when using ":edit" without argument. | |
| 164 | 2280 *cpo-H* |
| 2281 H When using "I" on a line with only blanks, insert | |
| 2282 before the last blank. Without this flag insert after | |
| 2283 the last blank. | |
| 7 | 2284 *cpo-i* |
| 2285 i When included, interrupting the reading of a file will | |
| 2286 leave it modified. | |
| 10 | 2287 *cpo-I* |
| 2288 I When moving the cursor up or down just after inserting | |
| 2289 indent for 'autoindent', do not delete the indent. | |
| 7 | 2290 *cpo-j* |
| 2291 j When joining lines, only add two spaces after a '.', | |
| 2292 not after '!' or '?'. Also see 'joinspaces'. | |
| 2293 *cpo-J* | |
| 2294 J A |sentence| has to be followed by two spaces after | |
| 233 | 2295 the '.', '!' or '?'. A <Tab> is not recognized as |
| 7 | 2296 white space. |
| 2297 *cpo-k* | |
| 2298 k Disable the recognition of raw key codes in | |
| 2299 mappings, abbreviations, and the "to" part of menu | |
| 2300 commands. For example, if <Key> sends ^[OA (where ^[ | |
| 2301 is <Esc>), the command ":map X ^[OA" results in X | |
| 2302 being mapped to: | |
| 2303 'k' included: "^[OA" (3 characters) | |
| 2304 'k' excluded: "<Key>" (one key code) | |
| 2305 Also see the '<' flag below. | |
| 2306 *cpo-K* | |
| 2307 K Don't wait for a key code to complete when it is | |
| 2308 halfway a mapping. This breaks mapping <F1><F1> when | |
| 2309 only part of the second <F1> has been read. It | |
| 2310 enables cancelling the mapping by typing <F1><Esc>. | |
| 2311 *cpo-l* | |
| 2312 l Backslash in a [] range in a search pattern is taken | |
| 168 | 2313 literally, only "\]", "\^", "\-" and "\\" are special. |
| 2314 See |/[]| | |
| 7 | 2315 'l' included: "/[ \t]" finds <Space>, '\' and 't' |
| 2316 'l' excluded: "/[ \t]" finds <Space> and <Tab> | |
| 168 | 2317 Also see |cpo-\|. |
| 7 | 2318 *cpo-L* |
| 2319 L When the 'list' option is set, 'wrapmargin', | |
| 2320 'textwidth', 'softtabstop' and Virtual Replace mode | |
| 2321 (see |gR|) count a <Tab> as two characters, instead of | |
| 2322 the normal behavior of a <Tab>. | |
| 2323 *cpo-m* | |
| 2324 m When included, a showmatch will always wait half a | |
| 2325 second. When not included, a showmatch will wait half | |
| 2326 a second or until a character is typed. |'showmatch'| | |
| 2327 *cpo-M* | |
| 2328 M When excluded, "%" matching will take backslashes into | |
| 2329 account. Thus in "( \( )" and "\( ( \)" the outer | |
| 2330 parenthesis match. When included "%" ignores | |
| 2331 backslashes, which is Vi compatible. | |
| 2332 *cpo-n* | |
|
2178
c6f1aa1e9f32
Add 'relativenumber' patch from Markus Heidelberg.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2333 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
|
2334 '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
|
2335 lines. |
| 7 | 2336 *cpo-o* |
| 2337 o Line offset to search command is not remembered for | |
| 2338 next search. | |
| 2339 *cpo-O* | |
| 2340 O Don't complain if a file is being overwritten, even | |
| 2341 when it didn't exist when editing it. This is a | |
| 2342 protection against a file unexpectedly created by | |
| 2343 someone else. Vi didn't complain about this. | |
| 2344 *cpo-p* | |
| 2345 p Vi compatible Lisp indenting. When not present, a | |
| 2346 slightly better algorithm is used. | |
| 590 | 2347 *cpo-P* |
| 2348 P When included, a ":write" command that appends to a | |
| 2349 file will set the file name for the current buffer, if | |
| 2350 the current buffer doesn't have a file name yet and | |
| 2351 the 'F' flag is also included |cpo-F|. | |
| 164 | 2352 *cpo-q* |
| 2353 q When joining multiple lines leave the cursor at the | |
| 2354 position where it would be when joining two lines. | |
| 7 | 2355 *cpo-r* |
| 2356 r Redo ("." command) uses "/" to repeat a search | |
| 2357 command, instead of the actually used search string. | |
| 2358 *cpo-R* | |
| 2359 R Remove marks from filtered lines. Without this flag | |
| 2360 marks are kept like |:keepmarks| was used. | |
| 2361 *cpo-s* | |
| 2362 s Set buffer options when entering the buffer for the | |
| 2363 first time. This is like it is in Vim version 3.0. | |
| 10 | 2364 And it is the default. If not present the options are |
| 7 | 2365 set when the buffer is created. |
| 2366 *cpo-S* | |
| 2367 S Set buffer options always when entering a buffer | |
| 2368 (except 'readonly', 'fileformat', 'filetype' and | |
| 2369 'syntax'). This is the (most) Vi compatible setting. | |
| 2370 The options are set to the values in the current | |
| 2371 buffer. When you change an option and go to another | |
| 2372 buffer, the value is copied. Effectively makes the | |
| 2373 buffer options global to all buffers. | |
| 2374 | |
| 2375 's' 'S' copy buffer options | |
| 2376 no no when buffer created | |
| 2377 yes no when buffer first entered (default) | |
| 2378 X yes each time when buffer entered (vi comp.) | |
| 2379 *cpo-t* | |
| 2380 t Search pattern for the tag command is remembered for | |
| 2381 "n" command. Otherwise Vim only puts the pattern in | |
| 2382 the history for search pattern, but doesn't change the | |
| 2383 last used search pattern. | |
| 2384 *cpo-u* | |
| 10 | 2385 u Undo is Vi compatible. See |undo-two-ways|. |
| 7 | 2386 *cpo-v* |
| 2387 v Backspaced characters remain visible on the screen in | |
| 2388 Insert mode. Without this flag the characters are | |
| 2389 erased from the screen right away. With this flag the | |
| 2390 screen newly typed text overwrites backspaced | |
| 2391 characters. | |
| 2392 *cpo-w* | |
| 2393 w When using "cw" on a blank character, only change one | |
| 2394 character and not all blanks until the start of the | |
| 2395 next word. | |
| 2396 *cpo-W* | |
| 2397 W Don't overwrite a readonly file. When omitted, ":w!" | |
| 2398 overwrites a readonly file, if possible. | |
| 2399 *cpo-x* | |
| 2400 x <Esc> on the command-line executes the command-line. | |
| 2401 The default in Vim is to abandon the command-line, | |
| 2402 because <Esc> normally aborts a command. |c_<Esc>| | |
| 164 | 2403 *cpo-X* |
| 2404 X When using a count with "R" the replaced text is | |
| 2405 deleted only once. Also when repeating "R" with "." | |
| 2406 and a count. | |
| 7 | 2407 *cpo-y* |
| 15512 | 2408 y A yank command can be redone with ".". Think twice if |
| 2409 you really want to use this, it may break some | |
| 2410 plugins, since most people expect "." to only repeat a | |
| 2411 change. | |
| 164 | 2412 *cpo-Z* |
| 2413 Z When using "w!" while the 'readonly' option is set, | |
| 2414 don't reset 'readonly'. | |
| 7 | 2415 *cpo-!* |
| 2416 ! When redoing a filter command, use the last used | |
| 2417 external command, whatever it was. Otherwise the last | |
| 2418 used -filter- command is used. | |
| 2419 *cpo-$* | |
| 2420 $ When making a change to one line, don't redisplay the | |
| 2421 line, but put a '$' at the end of the changed text. | |
| 2422 The changed text will be overwritten when you type the | |
| 2423 new text. The line is redisplayed if you type any | |
| 2424 command that moves the cursor from the insertion | |
| 2425 point. | |
| 2426 *cpo-%* | |
| 2427 % Vi-compatible matching is done for the "%" command. | |
| 2428 Does not recognize "#if", "#endif", etc. | |
| 2429 Does not recognize "/*" and "*/". | |
| 2430 Parens inside single and double quotes are also | |
| 2431 counted, causing a string that contains a paren to | |
| 2432 disturb the matching. For example, in a line like | |
| 2433 "if (strcmp("foo(", s))" the first paren does not | |
| 2434 match the last one. When this flag is not included, | |
| 2435 parens inside single and double quotes are treated | |
| 2436 specially. When matching a paren outside of quotes, | |
| 2437 everything inside quotes is ignored. When matching a | |
| 2438 paren inside quotes, it will find the matching one (if | |
| 10 | 2439 there is one). This works very well for C programs. |
| 36 | 2440 This flag is also used for other features, such as |
| 2441 C-indenting. | |
| 161 | 2442 *cpo--* |
| 2443 - When included, a vertical movement command fails when | |
| 632 | 2444 it would go above the first line or below the last |
| 2445 line. Without it the cursor moves to the first or | |
| 2446 last line, unless it already was in that line. | |
| 161 | 2447 Applies to the commands "-", "k", CTRL-P, "+", "j", |
| 632 | 2448 CTRL-N, CTRL-J and ":1234". |
| 39 | 2449 *cpo-+* |
| 2450 + When included, a ":write file" command will reset the | |
| 2451 'modified' flag of the buffer, even though the buffer | |
| 2452 itself may still be different from its file. | |
| 856 | 2453 *cpo-star* |
| 7 | 2454 * Use ":*" in the same way as ":@". When not included, |
| 2455 ":*" is an alias for ":'<,'>", select the Visual area. | |
| 2456 *cpo-<* | |
| 2457 < Disable the recognition of special key codes in |<>| | |
| 2458 form in mappings, abbreviations, and the "to" part of | |
| 10 | 2459 menu commands. For example, the command |
| 7 | 2460 ":map X <Tab>" results in X being mapped to: |
| 2461 '<' included: "<Tab>" (5 characters) | |
| 2462 '<' excluded: "^I" (^I is a real <Tab>) | |
| 2463 Also see the 'k' flag above. | |
| 164 | 2464 *cpo->* |
| 2465 > When appending to a register, put a line break before | |
| 2466 the appended text. | |
| 2925 | 2467 *cpo-;* |
| 2468 ; When using |,| or |;| to repeat the last |t| search | |
| 2469 and the cursor is right in front of the searched | |
| 2470 character, the cursor won't move. When not included, | |
| 2471 the cursor would skip over it and jump to the | |
| 3557 | 2472 following occurrence. |
| 164 | 2473 |
| 2474 POSIX flags. These are not included in the Vi default value, except | |
| 2475 when $VIM_POSIX was set on startup. |posix| | |
| 2476 | |
| 2477 contains behavior ~ | |
| 856 | 2478 *cpo-#* |
| 164 | 2479 # A count before "D", "o" and "O" has no effect. |
| 168 | 2480 *cpo-&* |
| 2481 & When ":preserve" was used keep the swap file when | |
| 2482 exiting normally while this buffer is still loaded. | |
| 2483 This flag is tested when exiting. | |
| 2484 *cpo-\* | |
| 2485 \ Backslash in a [] range in a search pattern is taken | |
| 2486 literally, only "\]" is special See |/[]| | |
| 488 | 2487 '\' included: "/[ \-]" finds <Space>, '\' and '-' |
| 2488 '\' excluded: "/[ \-]" finds <Space> and '-' | |
| 2489 Also see |cpo-l|. | |
| 168 | 2490 *cpo-/* |
| 2491 / When "%" is used as the replacement string in a |:s| | |
| 2492 command, use the previous replacement string. |:s%| | |
| 164 | 2493 *cpo-{* |
| 2494 { The |{| and |}| commands also stop at a "{" character | |
| 2495 at the start of a line. | |
| 168 | 2496 *cpo-.* |
| 2497 . The ":chdir" and ":cd" commands fail if the current | |
| 2498 buffer is modified, unless ! is used. Vim doesn't | |
| 2499 need this, since it remembers the full path of an | |
| 2500 opened file. | |
| 164 | 2501 *cpo-bar* |
| 2502 | The value of the $LINES and $COLUMNS environment | |
| 2503 variables overrule the terminal size values obtained | |
| 2504 with system specific functions. | |
| 2505 | |
| 7 | 2506 |
|
2180
f60a0c9cbe6c
Add the blowfish encryption patch from Mohsin Ahmed. Needs more work.
Bram Moolenaar <bram@vim.org>
parents:
2178
diff
changeset
|
2507 *'cryptmethod'* *'cm'* |
|
15192
690da0a83419
patch 8.1.0606: 'cryptmethod' defaults to a very old method
Bram Moolenaar <Bram@vim.org>
parents:
15131
diff
changeset
|
2508 '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
|
2509 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
|
2510 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
|
2511 *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
|
2512 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
|
2513 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
|
2514 *blowfish* |
| 6122 | 2515 blowfish Blowfish method. Medium strong encryption but it has |
| 2516 an implementation flaw. Requires Vim 7.3 or later, | |
| 2517 files can NOT be read by Vim 7.2 and older. This adds | |
| 2518 a "seed" to the file, every time you write the file | |
| 2519 the encrypted bytes will be different. | |
| 2520 *blowfish2* | |
| 2521 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
|
2522 Vim 7.4.401 or later, files can NOT be read by Vim 7.3 |
| 6122 | 2523 and older. This adds a "seed" to the file, every time |
| 2524 you write the file the encrypted bytes will be | |
| 2525 different. The whole undo file is encrypted, not just | |
| 2526 the pieces of text. | |
| 27537 | 2527 *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
|
2528 *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
|
2529 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
|
2530 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
|
2531 Encryption is provided by the libsodium library, it |
| 25973 | 2532 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
|
2533 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
|
2534 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
|
2535 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
|
2536 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
|
2537 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
|
2538 enabled. |
|
7e9e53a0368f
patch 8.2.3022: available encryption methods are not strong enough
Bram Moolenaar <Bram@vim.org>
parents:
24911
diff
changeset
|
2539 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
|
2540 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
|
2541 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
|
2542 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
|
2543 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
|
2544 |
|
8748
b1a19a2f73f0
commit https://github.com/vim/vim/commit/4f3f668c8486444e53163c29d2fc79bf47eb3c82
Christian Brabandt <cb@256bit.org>
parents:
8629
diff
changeset
|
2545 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
|
2546 |
|
2180
f60a0c9cbe6c
Add the blowfish encryption patch from Mohsin Ahmed. Needs more work.
Bram Moolenaar <bram@vim.org>
parents:
2178
diff
changeset
|
2547 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
|
2548 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
|
2549 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
|
2550 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
|
2551 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
|
2552 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
|
2553 |
|
d8e4b27cef80
Change 'cryptmethod' from a number to a string option. Make it global-local.
Bram Moolenaar <bram@vim.org>
parents:
2350
diff
changeset
|
2554 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
|
2555 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
|
2556 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
|
2557 |
|
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
|
2558 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
|
2559 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
|
2560 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
|
2561 |
|
f60a0c9cbe6c
Add the blowfish encryption patch from Mohsin Ahmed. Needs more work.
Bram Moolenaar <bram@vim.org>
parents:
2178
diff
changeset
|
2562 |
| 7 | 2563 *'cscopepathcomp'* *'cspc'* |
| 2564 'cscopepathcomp' 'cspc' number (default 0) | |
| 2565 global | |
| 2566 {not available when compiled without the |+cscope| | |
| 2567 feature} | |
| 2568 Determines how many components of the path to show in a list of tags. | |
| 2569 See |cscopepathcomp|. | |
| 11160 | 2570 NOTE: This option is set to 0 when 'compatible' is set. |
| 7 | 2571 |
| 2572 *'cscopeprg'* *'csprg'* | |
| 2573 'cscopeprg' 'csprg' string (default "cscope") | |
| 2574 global | |
| 2575 {not available when compiled without the |+cscope| | |
| 2576 feature} | |
| 2577 Specifies the command to execute cscope. See |cscopeprg|. | |
| 2578 This option cannot be set from a |modeline| or in the |sandbox|, for | |
| 2579 security reasons. | |
| 2580 | |
| 2581 *'cscopequickfix'* *'csqf'* | |
| 2582 'cscopequickfix' 'csqf' string (default "") | |
| 2583 global | |
| 2584 {not available when compiled without the |+cscope| | |
| 2585 or |+quickfix| features} | |
| 2586 Specifies whether to use quickfix window to show cscope results. | |
| 2587 See |cscopequickfix|. | |
| 2588 | |
| 4869 | 2589 *'cscoperelative'* *'csre'* *'nocscoperelative'* *'nocsre'* |
| 2873 | 2590 'cscoperelative' 'csre' boolean (default off) |
| 2591 global | |
| 2592 {not available when compiled without the |+cscope| | |
| 2593 feature} | |
| 2594 In the absence of a prefix (-P) for cscope. setting this option enables | |
| 2595 to use the basename of cscope.out path as the prefix. | |
| 2596 See |cscoperelative|. | |
| 11160 | 2597 NOTE: This option is reset when 'compatible' is set. |
| 2873 | 2598 |
| 7 | 2599 *'cscopetag'* *'cst'* *'nocscopetag'* *'nocst'* |
| 2600 'cscopetag' 'cst' boolean (default off) | |
| 2601 global | |
| 2602 {not available when compiled without the |+cscope| | |
| 2603 feature} | |
| 2604 Use cscope for tag commands. See |cscope-options|. | |
| 2605 NOTE: This option is reset when 'compatible' is set. | |
| 2606 | |
| 2607 *'cscopetagorder'* *'csto'* | |
| 2608 'cscopetagorder' 'csto' number (default 0) | |
| 2609 global | |
| 2610 {not available when compiled without the |+cscope| | |
| 2611 feature} | |
| 2612 Determines the order in which ":cstag" performs a search. See | |
| 2613 |cscopetagorder|. | |
| 2614 NOTE: This option is set to 0 when 'compatible' is set. | |
| 2615 | |
| 2616 *'cscopeverbose'* *'csverb'* | |
| 2617 *'nocscopeverbose'* *'nocsverb'* | |
| 2618 'cscopeverbose' 'csverb' boolean (default off) | |
| 2619 global | |
| 2620 {not available when compiled without the |+cscope| | |
| 2621 feature} | |
| 2622 Give messages when adding a cscope database. See |cscopeverbose|. | |
| 2623 NOTE: This option is reset when 'compatible' is set. | |
| 2624 | |
|
2250
1bac28a53fae
Add the conceal patch from Vince Negri.
Bram Moolenaar <bram@vim.org>
parents:
2249
diff
changeset
|
2625 *'cursorbind'* *'crb'* *'nocursorbind'* *'nocrb'* |
|
1bac28a53fae
Add the conceal patch from Vince Negri.
Bram Moolenaar <bram@vim.org>
parents:
2249
diff
changeset
|
2626 'cursorbind' 'crb' boolean (default off) |
|
1bac28a53fae
Add the conceal patch from Vince Negri.
Bram Moolenaar <bram@vim.org>
parents:
2249
diff
changeset
|
2627 local to window |
|
1bac28a53fae
Add the conceal patch from Vince Negri.
Bram Moolenaar <bram@vim.org>
parents:
2249
diff
changeset
|
2628 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
|
2629 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
|
2630 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
|
2631 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
|
2632 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
|
2633 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
|
2634 taken into account. |
|
2250
1bac28a53fae
Add the conceal patch from Vince Negri.
Bram Moolenaar <bram@vim.org>
parents:
2249
diff
changeset
|
2635 |
| 743 | 2636 |
| 2637 *'cursorcolumn'* *'cuc'* *'nocursorcolumn'* *'nocuc'* | |
| 2638 'cursorcolumn' 'cuc' boolean (default off) | |
| 2639 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
|
2640 {not available when compiled without the |+syntax| |
| 743 | 2641 feature} |
| 2642 Highlight the screen column of the cursor with CursorColumn | |
| 2643 |hl-CursorColumn|. Useful to align text. Will make screen redrawing | |
| 2644 slower. | |
| 826 | 2645 If you only want the highlighting in the current window you can use |
| 2646 these autocommands: > | |
| 2647 au WinLeave * set nocursorline nocursorcolumn | |
| 2648 au WinEnter * set cursorline cursorcolumn | |
| 2649 < | |
| 743 | 2650 |
| 2651 *'cursorline'* *'cul'* *'nocursorline'* *'nocul'* | |
| 2652 'cursorline' 'cul' boolean (default off) | |
| 2653 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
|
2654 {not available when compiled without the |+syntax| |
| 743 | 2655 feature} |
|
18047
6650e3dff8d4
patch 8.1.2019: 'cursorline' always highlights the whole line
Bram Moolenaar <Bram@vim.org>
parents:
17909
diff
changeset
|
2656 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
|
2657 Useful to easily spot the cursor. Will make screen redrawing slower. |
| 818 | 2658 When Visual mode is active the highlighting isn't used to make it |
| 825 | 2659 easier to see the selected text. |
| 743 | 2660 |
| 2661 | |
|
18047
6650e3dff8d4
patch 8.1.2019: 'cursorline' always highlights the whole line
Bram Moolenaar <Bram@vim.org>
parents:
17909
diff
changeset
|
2662 *'cursorlineopt'* *'culopt'* |
|
18068
1101eacc1444
patch 8.1.2029: cannot control 'cursorline' highlighting well
Bram Moolenaar <Bram@vim.org>
parents:
18053
diff
changeset
|
2663 '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
|
2664 local to window |
|
6650e3dff8d4
patch 8.1.2019: 'cursorline' always highlights the whole line
Bram Moolenaar <Bram@vim.org>
parents:
17909
diff
changeset
|
2665 {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
|
2666 feature} |
| 28379 | 2667 Comma-separated list of settings for how 'cursorline' is displayed. |
|
18068
1101eacc1444
patch 8.1.2029: cannot control 'cursorline' highlighting well
Bram Moolenaar <Bram@vim.org>
parents:
18053
diff
changeset
|
2668 Valid values: |
|
1101eacc1444
patch 8.1.2029: cannot control 'cursorline' highlighting well
Bram Moolenaar <Bram@vim.org>
parents:
18053
diff
changeset
|
2669 "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
|
2670 CursorLine |hl-CursorLine|. |
|
1101eacc1444
patch 8.1.2029: cannot control 'cursorline' highlighting well
Bram Moolenaar <Bram@vim.org>
parents:
18053
diff
changeset
|
2671 "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
|
2672 CursorLine |hl-CursorLine|. |
|
18068
1101eacc1444
patch 8.1.2029: cannot control 'cursorline' highlighting well
Bram Moolenaar <Bram@vim.org>
parents:
18053
diff
changeset
|
2673 "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
|
2674 CursorLineNr |hl-CursorLineNr|. |
|
18068
1101eacc1444
patch 8.1.2029: cannot control 'cursorline' highlighting well
Bram Moolenaar <Bram@vim.org>
parents:
18053
diff
changeset
|
2675 |
|
1101eacc1444
patch 8.1.2029: cannot control 'cursorline' highlighting well
Bram Moolenaar <Bram@vim.org>
parents:
18053
diff
changeset
|
2676 Special value: |
|
1101eacc1444
patch 8.1.2029: cannot control 'cursorline' highlighting well
Bram Moolenaar <Bram@vim.org>
parents:
18053
diff
changeset
|
2677 "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
|
2678 |
|
1101eacc1444
patch 8.1.2029: cannot control 'cursorline' highlighting well
Bram Moolenaar <Bram@vim.org>
parents:
18053
diff
changeset
|
2679 "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
|
2680 |
|
6650e3dff8d4
patch 8.1.2019: 'cursorline' always highlights the whole line
Bram Moolenaar <Bram@vim.org>
parents:
17909
diff
changeset
|
2681 |
| 7 | 2682 *'debug'* |
| 2683 'debug' string (default "") | |
| 2684 global | |
| 839 | 2685 These values can be used: |
| 2686 msg Error messages that would otherwise be omitted will be given | |
| 2687 anyway. | |
| 2688 throw Error messages that would otherwise be omitted will be given | |
| 2689 anyway and also throw an exception and set |v:errmsg|. | |
| 2690 beep A message will be given when otherwise only a beep would be | |
| 2691 produced. | |
| 168 | 2692 The values can be combined, separated by a comma. |
| 839 | 2693 "msg" and "throw" are useful for debugging 'foldexpr', 'formatexpr' or |
| 2694 'indentexpr'. | |
| 7 | 2695 |
| 2696 *'define'* *'def'* | |
| 2697 'define' 'def' string (default "^\s*#\s*define") | |
| 2698 global or local to buffer |global-local| | |
| 10 | 2699 Pattern to be used to find a macro definition. It is a search |
| 7 | 2700 pattern, just like for the "/" command. This option is used for the |
| 2701 commands like "[i" and "[d" |include-search|. The 'isident' option is | |
| 2702 used to recognize the defined name after the match: | |
| 2703 {match with 'define'}{non-ID chars}{defined name}{non-ID char} | |
| 2704 See |option-backslash| about inserting backslashes to include a space | |
| 2705 or backslash. | |
| 2706 The default value is for C programs. For C++ this value would be | |
| 2707 useful, to include const type declarations: > | |
| 2708 ^\(#\s*define\|[a-z]*\s*const\s*[a-z]*\) | |
| 16086 | 2709 < You can also use "\ze" just before the name and continue the pattern |
| 2710 to check what is following. E.g. for Javascript, if a function is | |
| 2711 defined with "func_name = function(args)": > | |
| 2712 ^\s*\ze\i\+\s*=\s*function( | |
| 2713 < If the function is defined with "func_name : function() {...": > | |
| 2714 ^\s*\ze\i\+\s*[:]\s*(*function\s*( | |
| 7 | 2715 < When using the ":set" command, you need to double the backslashes! |
| 16086 | 2716 To avoid that use `:let` with a single quote string: > |
| 2717 let &l:define = '^\s*\ze\k\+\s*=\s*function(' | |
| 16380 | 2718 < |
| 7 | 2719 |
| 2720 *'delcombine'* *'deco'* *'nodelcombine'* *'nodeco'* | |
| 2721 'delcombine' 'deco' boolean (default off) | |
| 2722 global | |
| 2723 If editing Unicode and this option is set, backspace and Normal mode | |
| 2724 "x" delete each combining character on its own. When it is off (the | |
| 2725 default) the character along with its combining characters are | |
| 2726 deleted. | |
| 22565 | 2727 Note: When 'delcombine' is set "xx" may work differently from "2x"! |
| 7 | 2728 |
| 2729 This is useful for Arabic, Hebrew and many other languages where one | |
| 2730 may have combining characters overtop of base characters, and want | |
| 2731 to remove only the combining ones. | |
| 11160 | 2732 NOTE: This option is reset when 'compatible' is set. |
| 7 | 2733 |
| 2734 *'dictionary'* *'dict'* | |
| 2735 'dictionary' 'dict' string (default "") | |
| 2736 global or local to buffer |global-local| | |
| 2737 List of file names, separated by commas, that are used to lookup words | |
| 2738 for keyword completion commands |i_CTRL-X_CTRL-K|. Each file should | |
| 2739 contain a list of words. This can be one word per line, or several | |
| 2740 words per line, separated by non-keyword characters (white space is | |
| 2741 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
|
2742 |
|
741b1feeac9f
patch 8.0.1845: various comment updates needed, missing white space
Christian Brabandt <cb@256bit.org>
parents:
13818
diff
changeset
|
2743 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
|
2744 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
|
2745 '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
|
2746 |
| 10 | 2747 To include a comma in a file name precede it with a backslash. Spaces |
| 7 | 2748 after a comma are ignored, otherwise spaces are included in the file |
| 2749 name. See |option-backslash| about using backslashes. | |
| 99 | 2750 This has nothing to do with the |Dictionary| variable type. |
| 7 | 2751 Where to find a list of words? |
| 2752 - On FreeBSD, there is the file "/usr/share/dict/words". | |
| 2753 - In the Simtel archive, look in the "msdos/linguist" directory. | |
| 2754 - In "miscfiles" of the GNU collection. | |
| 2755 The use of |:set+=| and |:set-=| is preferred when adding or removing | |
| 2756 directories from the list. This avoids problems when a future version | |
| 2757 uses another default. | |
| 2758 Backticks cannot be used in this option for security reasons. | |
| 2759 | |
| 2760 *'diff'* *'nodiff'* | |
| 2761 'diff' boolean (default off) | |
| 2762 local to window | |
| 2763 {not available when compiled without the |+diff| | |
| 2764 feature} | |
| 2765 Join the current window in the group of windows that shows differences | |
| 10 | 2766 between files. See |vimdiff|. |
| 7 | 2767 |
| 2768 *'dex'* *'diffexpr'* | |
| 2769 'diffexpr' 'dex' string (default "") | |
| 2770 global | |
| 2771 {not available when compiled without the |+diff| | |
| 2772 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
|
2773 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
|
2774 or unified-style) from two versions of a file. See |diff-diffexpr|. |
| 7 | 2775 This option cannot be set from a |modeline| or in the |sandbox|, for |
| 2776 security reasons. | |
| 2777 | |
| 2778 *'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
|
2779 'diffopt' 'dip' string (default "internal,filler,closeoff") |
| 7 | 2780 global |
| 2781 {not available when compiled without the |+diff| | |
| 2782 feature} | |
| 10 | 2783 Option settings for diff mode. It can consist of the following items. |
| 7 | 2784 All are optional. Items must be separated by a comma. |
| 2785 | |
| 2786 filler Show filler lines, to keep the text | |
| 2787 synchronized with a window that has inserted | |
| 2788 lines at the same position. Mostly useful | |
| 2789 when windows are side-by-side and 'scrollbind' | |
| 2790 is set. | |
| 2791 | |
| 2792 context:{n} Use a context of {n} lines between a change | |
| 2793 and a fold that contains unchanged lines. | |
| 2794 When omitted a context of six lines is used. | |
| 15932 | 2795 When using zero the context is actually one, |
| 2796 since folds require a line in between, also | |
| 2797 for a deleted line. | |
| 7 | 2798 See |fold-diff|. |
| 2799 | |
| 14864 | 2800 iblank Ignore changes where lines are all blank. Adds |
| 2801 the "-B" flag to the "diff" command if | |
| 2802 'diffexpr' is empty. Check the documentation | |
| 2803 of the "diff" command for what this does | |
| 2804 exactly. | |
| 2805 NOTE: the diff windows will get out of sync, | |
| 2806 because no differences between blank lines are | |
| 2807 taken into account. | |
| 2808 | |
| 7 | 2809 icase Ignore changes in case of text. "a" and "A" |
| 2810 are considered the same. Adds the "-i" flag | |
| 2811 to the "diff" command if 'diffexpr' is empty. | |
| 2812 | |
| 2813 iwhite Ignore changes in amount of white space. Adds | |
| 2814 the "-b" flag to the "diff" command if | |
| 2815 'diffexpr' is empty. Check the documentation | |
| 2816 of the "diff" command for what this does | |
| 2817 exactly. It should ignore adding trailing | |
| 2818 white space, but not leading white space. | |
| 2819 | |
| 14864 | 2820 iwhiteall Ignore all white space changes. Adds |
| 2821 the "-w" flag to the "diff" command if | |
| 2822 'diffexpr' is empty. Check the documentation | |
| 2823 of the "diff" command for what this does | |
| 2824 exactly. | |
| 2825 | |
| 2826 iwhiteeol Ignore white space changes at end of line. | |
| 2827 Adds the "-Z" flag to the "diff" command if | |
| 2828 'diffexpr' is empty. Check the documentation | |
| 2829 of the "diff" command for what this does | |
| 2830 exactly. | |
| 2831 | |
| 766 | 2832 horizontal Start diff mode with horizontal splits (unless |
| 2833 explicitly specified otherwise). | |
| 2834 | |
| 2835 vertical Start diff mode with vertical splits (unless | |
| 2836 explicitly specified otherwise). | |
| 2837 | |
|
18590
41484f342f80
patch 8.1.2289: after :diffsplit closing the window does not disable diff
Bram Moolenaar <Bram@vim.org>
parents:
18574
diff
changeset
|
2838 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
|
2839 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
|
2840 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
|
2841 `: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
|
2842 `: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
|
2843 |
|
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
|
2844 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
|
2845 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
|
2846 |
| 766 | 2847 foldcolumn:{n} Set the 'foldcolumn' option to {n} when |
| 2848 starting diff mode. Without this 2 is used. | |
| 2849 | |
|
23895
e313b6ee2d9c
patch 8.2.2490: 'wrap' option is always reset when starting diff mode
Bram Moolenaar <Bram@vim.org>
parents:
23825
diff
changeset
|
2850 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
|
2851 |
|
14696
195e8b1fcbbf
patch 8.1.0360: using an external diff program is slow and inflexible
Christian Brabandt <cb@256bit.org>
parents:
14695
diff
changeset
|
2852 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
|
2853 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
|
2854 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
|
2855 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
|
2856 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
|
2857 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
|
2858 |
|
195e8b1fcbbf
patch 8.1.0360: using an external diff program is slow and inflexible
Christian Brabandt <cb@256bit.org>
parents:
14695
diff
changeset
|
2859 indent-heuristic |
| 15033 | 2860 Use the indent heuristic for the internal |
| 2861 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
|
2862 |
|
195e8b1fcbbf
patch 8.1.0360: using an external diff program is slow and inflexible
Christian Brabandt <cb@256bit.org>
parents:
14695
diff
changeset
|
2863 algorithm:{text} Use the specified diff algorithm with the |
| 15033 | 2864 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
|
2865 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
|
2866 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
|
2867 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
|
2868 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
|
2869 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
|
2870 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
|
2871 |
| 7 | 2872 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
|
2873 :set diffopt=internal,filler,context:4 |
| 7 | 2874 :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
|
2875 :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
|
2876 :set diffopt-=internal " do NOT use the internal diff parser |
| 7 | 2877 < |
| 2878 *'digraph'* *'dg'* *'nodigraph'* *'nodg'* | |
| 2879 'digraph' 'dg' boolean (default off) | |
| 2880 global | |
| 2881 {not available when compiled without the |+digraphs| | |
| 2882 feature} | |
| 2883 Enable the entering of digraphs in Insert mode with {char1} <BS> | |
| 2884 {char2}. See |digraphs|. | |
| 2885 NOTE: This option is reset when 'compatible' is set. | |
| 2886 | |
| 2887 *'directory'* *'dir'* | |
| 2888 'directory' 'dir' string (default for Amiga: ".,t:", | |
| 18972 | 2889 for Win32: ".,$TEMP,c:\tmp,c:\temp" |
| 7 | 2890 for Unix: ".,~/tmp,/var/tmp,/tmp") |
| 2891 global | |
| 2892 List of directory names for the swap file, separated with commas. | |
| 21676 | 2893 Recommended value: ".,~/vimswap//" - this will put the swap file next |
| 2894 to the edited file if possible, and in your personal swap directory | |
| 2895 otherwise. Make sure "~/vimswap//" is only readable for you. | |
| 2896 | |
| 2897 Possible items: | |
| 7 | 2898 - The swap file will be created in the first directory where this is |
| 2899 possible. | |
| 2900 - 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
|
2901 impossible!) and no |E303| error will be given. |
| 7 | 2902 - A directory "." means to put the swap file in the same directory as |
| 2903 the edited file. On Unix, a dot is prepended to the file name, so | |
| 2904 it doesn't show in a directory listing. On MS-Windows the "hidden" | |
| 2905 attribute is set and a dot prepended if possible. | |
| 19116 | 2906 - A directory starting with "./" (or ".\" for MS-Windows) means to put |
| 2907 the swap file relative to where the edited file is. The leading "." | |
| 2908 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
|
2909 - 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
|
2910 the swap file name will be built from the complete path to the file |
| 21991 | 2911 with all path separators replaced by percent '%' signs (including |
| 2912 the colon following the drive letter on Win32). This will ensure | |
| 2913 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
|
2914 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
|
2915 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
|
2916 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
|
2917 use '//', instead of '\\'. |
| 7 | 2918 - Spaces after the comma are ignored, other spaces are considered part |
| 2919 of the directory name. To have a space at the start of a directory | |
| 2920 name, precede it with a backslash. | |
| 2921 - To include a comma in a directory name precede it with a backslash. | |
| 2922 - A directory name may end in an ':' or '/'. | |
| 2923 - Environment variables are expanded |:set_env|. | |
| 2924 - Careful with '\' characters, type one before a space, type two to | |
| 2925 get one in the option (see |option-backslash|), for example: > | |
| 2926 :set dir=c:\\tmp,\ dir\\,with\\,commas,\\\ dir\ with\ spaces | |
| 2927 < - For backwards compatibility with Vim version 3.0 a '>' at the start | |
| 2928 of the option is removed. | |
| 2929 Using "." first in the list is recommended. This means that editing | |
| 2930 the same file twice will result in a warning. Using "/tmp" on Unix is | |
| 2931 discouraged: When the system crashes you lose the swap file. | |
| 2932 "/var/tmp" is often not cleared when rebooting, thus is a better | |
| 21676 | 2933 choice than "/tmp". But others on the computer may be able to see the |
| 2934 files, and it can contain a lot of files, your swap files get lost in | |
| 2935 the crowd. That is why a "tmp" directory in your home directory is | |
| 2936 tried first. | |
| 7 | 2937 The use of |:set+=| and |:set-=| is preferred when adding or removing |
| 2938 directories from the list. This avoids problems when a future version | |
| 2939 uses another default. | |
| 2940 This option cannot be set from a |modeline| or in the |sandbox|, for | |
| 2941 security reasons. | |
| 2942 | |
| 2943 *'display'* *'dy'* | |
|
9737
35ce559b8553
commit https://github.com/vim/vim/commit/bc8801c9317eb721a2ee91322669f2dd5d136380
Christian Brabandt <cb@256bit.org>
parents:
9669
diff
changeset
|
2944 '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
|
2945 |defaults.vim|) |
| 7 | 2946 global |
| 30634 | 2947 Change the way text is displayed. This is a comma-separated list of |
| 7 | 2948 flags: |
| 2949 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
|
2950 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
|
2951 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
|
2952 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
|
2953 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
|
2954 column of the last screen line. Overrules "lastline". |
| 7 | 2955 uhex Show unprintable characters hexadecimal as <xx> |
| 2956 instead of using ^C and ~C. | |
| 2957 | |
|
10211
b7da8d4c594c
commit https://github.com/vim/vim/commit/d07969093a9b3051511c478d71c36de6fc33c0d6
Christian Brabandt <cb@256bit.org>
parents:
10198
diff
changeset
|
2958 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
|
2959 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
|
2960 |
|
30643
dfb02f9dcbe8
patch 9.0.0656: cannot specify another character to use instead of '@'
Bram Moolenaar <Bram@vim.org>
parents:
30634
diff
changeset
|
2961 The "@" character can be changed by setting the "lastline" item in |
|
dfb02f9dcbe8
patch 9.0.0656: cannot specify another character to use instead of '@'
Bram Moolenaar <Bram@vim.org>
parents:
30634
diff
changeset
|
2962 'fillchars'. The character is highlighted with |hl-NonText|. |
|
dfb02f9dcbe8
patch 9.0.0656: cannot specify another character to use instead of '@'
Bram Moolenaar <Bram@vim.org>
parents:
30634
diff
changeset
|
2963 |
| 7 | 2964 *'eadirection'* *'ead'* |
| 2965 'eadirection' 'ead' string (default "both") | |
| 2966 global | |
| 2967 Tells when the 'equalalways' option applies: | |
| 2968 ver vertically, width of windows is not affected | |
| 2969 hor horizontally, height of windows is not affected | |
| 2970 both width and height of windows is affected | |
| 2971 | |
| 2972 *'ed'* *'edcompatible'* *'noed'* *'noedcompatible'* | |
| 2973 'edcompatible' 'ed' boolean (default off) | |
| 2974 global | |
| 2975 Makes the 'g' and 'c' flags of the ":substitute" command to be | |
| 2976 toggled each time the flag is given. See |complex-change|. See | |
| 2977 also 'gdefault' option. | |
| 11442 | 2978 Switching this option on may break plugins! |
| 23305 | 2979 This option is not used in |Vim9| script. |
| 7 | 2980 |
|
8876
47f17f66da3d
commit https://github.com/vim/vim/commit/03413f44167c4b5cd0012def9bb331e2518c83cf
Christian Brabandt <cb@256bit.org>
parents:
8835
diff
changeset
|
2981 *'emoji'* *'emo'* *'noemoji'* *'noemo'* |
|
8629
54ac275e3fc4
commit https://github.com/vim/vim/commit/3848e00e0177abdb31bc600234967863ec487233
Christian Brabandt <cb@256bit.org>
parents:
8560
diff
changeset
|
2982 'emoji' 'emo' boolean (default: on) |
|
54ac275e3fc4
commit https://github.com/vim/vim/commit/3848e00e0177abdb31bc600234967863ec487233
Christian Brabandt <cb@256bit.org>
parents:
8560
diff
changeset
|
2983 global |
|
54ac275e3fc4
commit https://github.com/vim/vim/commit/3848e00e0177abdb31bc600234967863ec487233
Christian Brabandt <cb@256bit.org>
parents:
8560
diff
changeset
|
2984 When on all Unicode emoji characters are considered to be full width. |
| 22328 | 2985 This excludes "text emoji" characters, which are normally displayed as |
| 2986 single width. Unfortunately there is no good specification for this | |
| 2987 and it has been determined on trial-and-error basis. Use the | |
| 2988 |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
|
2989 |
| 7 | 2990 *'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
|
2991 '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
|
2992 otherwise: value from $LANG or "latin1") |
| 7 | 2993 global |
| 2994 Sets the character encoding used inside Vim. It applies to text in | |
| 2995 the buffers, registers, Strings in expressions, text stored in the | |
| 2996 viminfo file, etc. It sets the kind of characters which Vim can work | |
| 2997 with. See |encoding-names| for the possible values. | |
| 2998 | |
| 2999 NOTE: Changing this option will not change the encoding of the | |
| 39 | 3000 existing text in Vim. It may cause non-ASCII text to become invalid. |
| 7 | 3001 It should normally be kept at its default value, or set when Vim |
| 1152 | 3002 starts up. See |multibyte|. To reload the menus see |:menutrans|. |
| 7 | 3003 |
|
2317
2b2cd34569eb
Disallow setting 'enc' in a modeline. (Patrick Texier)
Bram Moolenaar <bram@vim.org>
parents:
2314
diff
changeset
|
3004 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
|
3005 corrupt the text. |
|
2b2cd34569eb
Disallow setting 'enc' in a modeline. (Patrick Texier)
Bram Moolenaar <bram@vim.org>
parents:
2314
diff
changeset
|
3006 |
|
10895
c391bfbdb452
Updated runtime files.
Christian Brabandt <cb@256bit.org>
parents:
10734
diff
changeset
|
3007 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
|
3008 to "utf-8". Although care has been taken to allow different values of |
| 7 | 3009 'encoding', "utf-8" is the natural choice for the environment and |
| 3010 avoids unnecessary conversion overhead. "utf-8" has not been made | |
| 10 | 3011 the default to prevent different behavior of the GUI and terminal |
| 7 | 3012 versions, and to avoid changing the encoding of newly created files |
| 3013 without your knowledge (in case 'fileencodings' is empty). | |
| 3014 | |
| 3015 The character encoding of files can be different from 'encoding'. | |
| 10 | 3016 This is specified with 'fileencoding'. The conversion is done with |
| 7 | 3017 iconv() or as specified with 'charconvert'. |
| 3018 | |
| 21991 | 3019 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
|
3020 can use: > |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
3021 if has("multi_byte_encoding") |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
3022 < |
| 7 | 3023 Normally 'encoding' will be equal to your current locale. This will |
| 3024 be the default if Vim recognizes your environment settings. If | |
| 3025 'encoding' is not set to the current locale, 'termencoding' must be | |
| 3026 set to convert typed and displayed text. See |encoding-table|. | |
| 3027 | |
| 3028 When you set this option, it fires the |EncodingChanged| autocommand | |
| 3029 event so that you can set up fonts if necessary. | |
| 3030 | |
| 3031 When the option is set, the value is converted to lowercase. Thus | |
| 3032 you can set it with uppercase values too. Underscores are translated | |
| 3033 to '-' signs. | |
| 3034 When the encoding is recognized, it is changed to the standard name. | |
| 3035 For example "Latin-1" becomes "latin1", "ISO_88592" becomes | |
| 3036 "iso-8859-2" and "utf8" becomes "utf-8". | |
| 3037 | |
| 3038 Note: "latin1" is also used when the encoding could not be detected. | |
| 3039 This only works when editing files in the same encoding! When the | |
| 3040 actual character set is not latin1, make sure 'fileencoding' and | |
| 3041 'fileencodings' are empty. When conversion is needed, switch to using | |
| 3042 utf-8. | |
| 3043 | |
| 3044 When "unicode", "ucs-2" or "ucs-4" is used, Vim internally uses utf-8. | |
| 3045 You don't notice this while editing, but it does matter for the | |
| 3046 |viminfo-file|. And Vim expects the terminal to use utf-8 too. Thus | |
| 3047 setting 'encoding' to one of these values instead of utf-8 only has | |
| 3048 effect for encoding used for files when 'fileencoding' is empty. | |
| 448 | 3049 |
| 3050 When 'encoding' is set to a Unicode encoding, and 'fileencodings' was | |
| 3051 not set yet, the default for 'fileencodings' is changed. | |
| 7 | 3052 |
| 30967 | 3053 *'endoffile'* *'eof'* *'noendoffile'* *'noeof'* |
|
31055
5a95f0c630b1
patch 9.0.0862: default value of 'endoffile' is wrong
Bram Moolenaar <Bram@vim.org>
parents:
30982
diff
changeset
|
3054 'endoffile' 'eof' boolean (default off) |
| 7 | 3055 local to buffer |
| 30967 | 3056 Indicates that a CTRL-Z character was found at the end of the file |
| 3057 when reading it. Normally only happens when 'fileformat' is "dos". | |
| 7 | 3058 When writing a file and this option is off and the 'binary' option |
| 30967 | 3059 is on, or 'fixeol' option is off, no CTRL-Z will be written at the |
| 30962 | 3060 end of the file. |
|
30982
92b1338023ee
patch 9.0.0826: if 'endofline' is set CTRL-Z may be written in a wrong place
Bram Moolenaar <Bram@vim.org>
parents:
30967
diff
changeset
|
3061 See |eol-and-eof| for example settings. |
| 30962 | 3062 |
| 3063 *'endofline'* *'eol'* *'noendofline'* *'noeol'* | |
| 3064 'endofline' 'eol' boolean (default on) | |
| 3065 local to buffer | |
| 3066 When writing a file and this option is off and the 'binary' option | |
| 6933 | 3067 is on, or 'fixeol' option is off, no <EOL> will be written for the |
| 3068 last line in the file. This option is automatically set or reset when | |
| 3069 starting to edit a new file, depending on whether file has an <EOL> | |
| 3070 for the last line in the file. Normally you don't have to set or | |
| 3071 reset this option. | |
| 3072 When 'binary' is off and 'fixeol' is on the value is not used when | |
| 3073 writing the file. When 'binary' is on or 'fixeol' is off it is used | |
| 3074 to remember the presence of a <EOL> for the last line in the file, so | |
| 3075 that when you write the file the situation from the original file can | |
| 3076 be kept. But you can change it if you want to. | |
|
30982
92b1338023ee
patch 9.0.0826: if 'endofline' is set CTRL-Z may be written in a wrong place
Bram Moolenaar <Bram@vim.org>
parents:
30967
diff
changeset
|
3077 See |eol-and-eof| for example settings. |
| 7 | 3078 |
| 3079 *'equalalways'* *'ea'* *'noequalalways'* *'noea'* | |
| 3080 'equalalways' 'ea' boolean (default on) | |
| 3081 global | |
| 3082 When on, all the windows are automatically made the same size after | |
| 33 | 3083 splitting or closing a window. This also happens the moment the |
| 3084 option is switched on. When off, splitting a window will reduce the | |
| 3085 size of the current window and leave the other windows the same. When | |
| 3086 closing a window the extra lines are given to the window next to it | |
| 3087 (depending on 'splitbelow' and 'splitright'). | |
| 7 | 3088 When mixing vertically and horizontally split windows, a minimal size |
| 3089 is computed and some windows may be larger if there is room. The | |
| 3090 'eadirection' option tells in which direction the size is affected. | |
| 1354 | 3091 Changing the height and width of a window can be avoided by setting |
| 3092 'winfixheight' and 'winfixwidth', respectively. | |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
3093 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
|
3094 currently not equalized (it's complicated, but may be implemented in |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
3095 the future). |
| 7 | 3096 |
| 3097 *'equalprg'* *'ep'* | |
| 3098 'equalprg' 'ep' string (default "") | |
| 3099 global or local to buffer |global-local| | |
| 3100 External program to use for "=" command. When this option is empty | |
| 1621 | 3101 the internal formatting functions are used; either 'lisp', 'cindent' |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
3102 or 'indentexpr'. When Vim was compiled without internal formatting, |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
3103 the "indent" program is used. |
| 10 | 3104 Environment variables are expanded |:set_env|. See |option-backslash| |
| 7 | 3105 about including spaces and backslashes. |
| 3106 This option cannot be set from a |modeline| or in the |sandbox|, for | |
| 3107 security reasons. | |
| 3108 | |
| 3109 *'errorbells'* *'eb'* *'noerrorbells'* *'noeb'* | |
| 3110 'errorbells' 'eb' boolean (default off) | |
| 3111 global | |
| 3112 Ring the bell (beep or screen flash) for error messages. This only | |
| 3113 makes a difference for error messages, the bell will be used always | |
| 3114 for a lot of errors without a message (e.g., hitting <Esc> in Normal | |
| 10 | 3115 mode). See 'visualbell' on how to make the bell behave like a beep, |
| 6949 | 3116 screen flash or do nothing. See 'belloff' to finetune when to ring the |
| 3117 bell. | |
| 7 | 3118 |
| 3119 *'errorfile'* *'ef'* | |
| 3120 'errorfile' 'ef' string (Amiga default: "AztecC.Err", | |
| 3121 others: "errors.err") | |
| 3122 global | |
| 3123 {not available when compiled without the |+quickfix| | |
| 3124 feature} | |
| 3125 Name of the errorfile for the QuickFix mode (see |:cf|). | |
| 3126 When the "-q" command-line argument is used, 'errorfile' is set to the | |
| 3127 following argument. See |-q|. | |
| 3128 NOT used for the ":make" command. See 'makeef' for that. | |
| 3129 Environment variables are expanded |:set_env|. | |
| 3130 See |option-backslash| about including spaces and backslashes. | |
| 3131 This option cannot be set from a |modeline| or in the |sandbox|, for | |
| 3132 security reasons. | |
| 3133 | |
| 3134 *'errorformat'* *'efm'* | |
| 3135 'errorformat' 'efm' string (default is very long) | |
| 3136 global or local to buffer |global-local| | |
| 3137 {not available when compiled without the |+quickfix| | |
| 3138 feature} | |
| 3139 Scanf-like description of the format for the lines in the error file | |
| 3140 (see |errorformat|). | |
| 3141 | |
| 3142 *'esckeys'* *'ek'* *'noesckeys'* *'noek'* | |
| 3143 'esckeys' 'ek' boolean (Vim default: on, Vi default: off) | |
| 3144 global | |
| 3145 Function keys that start with an <Esc> are recognized in Insert | |
| 3146 mode. When this option is off, the cursor and function keys cannot be | |
| 3147 used in Insert mode if they start with an <Esc>. The advantage of | |
| 3148 this is that the single <Esc> is recognized immediately, instead of | |
| 3149 after one second. Instead of resetting this option, you might want to | |
| 3150 try changing the values for 'timeoutlen' and 'ttimeoutlen'. Note that | |
| 3151 when 'esckeys' is off, you can still map anything, but the cursor keys | |
| 3152 won't work by default. | |
| 3153 NOTE: This option is set to the Vi default value when 'compatible' is | |
| 3154 set and to the Vim default value when 'compatible' is reset. | |
|
18590
41484f342f80
patch 8.1.2289: after :diffsplit closing the window does not disable diff
Bram Moolenaar <Bram@vim.org>
parents:
18574
diff
changeset
|
3155 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
|
3156 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
|
3157 key that has a modifier. |
| 7 | 3158 |
| 3159 *'eventignore'* *'ei'* | |
| 3160 'eventignore' 'ei' string (default "") | |
| 3161 global | |
| 3162 A list of autocommand event names, which are to be ignored. | |
| 844 | 3163 When set to "all" or when "all" is one of the items, all autocommand |
| 3164 events are ignored, autocommands will not be executed. | |
| 28379 | 3165 Otherwise this is a comma-separated list of event names. Example: > |
| 7 | 3166 :set ei=WinEnter,WinLeave |
| 3167 < | |
| 3168 *'expandtab'* *'et'* *'noexpandtab'* *'noet'* | |
| 3169 'expandtab' 'et' boolean (default off) | |
| 3170 local to buffer | |
| 3171 In Insert mode: Use the appropriate number of spaces to insert a | |
| 10 | 3172 <Tab>. Spaces are used in indents with the '>' and '<' commands and |
| 7 | 3173 when 'autoindent' is on. To insert a real tab when 'expandtab' is |
| 3174 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
|
3175 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
|
3176 the 'paste' option is reset. |
| 7 | 3177 NOTE: This option is reset when 'compatible' is set. |
| 3178 | |
| 3179 *'exrc'* *'ex'* *'noexrc'* *'noex'* | |
| 3180 'exrc' 'ex' boolean (default off) | |
| 3181 global | |
| 3182 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
|
3183 directory. |
|
018fead968c1
commit https://github.com/vim/vim/commit/36f44c21da2e912c008683a0c4447fca2a071e9a
Christian Brabandt <cb@256bit.org>
parents:
9975
diff
changeset
|
3184 |
|
018fead968c1
commit https://github.com/vim/vim/commit/36f44c21da2e912c008683a0c4447fca2a071e9a
Christian Brabandt <cb@256bit.org>
parents:
9975
diff
changeset
|
3185 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
|
3186 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
|
3187 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
|
3188 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
|
3189 matching directory. |
|
018fead968c1
commit https://github.com/vim/vim/commit/36f44c21da2e912c008683a0c4447fca2a071e9a
Christian Brabandt <cb@256bit.org>
parents:
9975
diff
changeset
|
3190 |
|
018fead968c1
commit https://github.com/vim/vim/commit/36f44c21da2e912c008683a0c4447fca2a071e9a
Christian Brabandt <cb@256bit.org>
parents:
9975
diff
changeset
|
3191 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
|
3192 'secure' option (see |initialization|). |
|
018fead968c1
commit https://github.com/vim/vim/commit/36f44c21da2e912c008683a0c4447fca2a071e9a
Christian Brabandt <cb@256bit.org>
parents:
9975
diff
changeset
|
3193 Also see |.vimrc| and |gui-init|. |
| 7 | 3194 This option cannot be set from a |modeline| or in the |sandbox|, for |
| 3195 security reasons. | |
| 3196 | |
| 3197 *'fileencoding'* *'fenc'* *E213* | |
| 3198 'fileencoding' 'fenc' string (default: "") | |
| 3199 local to buffer | |
| 3200 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
|
3201 |
| 7 | 3202 When 'fileencoding' is different from 'encoding', conversion will be |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
3203 done when writing the file. For reading see below. |
| 7 | 3204 When 'fileencoding' is empty, the same value as 'encoding' will be |
| 3205 used (no conversion when reading or writing a file). | |
| 11062 | 3206 No error will be given when the value is set, only when it is used, |
| 3207 only when writing a file. | |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
3208 Conversion will also be done when 'encoding' and 'fileencoding' are |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
3209 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
|
3210 because internally Unicode is always stored as utf-8. |
| 7 | 3211 WARNING: Conversion can cause loss of information! When |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
3212 'encoding' is "utf-8" or another Unicode encoding, conversion |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
3213 is most likely done in a way that the reverse conversion |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
3214 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
|
3215 characters may be lost! |
|
2317
2b2cd34569eb
Disallow setting 'enc' in a modeline. (Patrick Texier)
Bram Moolenaar <bram@vim.org>
parents:
2314
diff
changeset
|
3216 |
| 7 | 3217 See 'encoding' for the possible values. Additionally, values may be |
| 3218 specified that can be handled by the converter, see | |
| 3219 |mbyte-conversion|. | |
|
2317
2b2cd34569eb
Disallow setting 'enc' in a modeline. (Patrick Texier)
Bram Moolenaar <bram@vim.org>
parents:
2314
diff
changeset
|
3220 |
| 7 | 3221 When reading a file 'fileencoding' will be set from 'fileencodings'. |
| 3222 To read a file in a certain encoding it won't work by setting | |
| 1152 | 3223 'fileencoding', use the |++enc| argument. One exception: when |
| 3224 'fileencodings' is empty the value of 'fileencoding' is used. | |
| 692 | 3225 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
|
3226 |
| 7 | 3227 Prepending "8bit-" and "2byte-" has no meaning here, they are ignored. |
| 3228 When the option is set, the value is converted to lowercase. Thus | |
| 3229 you can set it with uppercase values too. '_' characters are | |
| 3230 replaced with '-'. If a name is recognized from the list for | |
| 3231 'encoding', it is replaced by the standard name. For example | |
| 3232 "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
|
3233 |
| 7 | 3234 When this option is set, after starting to edit a file, the 'modified' |
| 3235 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
|
3236 |
|
2b2cd34569eb
Disallow setting 'enc' in a modeline. (Patrick Texier)
Bram Moolenaar <bram@vim.org>
parents:
2314
diff
changeset
|
3237 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
|
3238 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
|
3239 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
|
3240 '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
|
3241 |
| 7 | 3242 This option can not be changed when 'modifiable' is off. |
| 3243 | |
| 3244 *'fe'* | |
| 3245 NOTE: Before version 6.0 this option specified the encoding for the | |
| 10 | 3246 whole of Vim, this was a mistake. Now use 'encoding' instead. The |
| 7 | 3247 old short name was 'fe', which is no longer used. |
| 3248 | |
| 3249 *'fileencodings'* *'fencs'* | |
| 39 | 3250 'fileencodings' 'fencs' string (default: "ucs-bom", |
| 3251 "ucs-bom,utf-8,default,latin1" when | |
| 3252 'encoding' is set to a Unicode value) | |
| 7 | 3253 global |
| 3254 This is a list of character encodings considered when starting to edit | |
| 3255 an existing file. When a file is read, Vim tries to use the first | |
| 3256 mentioned character encoding. If an error is detected, the next one | |
| 3257 in the list is tried. When an encoding is found that works, | |
| 10 | 3258 'fileencoding' is set to it. If all fail, 'fileencoding' is set to |
| 7 | 3259 an empty string, which means the value of 'encoding' is used. |
| 3260 WARNING: Conversion can cause loss of information! When | |
| 3261 'encoding' is "utf-8" (or one of the other Unicode variants) | |
| 3262 conversion is most likely done in a way that the reverse | |
| 3263 conversion results in the same text. When 'encoding' is not | |
| 596 | 3264 "utf-8" some non-ASCII characters may be lost! You can use |
| 3265 the |++bad| argument to specify what is done with characters | |
| 3266 that can't be converted. | |
| 7 | 3267 For an empty file or a file with only ASCII characters most encodings |
| 3268 will work and the first entry of 'fileencodings' will be used (except | |
| 3269 "ucs-bom", which requires the BOM to be present). If you prefer | |
| 3270 another encoding use an BufReadPost autocommand event to test if your | |
| 3271 preferred encoding is to be used. Example: > | |
| 3272 au BufReadPost * if search('\S', 'w') == 0 | | |
| 3273 \ set fenc=iso-2022-jp | endif | |
| 3274 < This sets 'fileencoding' to "iso-2022-jp" if the file does not contain | |
| 3275 non-blank characters. | |
| 596 | 3276 When the |++enc| argument is used then the value of 'fileencodings' is |
| 3277 not used. | |
| 692 | 3278 Note that 'fileencodings' is not used for a new file, the global value |
| 3279 of 'fileencoding' is used instead. You can set it with: > | |
| 3280 :setglobal fenc=iso-8859-2 | |
| 3281 < This means that a non-existing file may get a different encoding than | |
| 3282 an empty file. | |
| 7 | 3283 The special value "ucs-bom" can be used to check for a Unicode BOM |
| 3284 (Byte Order Mark) at the start of the file. It must not be preceded | |
| 3285 by "utf-8" or another Unicode encoding for this to work properly. | |
| 3286 An entry for an 8-bit encoding (e.g., "latin1") should be the last, | |
| 3287 because Vim cannot detect an error, thus the encoding is always | |
| 3288 accepted. | |
| 39 | 3289 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
|
3290 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
|
3291 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
|
3292 '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
|
3293 encoding, such as Russian. |
| 777 | 3294 When 'encoding' is "utf-8" and a file contains an illegal byte |
| 3295 sequence it won't be recognized as UTF-8. You can use the |8g8| | |
| 3296 command to find the illegal byte sequence. | |
| 7 | 3297 WRONG VALUES: WHAT'S WRONG: |
| 3298 latin1,utf-8 "latin1" will always be used | |
| 3299 utf-8,ucs-bom,latin1 BOM won't be recognized in an utf-8 | |
| 3300 file | |
| 3301 cp1250,latin1 "cp1250" will always be used | |
| 3302 If 'fileencodings' is empty, 'fileencoding' is not modified. | |
| 3303 See 'fileencoding' for the possible values. | |
| 3304 Setting this option does not have an effect until the next time a file | |
| 3305 is read. | |
| 3306 | |
| 3307 *'fileformat'* *'ff'* | |
|
15840
734b1928a5aa
patch 8.1.0927: USE_CR is never defined
Bram Moolenaar <Bram@vim.org>
parents:
15804
diff
changeset
|
3308 '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
|
3309 Unix, macOS default: "unix") |
| 7 | 3310 local to buffer |
| 3311 This gives the <EOL> of the current buffer, which is used for | |
| 3312 reading/writing the buffer from/to a file: | |
| 23305 | 3313 dos <CR><NL> |
| 7 | 3314 unix <NL> |
| 3315 mac <CR> | |
| 3316 When "dos" is used, CTRL-Z at the end of a file is ignored. | |
| 3317 See |file-formats| and |file-read|. | |
| 3318 For the character encoding of the file see 'fileencoding'. | |
| 3319 When 'binary' is set, the value of 'fileformat' is ignored, file I/O | |
| 4264 | 3320 works like it was set to "unix". |
| 7 | 3321 This option is set automatically when starting to edit a file and |
| 3322 'fileformats' is not empty and 'binary' is off. | |
| 3323 When this option is set, after starting to edit a file, the 'modified' | |
| 3324 option is set, because the file would be different when written. | |
| 3325 This option can not be changed when 'modifiable' is off. | |
| 3326 For backwards compatibility: When this option is set to "dos", | |
| 3327 'textmode' is set, otherwise 'textmode' is reset. | |
| 3328 | |
| 3329 *'fileformats'* *'ffs'* | |
| 3330 'fileformats' 'ffs' string (default: | |
|
15840
734b1928a5aa
patch 8.1.0927: USE_CR is never defined
Bram Moolenaar <Bram@vim.org>
parents:
15804
diff
changeset
|
3331 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
|
3332 Vim Unix, macOS: "unix,dos", |
| 7 | 3333 Vi Cygwin: "unix,dos", |
| 3334 Vi others: "") | |
| 3335 global | |
| 3336 This gives the end-of-line (<EOL>) formats that will be tried when | |
| 3337 starting to edit a new buffer and when reading a file into an existing | |
| 3338 buffer: | |
| 3339 - When empty, the format defined with 'fileformat' will be used | |
| 3340 always. It is not set automatically. | |
| 3341 - When set to one name, that format will be used whenever a new buffer | |
| 10 | 3342 is opened. 'fileformat' is set accordingly for that buffer. The |
| 7 | 3343 'fileformats' name will be used when a file is read into an existing |
| 3344 buffer, no matter what 'fileformat' for that buffer is set to. | |
| 3345 - When more than one name is present, separated by commas, automatic | |
| 3346 <EOL> detection will be done when reading a file. When starting to | |
| 3347 edit a file, a check is done for the <EOL>: | |
| 3348 1. If all lines end in <CR><NL>, and 'fileformats' includes "dos", | |
| 3349 'fileformat' is set to "dos". | |
| 3350 2. If a <NL> is found and 'fileformats' includes "unix", 'fileformat' | |
| 10 | 3351 is set to "unix". Note that when a <NL> is found without a |
| 7 | 3352 preceding <CR>, "unix" is preferred over "dos". |
| 6647 | 3353 3. If 'fileformat' has not yet been set, and if a <CR> is found, and |
| 3354 if 'fileformats' includes "mac", 'fileformat' is set to "mac". | |
| 2587 | 3355 This means that "mac" is only chosen when: |
| 3356 "unix" is not present or no <NL> is found in the file, and | |
| 3357 "dos" is not present or no <CR><NL> is found in the file. | |
| 3358 Except: if "unix" was chosen, but there is a <CR> before | |
| 3359 the first <NL>, and there appear to be more <CR>s than <NL>s in | |
| 2642 | 3360 the first few lines, "mac" is used. |
| 7 | 3361 4. If 'fileformat' is still not set, the first name from |
| 3362 'fileformats' is used. | |
| 3363 When reading a file into an existing buffer, the same is done, but | |
| 3364 this happens like 'fileformat' has been set appropriately for that | |
| 3365 file only, the option is not changed. | |
| 3366 When 'binary' is set, the value of 'fileformats' is not used. | |
| 3367 | |
|
8748
b1a19a2f73f0
commit https://github.com/vim/vim/commit/4f3f668c8486444e53163c29d2fc79bf47eb3c82
Christian Brabandt <cb@256bit.org>
parents:
8629
diff
changeset
|
3368 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
|
3369 can overrule this by setting 'fileformat' in your .vimrc. |
| 2662 | 3370 |
| 7 | 3371 For systems with a Dos-like <EOL> (<CR><NL>), when reading files that |
| 3372 are ":source"ed and for vimrc files, automatic <EOL> detection may be | |
| 3373 done: | |
| 3374 - When 'fileformats' is empty, there is no automatic detection. Dos | |
| 3375 format will be used. | |
| 3376 - When 'fileformats' is set to one or more names, automatic detection | |
| 3377 is done. This is based on the first <NL> in the file: If there is a | |
| 3378 <CR> in front of it, Dos format is used, otherwise Unix format is | |
| 3379 used. | |
| 3380 Also see |file-formats|. | |
| 3381 For backwards compatibility: When this option is set to an empty | |
| 3382 string or one format (no comma is included), 'textauto' is reset, | |
| 3383 otherwise 'textauto' is set. | |
| 3384 NOTE: This option is set to the Vi default value when 'compatible' is | |
| 3385 set and to the Vim default value when 'compatible' is reset. | |
| 3386 | |
| 4264 | 3387 *'fileignorecase'* *'fic'* *'nofileignorecase'* *'nofic'* |
| 3388 'fileignorecase' 'fic' boolean (default on for systems where case in file | |
| 3389 names is normally ignored) | |
| 4242 | 3390 global |
| 3391 When set case is ignored when using file names and directories. | |
| 3392 See 'wildignorecase' for only ignoring case when doing completion. | |
| 3393 | |
| 7 | 3394 *'filetype'* *'ft'* |
| 3395 'filetype' 'ft' string (default: "") | |
| 3396 local to buffer | |
| 3397 When this option is set, the FileType autocommand event is triggered. | |
| 3398 All autocommands that match with the value of this option will be | |
| 3399 executed. Thus the value of 'filetype' is used in place of the file | |
| 3400 name. | |
| 3401 Otherwise this option does not always reflect the current file type. | |
| 3402 This option is normally set when the file type is detected. To enable | |
| 3403 this use the ":filetype on" command. |:filetype| | |
| 3404 Setting this option to a different value is most useful in a modeline, | |
| 3405 for a file for which the file type is not automatically recognized. | |
| 782 | 3406 Example, for in an IDL file: |
| 3407 /* vim: set filetype=idl : */ ~ | |
| 3408 |FileType| |filetypes| | |
| 3409 When a dot appears in the value then this separates two filetype | |
| 3410 names. Example: | |
| 3411 /* vim: set filetype=c.doxygen : */ ~ | |
| 3412 This will use the "c" filetype first, then the "doxygen" filetype. | |
| 3413 This works both for filetype plugins and for syntax files. More than | |
| 3414 one dot may appear. | |
| 7 | 3415 This option is not copied to another buffer, independent of the 's' or |
| 3416 'S' flag in 'cpoptions'. | |
| 36 | 3417 Only normal file name characters can be used, "/\*?[|<>" are illegal. |
| 7 | 3418 |
| 3419 *'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
|
3420 'fillchars' 'fcs' string (default "vert:|,fold:-,eob:~") |
|
29387
9dce192d1ac2
patch 9.0.0036: 'fillchars' cannot have window-local values
Bram Moolenaar <Bram@vim.org>
parents:
29328
diff
changeset
|
3421 global or local to window |global-local| |
|
17771
4bd21046902b
patch 8.1.1882: cannot specify properties of the info popup window
Bram Moolenaar <Bram@vim.org>
parents:
17767
diff
changeset
|
3422 {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
|
3423 feature} |
|
29387
9dce192d1ac2
patch 9.0.0036: 'fillchars' cannot have window-local values
Bram Moolenaar <Bram@vim.org>
parents:
29328
diff
changeset
|
3424 Characters to fill the statuslines, vertical separators and special |
|
9dce192d1ac2
patch 9.0.0036: 'fillchars' cannot have window-local values
Bram Moolenaar <Bram@vim.org>
parents:
29328
diff
changeset
|
3425 lines in the window. |
|
9dce192d1ac2
patch 9.0.0036: 'fillchars' cannot have window-local values
Bram Moolenaar <Bram@vim.org>
parents:
29328
diff
changeset
|
3426 It is a comma-separated list of items. Each item has a name, a colon |
|
9dce192d1ac2
patch 9.0.0036: 'fillchars' cannot have window-local values
Bram Moolenaar <Bram@vim.org>
parents:
29328
diff
changeset
|
3427 and the value of that item: |
|
9dce192d1ac2
patch 9.0.0036: 'fillchars' cannot have window-local values
Bram Moolenaar <Bram@vim.org>
parents:
29328
diff
changeset
|
3428 |
|
9dce192d1ac2
patch 9.0.0036: 'fillchars' cannot have window-local values
Bram Moolenaar <Bram@vim.org>
parents:
29328
diff
changeset
|
3429 item name default Used for ~ |
|
9dce192d1ac2
patch 9.0.0036: 'fillchars' cannot have window-local values
Bram Moolenaar <Bram@vim.org>
parents:
29328
diff
changeset
|
3430 stl ' ' or '^' statusline of the current window |
|
9dce192d1ac2
patch 9.0.0036: 'fillchars' cannot have window-local values
Bram Moolenaar <Bram@vim.org>
parents:
29328
diff
changeset
|
3431 stlnc ' ' or '=' statusline of the non-current windows |
|
9dce192d1ac2
patch 9.0.0036: 'fillchars' cannot have window-local values
Bram Moolenaar <Bram@vim.org>
parents:
29328
diff
changeset
|
3432 vert '|' vertical separators |:vsplit| |
|
9dce192d1ac2
patch 9.0.0036: 'fillchars' cannot have window-local values
Bram Moolenaar <Bram@vim.org>
parents:
29328
diff
changeset
|
3433 fold '-' filling 'foldtext' |
|
9dce192d1ac2
patch 9.0.0036: 'fillchars' cannot have window-local values
Bram Moolenaar <Bram@vim.org>
parents:
29328
diff
changeset
|
3434 foldopen '-' mark the beginning of a fold |
|
9dce192d1ac2
patch 9.0.0036: 'fillchars' cannot have window-local values
Bram Moolenaar <Bram@vim.org>
parents:
29328
diff
changeset
|
3435 foldclose '+' show a closed fold |
|
9dce192d1ac2
patch 9.0.0036: 'fillchars' cannot have window-local values
Bram Moolenaar <Bram@vim.org>
parents:
29328
diff
changeset
|
3436 foldsep '|' open fold middle character |
|
9dce192d1ac2
patch 9.0.0036: 'fillchars' cannot have window-local values
Bram Moolenaar <Bram@vim.org>
parents:
29328
diff
changeset
|
3437 diff '-' deleted lines of the 'diff' option |
|
9dce192d1ac2
patch 9.0.0036: 'fillchars' cannot have window-local values
Bram Moolenaar <Bram@vim.org>
parents:
29328
diff
changeset
|
3438 eob '~' empty lines below the end of a buffer |
|
30643
dfb02f9dcbe8
patch 9.0.0656: cannot specify another character to use instead of '@'
Bram Moolenaar <Bram@vim.org>
parents:
30634
diff
changeset
|
3439 lastline '@' 'display' contains lastline/truncate |
| 7 | 3440 |
| 10 | 3441 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
|
3442 "stlnc" the space will be used when there is highlighting, '^' or '=' |
| 7 | 3443 otherwise. |
| 3444 | |
| 3445 Example: > | |
|
8061
abd64cf67bcf
commit https://github.com/vim/vim/commit/38a55639d603823efcf2d2fdf542dbffdeb60b75
Christian Brabandt <cb@256bit.org>
parents:
7876
diff
changeset
|
3446 :set fillchars=stl:^,stlnc:=,vert:\|,fold:-,diff:- |
| 7 | 3447 < This is similar to the default, except that these characters will also |
| 3448 be used when there is highlighting. | |
| 3449 | |
| 29269 | 3450 For the "stl", "stlnc", "foldopen", "foldclose" and "foldsep" items |
| 3451 single-byte and multibyte characters are supported. But double-width | |
| 3452 characters are not supported. | |
| 819 | 3453 |
| 7 | 3454 The highlighting used for these items: |
|
29387
9dce192d1ac2
patch 9.0.0036: 'fillchars' cannot have window-local values
Bram Moolenaar <Bram@vim.org>
parents:
29328
diff
changeset
|
3455 item name highlight group ~ |
|
9dce192d1ac2
patch 9.0.0036: 'fillchars' cannot have window-local values
Bram Moolenaar <Bram@vim.org>
parents:
29328
diff
changeset
|
3456 stl StatusLine |hl-StatusLine| |
|
9dce192d1ac2
patch 9.0.0036: 'fillchars' cannot have window-local values
Bram Moolenaar <Bram@vim.org>
parents:
29328
diff
changeset
|
3457 stlnc StatusLineNC |hl-StatusLineNC| |
|
9dce192d1ac2
patch 9.0.0036: 'fillchars' cannot have window-local values
Bram Moolenaar <Bram@vim.org>
parents:
29328
diff
changeset
|
3458 vert VertSplit |hl-VertSplit| |
|
9dce192d1ac2
patch 9.0.0036: 'fillchars' cannot have window-local values
Bram Moolenaar <Bram@vim.org>
parents:
29328
diff
changeset
|
3459 fold Folded |hl-Folded| |
|
9dce192d1ac2
patch 9.0.0036: 'fillchars' cannot have window-local values
Bram Moolenaar <Bram@vim.org>
parents:
29328
diff
changeset
|
3460 diff DiffDelete |hl-DiffDelete| |
|
9dce192d1ac2
patch 9.0.0036: 'fillchars' cannot have window-local values
Bram Moolenaar <Bram@vim.org>
parents:
29328
diff
changeset
|
3461 eob EndOfBuffer |hl-EndOfBuffer| |
|
30643
dfb02f9dcbe8
patch 9.0.0656: cannot specify another character to use instead of '@'
Bram Moolenaar <Bram@vim.org>
parents:
30634
diff
changeset
|
3462 lastline NonText |hl-NonText| |
| 7 | 3463 |
| 6933 | 3464 *'fixendofline'* *'fixeol'* *'nofixendofline'* *'nofixeol'* |
| 3465 'fixendofline' 'fixeol' boolean (default on) | |
| 3466 local to buffer | |
| 3467 When writing a file and this option is on, <EOL> at the end of file | |
| 30962 | 3468 will be restored if missing. Turn this option off if you want to |
| 6933 | 3469 preserve the situation from the original file. |
| 3470 When the 'binary' option is set the value of this option doesn't | |
| 3471 matter. | |
| 3472 See the 'endofline' option. | |
|
30982
92b1338023ee
patch 9.0.0826: if 'endofline' is set CTRL-Z may be written in a wrong place
Bram Moolenaar <Bram@vim.org>
parents:
30967
diff
changeset
|
3473 See |eol-and-eof| for example settings. |
| 6933 | 3474 |
| 7 | 3475 *'fkmap'* *'fk'* *'nofkmap'* *'nofk'* |
| 23666 | 3476 'fkmap' 'fk' boolean (default off) |
| 7 | 3477 global |
| 3478 {only available when compiled with the |+rightleft| | |
| 3479 feature} | |
|
15850
a6ca8cf07a98
patch 8.1.0932: Farsi support is outdated and unused
Bram Moolenaar <Bram@vim.org>
parents:
15840
diff
changeset
|
3480 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
|
3481 |farsi.txt|. |
| 7 | 3482 |
| 3483 *'foldclose'* *'fcl'* | |
| 3484 'foldclose' 'fcl' string (default "") | |
| 3485 global | |
| 3486 {not available when compiled without the |+folding| | |
| 3487 feature} | |
| 3488 When set to "all", a fold is closed when the cursor isn't in it and | |
| 3489 its level is higher than 'foldlevel'. Useful if you want folds to | |
| 3490 automatically close when moving out of them. | |
| 3491 | |
| 3492 *'foldcolumn'* *'fdc'* | |
| 3493 'foldcolumn' 'fdc' number (default 0) | |
| 3494 local to window | |
| 3495 {not available when compiled without the |+folding| | |
| 3496 feature} | |
| 3497 When non-zero, a column with the specified width is shown at the side | |
| 3498 of the window which indicates open and closed folds. The maximum | |
| 3499 value is 12. | |
| 3500 See |folding|. | |
| 3501 | |
| 3502 *'foldenable'* *'fen'* *'nofoldenable'* *'nofen'* | |
| 3503 'foldenable' 'fen' boolean (default on) | |
| 3504 local to window | |
| 3505 {not available when compiled without the |+folding| | |
| 3506 feature} | |
| 3507 When off, all folds are open. This option can be used to quickly | |
| 3508 switch between showing all text unfolded and viewing the text with | |
| 3509 folds (including manually opened or closed folds). It can be toggled | |
| 10 | 3510 with the |zi| command. The 'foldcolumn' will remain blank when |
| 7 | 3511 'foldenable' is off. |
| 3512 This option is set by commands that create a new fold or close a fold. | |
| 3513 See |folding|. | |
| 3514 | |
| 3515 *'foldexpr'* *'fde'* | |
| 3516 'foldexpr' 'fde' string (default: "0") | |
| 3517 local to window | |
| 3518 {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
|
3519 or |+eval| features} |
| 7 | 3520 The expression used for when 'foldmethod' is "expr". It is evaluated |
| 27321 | 3521 for each line to obtain its fold level. The context is set to the |
| 3522 script where 'foldexpr' was set, script-local items can be accessed. | |
| 3523 See |fold-expr| for the usage. | |
| 782 | 3524 |
| 3682 | 3525 The expression will be evaluated in the |sandbox| if set from a |
| 3526 modeline, see |sandbox-option|. | |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
3527 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
|
3528 on or the 'modelineexpr' option is off. |
| 634 | 3529 |
| 3530 It is not allowed to change text or jump to another window while | |
| 3531 evaluating 'foldexpr' |textlock|. | |
| 7 | 3532 |
| 3533 *'foldignore'* *'fdi'* | |
| 3534 'foldignore' 'fdi' string (default: "#") | |
| 3535 local to window | |
| 3536 {not available when compiled without the |+folding| | |
| 3537 feature} | |
| 3538 Used only when 'foldmethod' is "indent". Lines starting with | |
| 3539 characters in 'foldignore' will get their fold level from surrounding | |
| 10 | 3540 lines. White space is skipped before checking for this character. |
| 7 | 3541 The default "#" works well for C programs. See |fold-indent|. |
| 3542 | |
| 3543 *'foldlevel'* *'fdl'* | |
| 3544 'foldlevel' 'fdl' number (default: 0) | |
| 3545 local to window | |
| 3546 {not available when compiled without the |+folding| | |
| 3547 feature} | |
| 3548 Sets the fold level: Folds with a higher level will be closed. | |
| 3549 Setting this option to zero will close all folds. Higher numbers will | |
| 3550 close fewer folds. | |
| 3551 This option is set by commands like |zm|, |zM| and |zR|. | |
| 3552 See |fold-foldlevel|. | |
| 3553 | |
| 3554 *'foldlevelstart'* *'fdls'* | |
| 3555 'foldlevelstart' 'fdls' number (default: -1) | |
| 3556 global | |
| 3557 {not available when compiled without the |+folding| | |
| 3558 feature} | |
| 3559 Sets 'foldlevel' when starting to edit another buffer in a window. | |
| 3560 Useful to always start editing with all folds closed (value zero), | |
| 3561 some folds closed (one) or no folds closed (99). | |
| 3562 This is done before reading any modeline, thus a setting in a modeline | |
| 10 | 3563 overrules this option. Starting to edit a file for |diff-mode| also |
| 7 | 3564 ignores this option and closes all folds. |
| 3565 It is also done before BufReadPre autocommands, to allow an autocmd to | |
| 3566 overrule the 'foldlevel' value for specific files. | |
| 3567 When the value is negative, it is not used. | |
| 3568 | |
| 3569 *'foldmarker'* *'fmr'* *E536* | |
| 3570 'foldmarker' 'fmr' string (default: "{{{,}}}") | |
| 3571 local to window | |
| 3572 {not available when compiled without the |+folding| | |
| 3573 feature} | |
| 3574 The start and end marker used when 'foldmethod' is "marker". There | |
| 3575 must be one comma, which separates the start and end marker. The | |
| 3576 marker is a literal string (a regular expression would be too slow). | |
| 3577 See |fold-marker|. | |
| 3578 | |
| 3579 *'foldmethod'* *'fdm'* | |
| 3580 'foldmethod' 'fdm' string (default: "manual") | |
| 3581 local to window | |
| 3582 {not available when compiled without the |+folding| | |
| 3583 feature} | |
| 3584 The kind of folding used for the current window. Possible values: | |
| 3585 |fold-manual| manual Folds are created manually. | |
| 3586 |fold-indent| indent Lines with equal indent form a fold. | |
| 3587 |fold-expr| expr 'foldexpr' gives the fold level of a line. | |
| 3588 |fold-marker| marker Markers are used to specify folds. | |
| 3589 |fold-syntax| syntax Syntax highlighting items specify folds. | |
| 3590 |fold-diff| diff Fold text that is not changed. | |
| 3591 | |
| 3592 *'foldminlines'* *'fml'* | |
| 3593 'foldminlines' 'fml' number (default: 1) | |
| 3594 local to window | |
| 3595 {not available when compiled without the |+folding| | |
| 3596 feature} | |
| 2709 | 3597 Sets the number of screen lines above which a fold can be displayed |
| 3598 closed. Also for manually closed folds. With the default value of | |
| 3599 one a fold can only be closed if it takes up two or more screen lines. | |
| 3600 Set to zero to be able to close folds of just one screen line. | |
| 2826 | 3601 Note that this only has an effect on what is displayed. After using |
| 7 | 3602 "zc" to close a fold, which is displayed open because it's smaller |
| 3603 than 'foldminlines', a following "zc" may close a containing fold. | |
| 3604 | |
| 3605 *'foldnestmax'* *'fdn'* | |
| 3606 'foldnestmax' 'fdn' number (default: 20) | |
| 3607 local to window | |
| 3608 {not available when compiled without the |+folding| | |
| 3609 feature} | |
| 3610 Sets the maximum nesting of folds for the "indent" and "syntax" | |
| 3611 methods. This avoids that too many folds will be created. Using more | |
| 3612 than 20 doesn't work, because the internal limit is 20. | |
| 3613 | |
| 3614 *'foldopen'* *'fdo'* | |
| 3615 'foldopen' 'fdo' string (default: "block,hor,mark,percent,quickfix, | |
| 3616 search,tag,undo") | |
| 3617 global | |
| 3618 {not available when compiled without the |+folding| | |
| 3619 feature} | |
| 3620 Specifies for which type of commands folds will be opened, if the | |
| 28379 | 3621 command moves the cursor into a closed fold. It is a comma-separated |
| 7 | 3622 list of items. |
| 2625 | 3623 NOTE: When the command is part of a mapping this option is not used. |
| 3624 Add the |zv| command to the mapping to get the same effect. | |
| 3625 (rationale: the mapping may want to control opening folds itself) | |
| 3626 | |
| 7 | 3627 item commands ~ |
| 3628 all any | |
| 3629 block "(", "{", "[[", "[{", etc. | |
| 3630 hor horizontal movements: "l", "w", "fx", etc. | |
| 3631 insert any command in Insert mode | |
| 3632 jump far jumps: "G", "gg", etc. | |
| 3633 mark jumping to a mark: "'m", CTRL-O, etc. | |
| 3634 percent "%" | |
| 3635 quickfix ":cn", ":crew", ":make", etc. | |
| 3636 search search for a pattern: "/", "n", "*", "gd", etc. | |
| 3637 (not for a search pattern in a ":" command) | |
| 819 | 3638 Also for |[s| and |]s|. |
| 7 | 3639 tag jumping to a tag: ":ta", CTRL-T, etc. |
| 3640 undo undo or redo: "u" and CTRL-R | |
| 3641 When a movement command is used for an operator (e.g., "dl" or "y%") | |
| 3642 this option is not used. This means the operator will include the | |
| 3643 whole closed fold. | |
| 3644 Note that vertical movements are not here, because it would make it | |
| 3645 very difficult to move onto a closed fold. | |
| 3646 In insert mode the folds containing the cursor will always be open | |
| 3647 when text is inserted. | |
| 3648 To close folds you can re-apply 'foldlevel' with the |zx| command or | |
| 3649 set the 'foldclose' option to "all". | |
| 3650 | |
| 3651 *'foldtext'* *'fdt'* | |
| 3652 'foldtext' 'fdt' string (default: "foldtext()") | |
| 3653 local to window | |
| 3654 {not available when compiled without the |+folding| | |
| 3655 feature} | |
| 3656 An expression which is used to specify the text displayed for a closed | |
| 27321 | 3657 fold. The context is set to the script where 'foldexpr' was set, |
| 3658 script-local items can be accessed. See |fold-foldtext| for the | |
| 3659 usage. | |
| 7 | 3660 |
| 3682 | 3661 The expression will be evaluated in the |sandbox| if set from a |
| 3662 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
|
3663 This option cannot be set in a modeline when 'modelineexpr' is off. |
| 634 | 3664 |
| 3665 It is not allowed to change text or jump to another window while | |
| 3666 evaluating 'foldtext' |textlock|. | |
| 3667 | |
|
9286
64035abb986b
commit https://github.com/vim/vim/commit/c95a302a4c42ec8230473cd4a5e0064d0a143aa8
Christian Brabandt <cb@256bit.org>
parents:
9227
diff
changeset
|
3668 *'formatexpr'* *'fex'* |
|
64035abb986b
commit https://github.com/vim/vim/commit/c95a302a4c42ec8230473cd4a5e0064d0a143aa8
Christian Brabandt <cb@256bit.org>
parents:
9227
diff
changeset
|
3669 'formatexpr' 'fex' string (default "") |
|
64035abb986b
commit https://github.com/vim/vim/commit/c95a302a4c42ec8230473cd4a5e0064d0a143aa8
Christian Brabandt <cb@256bit.org>
parents:
9227
diff
changeset
|
3670 local to buffer |
|
64035abb986b
commit https://github.com/vim/vim/commit/c95a302a4c42ec8230473cd4a5e0064d0a143aa8
Christian Brabandt <cb@256bit.org>
parents:
9227
diff
changeset
|
3671 {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
|
3672 feature} |
|
64035abb986b
commit https://github.com/vim/vim/commit/c95a302a4c42ec8230473cd4a5e0064d0a143aa8
Christian Brabandt <cb@256bit.org>
parents:
9227
diff
changeset
|
3673 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
|
3674 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
|
3675 option is empty 'formatprg' is used. |
|
64035abb986b
commit https://github.com/vim/vim/commit/c95a302a4c42ec8230473cd4a5e0064d0a143aa8
Christian Brabandt <cb@256bit.org>
parents:
9227
diff
changeset
|
3676 |
|
64035abb986b
commit https://github.com/vim/vim/commit/c95a302a4c42ec8230473cd4a5e0064d0a143aa8
Christian Brabandt <cb@256bit.org>
parents:
9227
diff
changeset
|
3677 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
|
3678 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
|
3679 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
|
3680 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
|
3681 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
|
3682 it yet! |
|
64035abb986b
commit https://github.com/vim/vim/commit/c95a302a4c42ec8230473cd4a5e0064d0a143aa8
Christian Brabandt <cb@256bit.org>
parents:
9227
diff
changeset
|
3683 |
|
64035abb986b
commit https://github.com/vim/vim/commit/c95a302a4c42ec8230473cd4a5e0064d0a143aa8
Christian Brabandt <cb@256bit.org>
parents:
9227
diff
changeset
|
3684 Example: > |
|
64035abb986b
commit https://github.com/vim/vim/commit/c95a302a4c42ec8230473cd4a5e0064d0a143aa8
Christian Brabandt <cb@256bit.org>
parents:
9227
diff
changeset
|
3685 :set formatexpr=mylang#Format() |
|
64035abb986b
commit https://github.com/vim/vim/commit/c95a302a4c42ec8230473cd4a5e0064d0a143aa8
Christian Brabandt <cb@256bit.org>
parents:
9227
diff
changeset
|
3686 < 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
|
3687 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
|
3688 |
|
30598
37aa9fd2ed72
patch 9.0.0634: evaluating "expr" options has more overhead than needed
Bram Moolenaar <Bram@vim.org>
parents:
30547
diff
changeset
|
3689 The advantage of using a function call without arguments is that it is |
|
37aa9fd2ed72
patch 9.0.0634: evaluating "expr" options has more overhead than needed
Bram Moolenaar <Bram@vim.org>
parents:
30547
diff
changeset
|
3690 faster, see |expr-option-function|. |
|
37aa9fd2ed72
patch 9.0.0634: evaluating "expr" options has more overhead than needed
Bram Moolenaar <Bram@vim.org>
parents:
30547
diff
changeset
|
3691 |
|
9286
64035abb986b
commit https://github.com/vim/vim/commit/c95a302a4c42ec8230473cd4a5e0064d0a143aa8
Christian Brabandt <cb@256bit.org>
parents:
9227
diff
changeset
|
3692 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
|
3693 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
|
3694 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
|
3695 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
|
3696 return "i" or "R" in this situation. |
|
13341
acd7eaa13d2b
Updated runtime files.
Christian Brabandt <cb@256bit.org>
parents:
13314
diff
changeset
|
3697 |
|
9286
64035abb986b
commit https://github.com/vim/vim/commit/c95a302a4c42ec8230473cd4a5e0064d0a143aa8
Christian Brabandt <cb@256bit.org>
parents:
9227
diff
changeset
|
3698 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
|
3699 the internal format mechanism. |
|
64035abb986b
commit https://github.com/vim/vim/commit/c95a302a4c42ec8230473cd4a5e0064d0a143aa8
Christian Brabandt <cb@256bit.org>
parents:
9227
diff
changeset
|
3700 |
|
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
|
3701 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
|
3702 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
|
3703 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
|
3704 set formatexpr=<SID>SomeFormatExpr() |
| 27321 | 3705 < Otherwise, the expression is evaluated in the context of the script |
| 3706 where the option was set, thus script-local items are available. | |
| 3707 | |
|
9286
64035abb986b
commit https://github.com/vim/vim/commit/c95a302a4c42ec8230473cd4a5e0064d0a143aa8
Christian Brabandt <cb@256bit.org>
parents:
9227
diff
changeset
|
3708 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
|
3709 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
|
3710 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
|
3711 This option cannot be set in a modeline when 'modelineexpr' is off. |
| 11160 | 3712 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
|
3713 |
| 41 | 3714 *'formatlistpat'* *'flp'* |
| 3715 'formatlistpat' 'flp' string (default: "^\s*\d\+[\]:.)}\t ]\s*") | |
| 3716 local to buffer | |
| 3717 A pattern that is used to recognize a list header. This is used for | |
| 3718 the "n" flag in 'formatoptions'. | |
| 3719 The pattern must match exactly the text that will be the indent for | |
| 140 | 3720 the line below it. You can use |/\ze| to mark the end of the match |
| 41 | 3721 while still checking more characters. There must be a character |
| 3722 following the pattern, when it matches the whole line it is handled | |
| 3723 like there is no match. | |
| 3724 The default recognizes a number, followed by an optional punctuation | |
| 3725 character and white space. | |
| 3726 | |
|
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
|
3727 *'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
|
3728 '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
|
3729 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
|
3730 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
|
3731 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
|
3732 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
|
3733 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
|
3734 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
|
3735 "+=" 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
|
3736 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
|
3737 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
|
3738 |
| 7 | 3739 *'formatprg'* *'fp'* |
| 3740 '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
|
3741 global or local to buffer |global-local| |
| 7 | 3742 The name of an external program that will be used to format the lines |
| 667 | 3743 selected with the |gq| operator. The program must take the input on |
| 7 | 3744 stdin and produce the output on stdout. The Unix program "fmt" is |
| 557 | 3745 such a program. |
| 667 | 3746 If the 'formatexpr' option is not empty it will be used instead. |
| 3747 Otherwise, if 'formatprg' option is an empty string, the internal | |
| 3748 format function will be used |C-indenting|. | |
| 557 | 3749 Environment variables are expanded |:set_env|. See |option-backslash| |
| 3750 about including spaces and backslashes. | |
| 3682 | 3751 This option cannot be set from a |modeline| or in the |sandbox|, for |
| 3752 security reasons. | |
| 667 | 3753 |
|
7196
42717d048817
commit https://github.com/vim/vim/commit/d94464ee294a351ce7b6ba18e8bd3f24f1bef920
Christian Brabandt <cb@256bit.org>
parents:
7147
diff
changeset
|
3754 *'fsync'* *'fs'* *'nofsync'* *'nofs'* |
| 36 | 3755 'fsync' 'fs' boolean (default on) |
| 3756 global | |
| 3757 When on, the library function fsync() will be called after writing a | |
| 3758 file. This will flush a file to disk, ensuring that it is safely | |
| 3759 written even on filesystems which do metadata-only journaling. This | |
| 3760 will force the harddrive to spin up on Linux systems running in laptop | |
| 3761 mode, so it may be undesirable in some situations. Be warned that | |
| 3762 turning this off increases the chances of data loss after a crash. On | |
| 3763 systems without an fsync() implementation, this variable is always | |
| 3764 off. | |
| 3765 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
|
3766 '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
|
3767 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
|
3768 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
|
3769 security reasons. |
| 36 | 3770 |
| 7 | 3771 *'gdefault'* *'gd'* *'nogdefault'* *'nogd'* |
| 3772 'gdefault' 'gd' boolean (default off) | |
| 3773 global | |
| 3774 When on, the ":substitute" flag 'g' is default on. This means that | |
| 3775 all matches in a line are substituted instead of one. When a 'g' flag | |
| 3776 is given to a ":substitute" command, this will toggle the substitution | |
| 3777 of all or one match. See |complex-change|. | |
| 3778 | |
| 3779 command 'gdefault' on 'gdefault' off ~ | |
| 3780 :s/// subst. all subst. one | |
| 3781 :s///g subst. one subst. all | |
| 3782 :s///gg subst. all subst. one | |
| 3783 | |
| 3784 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
|
3785 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
|
3786 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
|
3787 has the opposite effect of that it normally does. |
| 23305 | 3788 This option is not used in |Vim9| script. |
| 7 | 3789 |
| 3790 *'grepformat'* *'gfm'* | |
| 6213 | 3791 'grepformat' 'gfm' string (default "%f:%l:%m,%f:%l%m,%f %l%m") |
| 7 | 3792 global |
| 3793 Format to recognize for the ":grep" command output. | |
| 3794 This is a scanf-like string that uses the same format as the | |
| 3795 'errorformat' option: see |errorformat|. | |
| 3796 | |
| 3797 *'grepprg'* *'gp'* | |
| 3798 'grepprg' 'gp' string (default "grep -n ", | |
| 3799 Unix: "grep -n $* /dev/null", | |
| 3800 Win32: "findstr /n" or "grep -n", | |
| 3801 VMS: "SEARCH/NUMBERS ") | |
| 3802 global or local to buffer |global-local| | |
| 233 | 3803 Program to use for the |:grep| command. This option may contain '%' |
| 7 | 3804 and '#' characters, which are expanded like when used in a command- |
| 3805 line. The placeholder "$*" is allowed to specify where the arguments | |
| 3806 will be included. Environment variables are expanded |:set_env|. See | |
| 3807 |option-backslash| about including spaces and backslashes. | |
| 3808 When your "grep" accepts the "-H" argument, use this to make ":grep" | |
| 3809 also work well with a single file: > | |
| 3810 :set grepprg=grep\ -nH | |
| 161 | 3811 < Special value: When 'grepprg' is set to "internal" the |:grep| command |
| 657 | 3812 works like |:vimgrep|, |:lgrep| like |:lvimgrep|, |:grepadd| like |
| 3813 |:vimgrepadd| and |:lgrepadd| like |:lvimgrepadd|. | |
| 41 | 3814 See also the section |:make_makeprg|, since most of the comments there |
| 7 | 3815 apply equally to 'grepprg'. |
| 3816 For Win32, the default is "findstr /n" if "findstr.exe" can be found, | |
| 3817 otherwise it's "grep -n". | |
| 3818 This option cannot be set from a |modeline| or in the |sandbox|, for | |
| 3819 security reasons. | |
| 3820 | |
| 3821 *'guicursor'* *'gcr'* *E545* *E546* *E548* *E549* | |
| 3822 'guicursor' 'gcr' string (default "n-v-c:block-Cursor/lCursor, | |
| 3823 ve:ver35-Cursor, | |
| 3824 o:hor50-Cursor, | |
| 3825 i-ci:ver25-Cursor/lCursor, | |
| 3826 r-cr:hor20-Cursor/lCursor, | |
| 3827 sm:block-Cursor | |
| 3828 -blinkwait175-blinkoff150-blinkon175", | |
| 18972 | 3829 for Win32 console: |
| 7 | 3830 "n-v-c:block,o:hor50,i-ci:hor15, |
| 3831 r-cr:hor30,sm:block") | |
| 3832 global | |
| 3833 {only available when compiled with GUI enabled, and | |
| 18972 | 3834 for Win32 console} |
| 7 | 3835 This option tells Vim what the cursor should look like in different |
| 19116 | 3836 modes. It fully works in the GUI. In a Win32 console, only the |
| 18972 | 3837 height of the cursor can be changed. This can be done by specifying a |
| 3838 block cursor, or a percentage for a vertical or horizontal cursor. | |
| 6727 | 3839 For a console the 't_SI', 't_SR', and 't_EI' escape sequences are |
| 3840 used. | |
| 7 | 3841 |
| 28379 | 3842 The option is a comma-separated list of parts. Each part consist of a |
| 7 | 3843 mode-list and an argument-list: |
| 3844 mode-list:argument-list,mode-list:argument-list,.. | |
| 3845 The mode-list is a dash separated list of these modes: | |
| 3846 n Normal mode | |
| 3847 v Visual mode | |
| 3848 ve Visual mode with 'selection' "exclusive" (same as 'v', | |
| 3849 if not specified) | |
| 3850 o Operator-pending mode | |
| 3851 i Insert mode | |
| 3852 r Replace mode | |
| 3853 c Command-line Normal (append) mode | |
| 3854 ci Command-line Insert mode | |
| 3855 cr Command-line Replace mode | |
| 3856 sm showmatch in Insert mode | |
| 3857 a all modes | |
| 3858 The argument-list is a dash separated list of these arguments: | |
| 3859 hor{N} horizontal bar, {N} percent of the character height | |
| 3860 ver{N} vertical bar, {N} percent of the character width | |
| 3861 block block cursor, fills the whole character | |
| 3862 [only one of the above three should be present] | |
| 3863 blinkwait{N} *cursor-blinking* | |
| 3864 blinkon{N} | |
| 3865 blinkoff{N} | |
| 3866 blink times for cursor: blinkwait is the delay before | |
| 3867 the cursor starts blinking, blinkon is the time that | |
| 3868 the cursor is shown and blinkoff is the time that the | |
| 3869 cursor is not shown. The times are in msec. When one | |
| 3870 of the numbers is zero, there is no blinking. The | |
| 3871 default is: "blinkwait700-blinkon400-blinkoff250". | |
| 3872 These numbers are used for a missing entry. This | |
| 3873 means that blinking is enabled by default. To switch | |
| 3874 blinking off you can use "blinkon0". The cursor only | |
| 3875 blinks when Vim is waiting for input, not while | |
| 3876 executing a command. | |
| 3877 To make the cursor blink in an xterm, see | |
| 3878 |xterm-blink|. | |
| 3879 {group-name} | |
| 3880 a highlight group name, that sets the color and font | |
| 3881 for the cursor | |
| 3882 {group-name}/{group-name} | |
| 3883 Two highlight group names, the first is used when | |
| 3884 no language mappings are used, the other when they | |
| 3885 are. |language-mapping| | |
| 3886 | |
| 3887 Examples of parts: | |
| 3888 n-c-v:block-nCursor in Normal, Command-line and Visual mode, use a | |
| 3889 block cursor with colors from the "nCursor" | |
| 3890 highlight group | |
| 3891 i-ci:ver30-iCursor-blinkwait300-blinkon200-blinkoff150 | |
| 3892 In Insert and Command-line Insert mode, use a | |
| 3893 30% vertical bar cursor with colors from the | |
| 3894 "iCursor" highlight group. Blink a bit | |
| 3895 faster. | |
| 3896 | |
| 3897 The 'a' mode is different. It will set the given argument-list for | |
| 3898 all modes. It does not reset anything to defaults. This can be used | |
| 3899 to do a common setting for all modes. For example, to switch off | |
| 3900 blinking: "a:blinkon0" | |
| 3901 | |
| 3902 Examples of cursor highlighting: > | |
| 3903 :highlight Cursor gui=reverse guifg=NONE guibg=NONE | |
| 3904 :highlight Cursor gui=NONE guifg=bg guibg=fg | |
| 3905 < | |
| 3906 *'guifont'* *'gfn'* | |
| 2908 | 3907 *E235* *E596* |
| 7 | 3908 'guifont' 'gfn' string (default "") |
| 3909 global | |
| 3910 {only available when compiled with GUI enabled} | |
| 3911 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
|
3912 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
|
3913 See |gui-font| for the details. |
| 7 | 3914 |
| 3915 *'guifontset'* *'gfs'* | |
| 3916 *E250* *E252* *E234* *E597* *E598* | |
| 3917 'guifontset' 'gfs' string (default "") | |
| 3918 global | |
| 3919 {only available when compiled with GUI enabled and | |
| 3920 with the |+xfontset| feature} | |
|
10895
c391bfbdb452
Updated runtime files.
Christian Brabandt <cb@256bit.org>
parents:
10734
diff
changeset
|
3921 {not available in the GTK+ GUI} |
| 7 | 3922 When not empty, specifies two (or more) fonts to be used. The first |
| 3923 one for normal English, the second one for your special language. See | |
| 3924 |xfontset|. | |
|
16439
9d20e26dc13c
patch 8.1.1224: MS-Windows: cannot specify font weight
Bram Moolenaar <Bram@vim.org>
parents:
16427
diff
changeset
|
3925 |
| 7 | 3926 *'guifontwide'* *'gfw'* *E231* *E533* *E534* |
| 3927 'guifontwide' 'gfw' string (default "") | |
| 3928 global | |
| 3929 {only available when compiled with GUI enabled} | |
| 3930 When not empty, specifies a comma-separated list of fonts to be used | |
| 3931 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
|
3932 used. See |gui-fontwide|. |
| 4055 | 3933 |
| 7 | 3934 *'guiheadroom'* *'ghr'* |
| 3935 'guiheadroom' 'ghr' number (default 50) | |
| 3936 global | |
|
16728
e55c26aaf484
patch 8.1.1366: using expressions in a modeline is unsafe
Bram Moolenaar <Bram@vim.org>
parents:
16610
diff
changeset
|
3937 {only for GTK and X11 GUI} |
| 7 | 3938 The number of pixels subtracted from the screen height when fitting |
| 3939 the GUI window on the screen. Set this before the GUI is started, | |
| 3940 e.g., in your |gvimrc| file. When zero, the whole screen height will | |
| 10 | 3941 be used by the window. When positive, the specified number of pixel |
| 7 | 3942 lines will be left for window decorations and other items on the |
| 3943 screen. Set it to a negative value to allow windows taller than the | |
| 3944 screen. | |
| 3945 | |
|
25982
aade8ef975d5
patch 8.2.3524: GUI: ligatures are not used
Bram Moolenaar <Bram@vim.org>
parents:
25978
diff
changeset
|
3946 *'guiligatures'* *'gli'* *E1243* |
|
aade8ef975d5
patch 8.2.3524: GUI: ligatures are not used
Bram Moolenaar <Bram@vim.org>
parents:
25978
diff
changeset
|
3947 'guiligatures' 'gli' string (default "") |
|
aade8ef975d5
patch 8.2.3524: GUI: ligatures are not used
Bram Moolenaar <Bram@vim.org>
parents:
25978
diff
changeset
|
3948 global |
|
aade8ef975d5
patch 8.2.3524: GUI: ligatures are not used
Bram Moolenaar <Bram@vim.org>
parents:
25978
diff
changeset
|
3949 {only for GTK GUI} |
|
aade8ef975d5
patch 8.2.3524: GUI: ligatures are not used
Bram Moolenaar <Bram@vim.org>
parents:
25978
diff
changeset
|
3950 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
|
3951 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
|
3952 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
|
3953 Example: > |
|
aade8ef975d5
patch 8.2.3524: GUI: ligatures are not used
Bram Moolenaar <Bram@vim.org>
parents:
25978
diff
changeset
|
3954 :set guiligatures=!\"#$%&()*+-./:<=>?@[]^_{\|~ |
|
aade8ef975d5
patch 8.2.3524: GUI: ligatures are not used
Bram Moolenaar <Bram@vim.org>
parents:
25978
diff
changeset
|
3955 < 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
|
3956 empty string to disable ligatures. |
|
aade8ef975d5
patch 8.2.3524: GUI: ligatures are not used
Bram Moolenaar <Bram@vim.org>
parents:
25978
diff
changeset
|
3957 |
| 7 | 3958 *'guioptions'* *'go'* |
| 14945 | 3959 'guioptions' 'go' string (default "egmrLtT" (MS-Windows, |
| 3960 "t" is removed in |defaults.vim|), | |
| 28379 | 3961 "aegimrLtT" (GTK and Motif), |
|
9669
284b4eb307fc
commit https://github.com/vim/vim/commit/8c08b5b569e2a9e9f63dea514591ecfa2d3bb392
Christian Brabandt <cb@256bit.org>
parents:
9665
diff
changeset
|
3962 ) |
| 7 | 3963 global |
| 3964 {only available when compiled with GUI enabled} | |
| 8 | 3965 This option only has an effect in the GUI version of Vim. It is a |
| 7 | 3966 sequence of letters which describes what components and options of the |
| 3967 GUI should be used. | |
| 3968 To avoid problems with flags that are added in the future, use the | |
| 3969 "+=" and "-=" feature of ":set" |add-option-flags|. | |
| 3970 | |
|
13470
6faef782f50b
patch 8.0.1609: shell commands in the GUI use a dumb terminal
Christian Brabandt <cb@256bit.org>
parents:
13437
diff
changeset
|
3971 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
|
3972 *'go-!'* |
|
6faef782f50b
patch 8.0.1609: shell commands in the GUI use a dumb terminal
Christian Brabandt <cb@256bit.org>
parents:
13437
diff
changeset
|
3973 '!' 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
|
3974 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
|
3975 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
|
3976 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
|
3977 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
|
3978 upwards as needed. |
| 14999 | 3979 *'go-a'* |
| 7 | 3980 'a' Autoselect: If present, then whenever VISUAL mode is started, |
| 3981 or the Visual area extended, Vim tries to become the owner of | |
| 3982 the windowing system's global selection. This means that the | |
| 3983 Visually highlighted text is available for pasting into other | |
| 3984 applications as well as into Vim itself. When the Visual mode | |
| 3985 ends, possibly due to an operation on the text, or when an | |
| 3986 application wants to paste the selection, the highlighted text | |
| 3987 is automatically yanked into the "* selection register. | |
| 3988 Thus the selection is still available for pasting into other | |
| 3989 applications after the VISUAL mode has ended. | |
| 3990 If not present, then Vim won't become the owner of the | |
| 3991 windowing system's global selection unless explicitly told to | |
| 3992 by a yank or delete operation for the "* register. | |
| 3993 The same applies to the modeless selection. | |
| 3674 | 3994 *'go-P'* |
| 3995 '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
|
3996 register. |
| 1152 | 3997 *'go-A'* |
| 10 | 3998 'A' Autoselect for the modeless selection. Like 'a', but only |
| 7 | 3999 applies to the modeless selection. |
| 4000 | |
| 4001 'guioptions' autoselect Visual autoselect modeless ~ | |
| 4002 "" - - | |
| 4003 "a" yes yes | |
| 4004 "A" - yes | |
| 4005 "aA" yes yes | |
| 4006 | |
| 30547 | 4007 When using a terminal see the 'clipboard' option. |
| 4008 | |
| 1152 | 4009 *'go-c'* |
| 7 | 4010 'c' Use console dialogs instead of popup dialogs for simple |
| 4011 choices. | |
|
18078
5ae41d0ea397
patch 8.1.2034: dark them of GTK 3 not supported
Bram Moolenaar <Bram@vim.org>
parents:
18068
diff
changeset
|
4012 *'go-d'* |
|
5ae41d0ea397
patch 8.1.2034: dark them of GTK 3 not supported
Bram Moolenaar <Bram@vim.org>
parents:
18068
diff
changeset
|
4013 '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
|
4014 GTK+ GUI. |
| 1152 | 4015 *'go-e'* |
| 697 | 4016 'e' Add tab pages when indicated with 'showtabline'. |
| 688 | 4017 'guitablabel' can be used to change the text in the labels. |
| 4018 When 'e' is missing a non-GUI tab pages line may be used. | |
| 857 | 4019 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
|
4020 GTK, Motif, Mac OS/X, Haiku, and MS-Windows. |
| 1152 | 4021 *'go-f'* |
| 7 | 4022 'f' Foreground: Don't use fork() to detach the GUI from the shell |
| 4023 where it was started. Use this for programs that wait for the | |
| 4024 editor to finish (e.g., an e-mail program). Alternatively you | |
| 4025 can use "gvim -f" or ":gui -f" to start the GUI in the | |
| 4026 foreground. |gui-fork| | |
| 4027 Note: Set this option in the vimrc file. The forking may have | |
| 819 | 4028 happened already when the |gvimrc| file is read. |
| 1152 | 4029 *'go-i'* |
| 7 | 4030 'i' Use a Vim icon. For GTK with KDE it is used in the left-upper |
| 4031 corner of the window. It's black&white on non-GTK, because of | |
| 4032 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
|
4033 *'go-m'* |
| 7 | 4034 'm' Menu bar is present. |
|
2290
22529abcd646
Fixed ":s" message. Docs updates.
Bram Moolenaar <bram@vim.org>
parents:
2283
diff
changeset
|
4035 *'go-M'* |
| 10 | 4036 'M' The system menu "$VIMRUNTIME/menu.vim" is not sourced. Note |
| 7 | 4037 that this flag must be added in the .vimrc file, before |
| 819 | 4038 switching on syntax or filetype recognition (when the |gvimrc| |
| 7 | 4039 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
|
4040 `: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
|
4041 *'go-g'* |
| 7 | 4042 'g' Grey menu items: Make menu items that are not active grey. If |
| 4043 'g' is not included inactive menu items are not shown at all. | |
| 1152 | 4044 *'go-t'* |
| 7 | 4045 't' Include tearoff menu items. Currently only works for Win32, |
| 4046 GTK+, and Motif 1.2 GUI. | |
| 1152 | 4047 *'go-T'* |
| 28379 | 4048 'T' Include Toolbar. Currently only in Win32, GTK+, Motif and |
| 4049 Photon GUIs. | |
| 1152 | 4050 *'go-r'* |
| 7 | 4051 'r' Right-hand scrollbar is always present. |
|
2290
22529abcd646
Fixed ":s" message. Docs updates.
Bram Moolenaar <bram@vim.org>
parents:
2283
diff
changeset
|
4052 *'go-R'* |
| 7 | 4053 'R' Right-hand scrollbar is present when there is a vertically |
| 4054 split window. | |
|
2290
22529abcd646
Fixed ":s" message. Docs updates.
Bram Moolenaar <bram@vim.org>
parents:
2283
diff
changeset
|
4055 *'go-l'* |
| 7 | 4056 'l' Left-hand scrollbar is always present. |
|
2290
22529abcd646
Fixed ":s" message. Docs updates.
Bram Moolenaar <bram@vim.org>
parents:
2283
diff
changeset
|
4057 *'go-L'* |
| 7 | 4058 'L' Left-hand scrollbar is present when there is a vertically |
| 4059 split window. | |
| 1152 | 4060 *'go-b'* |
| 7 | 4061 'b' Bottom (horizontal) scrollbar is present. Its size depends on |
| 4062 the longest visible line, or on the cursor line if the 'h' | |
| 4063 flag is included. |gui-horiz-scroll| | |
|
2290
22529abcd646
Fixed ":s" message. Docs updates.
Bram Moolenaar <bram@vim.org>
parents:
2283
diff
changeset
|
4064 *'go-h'* |
| 7 | 4065 'h' Limit horizontal scrollbar size to the length of the cursor |
| 4066 line. Reduces computations. |gui-horiz-scroll| | |
| 4067 | |
| 4068 And yes, you may even have scrollbars on the left AND the right if | |
| 4069 you really want to :-). See |gui-scrollbars| for more information. | |
| 4070 | |
|
2290
22529abcd646
Fixed ":s" message. Docs updates.
Bram Moolenaar <bram@vim.org>
parents:
2283
diff
changeset
|
4071 *'go-v'* |
| 7 | 4072 'v' Use a vertical button layout for dialogs. When not included, |
| 4073 a horizontal layout is preferred, but when it doesn't fit a | |
| 24278 | 4074 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
|
4075 *'go-p'* |
| 7 | 4076 'p' Use Pointer callbacks for X11 GUI. This is required for some |
| 4077 window managers. If the cursor is not blinking or hollow at | |
| 4078 the right moment, try adding this flag. This must be done | |
| 819 | 4079 before starting the GUI. Set it in your |gvimrc|. Adding or |
| 7 | 4080 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
|
4081 *'go-F'* |
| 10 | 4082 '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
|
4083 *'go-k'* |
|
29a728529f92
patch 8.0.1278: GUI window always resizes when adding scrollbar
Christian Brabandt <cb@256bit.org>
parents:
12785
diff
changeset
|
4084 '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
|
4085 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
|
4086 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
|
4087 '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
|
4088 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
|
4089 removing GUI components. |
| 1152 | 4090 |
| 7 | 4091 *'guipty'* *'noguipty'* |
| 4092 'guipty' boolean (default on) | |
| 4093 global | |
| 4094 {only available when compiled with GUI enabled} | |
| 4095 Only in the GUI: If on, an attempt is made to open a pseudo-tty for | |
| 4096 I/O to/from shell commands. See |gui-pty|. | |
| 4097 | |
| 688 | 4098 *'guitablabel'* *'gtl'* |
| 4099 'guitablabel' 'gtl' string (default empty) | |
| 4100 global | |
|
17771
4bd21046902b
patch 8.1.1882: cannot specify properties of the info popup window
Bram Moolenaar <Bram@vim.org>
parents:
17767
diff
changeset
|
4101 {only available when compiled with GUI enabled} |
| 27804 | 4102 When non-empty describes the text to use in a label of the GUI tab |
| 857 | 4103 pages line. When empty and when the result is empty Vim will use a |
| 4104 default label. See |setting-guitablabel| for more info. | |
| 688 | 4105 |
| 692 | 4106 The format of this option is like that of 'statusline'. |
| 839 | 4107 '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
|
4108 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
|
4109 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
|
4110 This option cannot be set in a modeline when 'modelineexpr' is off. |
| 692 | 4111 |
| 688 | 4112 Only used when the GUI tab pages line is displayed. 'e' must be |
| 4113 present in 'guioptions'. For the non-GUI tab pages line 'tabline' is | |
| 4114 used. | |
| 4115 | |
| 839 | 4116 *'guitabtooltip'* *'gtt'* |
| 4117 'guitabtooltip' 'gtt' string (default empty) | |
| 4118 global | |
|
17771
4bd21046902b
patch 8.1.1882: cannot specify properties of the info popup window
Bram Moolenaar <Bram@vim.org>
parents:
17767
diff
changeset
|
4119 {only available when compiled with GUI enabled} |
| 27804 | 4120 When non-empty describes the text to use in a tooltip for the GUI tab |
| 839 | 4121 pages line. When empty Vim will use a default tooltip. |
| 4122 This option is otherwise just like 'guitablabel' above. | |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
4123 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
|
4124 :let &guitabtooltip = "line one\nline two" |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
4125 < |
| 839 | 4126 |
| 7 | 4127 *'helpfile'* *'hf'* |
| 18972 | 4128 'helpfile' 'hf' string (default (MS-Windows) "$VIMRUNTIME\doc\help.txt" |
| 7 | 4129 (others) "$VIMRUNTIME/doc/help.txt") |
| 4130 global | |
| 4131 Name of the main help file. All distributed help files should be | |
| 4132 placed together in one directory. Additionally, all "doc" directories | |
| 4133 in 'runtimepath' will be used. | |
| 4134 Environment variables are expanded |:set_env|. For example: | |
| 4135 "$VIMRUNTIME/doc/help.txt". If $VIMRUNTIME is not set, $VIM is also | |
| 10 | 4136 tried. Also see |$VIMRUNTIME| and |option-backslash| about including |
| 7 | 4137 spaces and backslashes. |
| 4138 This option cannot be set from a |modeline| or in the |sandbox|, for | |
| 4139 security reasons. | |
| 4140 | |
| 4141 *'helpheight'* *'hh'* | |
| 4142 'helpheight' 'hh' number (default 20) | |
| 4143 global | |
| 4144 Minimal initial height of the help window when it is opened with the | |
| 4145 ":help" command. The initial height of the help window is half of the | |
| 4146 current window, or (when the 'ea' option is on) the same as other | |
| 4147 windows. When the height is less than 'helpheight', the height is | |
| 4148 set to 'helpheight'. Set to zero to disable. | |
| 4149 | |
| 4150 *'helplang'* *'hlg'* | |
| 4151 'helplang' 'hlg' string (default: messages language or empty) | |
| 4152 global | |
| 4153 {only available when compiled with the |+multi_lang| | |
| 4154 feature} | |
| 28379 | 4155 Comma-separated list of languages. Vim will use the first language |
| 7 | 4156 for which the desired help can be found. The English help will always |
| 4157 be used as a last resort. You can add "en" to prefer English over | |
| 4158 another language, but that will only find tags that exist in that | |
| 4159 language and not in the English help. | |
| 4160 Example: > | |
| 4161 :set helplang=de,it | |
| 4162 < This will first search German, then Italian and finally English help | |
| 4163 files. | |
| 4164 When using |CTRL-]| and ":help!" in a non-English help file Vim will | |
| 4165 try to find the tag in the current language before using this option. | |
| 4166 See |help-translated|. | |
| 4167 | |
| 4168 *'hidden'* *'hid'* *'nohidden'* *'nohid'* | |
| 4169 'hidden' 'hid' boolean (default off) | |
| 4170 global | |
| 4171 When off a buffer is unloaded when it is |abandon|ed. When on a | |
| 4172 buffer becomes hidden when it is |abandon|ed. If the buffer is still | |
| 4173 displayed in another window, it does not become hidden, of course. | |
| 28379 | 4174 |
| 7 | 4175 The commands that move through the buffer list sometimes make a buffer |
| 28379 | 4176 hidden even if the 'hidden' option is off when these three are true: |
| 4177 - the buffer is modified | |
| 4178 - 'autowrite' is off or writing is not possible | |
| 4179 - the '!' flag was used | |
| 4180 Also see |windows.txt|. | |
| 4181 | |
| 12 | 4182 To only make one buffer hidden use the 'bufhidden' option. |
| 7 | 4183 This option is set for one command with ":hide {command}" |:hide|. |
| 4184 WARNING: It's easy to forget that you have changes in hidden buffers. | |
| 4185 Think twice when using ":q!" or ":qa!". | |
| 4186 | |
| 4187 *'highlight'* *'hl'* | |
| 4188 '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
|
4189 "8:SpecialKey,~:EndOfBuffer,@:NonText, |
|
7da89d9c744b
commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents:
9860
diff
changeset
|
4190 d:Directory,e:ErrorMsg,i:IncSearch, |
|
7da89d9c744b
commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents:
9860
diff
changeset
|
4191 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
|
4192 a:LineNrAbove,b:LineNrBelow, |
|
9877
7da89d9c744b
commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents:
9860
diff
changeset
|
4193 N:CursorLineNr,r:Question,s:StatusLine, |
|
7da89d9c744b
commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents:
9860
diff
changeset
|
4194 S:StatusLineNC,c:VertSplit,t:Title, |
| 15194 | 4195 v:Visual,V:VisualNOS,w:WarningMsg, |
| 4196 W:WildMenu,f:Folded,F:FoldColumn, | |
| 4197 A:DiffAdd,C:DiffChange,D:DiffDelete, | |
| 4198 T:DiffText,>:SignColumn,-:Conceal, | |
| 15281 | 4199 B:SpellBad,P:SpellCap,R:SpellRare, |
| 15194 | 4200 L:SpellLocal,+:Pmenu,=:PmenuSel, |
|
32132
059e89bf9316
patch 9.0.1397: highlight for popupmenu kind and extra cannot be set
Bram Moolenaar <Bram@vim.org>
parents:
32004
diff
changeset
|
4201 [:PmenuKind,]:PmenuKindSel, |
|
059e89bf9316
patch 9.0.1397: highlight for popupmenu kind and extra cannot be set
Bram Moolenaar <Bram@vim.org>
parents:
32004
diff
changeset
|
4202 {:PmenuExtra,}:PmenuExtraSel, |
|
11516
80491a71c716
patch 8.0.0641: cannot set a separate highlighting for the quickfix line
Christian Brabandt <cb@256bit.org>
parents:
11473
diff
changeset
|
4203 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
|
4204 #:TabLineSel,_:TabLineFill,!:CursorColumn, |
| 11914 | 4205 .:CursorLine,o:ColorColumn,q:QuickFixLine, |
| 12254 | 4206 z:StatusLineTerm,Z:StatusLineTermNC") |
| 7 | 4207 global |
| 4208 This option can be used to set highlighting mode for various | |
| 28379 | 4209 occasions. It is a comma-separated list of character pairs. The |
| 7 | 4210 first character in a pair gives the occasion, the second the mode to |
| 10 | 4211 use for that occasion. The occasions are: |
| 7 | 4212 |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
|
4213 |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
|
4214 |hl-NonText| @ '@' at the end of the window and |
| 7 | 4215 characters from 'showbreak' |
| 4216 |hl-Directory| d directories in CTRL-D listing and other special | |
| 4217 things in listings | |
| 4218 |hl-ErrorMsg| e error messages | |
| 4219 h (obsolete, ignored) | |
| 4220 |hl-IncSearch| i 'incsearch' highlighting | |
|
28399
d395fadbaf67
patch 8.2.4724: current instance of last search pattern not easily spotted
Bram Moolenaar <Bram@vim.org>
parents:
28379
diff
changeset
|
4221 |hl-CurSearch| y current instance of last search pattern |
| 7 | 4222 |hl-Search| l last search pattern highlighting (see 'hlsearch') |
| 4223 |hl-MoreMsg| m |more-prompt| | |
| 4224 |hl-ModeMsg| M Mode (e.g., "-- INSERT --") | |
|
2178
c6f1aa1e9f32
Add 'relativenumber' patch from Markus Heidelberg.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
4225 |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
|
4226 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
|
4227 |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
|
4228 '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
|
4229 |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
|
4230 'relativenumber' option is set. |
| 4073 | 4231 |hl-CursorLineNr| N like n for when 'cursorline' or 'relativenumber' is |
| 4232 set. | |
| 7 | 4233 |hl-Question| r |hit-enter| prompt and yes/no questions |
| 4234 |hl-StatusLine| s status line of current window |status-line| | |
| 12785 | 4235 |hl-StatusLineNC| S status lines of not-current windows |
| 7 | 4236 |hl-Title| t Titles for output from ":set all", ":autocmd" etc. |
| 4237 |hl-VertSplit| c column used to separate vertically split windows | |
| 4238 |hl-Visual| v Visual mode | |
| 4239 |hl-VisualNOS| V Visual mode when Vim does is "Not Owning the | |
| 4240 Selection" Only X11 Gui's |gui-x11| and | |
| 4241 |xterm-clipboard|. | |
| 4242 |hl-WarningMsg| w warning messages | |
| 4243 |hl-WildMenu| W wildcard matches displayed for 'wildmenu' | |
| 4244 |hl-Folded| f line used for closed folds | |
| 4245 |hl-FoldColumn| F 'foldcolumn' | |
| 386 | 4246 |hl-DiffAdd| A added line in diff mode |
| 4247 |hl-DiffChange| C changed line in diff mode | |
| 4248 |hl-DiffDelete| D deleted line in diff mode | |
| 4249 |hl-DiffText| T inserted text in diff mode | |
| 7 | 4250 |hl-SignColumn| > column used for |signs| |
| 15194 | 4251 |hl-Conceal| - the placeholders used for concealed characters |
| 4252 (see 'conceallevel') | |
| 221 | 4253 |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
|
4254 |hl-SpellCap| P word that should start with capital |spell| |
| 221 | 4255 |hl-SpellRare| R rare word |spell| |
| 4256 |hl-SpellLocal| L word from other region |spell| | |
| 15194 | 4257 |hl-Pmenu| + popup menu normal line |
| 4258 |hl-PmenuSel| = popup menu selected line | |
|
32132
059e89bf9316
patch 9.0.1397: highlight for popupmenu kind and extra cannot be set
Bram Moolenaar <Bram@vim.org>
parents:
32004
diff
changeset
|
4259 |hl-PmenuKind| [ popup menu "kind" normal line |
|
059e89bf9316
patch 9.0.1397: highlight for popupmenu kind and extra cannot be set
Bram Moolenaar <Bram@vim.org>
parents:
32004
diff
changeset
|
4260 |hl-PmenuKindSel| ] popup menu "kind" selected line |
|
059e89bf9316
patch 9.0.1397: highlight for popupmenu kind and extra cannot be set
Bram Moolenaar <Bram@vim.org>
parents:
32004
diff
changeset
|
4261 |hl-PmenuExtra| { popup menu "kind" normal line |
|
059e89bf9316
patch 9.0.1397: highlight for popupmenu kind and extra cannot be set
Bram Moolenaar <Bram@vim.org>
parents:
32004
diff
changeset
|
4262 |hl-PmenuExtraSel| } popup menu "kind" selected line |
| 15194 | 4263 |hl-PmenuSbar| x popup menu scrollbar |
| 4264 |hl-PmenuThumb| X popup menu scrollbar thumb | |
| 7 | 4265 |
| 4266 The display modes are: | |
| 4267 r reverse (termcap entry "mr" and "me") | |
| 4268 i italic (termcap entry "ZH" and "ZR") | |
| 4269 b bold (termcap entry "md" and "me") | |
| 4270 s standout (termcap entry "so" and "se") | |
| 4271 u underline (termcap entry "us" and "ue") | |
|
29328
60977de70684
patch 9.0.0007: no support for double, dotted and dashed underlines
Bram Moolenaar <Bram@vim.org>
parents:
29314
diff
changeset
|
4272 c undercurl (termcap entry "Us" and "Ce") |
|
60977de70684
patch 9.0.0007: no support for double, dotted and dashed underlines
Bram Moolenaar <Bram@vim.org>
parents:
29314
diff
changeset
|
4273 2 double underline (termcap entry "Ds" and "Ce") |
|
60977de70684
patch 9.0.0007: no support for double, dotted and dashed underlines
Bram Moolenaar <Bram@vim.org>
parents:
29314
diff
changeset
|
4274 d dotted underline (termcap entry "ds" and "Ce") |
|
60977de70684
patch 9.0.0007: no support for double, dotted and dashed underlines
Bram Moolenaar <Bram@vim.org>
parents:
29314
diff
changeset
|
4275 = dashed underline (termcap entry "Ds" and "Ce") |
|
12317
2a8890b80923
patch 8.0.1038: strike-through text not supported
Christian Brabandt <cb@256bit.org>
parents:
12293
diff
changeset
|
4276 t strikethrough (termcap entry "Ts" and "Te") |
| 7 | 4277 n no highlighting |
| 4278 - no highlighting | |
| 4279 : use a highlight group | |
| 4280 The default is used for occasions that are not included. | |
| 4281 If you want to change what the display modes do, see |dos-colors| | |
| 4282 for an example. | |
| 4283 When using the ':' display mode, this must be followed by the name of | |
| 4284 a highlight group. A highlight group can be used to define any type | |
| 4285 of highlighting, including using color. See |:highlight| on how to | |
| 4286 define one. The default uses a different group for each occasion. | |
| 4287 See |highlight-default| for the default highlight groups. | |
| 4288 | |
| 4289 *'history'* *'hi'* | |
|
9669
284b4eb307fc
commit https://github.com/vim/vim/commit/8c08b5b569e2a9e9f63dea514591ecfa2d3bb392
Christian Brabandt <cb@256bit.org>
parents:
9665
diff
changeset
|
4290 '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
|
4291 set to 200 in |defaults.vim|) |
| 7 | 4292 global |
| 4293 A history of ":" commands, and a history of previous search patterns | |
| 5991 | 4294 is remembered. This option decides how many entries may be stored in |
| 7 | 4295 each of these histories (see |cmdline-editing|). |
| 5991 | 4296 The maximum value is 10000. |
| 7 | 4297 NOTE: This option is set to the Vi default value when 'compatible' is |
| 4298 set and to the Vim default value when 'compatible' is reset. | |
| 4299 | |
| 4300 *'hkmap'* *'hk'* *'nohkmap'* *'nohk'* | |
| 4301 'hkmap' 'hk' boolean (default off) | |
| 4302 global | |
| 4303 {only available when compiled with the |+rightleft| | |
| 4304 feature} | |
| 4305 When on, the keyboard is mapped for the Hebrew character set. | |
| 4306 Normally you would set 'allowrevins' and use CTRL-_ in insert mode to | |
| 4307 toggle this option. See |rileft.txt|. | |
| 4308 NOTE: This option is reset when 'compatible' is set. | |
| 4309 | |
| 4310 *'hkmapp'* *'hkp'* *'nohkmapp'* *'nohkp'* | |
| 4311 'hkmapp' 'hkp' boolean (default off) | |
| 4312 global | |
| 4313 {only available when compiled with the |+rightleft| | |
| 4314 feature} | |
| 4315 When on, phonetic keyboard mapping is used. 'hkmap' must also be on. | |
| 4316 This is useful if you have a non-Hebrew keyboard. | |
| 4317 See |rileft.txt|. | |
| 4318 NOTE: This option is reset when 'compatible' is set. | |
| 4319 | |
| 11160 | 4320 *'hlsearch'* *'hls'* *'nohlsearch'* *'nohls'* |
| 4321 'hlsearch' 'hls' boolean (default off) | |
| 4322 global | |
| 4323 {not available when compiled without the | |
| 4324 |+extra_search| feature} | |
| 4325 When there is a previous search pattern, highlight all its matches. | |
| 4326 The type of highlighting used can be set with the 'l' occasion in the | |
| 4327 'highlight' option. This uses the "Search" highlight group by | |
| 4328 default. Note that only the matching text is highlighted, any offsets | |
| 29066 | 4329 are not applied. If the "CurSearch" highlight group is set then the |
| 4330 current match is highlighted with that. | |
| 11160 | 4331 See also: 'incsearch' and |:match|. |
| 4332 When you get bored looking at the highlighted matches, you can turn it | |
| 4333 off with |:nohlsearch|. This does not change the option value, as | |
| 4334 soon as you use a search command, the highlighting comes back. | |
| 4335 'redrawtime' specifies the maximum time spent on finding matches. | |
| 4336 When the search pattern can match an end-of-line, Vim will try to | |
| 4337 highlight all of the matched text. However, this depends on where the | |
| 4338 search starts. This will be the first line in the window or the first | |
| 4339 line below a closed fold. A match in a previous line which is not | |
| 4340 drawn may not continue in a newly drawn line. | |
| 4341 You can specify whether the highlight status is restored on startup | |
| 4342 with the 'h' flag in 'viminfo' |viminfo-h|. | |
| 4343 NOTE: This option is reset when 'compatible' is set. | |
| 4344 | |
| 7 | 4345 *'icon'* *'noicon'* |
| 4346 'icon' boolean (default off, on when title can be restored) | |
| 4347 global | |
| 4348 When on, the icon text of the window will be set to the value of | |
| 4349 'iconstring' (if it is not empty), or to the name of the file | |
| 4350 currently being edited. Only the last part of the name is used. | |
| 4351 Overridden by the 'iconstring' option. | |
| 4352 Only works if the terminal supports setting window icons (currently | |
| 4353 only X11 GUI and terminals with a non-empty 't_IS' option - these are | |
| 4354 Unix xterm and iris-ansi by default, where 't_IS' is taken from the | |
| 4355 builtin termcap). | |
| 4356 When Vim was compiled with HAVE_X11 defined, the original icon will be | |
| 233 | 4357 restored if possible |X11|. See |X11-icon| for changing the icon on |
| 7 | 4358 X11. |
| 6259 | 4359 For MS-Windows the icon can be changed, see |windows-icon|. |
| 7 | 4360 |
| 4361 *'iconstring'* | |
| 4362 'iconstring' string (default "") | |
| 4363 global | |
| 4364 When this option is not empty, it will be used for the icon text of | |
| 4365 the window. This happens only when the 'icon' option is on. | |
| 4366 Only works if the terminal supports setting window icon text | |
| 4367 (currently only X11 GUI and terminals with a non-empty 't_IS' option). | |
| 24387 | 4368 Does not work for MS-Windows. |
| 7 | 4369 When Vim was compiled with HAVE_X11 defined, the original icon will be |
| 4370 restored if possible |X11|. | |
| 4371 When this option contains printf-style '%' items, they will be | |
| 10 | 4372 expanded according to the rules used for 'statusline'. See |
| 7 | 4373 '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
|
4374 This option cannot be set in a modeline when 'modelineexpr' is off. |
| 7 | 4375 {not available when compiled without the |+statusline| feature} |
| 4376 | |
| 4377 *'ignorecase'* *'ic'* *'noignorecase'* *'noic'* | |
| 4378 'ignorecase' 'ic' boolean (default off) | |
| 4379 global | |
| 4380 Ignore case in search patterns. Also used when searching in the tags | |
| 4381 file. | |
|
7266
6ba7182fb7bd
commit https://github.com/vim/vim/commit/0f6562e9036f889185dff49a75c7fc5ffb28b307
Christian Brabandt <cb@256bit.org>
parents:
7245
diff
changeset
|
4382 Also see 'smartcase' and 'tagcase'. |
| 7 | 4383 Can be overruled by using "\c" or "\C" in the pattern, see |
| 4384 |/ignorecase|. | |
| 4385 | |
|
5008
3717d569027d
updated for version 7.3.1248
Bram Moolenaar <bram@vim.org>
parents:
4869
diff
changeset
|
4386 *'imactivatefunc'* *'imaf'* |
|
3717d569027d
updated for version 7.3.1248
Bram Moolenaar <bram@vim.org>
parents:
4869
diff
changeset
|
4387 'imactivatefunc' 'imaf' string (default "") |
|
3717d569027d
updated for version 7.3.1248
Bram Moolenaar <bram@vim.org>
parents:
4869
diff
changeset
|
4388 global |
|
3717d569027d
updated for version 7.3.1248
Bram Moolenaar <bram@vim.org>
parents:
4869
diff
changeset
|
4389 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
|
4390 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
|
4391 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
|
4392 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
|
4393 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
|
4394 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
|
4395 modeline, see |sandbox-option|. |
|
5008
3717d569027d
updated for version 7.3.1248
Bram Moolenaar <bram@vim.org>
parents:
4869
diff
changeset
|
4396 |
|
3717d569027d
updated for version 7.3.1248
Bram Moolenaar <bram@vim.org>
parents:
4869
diff
changeset
|
4397 Example: > |
|
3717d569027d
updated for version 7.3.1248
Bram Moolenaar <bram@vim.org>
parents:
4869
diff
changeset
|
4398 function ImActivateFunc(active) |
|
3717d569027d
updated for version 7.3.1248
Bram Moolenaar <bram@vim.org>
parents:
4869
diff
changeset
|
4399 if a:active |
|
3717d569027d
updated for version 7.3.1248
Bram Moolenaar <bram@vim.org>
parents:
4869
diff
changeset
|
4400 ... do something |
|
3717d569027d
updated for version 7.3.1248
Bram Moolenaar <bram@vim.org>
parents:
4869
diff
changeset
|
4401 else |
|
3717d569027d
updated for version 7.3.1248
Bram Moolenaar <bram@vim.org>
parents:
4869
diff
changeset
|
4402 ... do something |
|
3717d569027d
updated for version 7.3.1248
Bram Moolenaar <bram@vim.org>
parents:
4869
diff
changeset
|
4403 endif |
|
3717d569027d
updated for version 7.3.1248
Bram Moolenaar <bram@vim.org>
parents:
4869
diff
changeset
|
4404 " return value is not used |
|
3717d569027d
updated for version 7.3.1248
Bram Moolenaar <bram@vim.org>
parents:
4869
diff
changeset
|
4405 endfunction |
|
3717d569027d
updated for version 7.3.1248
Bram Moolenaar <bram@vim.org>
parents:
4869
diff
changeset
|
4406 set imactivatefunc=ImActivateFunc |
|
3717d569027d
updated for version 7.3.1248
Bram Moolenaar <bram@vim.org>
parents:
4869
diff
changeset
|
4407 < |
| 7 | 4408 *'imactivatekey'* *'imak'* |
| 4409 'imactivatekey' 'imak' string (default "") | |
| 4410 global | |
| 4411 {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
|
4412 |+GUI_GTK|} *E599* |
| 7 | 4413 Specifies the key that your Input Method in X-Windows uses for |
| 4414 activation. When this is specified correctly, vim can fully control | |
| 4415 IM with 'imcmdline', 'iminsert' and 'imsearch'. | |
| 4416 You can't use this option to change the activation key, the option | |
| 4417 tells Vim what the key is. | |
| 4418 Format: | |
| 4419 [MODIFIER_FLAG-]KEY_STRING | |
| 4420 | |
| 4421 These characters can be used for MODIFIER_FLAG (case is ignored): | |
| 4422 S Shift key | |
| 4423 L Lock key | |
| 4424 C Control key | |
| 4425 1 Mod1 key | |
| 4426 2 Mod2 key | |
| 4427 3 Mod3 key | |
| 4428 4 Mod4 key | |
| 4429 5 Mod5 key | |
| 4430 Combinations are allowed, for example "S-C-space" or "SC-space" are | |
| 4431 both shift+ctrl+space. | |
| 4432 See <X11/keysymdef.h> and XStringToKeysym for KEY_STRING. | |
| 4433 | |
| 4434 Example: > | |
| 4435 :set imactivatekey=S-space | |
| 4436 < "S-space" means shift+space. This is the activation key for kinput2 + | |
| 4437 canna (Japanese), and ami (Korean). | |
| 4438 | |
| 4439 *'imcmdline'* *'imc'* *'noimcmdline'* *'noimc'* | |
| 4440 'imcmdline' 'imc' boolean (default off) | |
| 4441 global | |
| 4442 When set the Input Method is always on when starting to edit a command | |
| 4443 line, unless entering a search pattern (see 'imsearch' for that). | |
| 4444 Setting this option is useful when your input method allows entering | |
| 4445 English characters directly, e.g., when it's used to type accented | |
| 4446 characters with dead keys. | |
| 4447 | |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
4448 *'imdisable'* *'imd'* *'noimdisable'* *'noimd'* |
| 7 | 4449 'imdisable' 'imd' boolean (default off, on for some systems (SGI)) |
| 4450 global | |
| 4451 When set the Input Method is never used. This is useful to disable | |
| 4452 the IM when it doesn't work properly. | |
| 4453 Currently this option is on by default for SGI/IRIX machines. This | |
| 4454 may change in later releases. | |
| 4455 | |
| 4456 *'iminsert'* *'imi'* | |
|
12469
61d910f0999d
patch 8.0.1114: default for 'iminsert' is annoying
Christian Brabandt <cb@256bit.org>
parents:
12317
diff
changeset
|
4457 'iminsert' 'imi' number (default 0) |
| 7 | 4458 local to buffer |
| 4459 Specifies whether :lmap or an Input Method (IM) is to be used in | |
| 4460 Insert mode. Valid values: | |
| 4461 0 :lmap is off and IM is off | |
| 4462 1 :lmap is ON and IM is off | |
| 4463 2 :lmap is off and IM is ON | |
| 4464 To always reset the option to zero when leaving Insert mode with <Esc> | |
| 4465 this can be used: > | |
| 4466 :inoremap <ESC> <ESC>:set iminsert=0<CR> | |
| 4467 < This makes :lmap and IM turn off automatically when leaving Insert | |
| 4468 mode. | |
| 4469 Note that this option changes when using CTRL-^ in Insert mode | |
| 4470 |i_CTRL-^|. | |
| 4471 The value is set to 1 when setting 'keymap' to a valid keymap name. | |
| 4472 It is also used for the argument of commands like "r" and "f". | |
| 28379 | 4473 The value 0 may not work correctly with Motif with some XIM |
| 7 | 4474 methods. Use 'imdisable' to disable XIM then. |
| 4475 | |
|
12920
327e1264b9bf
patch 8.0.1336: cannot use imactivatefunc() unless compiled with +xim
Christian Brabandt <cb@256bit.org>
parents:
12865
diff
changeset
|
4476 You can set 'imactivatefunc' and 'imstatusfunc' to handle IME/XIM |
| 14519 | 4477 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
|
4478 |+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
|
4479 |
| 7 | 4480 *'imsearch'* *'ims'* |
|
12469
61d910f0999d
patch 8.0.1114: default for 'iminsert' is annoying
Christian Brabandt <cb@256bit.org>
parents:
12317
diff
changeset
|
4481 'imsearch' 'ims' number (default -1) |
| 7 | 4482 local to buffer |
| 4483 Specifies whether :lmap or an Input Method (IM) is to be used when | |
| 4484 entering a search pattern. Valid values: | |
| 4485 -1 the value of 'iminsert' is used, makes it look like | |
| 4486 'iminsert' is also used when typing a search pattern | |
| 4487 0 :lmap is off and IM is off | |
| 4488 1 :lmap is ON and IM is off | |
| 4489 2 :lmap is off and IM is ON | |
| 4490 Note that this option changes when using CTRL-^ in Command-line mode | |
| 4491 |c_CTRL-^|. | |
| 4492 The value is set to 1 when it is not -1 and setting the 'keymap' | |
| 4493 option to a valid keymap name. | |
| 28379 | 4494 The value 0 may not work correctly with Motif with some XIM |
| 7 | 4495 methods. Use 'imdisable' to disable XIM then. |
| 4496 | |
|
5008
3717d569027d
updated for version 7.3.1248
Bram Moolenaar <bram@vim.org>
parents:
4869
diff
changeset
|
4497 *'imstatusfunc'* *'imsf'* |
|
3717d569027d
updated for version 7.3.1248
Bram Moolenaar <bram@vim.org>
parents:
4869
diff
changeset
|
4498 'imstatusfunc' 'imsf' string (default "") |
|
3717d569027d
updated for version 7.3.1248
Bram Moolenaar <bram@vim.org>
parents:
4869
diff
changeset
|
4499 global |
|
3717d569027d
updated for version 7.3.1248
Bram Moolenaar <bram@vim.org>
parents:
4869
diff
changeset
|
4500 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
|
4501 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
|
4502 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
|
4503 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
|
4504 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
|
4505 |
|
3717d569027d
updated for version 7.3.1248
Bram Moolenaar <bram@vim.org>
parents:
4869
diff
changeset
|
4506 Example: > |
|
3717d569027d
updated for version 7.3.1248
Bram Moolenaar <bram@vim.org>
parents:
4869
diff
changeset
|
4507 function ImStatusFunc() |
|
3717d569027d
updated for version 7.3.1248
Bram Moolenaar <bram@vim.org>
parents:
4869
diff
changeset
|
4508 let is_active = ...do something |
|
3717d569027d
updated for version 7.3.1248
Bram Moolenaar <bram@vim.org>
parents:
4869
diff
changeset
|
4509 return is_active ? 1 : 0 |
|
3717d569027d
updated for version 7.3.1248
Bram Moolenaar <bram@vim.org>
parents:
4869
diff
changeset
|
4510 endfunction |
|
3717d569027d
updated for version 7.3.1248
Bram Moolenaar <bram@vim.org>
parents:
4869
diff
changeset
|
4511 set imstatusfunc=ImStatusFunc |
|
3717d569027d
updated for version 7.3.1248
Bram Moolenaar <bram@vim.org>
parents:
4869
diff
changeset
|
4512 < |
|
3717d569027d
updated for version 7.3.1248
Bram Moolenaar <bram@vim.org>
parents:
4869
diff
changeset
|
4513 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
|
4514 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
|
4515 modeline, see |sandbox-option|. |
|
5008
3717d569027d
updated for version 7.3.1248
Bram Moolenaar <bram@vim.org>
parents:
4869
diff
changeset
|
4516 |
|
12293
1ff5e5dfa9b0
patch 8.0.1026: GTK on-the-spot input has problems
Christian Brabandt <cb@256bit.org>
parents:
12254
diff
changeset
|
4517 *'imstyle'* *'imst'* |
|
1ff5e5dfa9b0
patch 8.0.1026: GTK on-the-spot input has problems
Christian Brabandt <cb@256bit.org>
parents:
12254
diff
changeset
|
4518 '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
|
4519 global |
|
1ff5e5dfa9b0
patch 8.0.1026: GTK on-the-spot input has problems
Christian Brabandt <cb@256bit.org>
parents:
12254
diff
changeset
|
4520 {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
|
4521 |+GUI_GTK|} |
| 12499 | 4522 This option specifies the input style of Input Method: |
| 4523 0 use on-the-spot style | |
| 4524 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
|
4525 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
|
4526 |
| 12559 | 4527 For a long time on-the-spot style had been used in the GTK version of |
| 4528 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
|
4529 |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
|
4530 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
|
4531 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
|
4532 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
|
4533 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
|
4534 |
| 7 | 4535 *'include'* *'inc'* |
| 4536 'include' 'inc' string (default "^\s*#\s*include") | |
| 4537 global or local to buffer |global-local| | |
| 4538 {not available when compiled without the | |
| 4539 |+find_in_path| feature} | |
| 10 | 4540 Pattern to be used to find an include command. It is a search |
| 7 | 4541 pattern, just like for the "/" command (See |pattern|). The default |
| 4542 value is for C programs. This option is used for the commands "[i", | |
| 532 | 4543 "]I", "[d", etc. |
| 4544 Normally the 'isfname' option is used to recognize the file name that | |
| 534 | 4545 comes after the matched pattern. But if "\zs" appears in the pattern |
| 4546 then the text matched from "\zs" to the end, or until "\ze" if it | |
| 4547 appears, is used as the file name. Use this to include characters | |
| 4548 that are not in 'isfname', such as a space. You can then use | |
| 4549 'includeexpr' to process the matched text. | |
| 532 | 4550 See |option-backslash| about including spaces and backslashes. |
| 7 | 4551 |
| 4552 *'includeexpr'* *'inex'* | |
| 4553 'includeexpr' 'inex' string (default "") | |
| 4554 local to buffer | |
| 4555 {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
|
4556 |+find_in_path| or |+eval| features} |
| 7 | 4557 Expression to be used to transform the string found with the 'include' |
| 10 | 4558 option to a file name. Mostly useful to change "." to "/" for Java: > |
| 31200 | 4559 :setlocal includeexpr=substitute(v:fname,'\\.','/','g') |
| 7 | 4560 < The "v:fname" variable will be set to the file name that was detected. |
| 31200 | 4561 Note the double backslash: the `:set` command first halves them, then |
| 4562 one remains it the value, where "\." matches a dot literally. For | |
| 4563 simple character replacements `tr()` avoids the need for escaping: > | |
| 4564 :setlocal includeexpr=tr(v:fname,'.','/') | |
| 4565 < | |
| 7 | 4566 Also used for the |gf| command if an unmodified file name can't be |
| 10 | 4567 found. Allows doing "gf" on the name after an 'include' statement. |
| 7 | 4568 Also used for |<cfile>|. |
| 4569 | |
|
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
|
4570 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
|
4571 the script ID (|local-function|). Example: > |
| 31200 | 4572 setlocal includeexpr=s:MyIncludeExpr() |
| 4573 setlocal includeexpr=<SID>SomeIncludeExpr() | |
| 27321 | 4574 < Otherwise, the expression is evaluated in the context of the script |
| 4575 where the option was set, thus script-local items are available. | |
| 4576 | |
|
30598
37aa9fd2ed72
patch 9.0.0634: evaluating "expr" options has more overhead than needed
Bram Moolenaar <Bram@vim.org>
parents:
30547
diff
changeset
|
4577 It is more efficient if the value is just a function call without |
|
37aa9fd2ed72
patch 9.0.0634: evaluating "expr" options has more overhead than needed
Bram Moolenaar <Bram@vim.org>
parents:
30547
diff
changeset
|
4578 arguments, see |expr-option-function|. |
|
37aa9fd2ed72
patch 9.0.0634: evaluating "expr" options has more overhead than needed
Bram Moolenaar <Bram@vim.org>
parents:
30547
diff
changeset
|
4579 |
| 3682 | 4580 The expression will be evaluated in the |sandbox| when set from a |
| 4581 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
|
4582 This option cannot be set in a modeline when 'modelineexpr' is off. |
| 634 | 4583 |
| 4584 It is not allowed to change text or jump to another window while | |
| 4585 evaluating 'includeexpr' |textlock|. | |
| 4586 | |
| 7 | 4587 *'incsearch'* *'is'* *'noincsearch'* *'nois'* |
|
9669
284b4eb307fc
commit https://github.com/vim/vim/commit/8c08b5b569e2a9e9f63dea514591ecfa2d3bb392
Christian Brabandt <cb@256bit.org>
parents:
9665
diff
changeset
|
4588 'incsearch' 'is' boolean (default off, set in |defaults.vim| if the |
| 29290 | 4589 |+reltime| feature is supported) |
| 7 | 4590 global |
| 4591 {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
|
4592 |+extra_search| features} |
| 17 | 4593 While typing a search command, show where the pattern, as it was typed |
| 4594 so far, matches. The matched string is highlighted. If the pattern | |
| 4595 is invalid or not found, nothing is shown. The screen will be updated | |
| 4596 often, this is only useful on fast terminals. | |
| 14637 | 4597 Also applies to the pattern in commands: > |
| 4598 :global | |
| 4599 :lvimgrep | |
| 4600 :lvimgrepadd | |
| 4601 :smagic | |
| 4602 :snomagic | |
| 4603 :sort | |
| 4604 :substitute | |
| 4605 :vglobal | |
| 4606 :vimgrep | |
| 4607 :vimgrepadd | |
| 4608 < Note that the match will be shown, but the cursor will return to its | |
| 17 | 4609 original position when no match is found and when pressing <Esc>. You |
| 4610 still need to finish the search command with <Enter> to move the | |
| 4611 cursor to the match. | |
|
10261
bdd7fc1a38c0
commit https://github.com/vim/vim/commit/dc08328821a2c11e33dfb1980332e4923ec64fca
Christian Brabandt <cb@256bit.org>
parents:
10244
diff
changeset
|
4612 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
|
4613 previous match. |c_CTRL-G| |c_CTRL-T| |
| 1521 | 4614 When compiled with the |+reltime| feature Vim only searches for about |
| 4615 half a second. With a complicated pattern and/or a lot of text the | |
| 4616 match may not be found. This is to avoid that Vim hangs while you | |
| 4617 are typing the pattern. | |
| 17 | 4618 The highlighting can be set with the 'i' flag in 'highlight'. |
| 12968 | 4619 When 'hlsearch' is on, all matched strings are highlighted too while |
| 4620 typing a search command. See also: 'hlsearch'. | |
| 14519 | 4621 If you don't want to turn 'hlsearch' on, but want to highlight all |
| 4622 matches while searching, you can turn on and off 'hlsearch' with | |
| 4623 autocmd. Example: > | |
|
12720
37c384802df4
patch 8.0.1238: incremental search only shows one match
Christian Brabandt <cb@256bit.org>
parents:
12608
diff
changeset
|
4624 augroup vimrc-incsearch-highlight |
|
37c384802df4
patch 8.0.1238: incremental search only shows one match
Christian Brabandt <cb@256bit.org>
parents:
12608
diff
changeset
|
4625 autocmd! |
|
12744
0c704288ced4
patch 8.0.1250: 'hlsearch' highlighting not removed after incsearch
Christian Brabandt <cb@256bit.org>
parents:
12720
diff
changeset
|
4626 autocmd CmdlineEnter /,\? :set hlsearch |
|
0c704288ced4
patch 8.0.1250: 'hlsearch' highlighting not removed after incsearch
Christian Brabandt <cb@256bit.org>
parents:
12720
diff
changeset
|
4627 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
|
4628 augroup END |
|
37c384802df4
patch 8.0.1238: incremental search only shows one match
Christian Brabandt <cb@256bit.org>
parents:
12608
diff
changeset
|
4629 < |
| 772 | 4630 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
|
4631 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
|
4632 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
|
4633 converted to lowercase. |
| 772 | 4634 CTRL-R CTRL-W can be used to add the word at the end of the current |
| 4635 match, excluding the characters that were already typed. | |
| 7 | 4636 NOTE: This option is reset when 'compatible' is set. |
| 4637 | |
| 4638 *'indentexpr'* *'inde'* | |
| 4639 'indentexpr' 'inde' string (default "") | |
| 4640 local to buffer | |
|
28942
6cdf55afaae9
patch 8.2.4993: smart/C/lisp indenting is optional
Bram Moolenaar <Bram@vim.org>
parents:
28777
diff
changeset
|
4641 {not available when compiled without the |+eval| |
|
6cdf55afaae9
patch 8.2.4993: smart/C/lisp indenting is optional
Bram Moolenaar <Bram@vim.org>
parents:
28777
diff
changeset
|
4642 feature} |
| 7 | 4643 Expression which is evaluated to obtain the proper indent for a line. |
| 4644 It is used when a new line is created, for the |=| operator and | |
| 4645 in Insert mode as specified with the 'indentkeys' option. | |
| 4646 When this option is not empty, it overrules the 'cindent' and | |
| 2833 | 4647 'smartindent' indenting. When 'lisp' is set, this option is |
|
30853
40df8a6515f6
patch 9.0.0761: cannot use 'indentexpr' for Lisp indenting
Bram Moolenaar <Bram@vim.org>
parents:
30825
diff
changeset
|
4648 is only used when 'lispoptions' contains "expr:1". |
| 7 | 4649 When 'paste' is set this option is not used for indenting. |
| 4650 The expression is evaluated with |v:lnum| set to the line number for | |
| 534 | 4651 which the indent is to be computed. The cursor is also in this line |
| 7 | 4652 when the expression is evaluated (but it may be moved around). |
| 27321 | 4653 |
|
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
|
4654 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
|
4655 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
|
4656 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
|
4657 set indentexpr=<SID>SomeIndentExpr() |
| 27321 | 4658 < Otherwise, the expression is evaluated in the context of the script |
| 4659 where the option was set, thus script-local items are available. | |
| 4660 | |
|
30598
37aa9fd2ed72
patch 9.0.0634: evaluating "expr" options has more overhead than needed
Bram Moolenaar <Bram@vim.org>
parents:
30547
diff
changeset
|
4661 The advantage of using a function call without arguments is that it is |
|
37aa9fd2ed72
patch 9.0.0634: evaluating "expr" options has more overhead than needed
Bram Moolenaar <Bram@vim.org>
parents:
30547
diff
changeset
|
4662 faster, see |expr-option-function|. |
|
37aa9fd2ed72
patch 9.0.0634: evaluating "expr" options has more overhead than needed
Bram Moolenaar <Bram@vim.org>
parents:
30547
diff
changeset
|
4663 |
| 7 | 4664 The expression must return the number of spaces worth of indent. It |
| 4665 can return "-1" to keep the current indent (this means 'autoindent' is | |
| 4666 used for the indent). | |
| 4667 Functions useful for computing the indent are |indent()|, |cindent()| | |
| 4668 and |lispindent()|. | |
| 4669 The evaluation of the expression must not have side effects! It must | |
| 4670 not change the text, jump to another window, etc. Afterwards the | |
| 4671 cursor position is always restored, thus the cursor may be moved. | |
| 4672 Normally this option would be set to call a function: > | |
| 4673 :set indentexpr=GetMyIndent() | |
| 4674 < Error messages will be suppressed, unless the 'debug' option contains | |
| 4675 "msg". | |
| 634 | 4676 See |indent-expression|. |
| 11160 | 4677 NOTE: This option is set to "" when 'compatible' is set. |
| 7 | 4678 |
| 3682 | 4679 The expression will be evaluated in the |sandbox| when set from a |
| 4680 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
|
4681 This option cannot be set in a modeline when 'modelineexpr' is off. |
| 634 | 4682 |
| 4683 It is not allowed to change text or jump to another window while | |
| 4684 evaluating 'indentexpr' |textlock|. | |
| 4685 | |
| 4686 | |
| 7 | 4687 *'indentkeys'* *'indk'* |
|
15701
9cd11f6beb70
patch 8.1.0858: 'indentkeys' and 'cinkeys' defaults are different
Bram Moolenaar <Bram@vim.org>
parents:
15512
diff
changeset
|
4688 'indentkeys' 'indk' string (default "0{,0},0),0],:,0#,!^F,o,O,e") |
| 7 | 4689 local to buffer |
| 4690 A list of keys that, when typed in Insert mode, cause reindenting of | |
| 4691 the current line. Only happens if 'indentexpr' isn't empty. | |
| 4692 The format is identical to 'cinkeys', see |indentkeys-format|. | |
| 4693 See |C-indenting| and |indent-expression|. | |
| 4694 | |
| 4695 *'infercase'* *'inf'* *'noinfercase'* *'noinf'* | |
| 4696 'infercase' 'inf' boolean (default off) | |
| 4697 local to buffer | |
| 4698 When doing keyword completion in insert mode |ins-completion|, and | |
| 1621 | 4699 'ignorecase' is also on, the case of the match is adjusted depending |
| 4700 on the typed text. If the typed text contains a lowercase letter | |
| 4701 where the match has an upper case letter, the completed part is made | |
| 4702 lowercase. If the typed text has no lowercase letters and the match | |
| 4703 has a lowercase letter where the typed text has an uppercase letter, | |
| 4704 and there is a letter before it, the completed part is made uppercase. | |
| 4705 With 'noinfercase' the match is used as-is. | |
| 7 | 4706 |
| 4707 *'insertmode'* *'im'* *'noinsertmode'* *'noim'* | |
| 4708 'insertmode' 'im' boolean (default off) | |
| 4709 global | |
| 4710 Makes Vim work in a way that Insert mode is the default mode. Useful | |
| 4711 if you want to use Vim as a modeless editor. Used for |evim|. | |
| 4712 These Insert mode commands will be useful: | |
| 4713 - 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
|
4714 - Use CTRL-O to execute one Normal mode command |i_CTRL-O|. When |
| 7 | 4715 this is a mapping, it is executed as if 'insertmode' was off. |
| 4716 Normal mode remains active until the mapping is finished. | |
| 4717 - Use CTRL-L to execute a number of Normal mode commands, then use | |
| 477 | 4718 <Esc> to get back to Insert mode. Note that CTRL-L moves the cursor |
| 4719 left, like <Esc> does when 'insertmode' isn't set. |i_CTRL-L| | |
| 7 | 4720 |
| 4721 These items change when 'insertmode' is set: | |
| 4722 - when starting to edit of a file, Vim goes to Insert mode. | |
| 4723 - <Esc> in Insert mode is a no-op and beeps. | |
| 4724 - <Esc> in Normal mode makes Vim go to Insert mode. | |
| 4725 - CTRL-L in Insert mode is a command, it is not inserted. | |
| 4726 - CTRL-Z in Insert mode suspends Vim, see |CTRL-Z|. *i_CTRL-Z* | |
| 4727 However, when <Esc> is used inside a mapping, it behaves like | |
| 4728 'insertmode' was not set. This was done to be able to use the same | |
| 4729 mappings with 'insertmode' set or not set. | |
| 4730 When executing commands with |:normal| 'insertmode' is not used. | |
| 4731 | |
| 4732 NOTE: This option is reset when 'compatible' is set. | |
| 4733 | |
| 4734 *'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
|
4735 'isfname' 'isf' string (default for Win32: |
| 7 | 4736 "@,48-57,/,\,.,-,_,+,,,#,$,%,{,},[,],:,@-@,!,~,=" |
| 4737 for AMIGA: "@,48-57,/,.,-,_,+,,,$,:" | |
| 4738 for VMS: "@,48-57,/,.,-,_,+,,,#,$,%,<,>,[,],:,;,~" | |
| 4739 for OS/390: "@,240-249,/,.,-,_,+,,,#,$,%,~,=" | |
| 4740 otherwise: "@,48-57,/,.,-,_,+,,,#,$,%,~,=") | |
| 4741 global | |
| 4742 The characters specified by this option are included in file names and | |
| 4743 path names. Filenames are used for commands like "gf", "[i" and in | |
| 10 | 4744 the tags file. It is also used for "\f" in a |pattern|. |
| 7 | 4745 Multi-byte characters 256 and above are always included, only the |
| 4746 characters up to 255 are specified with this option. | |
| 4747 For UTF-8 the characters 0xa0 to 0xff are included as well. | |
| 1621 | 4748 Think twice before adding white space to this option. Although a |
| 4749 space may appear inside a file name, the effect will be that Vim | |
| 4750 doesn't know where a file name starts or ends when doing completion. | |
| 4751 It most likely works better without a space in 'isfname'. | |
| 7 | 4752 |
| 4753 Note that on systems using a backslash as path separator, Vim tries to | |
| 4754 do its best to make it work as you would expect. That is a bit | |
| 4755 tricky, since Vi originally used the backslash to escape special | |
| 4756 characters. Vim will not remove a backslash in front of a normal file | |
| 4757 name character on these systems, but it will on Unix and alikes. The | |
| 4758 '&' and '^' are not included by default, because these are special for | |
| 4759 cmd.exe. | |
| 4760 | |
| 4761 The format of this option is a list of parts, separated with commas. | |
| 10 | 4762 Each part can be a single character number or a range. A range is two |
| 4763 character numbers with '-' in between. A character number can be a | |
| 7 | 4764 decimal number between 0 and 255 or the ASCII character itself (does |
| 4765 not work for digits). Example: | |
| 4766 "_,-,128-140,#-43" (include '_' and '-' and the range | |
| 4767 128 to 140 and '#' to 43) | |
| 4768 If a part starts with '^', the following character number or range | |
| 4769 will be excluded from the option. The option is interpreted from left | |
| 4770 to right. Put the excluded character after the range where it is | |
| 4771 included. To include '^' itself use it as the last character of the | |
| 4772 option or the end of a range. Example: | |
| 4773 "^a-z,#,^" (exclude 'a' to 'z', include '#' and '^') | |
| 4774 If the character is '@', all characters where isalpha() returns TRUE | |
| 4775 are included. Normally these are the characters a to z and A to Z, | |
| 4776 plus accented characters. To include '@' itself use "@-@". Examples: | |
| 4777 "@,^a-z" All alphabetic characters, excluding lower | |
| 1621 | 4778 case ASCII letters. |
| 7 | 4779 "a-z,A-Z,@-@" All letters plus the '@' character. |
| 4780 A comma can be included by using it where a character number is | |
| 4781 expected. Example: | |
| 4782 "48-57,,,_" Digits, comma and underscore. | |
| 4783 A comma can be excluded by prepending a '^'. Example: | |
| 4784 " -~,^,,9" All characters from space to '~', excluding | |
| 4785 comma, plus <Tab>. | |
| 4786 See |option-backslash| about including spaces and backslashes. | |
| 4787 | |
| 4788 *'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
|
4789 'isident' 'isi' string (default for Win32: |
| 7 | 4790 "@,48-57,_,128-167,224-235" |
| 4791 otherwise: "@,48-57,_,192-255") | |
| 4792 global | |
| 4793 The characters given by this option are included in identifiers. | |
| 4794 Identifiers are used in recognizing environment variables and after a | |
| 4795 match of the 'define' option. It is also used for "\i" in a | |
| 233 | 4796 |pattern|. See 'isfname' for a description of the format of this |
| 14864 | 4797 option. For '@' only characters up to 255 are used. |
| 7 | 4798 Careful: If you change this option, it might break expanding |
| 10 | 4799 environment variables. E.g., when '/' is included and Vim tries to |
| 7 | 4800 expand "$HOME/.viminfo". Maybe you should change 'iskeyword' instead. |
| 4801 | |
| 4802 *'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
|
4803 'iskeyword' 'isk' string (Vim default for Win32: |
| 7 | 4804 "@,48-57,_,128-167,224-235" |
| 4805 otherwise: "@,48-57,_,192-255" | |
| 4806 Vi default: "@,48-57,_") | |
| 4807 local to buffer | |
| 4808 Keywords are used in searching and recognizing with many commands: | |
| 10 | 4809 "w", "*", "[i", etc. It is also used for "\k" in a |pattern|. See |
| 14864 | 4810 'isfname' for a description of the format of this option. For '@' |
| 24569 | 4811 characters above 255 check the "word" character class (any character |
| 4812 that is not white space or punctuation). | |
| 14864 | 4813 For C programs you could use "a-z,A-Z,48-57,_,.,-,>". |
| 7 | 4814 For a help file it is set to all non-blank printable characters except |
| 4815 '*', '"' and '|' (so that CTRL-] on a command finds the help for that | |
| 4816 command). | |
| 4817 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
|
4818 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
|
4819 uses |:syn-iskeyword|. |
| 7 | 4820 NOTE: This option is set to the Vi default value when 'compatible' is |
| 4821 set and to the Vim default value when 'compatible' is reset. | |
| 4822 | |
| 4823 *'isprint'* *'isp'* | |
| 21825 | 4824 'isprint' 'isp' string (default for Win32 and macOS: |
| 7 | 4825 "@,~-255"; otherwise: "@,161-255") |
| 4826 global | |
| 4827 The characters given by this option are displayed directly on the | |
| 4828 screen. It is also used for "\p" in a |pattern|. The characters from | |
| 4829 space (ASCII 32) to '~' (ASCII 126) are always displayed directly, | |
| 4830 even when they are not included in 'isprint' or excluded. See | |
| 4831 'isfname' for a description of the format of this option. | |
| 4832 | |
| 4833 Non-printable characters are displayed with two characters: | |
| 4834 0 - 31 "^@" - "^_" | |
| 4835 32 - 126 always single characters | |
| 4836 127 "^?" | |
| 4837 128 - 159 "~@" - "~_" | |
| 4838 160 - 254 "| " - "|~" | |
| 4839 255 "~?" | |
| 4840 When 'encoding' is a Unicode one, illegal bytes from 128 to 255 are | |
| 4841 displayed as <xx>, with the hexadecimal value of the byte. | |
| 4842 When 'display' contains "uhex" all unprintable characters are | |
| 4843 displayed as <xx>. | |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
4844 The SpecialKey highlighting will be used for unprintable characters. |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
4845 |hl-SpecialKey| |
| 7 | 4846 |
| 4847 Multi-byte characters 256 and above are always included, only the | |
| 4848 characters up to 255 are specified with this option. When a character | |
| 4849 is printable but it is not available in the current font, a | |
| 4850 replacement character will be shown. | |
| 4851 Unprintable and zero-width Unicode characters are displayed as <xxxx>. | |
| 4852 There is no option to specify these characters. | |
| 4853 | |
| 4854 *'joinspaces'* *'js'* *'nojoinspaces'* *'nojs'* | |
| 4855 'joinspaces' 'js' boolean (default on) | |
| 4856 global | |
| 4857 Insert two spaces after a '.', '?' and '!' with a join command. | |
| 4858 When 'cpoptions' includes the 'j' flag, only do this after a '.'. | |
| 4859 Otherwise only one space is inserted. | |
| 4860 NOTE: This option is set when 'compatible' is set. | |
| 4861 | |
| 4862 *'key'* | |
| 4863 'key' string (default "") | |
| 4864 local to buffer | |
|
2283
7e1bd501306d
Mainly documentation updates.
Bram Moolenaar <bram@vim.org>
parents:
2265
diff
changeset
|
4865 {only available when compiled with the |+cryptv| |
|
7e1bd501306d
Mainly documentation updates.
Bram Moolenaar <bram@vim.org>
parents:
2265
diff
changeset
|
4866 feature} |
| 7 | 4867 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
|
4868 See |encryption| and 'cryptmethod'. |
| 7 | 4869 Careful: Do not set the key value by hand, someone might see the typed |
| 4870 key. Use the |:X| command. But you can make 'key' empty: > | |
| 4871 :set key= | |
| 4872 < It is not possible to get the value of this option with ":set key" or | |
| 4873 "echo &key". This is to avoid showing it to someone who shouldn't | |
| 4874 know. It also means you cannot see it yourself once you have set it, | |
| 4875 be careful not to make a typing error! | |
|
2698
b6471224d2af
Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents:
2681
diff
changeset
|
4876 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
|
4877 enabled. When 'key' is set it returns "*****" (five stars). |
| 7 | 4878 |
| 4879 *'keymap'* *'kmp'* *E544* | |
| 4880 'keymap' 'kmp' string (default "") | |
| 4881 local to buffer | |
| 4882 {only available when compiled with the |+keymap| | |
| 4883 feature} | |
| 4884 Name of a keyboard mapping. See |mbyte-keymap|. | |
| 4885 Setting this option to a valid keymap name has the side effect of | |
| 4886 setting 'iminsert' to one, so that the keymap becomes effective. | |
| 4887 'imsearch' is also set to one, unless it was -1 | |
| 36 | 4888 Only normal file name characters can be used, "/\*?[|<>" are illegal. |
| 7 | 4889 |
| 4890 *'keymodel'* *'km'* | |
| 4891 'keymodel' 'km' string (default "") | |
| 4892 global | |
| 28379 | 4893 List of comma-separated words, which enable special things that keys |
| 7 | 4894 can do. These values can be used: |
| 4895 startsel Using a shifted special key starts selection (either | |
| 4896 Select mode or Visual mode, depending on "key" being | |
| 4897 present in 'selectmode'). | |
| 4898 stopsel Using a not-shifted special key stops selection. | |
| 4899 Special keys in this context are the cursor keys, <End>, <Home>, | |
| 4900 <PageUp> and <PageDown>. | |
| 4901 The 'keymodel' option is set by the |:behave| command. | |
| 4902 | |
|
31192
dcde141f2d1e
patch 9.0.0930: cannot debug the Kitty keyboard protocol with TermDebug
Bram Moolenaar <Bram@vim.org>
parents:
31139
diff
changeset
|
4903 *'keyprotocol'* *'kpc'* |
|
dcde141f2d1e
patch 9.0.0930: cannot debug the Kitty keyboard protocol with TermDebug
Bram Moolenaar <Bram@vim.org>
parents:
31139
diff
changeset
|
4904 'keyprotocol' 'kpc' string (default: see below) |
|
dcde141f2d1e
patch 9.0.0930: cannot debug the Kitty keyboard protocol with TermDebug
Bram Moolenaar <Bram@vim.org>
parents:
31139
diff
changeset
|
4905 global |
|
dcde141f2d1e
patch 9.0.0930: cannot debug the Kitty keyboard protocol with TermDebug
Bram Moolenaar <Bram@vim.org>
parents:
31139
diff
changeset
|
4906 Specifies what keyboard protocol to use depending on the value of |
|
dcde141f2d1e
patch 9.0.0930: cannot debug the Kitty keyboard protocol with TermDebug
Bram Moolenaar <Bram@vim.org>
parents:
31139
diff
changeset
|
4907 'term'. The supported keyboard protocols names are: |
|
dcde141f2d1e
patch 9.0.0930: cannot debug the Kitty keyboard protocol with TermDebug
Bram Moolenaar <Bram@vim.org>
parents:
31139
diff
changeset
|
4908 none whatever the terminal uses |
|
dcde141f2d1e
patch 9.0.0930: cannot debug the Kitty keyboard protocol with TermDebug
Bram Moolenaar <Bram@vim.org>
parents:
31139
diff
changeset
|
4909 mok2 modifyOtherKeys level 2, as supported by xterm |
|
dcde141f2d1e
patch 9.0.0930: cannot debug the Kitty keyboard protocol with TermDebug
Bram Moolenaar <Bram@vim.org>
parents:
31139
diff
changeset
|
4910 kitty Kitty keyboard protocol, as supported by Kitty |
|
dcde141f2d1e
patch 9.0.0930: cannot debug the Kitty keyboard protocol with TermDebug
Bram Moolenaar <Bram@vim.org>
parents:
31139
diff
changeset
|
4911 |
|
31285
76acee969543
patch 9.0.0976: enabling the kitty keyboard protocol uses push/pop
Bram Moolenaar <Bram@vim.org>
parents:
31229
diff
changeset
|
4912 The option value is a list of comma separated items. Each item has |
|
31192
dcde141f2d1e
patch 9.0.0930: cannot debug the Kitty keyboard protocol with TermDebug
Bram Moolenaar <Bram@vim.org>
parents:
31139
diff
changeset
|
4913 a pattern that is matched against the 'term' option, a colon and the |
|
dcde141f2d1e
patch 9.0.0930: cannot debug the Kitty keyboard protocol with TermDebug
Bram Moolenaar <Bram@vim.org>
parents:
31139
diff
changeset
|
4914 protocol name to be used. To illustrate this, the default value would |
|
dcde141f2d1e
patch 9.0.0930: cannot debug the Kitty keyboard protocol with TermDebug
Bram Moolenaar <Bram@vim.org>
parents:
31139
diff
changeset
|
4915 be set with: > |
|
dcde141f2d1e
patch 9.0.0930: cannot debug the Kitty keyboard protocol with TermDebug
Bram Moolenaar <Bram@vim.org>
parents:
31139
diff
changeset
|
4916 set keyprotocol=kitty:kitty,foot:kitty,wezterm:kitty,xterm:mok2 |
|
dcde141f2d1e
patch 9.0.0930: cannot debug the Kitty keyboard protocol with TermDebug
Bram Moolenaar <Bram@vim.org>
parents:
31139
diff
changeset
|
4917 |
|
dcde141f2d1e
patch 9.0.0930: cannot debug the Kitty keyboard protocol with TermDebug
Bram Moolenaar <Bram@vim.org>
parents:
31139
diff
changeset
|
4918 < This means that when 'term' contains "kitty, "foot" or "wezterm" |
|
dcde141f2d1e
patch 9.0.0930: cannot debug the Kitty keyboard protocol with TermDebug
Bram Moolenaar <Bram@vim.org>
parents:
31139
diff
changeset
|
4919 somewhere then the "kitty" protocol is used. When 'term' contains |
| 32004 | 4920 "xterm" somewhere, then the "mok2" protocol is used. |
|
31192
dcde141f2d1e
patch 9.0.0930: cannot debug the Kitty keyboard protocol with TermDebug
Bram Moolenaar <Bram@vim.org>
parents:
31139
diff
changeset
|
4921 |
|
dcde141f2d1e
patch 9.0.0930: cannot debug the Kitty keyboard protocol with TermDebug
Bram Moolenaar <Bram@vim.org>
parents:
31139
diff
changeset
|
4922 The first match is used, thus if you want to have "kitty" use the |
|
dcde141f2d1e
patch 9.0.0930: cannot debug the Kitty keyboard protocol with TermDebug
Bram Moolenaar <Bram@vim.org>
parents:
31139
diff
changeset
|
4923 kitty protocol, but "badkitty" not, then you should match "badkitty" |
|
dcde141f2d1e
patch 9.0.0930: cannot debug the Kitty keyboard protocol with TermDebug
Bram Moolenaar <Bram@vim.org>
parents:
31139
diff
changeset
|
4924 first and use the "none" value: > |
|
dcde141f2d1e
patch 9.0.0930: cannot debug the Kitty keyboard protocol with TermDebug
Bram Moolenaar <Bram@vim.org>
parents:
31139
diff
changeset
|
4925 set keyprotocol=badkitty:none,kitty:kitty |
|
dcde141f2d1e
patch 9.0.0930: cannot debug the Kitty keyboard protocol with TermDebug
Bram Moolenaar <Bram@vim.org>
parents:
31139
diff
changeset
|
4926 < |
|
dcde141f2d1e
patch 9.0.0930: cannot debug the Kitty keyboard protocol with TermDebug
Bram Moolenaar <Bram@vim.org>
parents:
31139
diff
changeset
|
4927 The option is used after 'term' has been changed. First the termcap |
|
dcde141f2d1e
patch 9.0.0930: cannot debug the Kitty keyboard protocol with TermDebug
Bram Moolenaar <Bram@vim.org>
parents:
31139
diff
changeset
|
4928 entries are set, possibly using the builtin list, see |builtin-terms|. |
|
dcde141f2d1e
patch 9.0.0930: cannot debug the Kitty keyboard protocol with TermDebug
Bram Moolenaar <Bram@vim.org>
parents:
31139
diff
changeset
|
4929 Then this option is inspected and if there is a match and a protocol |
|
dcde141f2d1e
patch 9.0.0930: cannot debug the Kitty keyboard protocol with TermDebug
Bram Moolenaar <Bram@vim.org>
parents:
31139
diff
changeset
|
4930 is specified the following happens: |
|
dcde141f2d1e
patch 9.0.0930: cannot debug the Kitty keyboard protocol with TermDebug
Bram Moolenaar <Bram@vim.org>
parents:
31139
diff
changeset
|
4931 none Nothing, the regular t_TE and t_TI values remain |
|
dcde141f2d1e
patch 9.0.0930: cannot debug the Kitty keyboard protocol with TermDebug
Bram Moolenaar <Bram@vim.org>
parents:
31139
diff
changeset
|
4932 |
|
dcde141f2d1e
patch 9.0.0930: cannot debug the Kitty keyboard protocol with TermDebug
Bram Moolenaar <Bram@vim.org>
parents:
31139
diff
changeset
|
4933 mok2 The t_TE value is changed to: |
|
dcde141f2d1e
patch 9.0.0930: cannot debug the Kitty keyboard protocol with TermDebug
Bram Moolenaar <Bram@vim.org>
parents:
31139
diff
changeset
|
4934 CSI >4;m disables modifyOtherKeys |
|
dcde141f2d1e
patch 9.0.0930: cannot debug the Kitty keyboard protocol with TermDebug
Bram Moolenaar <Bram@vim.org>
parents:
31139
diff
changeset
|
4935 The t_TI value is changed to: |
|
dcde141f2d1e
patch 9.0.0930: cannot debug the Kitty keyboard protocol with TermDebug
Bram Moolenaar <Bram@vim.org>
parents:
31139
diff
changeset
|
4936 CSI >4;2m enables modifyOtherKeys |
|
31285
76acee969543
patch 9.0.0976: enabling the kitty keyboard protocol uses push/pop
Bram Moolenaar <Bram@vim.org>
parents:
31229
diff
changeset
|
4937 CSI ?4m request the modifyOtherKeys state |
|
31192
dcde141f2d1e
patch 9.0.0930: cannot debug the Kitty keyboard protocol with TermDebug
Bram Moolenaar <Bram@vim.org>
parents:
31139
diff
changeset
|
4938 |
|
dcde141f2d1e
patch 9.0.0930: cannot debug the Kitty keyboard protocol with TermDebug
Bram Moolenaar <Bram@vim.org>
parents:
31139
diff
changeset
|
4939 kitty The t_TE value is changed to: |
|
dcde141f2d1e
patch 9.0.0930: cannot debug the Kitty keyboard protocol with TermDebug
Bram Moolenaar <Bram@vim.org>
parents:
31139
diff
changeset
|
4940 CSI >4;m disables modifyOtherKeys |
|
31285
76acee969543
patch 9.0.0976: enabling the kitty keyboard protocol uses push/pop
Bram Moolenaar <Bram@vim.org>
parents:
31229
diff
changeset
|
4941 CSI =0;1u disables the kitty keyboard protocol |
|
31192
dcde141f2d1e
patch 9.0.0930: cannot debug the Kitty keyboard protocol with TermDebug
Bram Moolenaar <Bram@vim.org>
parents:
31139
diff
changeset
|
4942 The t_TI value is changed to: |
|
31285
76acee969543
patch 9.0.0976: enabling the kitty keyboard protocol uses push/pop
Bram Moolenaar <Bram@vim.org>
parents:
31229
diff
changeset
|
4943 CSI =1;1u enables the kitty keyboard protocol |
|
31192
dcde141f2d1e
patch 9.0.0930: cannot debug the Kitty keyboard protocol with TermDebug
Bram Moolenaar <Bram@vim.org>
parents:
31139
diff
changeset
|
4944 CSI ?u request kitty keyboard protocol state |
|
dcde141f2d1e
patch 9.0.0930: cannot debug the Kitty keyboard protocol with TermDebug
Bram Moolenaar <Bram@vim.org>
parents:
31139
diff
changeset
|
4945 CSI >c request the termresponse |
|
dcde141f2d1e
patch 9.0.0930: cannot debug the Kitty keyboard protocol with TermDebug
Bram Moolenaar <Bram@vim.org>
parents:
31139
diff
changeset
|
4946 |
| 31579 | 4947 If you notice problems, such as characters being displayed that |
| 4948 disappear after `CTRL-L`, you might want to try making this option | |
| 4949 empty. Then set the 'term' option to have it take effect: > | |
| 4950 set keyprotocol= | |
| 4951 let &term = &term | |
| 31885 | 4952 < |
|
31192
dcde141f2d1e
patch 9.0.0930: cannot debug the Kitty keyboard protocol with TermDebug
Bram Moolenaar <Bram@vim.org>
parents:
31139
diff
changeset
|
4953 |
| 7 | 4954 *'keywordprg'* *'kp'* |
| 4955 '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
|
4956 VMS: "help") |
| 7 | 4957 global or local to buffer |global-local| |
| 4958 Program to use for the |K| command. Environment variables are | |
| 4959 expanded |:set_env|. ":help" may be used to access the Vim internal | |
| 4960 help. (Note that previously setting the global option to the empty | |
| 4961 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
|
4962 When the first character is ":", the command is invoked as a Vim |
| 29450 | 4963 Ex command with [count] added as an argument if it is not zero. |
|
9098
0d52ddff8db4
commit https://github.com/vim/vim/commit/2ff8b64679242e73248774a388d54931c9ce49bd
Christian Brabandt <cb@256bit.org>
parents:
9097
diff
changeset
|
4964 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
|
4965 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
|
4966 argument. For "man -s" the "-s" is removed when there is no count. |
| 7 | 4967 See |option-backslash| about including spaces and backslashes. |
| 4968 Example: > | |
| 4969 :set keywordprg=man\ -s | |
| 4970 < This option cannot be set from a |modeline| or in the |sandbox|, for | |
| 4971 security reasons. | |
| 4972 | |
| 4973 *'langmap'* *'lmap'* *E357* *E358* | |
| 4974 'langmap' 'lmap' string (default "") | |
| 4975 global | |
| 4976 {only available when compiled with the |+langmap| | |
| 4977 feature} | |
| 4978 This option allows switching your keyboard into a special language | |
| 10 | 4979 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
|
4980 inserted directly. When in Normal mode the 'langmap' option takes |
| 7 | 4981 care of translating these special characters to the original meaning |
| 4982 of the key. This means you don't have to change the keyboard mode to | |
| 4983 be able to execute Normal mode commands. | |
| 4984 This is the opposite of the 'keymap' option, where characters are | |
| 4985 mapped in Insert mode. | |
| 19646 | 4986 Also consider setting 'langremap' to off, to prevent 'langmap' from |
| 4987 applying to characters resulting from a mapping. | |
| 5908 | 4988 This option cannot be set from a |modeline| or in the |sandbox|, for |
| 4989 security reasons. | |
| 7 | 4990 |
| 699 | 4991 Example (for Greek, in UTF-8): *greek* > |
| 4992 :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 | 4993 < Example (exchanges meaning of z and y for commands): > |
| 4994 :set langmap=zy,yz,ZY,YZ | |
| 4995 < | |
| 4996 The 'langmap' option is a list of parts, separated with commas. Each | |
| 4997 part can be in one of two forms: | |
| 4998 1. A list of pairs. Each pair is a "from" character immediately | |
| 4999 followed by the "to" character. Examples: "aA", "aAbBcC". | |
| 5000 2. A list of "from" characters, a semi-colon and a list of "to" | |
| 5001 characters. Example: "abc;ABC" | |
| 5002 Example: "aA,fgh;FGH,cCdDeE" | |
| 5003 Special characters need to be preceded with a backslash. These are | |
| 22565 | 5004 ";", ',', '"', '|' and backslash itself. |
| 7 | 5005 |
| 5006 This will allow you to activate vim actions without having to switch | |
| 5007 back and forth between the languages. Your language characters will | |
| 5008 be understood as normal vim English characters (according to the | |
| 5009 langmap mappings) in the following cases: | |
| 5010 o Normal/Visual mode (commands, buffer/register names, user mappings) | |
| 5011 o Insert/Replace Mode: Register names after CTRL-R | |
| 5012 o Insert/Replace Mode: Mappings | |
| 5013 Characters entered in Command-line mode will NOT be affected by | |
| 5014 this option. Note that this option can be changed at any time | |
| 5015 allowing to switch between mappings for different languages/encodings. | |
| 5016 Use a mapping to avoid having to type it each time! | |
| 5017 | |
| 5018 *'langmenu'* *'lm'* | |
| 5019 'langmenu' 'lm' string (default "") | |
| 5020 global | |
| 5021 {only available when compiled with the |+menu| and | |
| 5022 |+multi_lang| features} | |
| 5023 Language to use for menu translation. Tells which file is loaded | |
| 5024 from the "lang" directory in 'runtimepath': > | |
| 27903 | 5025 "lang/menu_" .. &langmenu .. ".vim" |
| 7 | 5026 < (without the spaces). For example, to always use the Dutch menus, no |
| 5027 matter what $LANG is set to: > | |
| 5028 :set langmenu=nl_NL.ISO_8859-1 | |
| 5029 < When 'langmenu' is empty, |v:lang| is used. | |
| 36 | 5030 Only normal file name characters can be used, "/\*?[|<>" are illegal. |
| 7 | 5031 If your $LANG is set to a non-English language but you do want to use |
| 5032 the English menus: > | |
| 5033 :set langmenu=none | |
| 5034 < This option must be set before loading menus, switching on filetype | |
| 5035 detection or syntax highlighting. Once the menus are defined setting | |
| 5036 this option has no effect. But you could do this: > | |
| 5037 :source $VIMRUNTIME/delmenu.vim | |
| 5038 :set langmenu=de_DE.ISO_8859-1 | |
| 5039 :source $VIMRUNTIME/menu.vim | |
| 5040 < Warning: This deletes all menus that you defined yourself! | |
| 5041 | |
|
7196
42717d048817
commit https://github.com/vim/vim/commit/d94464ee294a351ce7b6ba18e8bd3f24f1bef920
Christian Brabandt <cb@256bit.org>
parents:
7147
diff
changeset
|
5042 *'langnoremap'* *'lnr'* *'nolangnoremap'* *'nolnr'* |
|
9669
284b4eb307fc
commit https://github.com/vim/vim/commit/8c08b5b569e2a9e9f63dea514591ecfa2d3bb392
Christian Brabandt <cb@256bit.org>
parents:
9665
diff
changeset
|
5043 'langnoremap' 'lnr' boolean (default off, set in |defaults.vim|) |
| 6339 | 5044 global |
| 5045 {only available when compiled with the |+langmap| | |
| 5046 feature} | |
|
9975
03fa8a51e9dc
commit https://github.com/vim/vim/commit/e4a3bcf28d92d0bde9ca227ccb40d401038185e5
Christian Brabandt <cb@256bit.org>
parents:
9913
diff
changeset
|
5047 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
|
5048 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
|
5049 '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
|
5050 |
|
03fa8a51e9dc
commit https://github.com/vim/vim/commit/e4a3bcf28d92d0bde9ca227ccb40d401038185e5
Christian Brabandt <cb@256bit.org>
parents:
9913
diff
changeset
|
5051 *'langremap'* *'lrm'* *'nolangremap'* *'nolrm'* |
| 19646 | 5052 '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
|
5053 global |
|
03fa8a51e9dc
commit https://github.com/vim/vim/commit/e4a3bcf28d92d0bde9ca227ccb40d401038185e5
Christian Brabandt <cb@256bit.org>
parents:
9913
diff
changeset
|
5054 {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
|
5055 feature} |
|
03fa8a51e9dc
commit https://github.com/vim/vim/commit/e4a3bcf28d92d0bde9ca227ccb40d401038185e5
Christian Brabandt <cb@256bit.org>
parents:
9913
diff
changeset
|
5056 When off, setting 'langmap' does not apply to characters resulting from |
| 6339 | 5057 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
|
5058 '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
|
5059 This option defaults to on for backwards compatibility. Set it off if |
| 6339 | 5060 that works for you to avoid mappings to break. |
| 5061 | |
| 7 | 5062 *'laststatus'* *'ls'* |
| 5063 'laststatus' 'ls' number (default 1) | |
| 5064 global | |
| 5065 The value of this option influences when the last window will have a | |
| 5066 status line: | |
| 5067 0: never | |
| 5068 1: only if there are at least two windows | |
| 5069 2: always | |
| 5070 The screen looks nicer with a status line if you have several | |
| 5071 windows, but it takes another screen line. |status-line| | |
| 5072 | |
| 5073 *'lazyredraw'* *'lz'* *'nolazyredraw'* *'nolz'* | |
| 5074 'lazyredraw' 'lz' boolean (default off) | |
| 5075 global | |
| 5076 When this option is set, the screen will not be redrawn while | |
| 5077 executing macros, registers and other commands that have not been | |
| 10 | 5078 typed. Also, updating the window title is postponed. To force an |
| 7 | 5079 update use |:redraw|. |
| 29274 | 5080 This may occasionally cause display errors. It is only meant to be set |
| 5081 temporarily when performing an operation where redrawing may cause | |
| 29269 | 5082 flickering or cause a slow down. |
| 7 | 5083 |
| 5084 *'linebreak'* *'lbr'* *'nolinebreak'* *'nolbr'* | |
| 5085 'linebreak' 'lbr' boolean (default off) | |
| 5086 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
|
5087 {not available when compiled without the |+linebreak| |
| 7 | 5088 feature} |
| 6009 | 5089 If on, Vim will wrap long lines at a character in 'breakat' rather |
| 7 | 5090 than at the last character that fits on the screen. Unlike |
| 5091 'wrapmargin' and 'textwidth', this does not insert <EOL>s in the file, | |
| 6009 | 5092 it only affects the way the file is displayed, not its contents. |
| 5093 If 'breakindent' is set, line is visually indented. Then, the value | |
| 5094 of 'showbreak' is used to put in front of wrapped lines. This option | |
| 6026 | 5095 is not used when the 'wrap' option is off. |
| 7 | 5096 Note that <Tab> characters after an <EOL> are mostly not displayed |
| 5097 with the right amount of white space. | |
| 5098 | |
| 5099 *'lines'* *E593* | |
| 5100 'lines' number (default 24 or terminal height) | |
| 5101 global | |
| 5102 Number of lines of the Vim window. | |
| 5103 Normally you don't need to set this. It is done automatically by the | |
| 161 | 5104 terminal initialization code. Also see |posix-screen-size|. |
| 7 | 5105 When Vim is running in the GUI or in a resizable window, setting this |
| 5106 option will cause the window size to be changed. When you only want | |
| 5107 to use the size for the GUI, put the command in your |gvimrc| file. | |
| 5108 Vim limits the number of lines to what fits on the screen. You can | |
| 5109 use this command to get the tallest window possible: > | |
| 5110 :set lines=999 | |
| 571 | 5111 < 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
|
5112 If you get fewer lines than expected, check the 'guiheadroom' option. |
| 7 | 5113 When you set this option and Vim is unable to change the physical |
| 5114 number of lines of the display, the display may be messed up. | |
| 5115 | |
| 5116 *'linespace'* *'lsp'* | |
| 5117 'linespace' 'lsp' number (default 0, 1 for Win32 GUI) | |
| 5118 global | |
| 5119 {only in the GUI} | |
| 5120 Number of pixel lines inserted between characters. Useful if the font | |
| 5121 uses the full character cell height, making lines touch each other. | |
| 5122 When non-zero there is room for underlining. | |
| 180 | 5123 With some fonts there can be too much room between lines (to have |
| 5124 space for ascents and descents). Then it makes sense to set | |
| 5125 'linespace' to a negative value. This may cause display problems | |
| 5126 though! | |
| 7 | 5127 |
| 5128 *'lisp'* *'nolisp'* | |
| 5129 'lisp' boolean (default off) | |
| 5130 local to buffer | |
| 5131 Lisp mode: When <Enter> is typed in insert mode set the indent for | |
| 5132 the next line to Lisp standards (well, sort of). Also happens with | |
| 5133 "cc" or "S". 'autoindent' must also be on for this to work. The 'p' | |
| 5134 flag in 'cpoptions' changes the method of indenting: Vi compatible or | |
| 5135 better. Also see 'lispwords'. | |
| 5136 The '-' character is included in keyword characters. Redefines the | |
| 5137 "=" operator to use this same indentation algorithm rather than | |
| 5138 calling an external program if 'equalprg' is empty. | |
| 5139 This option is not used when 'paste' is set. | |
| 5140 | |
|
30853
40df8a6515f6
patch 9.0.0761: cannot use 'indentexpr' for Lisp indenting
Bram Moolenaar <Bram@vim.org>
parents:
30825
diff
changeset
|
5141 *'lispoptions'* *'lop'* |
|
40df8a6515f6
patch 9.0.0761: cannot use 'indentexpr' for Lisp indenting
Bram Moolenaar <Bram@vim.org>
parents:
30825
diff
changeset
|
5142 'lispoptions' 'lop' string (default "") |
|
40df8a6515f6
patch 9.0.0761: cannot use 'indentexpr' for Lisp indenting
Bram Moolenaar <Bram@vim.org>
parents:
30825
diff
changeset
|
5143 local to buffer |
|
40df8a6515f6
patch 9.0.0761: cannot use 'indentexpr' for Lisp indenting
Bram Moolenaar <Bram@vim.org>
parents:
30825
diff
changeset
|
5144 Comma-separated list of items that influence the Lisp indenting when |
|
40df8a6515f6
patch 9.0.0761: cannot use 'indentexpr' for Lisp indenting
Bram Moolenaar <Bram@vim.org>
parents:
30825
diff
changeset
|
5145 enabled with the |'lisp'| option. Currently only one item is |
|
40df8a6515f6
patch 9.0.0761: cannot use 'indentexpr' for Lisp indenting
Bram Moolenaar <Bram@vim.org>
parents:
30825
diff
changeset
|
5146 supported: |
|
40df8a6515f6
patch 9.0.0761: cannot use 'indentexpr' for Lisp indenting
Bram Moolenaar <Bram@vim.org>
parents:
30825
diff
changeset
|
5147 expr:1 use 'indentexpr' for Lisp indenting when it is set |
|
40df8a6515f6
patch 9.0.0761: cannot use 'indentexpr' for Lisp indenting
Bram Moolenaar <Bram@vim.org>
parents:
30825
diff
changeset
|
5148 expr:0 do not use 'indentexpr' for Lisp indenting (default) |
|
40df8a6515f6
patch 9.0.0761: cannot use 'indentexpr' for Lisp indenting
Bram Moolenaar <Bram@vim.org>
parents:
30825
diff
changeset
|
5149 Note that when using 'indentexpr' the `=` operator indents all the |
|
40df8a6515f6
patch 9.0.0761: cannot use 'indentexpr' for Lisp indenting
Bram Moolenaar <Bram@vim.org>
parents:
30825
diff
changeset
|
5150 lines, otherwise the first line is not indented (Vi-compatible). |
|
40df8a6515f6
patch 9.0.0761: cannot use 'indentexpr' for Lisp indenting
Bram Moolenaar <Bram@vim.org>
parents:
30825
diff
changeset
|
5151 |
| 7 | 5152 *'lispwords'* *'lw'* |
| 5153 'lispwords' 'lw' string (default is very long) | |
| 5712 | 5154 global or local to buffer |global-local| |
| 29659 | 5155 Comma-separated list of words that influence the Lisp indenting when |
| 5156 enabled with the |'lisp'| option. | |
| 7 | 5157 |
| 5158 *'list'* *'nolist'* | |
| 5159 'list' boolean (default off) | |
| 5160 local to window | |
| 26100 | 5161 List mode: By default show tabs as CTRL-I is displayed, display $ |
| 5162 after end of line. Useful to see the difference between tabs and | |
| 5163 spaces and for trailing blanks. Further changed by the 'listchars' | |
| 5164 option. | |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
5165 |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
5166 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
|
5167 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
|
5168 position while displaying Tabs with spaces, use: > |
|
5161
f7add3891e95
Updated runtime files. Fix NL translations.
Bram Moolenaar <bram@vim.org>
parents:
5146
diff
changeset
|
5169 :set list lcs=tab:\ \ |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
5170 < |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
5171 Note that list mode will also affect formatting (set with 'textwidth' |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
5172 or 'wrapmargin') when 'cpoptions' includes 'L'. See 'listchars' for |
| 7 | 5173 changing the way tabs are displayed. |
| 5174 | |
| 5175 *'listchars'* *'lcs'* | |
| 5176 '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
|
5177 global or local to window |global-local| |
| 2458 | 5178 Strings to use in 'list' mode and for the |:list| command. It is a |
| 28379 | 5179 comma-separated list of string settings. |
| 6777 | 5180 *lcs-eol* |
| 7 | 5181 eol:c Character to show at the end of each line. When |
| 5182 omitted, there is no extra character at the end of the | |
| 5183 line. | |
| 6777 | 5184 *lcs-tab* |
|
15502
bc17a9d37810
patch 8.1.0759: showing two characters for tab is limited
Bram Moolenaar <Bram@vim.org>
parents:
15396
diff
changeset
|
5185 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
|
5186 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
|
5187 |
|
bc17a9d37810
patch 8.1.0759: showing two characters for tab is limited
Bram Moolenaar <Bram@vim.org>
parents:
15396
diff
changeset
|
5188 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
|
5189 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
|
5190 > |
|
bc17a9d37810
patch 8.1.0759: showing two characters for tab is limited
Bram Moolenaar <Bram@vim.org>
parents:
15396
diff
changeset
|
5191 >- |
|
bc17a9d37810
patch 8.1.0759: showing two characters for tab is limited
Bram Moolenaar <Bram@vim.org>
parents:
15396
diff
changeset
|
5192 >-- |
|
bc17a9d37810
patch 8.1.0759: showing two characters for tab is limited
Bram Moolenaar <Bram@vim.org>
parents:
15396
diff
changeset
|
5193 etc. |
|
bc17a9d37810
patch 8.1.0759: showing two characters for tab is limited
Bram Moolenaar <Bram@vim.org>
parents:
15396
diff
changeset
|
5194 |
|
bc17a9d37810
patch 8.1.0759: showing two characters for tab is limited
Bram Moolenaar <Bram@vim.org>
parents:
15396
diff
changeset
|
5195 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
|
5196 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
|
5197 "tab:<->" displays: |
|
bc17a9d37810
patch 8.1.0759: showing two characters for tab is limited
Bram Moolenaar <Bram@vim.org>
parents:
15396
diff
changeset
|
5198 > |
|
bc17a9d37810
patch 8.1.0759: showing two characters for tab is limited
Bram Moolenaar <Bram@vim.org>
parents:
15396
diff
changeset
|
5199 <> |
|
bc17a9d37810
patch 8.1.0759: showing two characters for tab is limited
Bram Moolenaar <Bram@vim.org>
parents:
15396
diff
changeset
|
5200 <-> |
|
bc17a9d37810
patch 8.1.0759: showing two characters for tab is limited
Bram Moolenaar <Bram@vim.org>
parents:
15396
diff
changeset
|
5201 <--> |
|
bc17a9d37810
patch 8.1.0759: showing two characters for tab is limited
Bram Moolenaar <Bram@vim.org>
parents:
15396
diff
changeset
|
5202 etc. |
|
bc17a9d37810
patch 8.1.0759: showing two characters for tab is limited
Bram Moolenaar <Bram@vim.org>
parents:
15396
diff
changeset
|
5203 |
|
bc17a9d37810
patch 8.1.0759: showing two characters for tab is limited
Bram Moolenaar <Bram@vim.org>
parents:
15396
diff
changeset
|
5204 When "tab:" is omitted, a tab is shown as ^I. |
| 6777 | 5205 *lcs-space* |
| 5206 space:c Character to show for a space. When omitted, spaces | |
| 5207 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
|
5208 *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
|
5209 multispace:c... |
| 31885 | 5210 One or more characters to use cyclically to show for |
| 5211 multiple consecutive spaces. Overrides the "space" | |
|
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
|
5212 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
|
5213 "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
|
5214 `: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
|
5215 spaces as: |
|
29090
9b292596a332
patch 8.2.5066: timer_create is not available on every Mac system
Bram Moolenaar <Bram@vim.org>
parents:
29066
diff
changeset
|
5216 ---+---+-- ~ |
|
23825
0bd44e94dd14
patch 8.2.2454: leading space can not be made visible
Bram Moolenaar <Bram@vim.org>
parents:
23666
diff
changeset
|
5217 *lcs-lead* |
|
0bd44e94dd14
patch 8.2.2454: leading space can not be made visible
Bram Moolenaar <Bram@vim.org>
parents:
23666
diff
changeset
|
5218 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
|
5219 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
|
5220 "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
|
5221 combine it with "tab:", for example: > |
| 23931 | 5222 :set listchars+=tab:>-,lead:. |
|
29090
9b292596a332
patch 8.2.5066: timer_create is not available on every Mac system
Bram Moolenaar <Bram@vim.org>
parents:
29066
diff
changeset
|
5223 < *lcs-leadmultispace* |
|
9b292596a332
patch 8.2.5066: timer_create is not available on every Mac system
Bram Moolenaar <Bram@vim.org>
parents:
29066
diff
changeset
|
5224 leadmultispace:c... |
| 29307 | 5225 Like the |lcs-multispace| value, but for leading |
| 5226 spaces only. Also overrides |lcs-lead| for leading | |
| 5227 multiple spaces. | |
| 29290 | 5228 `:set listchars=leadmultispace:---+` shows ten |
| 5229 consecutive leading spaces as: | |
|
29090
9b292596a332
patch 8.2.5066: timer_create is not available on every Mac system
Bram Moolenaar <Bram@vim.org>
parents:
29066
diff
changeset
|
5230 ---+---+--XXX ~ |
|
9b292596a332
patch 8.2.5066: timer_create is not available on every Mac system
Bram Moolenaar <Bram@vim.org>
parents:
29066
diff
changeset
|
5231 Where "XXX" denotes the first non-blank characters in |
|
9b292596a332
patch 8.2.5066: timer_create is not available on every Mac system
Bram Moolenaar <Bram@vim.org>
parents:
29066
diff
changeset
|
5232 the line. |
|
9b292596a332
patch 8.2.5066: timer_create is not available on every Mac system
Bram Moolenaar <Bram@vim.org>
parents:
29066
diff
changeset
|
5233 *lcs-trail* |
| 10 | 5234 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
|
5235 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
|
5236 "multispace" settings for trailing spaces. |
| 6777 | 5237 *lcs-extends* |
| 7 | 5238 extends:c Character to show in the last column, when 'wrap' is |
| 5239 off and the line continues beyond the right of the | |
| 5240 screen. | |
| 6777 | 5241 *lcs-precedes* |
|
18131
851a014dfd8b
patch 8.1.2060: "precedes" in 'listchars' not used properly
Bram Moolenaar <Bram@vim.org>
parents:
18130
diff
changeset
|
5242 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
|
5243 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
|
5244 character visible in the first column. |
| 6777 | 5245 *lcs-conceal* |
|
2250
1bac28a53fae
Add the conceal patch from Vince Negri.
Bram Moolenaar <bram@vim.org>
parents:
2249
diff
changeset
|
5246 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
|
5247 'conceallevel' is set to 1. |
| 6777 | 5248 *lcs-nbsp* |
| 6801 | 5249 nbsp:c Character to show for a non-breakable space character |
| 5250 (0xA0 (160 decimal) and U+202F). Left blank when | |
| 5251 omitted. | |
| 7 | 5252 |
| 10 | 5253 The characters ':' and ',' should not be used. UTF-8 characters can |
| 7 | 5254 be used when 'encoding' is "utf-8", otherwise only printable |
| 819 | 5255 characters are allowed. All characters must be single width. |
| 7 | 5256 |
|
25978
40b17deb294f
patch 8.2.3522: cannot use x and u when setting 'listchars'
Bram Moolenaar <Bram@vim.org>
parents:
25974
diff
changeset
|
5257 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
|
5258 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
|
5259 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
|
5260 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
|
5261 < 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
|
5262 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
|
5263 |
| 7 | 5264 Examples: > |
| 5265 :set lcs=tab:>-,trail:- | |
| 12 | 5266 :set lcs=tab:>-,eol:<,nbsp:% |
| 7 | 5267 :set lcs=extends:>,precedes:< |
| 5268 < The "NonText" highlighting will be used for "eol", "extends" and | |
| 25836 | 5269 "precedes". "SpecialKey" will be used for "tab", "nbsp", "space", |
| 5270 "multispace", "lead" and "trail". | |
| 1152 | 5271 |hl-NonText| |hl-SpecialKey| |
| 7 | 5272 |
| 5273 *'lpl'* *'nolpl'* *'loadplugins'* *'noloadplugins'* | |
| 5274 'loadplugins' 'lpl' boolean (default on) | |
| 5275 global | |
| 5276 When on the plugin scripts are loaded when starting up |load-plugins|. | |
| 5277 This option can be reset in your |vimrc| file to disable the loading | |
| 5278 of plugins. | |
|
11666
5cd9ba96561d
patch 8.0.0716: not easy to start Vim cleanly
Christian Brabandt <cb@256bit.org>
parents:
11659
diff
changeset
|
5279 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
|
5280 line arguments reset this option. See |-u| and |--noplugin|. |
| 7 | 5281 |
|
7196
42717d048817
commit https://github.com/vim/vim/commit/d94464ee294a351ce7b6ba18e8bd3f24f1bef920
Christian Brabandt <cb@256bit.org>
parents:
7147
diff
changeset
|
5282 *'luadll'* |
|
8629
54ac275e3fc4
commit https://github.com/vim/vim/commit/3848e00e0177abdb31bc600234967863ec487233
Christian Brabandt <cb@256bit.org>
parents:
8560
diff
changeset
|
5283 '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
|
5284 global |
|
7196
42717d048817
commit https://github.com/vim/vim/commit/d94464ee294a351ce7b6ba18e8bd3f24f1bef920
Christian Brabandt <cb@256bit.org>
parents:
7147
diff
changeset
|
5285 {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
|
5286 feature} |
|
7528
53163e4d9e4f
commit https://github.com/vim/vim/commit/25e4fcde767084d1a79e0926bc301c92987c0cce
Christian Brabandt <cb@256bit.org>
parents:
7477
diff
changeset
|
5287 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
|
5288 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
|
5289 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
|
5290 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
|
5291 security reasons. |
|
42717d048817
commit https://github.com/vim/vim/commit/d94464ee294a351ce7b6ba18e8bd3f24f1bef920
Christian Brabandt <cb@256bit.org>
parents:
7147
diff
changeset
|
5292 |
| 842 | 5293 *'macatsui'* *'nomacatsui'* |
| 5294 'macatsui' boolean (default on) | |
| 5295 global | |
| 21825 | 5296 {not supported} |
| 5297 No longer supported, as the Mac OS X GUI code was removed. | |
| 1152 | 5298 |
| 7 | 5299 *'magic'* *'nomagic'* |
| 5300 'magic' boolean (default on) | |
| 5301 global | |
| 5302 Changes the special characters that can be used in search patterns. | |
| 5303 See |pattern|. | |
|
10140
b11ceef7116e
commit https://github.com/vim/vim/commit/64d8e25bf6efe5f18b032563521c3ce278c316ab
Christian Brabandt <cb@256bit.org>
parents:
10027
diff
changeset
|
5304 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
|
5305 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
|
5306 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
|
5307 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
|
5308 when you want to |/\M|. |
| 23305 | 5309 In |Vim9| script the value of 'magic' is ignored, patterns behave like |
| 5310 it is always set. | |
| 7 | 5311 |
| 5312 *'makeef'* *'mef'* | |
| 5313 'makeef' 'mef' string (default: "") | |
| 5314 global | |
| 5315 {not available when compiled without the |+quickfix| | |
| 5316 feature} | |
| 5317 Name of the errorfile for the |:make| command (see |:make_makeprg|) | |
| 5318 and the |:grep| command. | |
| 5319 When it is empty, an internally generated temp file will be used. | |
| 5320 When "##" is included, it is replaced by a number to make the name | |
| 5321 unique. This makes sure that the ":make" command doesn't overwrite an | |
| 5322 existing file. | |
| 5323 NOT used for the ":cf" command. See 'errorfile' for that. | |
| 5324 Environment variables are expanded |:set_env|. | |
| 5325 See |option-backslash| about including spaces and backslashes. | |
| 5326 This option cannot be set from a |modeline| or in the |sandbox|, for | |
| 5327 security reasons. | |
| 5328 | |
|
11063
e71d3bdf3bc3
patch 8.0.0420: text garbled when the system encoding differs from 'encoding'
Christian Brabandt <cb@256bit.org>
parents:
11062
diff
changeset
|
5329 *'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
|
5330 '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
|
5331 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
|
5332 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
|
5333 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
|
5334 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
|
5335 `: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
|
5336 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
|
5337 |
|
e71d3bdf3bc3
patch 8.0.0420: text garbled when the system encoding differs from 'encoding'
Christian Brabandt <cb@256bit.org>
parents:
11062
diff
changeset
|
5338 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
|
5339 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
|
5340 '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
|
5341 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
|
5342 :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
|
5343 :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
|
5344 < |
| 7 | 5345 *'makeprg'* *'mp'* |
| 5346 'makeprg' 'mp' string (default "make", VMS: "MMS") | |
| 5347 global or local to buffer |global-local| | |
| 1152 | 5348 Program to use for the ":make" command. See |:make_makeprg|. |
|
13341
acd7eaa13d2b
Updated runtime files.
Christian Brabandt <cb@256bit.org>
parents:
13314
diff
changeset
|
5349 This option may contain '%' and '#' characters (see |:_%| and |:_#|), |
|
acd7eaa13d2b
Updated runtime files.
Christian Brabandt <cb@256bit.org>
parents:
13314
diff
changeset
|
5350 which are expanded to the current and alternate file name. Use |::S| |
| 5690 | 5351 to escape file names in case they contain special characters. |
| 1152 | 5352 Environment variables are expanded |:set_env|. See |option-backslash| |
| 5353 about including spaces and backslashes. | |
| 5354 Note that a '|' must be escaped twice: once for ":set" and once for | |
| 5355 the interpretation of a command. When you use a filter called | |
| 5356 "myfilter" do it like this: > | |
| 7 | 5357 :set makeprg=gmake\ \\\|\ myfilter |
| 5358 < The placeholder "$*" can be given (even multiple times) to specify | |
| 5359 where the arguments will be included, for example: > | |
| 5360 :set makeprg=latex\ \\\\nonstopmode\ \\\\input\\{$*} | |
| 5361 < This option cannot be set from a |modeline| or in the |sandbox|, for | |
| 5362 security reasons. | |
| 5363 | |
| 5364 *'matchpairs'* *'mps'* | |
| 5365 'matchpairs' 'mps' string (default "(:),{:},[:]") | |
| 5366 local to buffer | |
| 5367 Characters that form pairs. The |%| command jumps from one to the | |
| 4073 | 5368 other. |
| 5369 Only character pairs are allowed that are different, thus you cannot | |
| 5370 jump between two double quotes. | |
| 5371 The characters must be separated by a colon. | |
| 1152 | 5372 The pairs must be separated by a comma. Example for including '<' and |
| 24387 | 5373 '>' (for HTML): > |
| 7 | 5374 :set mps+=<:> |
| 5375 | |
| 5376 < A more exotic example, to jump between the '=' and ';' in an | |
| 5377 assignment, useful for languages like C and Java: > | |
| 5378 :au FileType c,cpp,java set mps+==:; | |
| 5379 | |
| 5380 < 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
|
5381 the $VIMRUNTIME/pack/dist/opt/matchit directory. |add-local-help| |
| 7 | 5382 |
| 5383 *'matchtime'* *'mat'* | |
| 5384 'matchtime' 'mat' number (default 5) | |
| 5385 global | |
| 5386 Tenths of a second to show the matching paren, when 'showmatch' is | |
| 5387 set. Note that this is not in milliseconds, like other options that | |
| 5388 set a time. This is to be compatible with Nvi. | |
| 5389 | |
| 714 | 5390 *'maxcombine'* *'mco'* |
| 5391 'maxcombine' 'mco' number (default 2) | |
| 5392 global | |
| 5393 The maximum number of combining characters supported for displaying. | |
| 5394 Only used when 'encoding' is "utf-8". | |
| 5395 The default is OK for most languages. Hebrew may require 4. | |
| 5396 Maximum value is 6. | |
| 5397 Even when this option is set to 2 you can still edit text with more | |
| 5398 combining characters, you just can't see them. Use |g8| or |ga|. | |
| 5399 See |mbyte-combining|. | |
| 5400 | |
| 7 | 5401 *'maxfuncdepth'* *'mfd'* |
| 5402 'maxfuncdepth' 'mfd' number (default 100) | |
| 5403 global | |
|
2570
71b56b4e7785
Make the references to features in the help more consistent. (Sylvain Hitier)
Bram Moolenaar <bram@vim.org>
parents:
2561
diff
changeset
|
5404 {not available when compiled without the |+eval| |
| 1152 | 5405 feature} |
| 7 | 5406 Maximum depth of function calls for user functions. This normally |
| 5407 catches endless recursion. When using a recursive function with | |
| 5408 more depth, set 'maxfuncdepth' to a bigger number. But this will use | |
| 5409 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
|
5410 Increasing this limit above 200 also changes the maximum for Ex |
| 14006 | 5411 command recursion, see |E169|. |
| 7 | 5412 See also |:function|. |
| 5413 | |
| 5414 *'maxmapdepth'* *'mmd'* *E223* | |
| 5415 'maxmapdepth' 'mmd' number (default 1000) | |
| 5416 global | |
| 5417 Maximum number of times a mapping is done without resulting in a | |
| 5418 character to be used. This normally catches endless mappings, like | |
| 5419 ":map x y" with ":map y x". It still does not catch ":map g wg", | |
| 5420 because the 'w' is used before the next mapping is done. See also | |
| 5421 |key-mapping|. | |
| 5422 | |
| 5423 *'maxmem'* *'mm'* | |
| 5424 'maxmem' 'mm' number (default between 256 to 5120 (system | |
| 5425 dependent) or half the amount of memory | |
| 5426 available) | |
| 5427 global | |
| 5428 Maximum amount of memory (in Kbyte) to use for one buffer. When this | |
| 5429 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
|
5430 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
|
5431 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
|
5432 limit. |
|
65c3e8259124
patch 8.0.1531: cannot use 24 bit colors in MS-Windows console
Christian Brabandt <cb@256bit.org>
parents:
13234
diff
changeset
|
5433 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
|
5434 Also see 'maxmemtot'. |
| 7 | 5435 |
| 189 | 5436 *'maxmempattern'* *'mmp'* |
| 5437 'maxmempattern' 'mmp' number (default 1000) | |
| 5438 global | |
| 5439 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
|
5440 The maximum value is about 2000000. Use this to work without a limit. |
| 189 | 5441 *E363* |
| 1152 | 5442 When Vim runs into the limit it gives an error message and mostly |
| 5443 behaves like CTRL-C was typed. | |
| 189 | 5444 Running into the limit often means that the pattern is very |
| 5445 inefficient or too complex. This may already happen with the pattern | |
| 5446 "\(.\)*" 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
|
5447 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
|
5448 text structure. |
|
4a588e3afd4a
Update runtime files, add Danish translations.
Christian Brabandt <cb@256bit.org>
parents:
14249
diff
changeset
|
5449 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
|
5450 which case you get an "Out of memory" error instead. |
| 189 | 5451 |
| 7 | 5452 *'maxmemtot'* *'mmt'* |
| 5453 'maxmemtot' 'mmt' number (default between 2048 and 10240 (system | |
| 5454 dependent) or half the amount of memory | |
| 5455 available) | |
| 5456 global | |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
5457 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
|
5458 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
|
5459 without a limit. |
|
05cf4cc72a9f
commit https://github.com/vim/vim/commit/fa7353428f705f7a13465a1943dddeede4083023
Christian Brabandt <cb@256bit.org>
parents:
7272
diff
changeset
|
5460 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
|
5461 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
|
5462 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
|
5463 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
|
5464 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
|
5465 used. |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
5466 Also see 'maxmem'. |
| 7 | 5467 |
| 5468 *'menuitems'* *'mis'* | |
| 5469 'menuitems' 'mis' number (default 25) | |
| 5470 global | |
| 5471 {not available when compiled without the |+menu| | |
| 5472 feature} | |
| 5473 Maximum number of items to use in a menu. Used for menus that are | |
| 5474 generated from a list of items, e.g., the Buffers menu. Changing this | |
| 5475 option has no direct effect, the menu must be refreshed first. | |
| 5476 | |
| 484 | 5477 *'mkspellmem'* *'msm'* |
| 5478 'mkspellmem' 'msm' string (default "460000,2000,500") | |
| 5479 global | |
| 5480 {not available when compiled without the |+syntax| | |
| 5481 feature} | |
| 5482 Parameters for |:mkspell|. This tunes when to start compressing the | |
| 5483 word tree. Compression can be slow when there are many words, but | |
| 5484 it's needed to avoid running out of memory. The amount of memory used | |
| 5485 per word depends very much on how similar the words are, that's why | |
| 5486 this tuning is complicated. | |
| 5487 | |
| 5488 There are three numbers, separated by commas: | |
| 5489 {start},{inc},{added} | |
| 5490 | |
| 5491 For most languages the uncompressed word tree fits in memory. {start} | |
| 5492 gives the amount of memory in Kbyte that can be used before any | |
| 5493 compression is done. It should be a bit smaller than the amount of | |
| 5494 memory that is available to Vim. | |
| 5495 | |
| 5496 When going over the {start} limit the {inc} number specifies the | |
| 5497 amount of memory in Kbyte that can be allocated before another | |
| 5498 compression is done. A low number means compression is done after | |
| 5499 less words are added, which is slow. A high number means more memory | |
| 5500 will be allocated. | |
| 5501 | |
| 5502 After doing compression, {added} times 1024 words can be added before | |
| 5503 the {inc} limit is ignored and compression is done when any extra | |
| 5504 amount of memory is needed. A low number means there is a smaller | |
| 5505 chance of hitting the {inc} limit, less memory is used but it's | |
| 5506 slower. | |
| 5507 | |
| 5508 The languages for which these numbers are important are Italian and | |
| 5509 Hungarian. The default works for when you have about 512 Mbyte. If | |
| 5510 you have 1 Gbyte you could use: > | |
| 5511 :set mkspellmem=900000,3000,800 | |
| 5512 < If you have less than 512 Mbyte |:mkspell| may fail for some | |
| 5513 languages, no matter what you set 'mkspellmem' to. | |
| 5514 | |
|
16798
63ac51f16ea1
patch 8.1.1401: misspelled mkspellmem as makespellmem
Bram Moolenaar <Bram@vim.org>
parents:
16778
diff
changeset
|
5515 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
|
5516 |
| 7 | 5517 *'modeline'* *'ml'* *'nomodeline'* *'noml'* |
| 1111 | 5518 'modeline' 'ml' boolean (Vim default: on (off for root), |
| 5519 Vi default: off) | |
| 7 | 5520 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
|
5521 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
|
5522 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
|
5523 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
|
5524 |
|
e55c26aaf484
patch 8.1.1366: using expressions in a modeline is unsafe
Bram Moolenaar <Bram@vim.org>
parents:
16610
diff
changeset
|
5525 *'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
|
5526 '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
|
5527 global |
|
e55c26aaf484
patch 8.1.1366: using expressions in a modeline is unsafe
Bram Moolenaar <Bram@vim.org>
parents:
16610
diff
changeset
|
5528 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
|
5529 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
|
5530 '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
|
5531 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
|
5532 security reasons. |
|
16728
e55c26aaf484
patch 8.1.1366: using expressions in a modeline is unsafe
Bram Moolenaar <Bram@vim.org>
parents:
16610
diff
changeset
|
5533 |
| 7 | 5534 *'modelines'* *'mls'* |
| 5535 'modelines' 'mls' number (default 5) | |
| 5536 global | |
| 5537 If 'modeline' is on 'modelines' gives the number of lines that is | |
| 5538 checked for set commands. If 'modeline' is off or 'modelines' is zero | |
| 5539 no lines are checked. See |modeline|. | |
| 5540 NOTE: 'modeline' is set to the Vi default value when 'compatible' is | |
| 5541 set and to the Vim default value when 'compatible' is reset. | |
| 5542 | |
| 5543 *'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
|
5544 *E21* |
| 7 | 5545 'modifiable' 'ma' boolean (default on) |
| 5546 local to buffer | |
| 5547 When off the buffer contents cannot be changed. The 'fileformat' and | |
| 5548 'fileencoding' options also can't be changed. | |
| 10617 | 5549 Can be reset on startup with the |-M| command line argument. |
| 7 | 5550 |
| 5551 *'modified'* *'mod'* *'nomodified'* *'nomod'* | |
| 5552 'modified' 'mod' boolean (default off) | |
| 5553 local to buffer | |
| 5554 When on, the buffer is considered to be modified. This option is set | |
| 5555 when: | |
| 5556 1. A change was made to the text since it was last written. Using the | |
| 5557 |undo| command to go back to the original text will reset the | |
| 5558 option. But undoing changes that were made before writing the | |
| 5559 buffer will set the option again, since the text is different from | |
| 5560 when it was written. | |
| 5561 2. 'fileformat' or 'fileencoding' is different from its original | |
| 5562 value. The original value is set when the buffer is read or | |
| 5563 written. A ":set nomodified" command also resets the original | |
| 5564 values to the current values and the 'modified' option will be | |
| 5565 reset. | |
|
8748
b1a19a2f73f0
commit https://github.com/vim/vim/commit/4f3f668c8486444e53163c29d2fc79bf47eb3c82
Christian Brabandt <cb@256bit.org>
parents:
8629
diff
changeset
|
5566 Similarly for 'eol' and 'bomb'. |
| 3082 | 5567 This option is not set when a change is made to the buffer as the |
| 5568 result of a BufNewFile, BufRead/BufReadPost, BufWritePost, | |
| 5569 FileAppendPost or VimLeave autocommand event. See |gzip-example| for | |
| 5570 an explanation. | |
| 7 | 5571 When 'buftype' is "nowrite" or "nofile" this option may be set, but |
| 5572 will be ignored. | |
| 13437 | 5573 Note that the text may actually be the same, e.g. 'modified' is set |
| 5574 when using "rA" on an "A". | |
| 7 | 5575 |
| 5576 *'more'* *'nomore'* | |
| 5577 'more' boolean (Vim default: on, Vi default: off) | |
| 5578 global | |
| 5579 When on, listings pause when the whole screen is filled. You will get | |
| 5580 the |more-prompt|. When this option is off there are no pauses, the | |
| 5581 listing continues until finished. | |
| 5582 NOTE: This option is set to the Vi default value when 'compatible' is | |
| 5583 set and to the Vim default value when 'compatible' is reset. | |
| 5584 | |
| 23666 | 5585 *'mouse'* |
| 18972 | 5586 '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
|
5587 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
|
5588 global |
| 18972 | 5589 Enable the use of the mouse. Works for most terminals (xterm, Win32 |
| 5590 |win32-mouse|, QNX pterm, *BSD console with sysmouse and Linux console | |
| 5591 with gpm). For using the mouse in the GUI, see |gui-mouse|. The | |
| 5592 mouse can be enabled for different modes: | |
| 12826 | 5593 n Normal mode and Terminal modes |
| 7 | 5594 v Visual mode |
| 5595 i Insert mode | |
| 5596 c Command-line mode | |
| 5597 h all previous modes when editing a help file | |
| 5598 a all previous modes | |
| 5599 r for |hit-enter| and |more-prompt| prompt | |
| 14864 | 5600 Normally you would enable the mouse in all five modes with: > |
| 7 | 5601 :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
|
5602 < 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
|
5603 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
|
5604 :set mouse=nvi |
| 20856 | 5605 < 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
|
5606 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
|
5607 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
|
5608 "xterm". |
|
d7619a9874cd
patch 8.1.2226: cannot use system copy/paste in non-xterm terminals
Bram Moolenaar <Bram@vim.org>
parents:
18463
diff
changeset
|
5609 |
|
d7619a9874cd
patch 8.1.2226: cannot use system copy/paste in non-xterm terminals
Bram Moolenaar <Bram@vim.org>
parents:
18463
diff
changeset
|
5610 When the mouse is not enabled, the GUI will still use the mouse for |
| 7 | 5611 modeless selection. This doesn't move the text cursor. |
| 5612 | |
| 5613 See |mouse-using|. Also see |'clipboard'|. | |
| 5614 | |
| 5615 Note: When enabling the mouse in a terminal, copy/paste will use the | |
| 10 | 5616 "* register if there is access to an X-server. The xterm handling of |
| 7 | 5617 the mouse buttons can still be used by keeping the shift key pressed. |
| 5618 Also see the 'clipboard' option. | |
| 5619 | |
| 5620 *'mousefocus'* *'mousef'* *'nomousefocus'* *'nomousef'* | |
| 5621 'mousefocus' 'mousef' boolean (default off) | |
| 5622 global | |
| 5623 {only works in the GUI} | |
| 5624 The window that the mouse pointer is on is automatically activated. | |
| 5625 When changing the window layout or window focus in another way, the | |
| 5626 mouse pointer is moved to the window with keyboard focus. Off is the | |
| 5627 default because it makes using the pull down menus a little goofy, as | |
| 5628 a pointer transit may activate a window unintentionally. | |
| 18594 | 5629 MS-Windows: Also see 'scrollfocus' for what window is scrolled when |
| 19180 | 5630 using the mouse scroll wheel. |
| 7 | 5631 |
| 5632 *'mousehide'* *'mh'* *'nomousehide'* *'nomh'* | |
| 5633 'mousehide' 'mh' boolean (default on) | |
| 5634 global | |
| 5635 {only works in the GUI} | |
| 5636 When on, the mouse pointer is hidden when characters are typed. | |
| 5637 The mouse pointer is restored when the mouse is moved. | |
| 5638 | |
| 5639 *'mousemodel'* *'mousem'* | |
| 18972 | 5640 'mousemodel' 'mousem' string (default "extend", "popup" for Win32) |
| 7 | 5641 global |
| 5642 Sets the model to use for the mouse. The name mostly specifies what | |
| 5643 the right mouse button is used for: | |
| 5644 extend Right mouse button extends a selection. This works | |
| 5645 like in an xterm. | |
| 5646 popup Right mouse button pops up a menu. The shifted left | |
| 5647 mouse button extends a selection. This works like | |
| 233 | 5648 with Microsoft Windows. |
| 7 | 5649 popup_setpos Like "popup", but the cursor will be moved to the |
| 5650 position where the mouse was clicked, and thus the | |
| 5651 selected operation will act upon the clicked object. | |
| 5652 If clicking inside a selection, that selection will | |
| 233 | 5653 be acted upon, i.e. no cursor move. This implies of |
| 7 | 5654 course, that right clicking outside a selection will |
| 5655 end Visual mode. | |
| 5656 Overview of what button does what for each model: | |
| 5657 mouse extend popup(_setpos) ~ | |
| 5658 left click place cursor place cursor | |
| 5659 left drag start selection start selection | |
| 5660 shift-left search word extend selection | |
| 5661 right click extend selection popup menu (place cursor) | |
| 5662 right drag extend selection - | |
| 5663 middle click paste paste | |
| 5664 | |
| 5665 In the "popup" model the right mouse button produces a pop-up menu. | |
| 5666 You need to define this first, see |popup-menu|. | |
| 5667 | |
| 5668 Note that you can further refine the meaning of buttons with mappings. | |
| 5669 See |gui-mouse-mapping|. But mappings are NOT used for modeless | |
| 5670 selection (because that's handled in the GUI code directly). | |
| 5671 | |
| 5672 The 'mousemodel' option is set by the |:behave| command. | |
| 5673 | |
| 32004 | 5674 *'mousemoveevent'* *'mousemev'* *'nomousemoveevent'* *'nomousemev'* |
|
28297
4190b932e6ca
patch 8.2.4674: cannot force getting MouseMove events
Bram Moolenaar <Bram@vim.org>
parents:
28246
diff
changeset
|
5675 'mousemoveevent' 'mousemev' boolean (default off) |
|
4190b932e6ca
patch 8.2.4674: cannot force getting MouseMove events
Bram Moolenaar <Bram@vim.org>
parents:
28246
diff
changeset
|
5676 global |
|
4190b932e6ca
patch 8.2.4674: cannot force getting MouseMove events
Bram Moolenaar <Bram@vim.org>
parents:
28246
diff
changeset
|
5677 {only works in the GUI} |
|
4190b932e6ca
patch 8.2.4674: cannot force getting MouseMove events
Bram Moolenaar <Bram@vim.org>
parents:
28246
diff
changeset
|
5678 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
|
5679 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
|
5680 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
|
5681 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
|
5682 when the mouse is moved. |
|
4190b932e6ca
patch 8.2.4674: cannot force getting MouseMove events
Bram Moolenaar <Bram@vim.org>
parents:
28246
diff
changeset
|
5683 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
|
5684 later. |
|
4190b932e6ca
patch 8.2.4674: cannot force getting MouseMove events
Bram Moolenaar <Bram@vim.org>
parents:
28246
diff
changeset
|
5685 |
| 7 | 5686 *'mouseshape'* *'mouses'* *E547* |
| 15932 | 5687 'mouseshape' 'mouses' string (default "i-r:beam,s:updown,sd:udsizing, |
| 5688 vs:leftright,vd:lrsizing,m:no, | |
| 5689 ml:up-arrow,v:rightup-arrow") | |
| 7 | 5690 global |
| 5691 {only available when compiled with the |+mouseshape| | |
| 5692 feature} | |
| 5693 This option tells Vim what the mouse pointer should look like in | |
| 28379 | 5694 different modes. The option is a comma-separated list of parts, much |
| 7 | 5695 like used for 'guicursor'. Each part consist of a mode/location-list |
| 5696 and an argument-list: | |
| 5697 mode-list:shape,mode-list:shape,.. | |
| 5698 The mode-list is a dash separated list of these modes/locations: | |
| 5699 In a normal window: ~ | |
| 5700 n Normal mode | |
| 5701 v Visual mode | |
| 5702 ve Visual mode with 'selection' "exclusive" (same as 'v', | |
| 5703 if not specified) | |
| 5704 o Operator-pending mode | |
| 5705 i Insert mode | |
| 5706 r Replace mode | |
| 5707 | |
| 5708 Others: ~ | |
| 5709 c appending to the command-line | |
| 5710 ci inserting in the command-line | |
| 5711 cr replacing in the command-line | |
| 5712 m at the 'Hit ENTER' or 'More' prompts | |
| 5713 ml idem, but cursor in the last line | |
| 5714 e any mode, pointer below last window | |
| 5715 s any mode, pointer on a status line | |
| 5716 sd any mode, while dragging a status line | |
| 5717 vs any mode, pointer on a vertical separator line | |
| 5718 vd any mode, while dragging a vertical separator line | |
| 5719 a everywhere | |
| 5720 | |
| 5721 The shape is one of the following: | |
| 5722 avail name looks like ~ | |
| 5723 w x arrow Normal mouse pointer | |
| 5724 w x blank no pointer at all (use with care!) | |
| 5725 w x beam I-beam | |
| 5726 w x updown up-down sizing arrows | |
| 5727 w x leftright left-right sizing arrows | |
| 5728 w x busy The system's usual busy pointer | |
| 5729 w x no The system's usual 'no input' pointer | |
| 5730 x udsizing indicates up-down resizing | |
| 5731 x lrsizing indicates left-right resizing | |
| 5732 x crosshair like a big thin + | |
| 5733 x hand1 black hand | |
| 5734 x hand2 white hand | |
| 5735 x pencil what you write with | |
| 5736 x question big ? | |
| 5737 x rightup-arrow arrow pointing right-up | |
| 5738 w x up-arrow arrow pointing up | |
| 5739 x <number> any X11 pointer number (see X11/cursorfont.h) | |
| 5740 | |
| 5741 The "avail" column contains a 'w' if the shape is available for Win32, | |
| 5742 x for X11. | |
| 5743 Any modes not specified or shapes not available use the normal mouse | |
| 5744 pointer. | |
| 5745 | |
| 5746 Example: > | |
| 5747 :set mouseshape=s:udsizing,m:no | |
| 5748 < will make the mouse turn to a sizing arrow over the status lines and | |
| 5749 indicate no input when the hit-enter prompt is displayed (since | |
| 5750 clicking the mouse has no effect in this state.) | |
| 5751 | |
| 5752 *'mousetime'* *'mouset'* | |
| 5753 'mousetime' 'mouset' number (default 500) | |
| 5754 global | |
| 18972 | 5755 Only for GUI, Win32 and Unix with xterm. Defines the maximum |
| 7 | 5756 time in msec between two mouse clicks for the second click to be |
| 5757 recognized as a multi click. | |
| 5758 | |
|
12608
b390f5003e2f
patch 8.0.1182: cannot see or change mzscheme dll name
Christian Brabandt <cb@256bit.org>
parents:
12559
diff
changeset
|
5759 *'mzschemedll'* |
|
b390f5003e2f
patch 8.0.1182: cannot see or change mzscheme dll name
Christian Brabandt <cb@256bit.org>
parents:
12559
diff
changeset
|
5760 '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
|
5761 global |
|
b390f5003e2f
patch 8.0.1182: cannot see or change mzscheme dll name
Christian Brabandt <cb@256bit.org>
parents:
12559
diff
changeset
|
5762 {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
|
5763 feature} |
|
b390f5003e2f
patch 8.0.1182: cannot see or change mzscheme dll name
Christian Brabandt <cb@256bit.org>
parents:
12559
diff
changeset
|
5764 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
|
5765 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
|
5766 Environment variables are expanded |:set_env|. |
| 12785 | 5767 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
|
5768 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
|
5769 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
|
5770 security reasons. |
|
b390f5003e2f
patch 8.0.1182: cannot see or change mzscheme dll name
Christian Brabandt <cb@256bit.org>
parents:
12559
diff
changeset
|
5771 |
|
b390f5003e2f
patch 8.0.1182: cannot see or change mzscheme dll name
Christian Brabandt <cb@256bit.org>
parents:
12559
diff
changeset
|
5772 *'mzschemegcdll'* |
|
b390f5003e2f
patch 8.0.1182: cannot see or change mzscheme dll name
Christian Brabandt <cb@256bit.org>
parents:
12559
diff
changeset
|
5773 '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
|
5774 global |
|
b390f5003e2f
patch 8.0.1182: cannot see or change mzscheme dll name
Christian Brabandt <cb@256bit.org>
parents:
12559
diff
changeset
|
5775 {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
|
5776 feature} |
|
b390f5003e2f
patch 8.0.1182: cannot see or change mzscheme dll name
Christian Brabandt <cb@256bit.org>
parents:
12559
diff
changeset
|
5777 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
|
5778 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
|
5779 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
|
5780 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
|
5781 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
|
5782 security reasons. |
|
b390f5003e2f
patch 8.0.1182: cannot see or change mzscheme dll name
Christian Brabandt <cb@256bit.org>
parents:
12559
diff
changeset
|
5783 |
| 14 | 5784 *'mzquantum'* *'mzq'* |
| 5785 'mzquantum' 'mzq' number (default 100) | |
| 5786 global | |
| 5787 {not available when compiled without the |+mzscheme| | |
| 5788 feature} | |
| 5789 The number of milliseconds between polls for MzScheme threads. | |
| 5790 Negative or zero value means no thread scheduling. | |
| 11160 | 5791 NOTE: This option is set to the Vim default value when 'compatible' |
| 5792 is reset. | |
| 14 | 5793 |
| 7 | 5794 *'nrformats'* *'nf'* |
|
9669
284b4eb307fc
commit https://github.com/vim/vim/commit/8c08b5b569e2a9e9f63dea514591ecfa2d3bb392
Christian Brabandt <cb@256bit.org>
parents:
9665
diff
changeset
|
5795 '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
|
5796 set to "bin,hex" in |defaults.vim|) |
| 7 | 5797 local to buffer |
| 5798 This defines what bases Vim will consider for numbers when using the | |
| 5799 CTRL-A and CTRL-X commands for adding to and subtracting from a number | |
| 5800 respectively; see |CTRL-A| for more info on these commands. | |
| 625 | 5801 alpha If included, single alphabetical characters will be |
| 7 | 5802 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
|
5803 letter index a), b), etc. *octal-nrformats* |
| 625 | 5804 octal If included, numbers that start with a zero will be considered |
| 7 | 5805 to be octal. Example: Using CTRL-A on "007" results in "010". |
| 625 | 5806 hex If included, numbers starting with "0x" or "0X" will be |
| 7 | 5807 considered to be hexadecimal. Example: Using CTRL-X on |
| 5808 "0x100" results in "0x0ff". | |
|
7528
53163e4d9e4f
commit https://github.com/vim/vim/commit/25e4fcde767084d1a79e0926bc301c92987c0cce
Christian Brabandt <cb@256bit.org>
parents:
7477
diff
changeset
|
5809 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
|
5810 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
|
5811 "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
|
5812 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
|
5813 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
|
5814 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
|
5815 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
|
5816 (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
|
5817 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
|
5818 (without "unsigned" it would become "9-2019"). |
| 20753 | 5819 Using CTRL-X on "0" or CTRL-A on "18446744073709551615" |
| 5820 (2^64 - 1) has no effect, overflow is prevented. | |
| 7 | 5821 Numbers which simply begin with a digit in the range 1-9 are always |
| 5822 considered decimal. This also happens for numbers that are not | |
| 5823 recognized as octal or hex. | |
| 5824 | |
| 5825 *'number'* *'nu'* *'nonumber'* *'nonu'* | |
| 5826 'number' 'nu' boolean (default off) | |
| 5827 local to window | |
| 5828 Print the line number in front of each line. When the 'n' option is | |
| 5829 excluded from 'cpoptions' a wrapped line will not use the column of | |
| 5830 line numbers (this is the default when 'compatible' isn't set). | |
| 13 | 5831 The 'numberwidth' option can be used to set the room used for the line |
| 5832 number. | |
| 7 | 5833 When a long, wrapped line doesn't start with the first character, '-' |
| 5834 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
|
5835 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
|
5836 |:sign-define| "numhl" argument. |
| 4780 | 5837 *number_relativenumber* |
| 5838 The 'relativenumber' option changes the displayed number to be | |
| 5839 relative to the cursor. Together with 'number' there are these | |
| 5840 four combinations (cursor in line 3): | |
| 5841 | |
|
8629
54ac275e3fc4
commit https://github.com/vim/vim/commit/3848e00e0177abdb31bc600234967863ec487233
Christian Brabandt <cb@256bit.org>
parents:
8560
diff
changeset
|
5842 'nonu' 'nu' 'nonu' 'nu' |
| 4780 | 5843 'nornu' 'nornu' 'rnu' 'rnu' |
| 5844 | |
| 5845 |apple | 1 apple | 2 apple | 2 apple | |
| 5846 |pear | 2 pear | 1 pear | 1 pear | |
| 5847 |nobody | 3 nobody | 0 nobody |3 nobody | |
| 5848 |there | 4 there | 1 there | 1 there | |
| 7 | 5849 |
| 13 | 5850 *'numberwidth'* *'nuw'* |
| 5851 'numberwidth' 'nuw' number (Vim default: 4 Vi default: 8) | |
| 5852 local to window | |
| 14 | 5853 {only available when compiled with the |+linebreak| |
| 5854 feature} | |
| 13 | 5855 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
|
5856 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
|
5857 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
|
5858 the text, there is one less character for the number itself. |
| 13 | 5859 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
|
5860 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
|
5861 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
|
5862 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
|
5863 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
|
5864 The minimum value is 1, the maximum value is 20. |
| 11160 | 5865 NOTE: This option is set to the Vi default value when 'compatible' is |
| 5866 set and to the Vim default value when 'compatible' is reset. | |
| 13 | 5867 |
| 523 | 5868 *'omnifunc'* *'ofu'* |
| 5869 'omnifunc' 'ofu' string (default: empty) | |
| 502 | 5870 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
|
5871 {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
|
5872 feature} |
| 623 | 5873 This option specifies a function to be used for Insert mode omni |
| 5874 completion with CTRL-X CTRL-O. |i_CTRL-X_CTRL-O| | |
| 648 | 5875 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
|
5876 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
|
5877 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
|
5878 more information. |
| 1004 | 5879 This option is usually set by a filetype plugin: |
| 859 | 5880 |:filetype-plugin-on| |
| 3682 | 5881 This option cannot be set from a |modeline| or in the |sandbox|, for |
| 5882 security reasons. | |
| 502 | 5883 |
| 5884 | |
| 1152 | 5885 *'opendevice'* *'odev'* *'noopendevice'* *'noodev'* |
| 1004 | 5886 'opendevice' 'odev' boolean (default off) |
| 5887 global | |
| 27321 | 5888 {only for MS-Windows} *E796* |
| 1004 | 5889 Enable reading and writing from devices. This may get Vim stuck on a |
| 5890 device that can be opened but doesn't actually do the I/O. Therefore | |
| 5891 it is off by default. | |
| 5892 Note that on MS-Windows editing "aux.h", "lpt1.txt" and the like also | |
| 5893 result in editing a device. | |
| 5894 | |
| 5895 | |
| 593 | 5896 *'operatorfunc'* *'opfunc'* |
| 5897 'operatorfunc' 'opfunc' string (default: empty) | |
| 5898 global | |
| 5899 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
|
5900 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
|
5901 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
|
5902 |option-value-function| for more information. |
| 593 | 5903 |
| 5904 This option cannot be set from a |modeline| or in the |sandbox|, for | |
| 5905 security reasons. | |
| 5906 | |
| 5907 | |
| 2908 | 5908 *'osfiletype'* *'oft'* |
| 5909 'osfiletype' 'oft' string (default: "") | |
| 7 | 5910 local to buffer |
| 2908 | 5911 This option was supported on RISC OS, which has been removed. |
| 5912 | |
| 7 | 5913 |
|
8182
95d59081580f
commit https://github.com/vim/vim/commit/f6fee0e2d4341c0c2f5339c1268e5877fafd07cf
Christian Brabandt <cb@256bit.org>
parents:
8148
diff
changeset
|
5914 *'packpath'* *'pp'* |
|
95d59081580f
commit https://github.com/vim/vim/commit/f6fee0e2d4341c0c2f5339c1268e5877fafd07cf
Christian Brabandt <cb@256bit.org>
parents:
8148
diff
changeset
|
5915 'packpath' 'pp' string (default: see 'runtimepath') |
|
95d59081580f
commit https://github.com/vim/vim/commit/f6fee0e2d4341c0c2f5339c1268e5877fafd07cf
Christian Brabandt <cb@256bit.org>
parents:
8148
diff
changeset
|
5916 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
|
5917 |
|
95d59081580f
commit https://github.com/vim/vim/commit/f6fee0e2d4341c0c2f5339c1268e5877fafd07cf
Christian Brabandt <cb@256bit.org>
parents:
8148
diff
changeset
|
5918 |
| 7 | 5919 *'paragraphs'* *'para'* |
| 1564 | 5920 'paragraphs' 'para' string (default "IPLPPPQPP TPHPLIPpLpItpplpipbp") |
| 7 | 5921 global |
| 5922 Specifies the nroff macros that separate paragraphs. These are pairs | |
| 5923 of two letters (see |object-motions|). | |
| 5924 | |
| 5925 *'paste'* *'nopaste'* | |
| 5926 'paste' boolean (default off) | |
| 5927 global | |
| 10 | 5928 Put Vim in Paste mode. This is useful if you want to cut or copy |
| 5929 some text from one window and paste it in Vim. This will avoid | |
| 7 | 5930 unexpected effects. |
| 5931 Setting this option is useful when using Vim in a terminal, where Vim | |
| 10 | 5932 cannot distinguish between typed text and pasted text. In the GUI, Vim |
| 7 | 5933 knows about pasting and will mostly do the right thing without 'paste' |
| 5934 being set. The same is true for a terminal where Vim handles the | |
| 5935 mouse clicks itself. | |
| 148 | 5936 This option is reset when starting the GUI. Thus if you set it in |
| 5937 your .vimrc it will work in a terminal, but not in the GUI. Setting | |
| 5938 'paste' in the GUI has side effects: e.g., the Paste toolbar button | |
| 5939 will no longer work in Insert mode, because it uses a mapping. | |
| 7 | 5940 When the 'paste' option is switched on (also when it was already on): |
| 5941 - mapping in Insert mode and Command-line mode is disabled | |
| 5942 - abbreviations are disabled | |
| 5943 - 'autoindent' is reset | |
|
7147
c590de398af9
commit https://github.com/vim/vim/commit/ca63501fbcd1cf9c8aa9ff12c093c95b62a89ed7
Christian Brabandt <cb@256bit.org>
parents:
7080
diff
changeset
|
5944 - 'expandtab' is reset |
| 25056 | 5945 - 'hkmap' is reset |
| 7 | 5946 - 'revins' is reset |
| 5947 - 'ruler' is reset | |
| 5948 - 'showmatch' is reset | |
|
7147
c590de398af9
commit https://github.com/vim/vim/commit/ca63501fbcd1cf9c8aa9ff12c093c95b62a89ed7
Christian Brabandt <cb@256bit.org>
parents:
7080
diff
changeset
|
5949 - 'smarttab' is reset |
|
c590de398af9
commit https://github.com/vim/vim/commit/ca63501fbcd1cf9c8aa9ff12c093c95b62a89ed7
Christian Brabandt <cb@256bit.org>
parents:
7080
diff
changeset
|
5950 - 'softtabstop' is set to 0 |
|
c590de398af9
commit https://github.com/vim/vim/commit/ca63501fbcd1cf9c8aa9ff12c093c95b62a89ed7
Christian Brabandt <cb@256bit.org>
parents:
7080
diff
changeset
|
5951 - 'textwidth' is set to 0 |
|
c590de398af9
commit https://github.com/vim/vim/commit/ca63501fbcd1cf9c8aa9ff12c093c95b62a89ed7
Christian Brabandt <cb@256bit.org>
parents:
7080
diff
changeset
|
5952 - 'wrapmargin' is set to 0 |
| 25056 | 5953 - 'varsofttabstop' is made empty |
| 7 | 5954 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
|
5955 - 'cindent' |
| 25056 | 5956 - '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
|
5957 - 'indentexpr' |
| 7 | 5958 - 'lisp' |
| 25056 | 5959 - 'smartindent' |
| 7 | 5960 NOTE: When you start editing another file while the 'paste' option is |
| 5961 on, settings from the modelines or autocommands may change the | |
| 5962 settings again, causing trouble when pasting text. You might want to | |
| 5963 set the 'paste' option again. | |
| 5964 When the 'paste' option is reset the mentioned options are restored to | |
| 5965 the value before the moment 'paste' was switched from off to on. | |
| 5966 Resetting 'paste' before ever setting it does not have any effect. | |
| 5967 Since mapping doesn't work while 'paste' is active, you need to use | |
| 5968 the 'pastetoggle' option to toggle the 'paste' option with some key. | |
| 5969 | |
| 5970 *'pastetoggle'* *'pt'* | |
| 5971 'pastetoggle' 'pt' string (default "") | |
| 5972 global | |
| 5973 When non-empty, specifies the key sequence that toggles the 'paste' | |
| 5974 option. This is like specifying a mapping: > | |
| 5975 :map {keys} :set invpaste<CR> | |
| 5976 < Where {keys} is the value of 'pastetoggle'. | |
| 5977 The difference is that it will work even when 'paste' is set. | |
| 5978 'pastetoggle' works in Insert mode and Normal mode, but not in | |
| 5979 Command-line mode. | |
| 5980 Mappings are checked first, thus overrule 'pastetoggle'. However, | |
| 5981 when 'paste' is on mappings are ignored in Insert mode, thus you can do | |
| 5982 this: > | |
| 5983 :map <F10> :set paste<CR> | |
| 5984 :map <F11> :set nopaste<CR> | |
| 5985 :imap <F10> <C-O>:set paste<CR> | |
| 5986 :imap <F11> <nop> | |
| 5987 :set pastetoggle=<F11> | |
| 5988 < This will make <F10> start paste mode and <F11> stop paste mode. | |
| 5989 Note that typing <F10> in paste mode inserts "<F10>", since in paste | |
| 5990 mode everything is inserted literally, except the 'pastetoggle' key | |
| 5991 sequence. | |
| 1621 | 5992 When the value has several bytes 'ttimeoutlen' applies. |
| 7 | 5993 |
| 5994 *'pex'* *'patchexpr'* | |
| 5995 'patchexpr' 'pex' string (default "") | |
| 5996 global | |
| 5997 {not available when compiled without the |+diff| | |
| 5998 feature} | |
| 5999 Expression which is evaluated to apply a patch to a file and generate | |
| 10 | 6000 the resulting new version of the file. See |diff-patchexpr|. |
| 7 | 6001 |
|
6091
7090d7f160f7
Update runtime files. Add vroom file support.
Bram Moolenaar <bram@vim.org>
parents:
6032
diff
changeset
|
6002 *'patchmode'* *'pm'* *E205* *E206* |
| 7 | 6003 'patchmode' 'pm' string (default "") |
| 6004 global | |
| 6005 When non-empty the oldest version of a file is kept. This can be used | |
| 6006 to keep the original version of a file if you are changing files in a | |
| 6007 source distribution. Only the first time that a file is written a | |
| 6008 copy of the original file will be kept. The name of the copy is the | |
| 6009 name of the original file with the string in the 'patchmode' option | |
| 6010 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
|
6011 ".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
|
6012 (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
|
6013 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
|
6014 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
|
6015 empty file is created. |
| 7 | 6016 When the 'backupskip' pattern matches, a patchmode file is not made. |
| 6017 Using 'patchmode' for compressed files appends the extension at the | |
| 6018 end (e.g., "file.gz.orig"), thus the resulting name isn't always | |
| 6019 recognized as a compressed file. | |
| 36 | 6020 Only normal file name characters can be used, "/\*?[|<>" are illegal. |
| 7 | 6021 |
| 3224 | 6022 *'path'* *'pa'* *E343* *E345* *E347* *E854* |
| 7 | 6023 'path' 'pa' string (default on Unix: ".,/usr/include,," |
| 6024 other systems: ".,,") | |
| 6025 global or local to buffer |global-local| | |
| 6026 This is a list of directories which will be searched when using the | |
| 1668 | 6027 |gf|, [f, ]f, ^Wf, |:find|, |:sfind|, |:tabfind| and other commands, |
| 6028 provided that the file being searched for has a relative path (not | |
| 6029 starting with "/", "./" or "../"). The directories in the 'path' | |
| 6030 option may be relative or absolute. | |
| 7 | 6031 - Use commas to separate directory names: > |
| 6032 :set path=.,/usr/local/include,/usr/include | |
| 6033 < - Spaces can also be used to separate directory names (for backwards | |
| 6034 compatibility with version 3.0). To have a space in a directory | |
| 6035 name, precede it with an extra backslash, and escape the space: > | |
| 6036 :set path=.,/dir/with\\\ space | |
| 6037 < - To include a comma in a directory name precede it with an extra | |
| 6038 backslash: > | |
| 6039 :set path=.,/dir/with\\,comma | |
| 6040 < - To search relative to the directory of the current file, use: > | |
| 6041 :set path=. | |
| 6042 < - To search in the current directory use an empty string between two | |
| 6043 commas: > | |
| 6044 :set path=,, | |
| 6045 < - A directory name may end in a ':' or '/'. | |
| 6046 - Environment variables are expanded |:set_env|. | |
| 6047 - When using |netrw.vim| URLs can be used. For example, adding | |
| 6048 "http://www.vim.org" will make ":find index.html" work. | |
| 1668 | 6049 - Search upwards and downwards in a directory tree using "*", "**" and |
| 6050 ";". See |file-searching| for info and syntax. | |
| 7 | 6051 - Careful with '\' characters, type two to get one in the option: > |
| 6052 :set path=.,c:\\include | |
| 6053 < Or just use '/' instead: > | |
| 6054 :set path=.,c:/include | |
| 6055 < Don't forget "." or files won't even be found in the same directory as | |
| 6056 the file! | |
| 10 | 6057 The maximum length is limited. How much depends on the system, mostly |
| 7 | 6058 it is something like 256 or 1024 characters. |
| 6059 You can check if all the include files are found, using the value of | |
| 6060 'path', see |:checkpath|. | |
| 6061 The use of |:set+=| and |:set-=| is preferred when adding or removing | |
| 6062 directories from the list. This avoids problems when a future version | |
| 6063 uses another default. To remove the current directory use: > | |
| 6064 :set path-= | |
| 6065 < To add the current directory use: > | |
| 6066 :set path+= | |
| 6067 < To use an environment variable, you probably need to replace the | |
| 6068 separator. Here is an example to append $INCL, in which directory | |
| 6069 names are separated with a semi-colon: > | |
| 27903 | 6070 :let &path = &path .. "," .. substitute($INCL, ';', ',', 'g') |
| 7 | 6071 < Replace the ';' with a ':' or whatever separator is used. Note that |
| 6072 this doesn't work when $INCL contains a comma or white space. | |
| 6073 | |
| 12499 | 6074 *'perldll'* |
| 6075 'perldll' string (default depends on the build) | |
| 6076 global | |
| 6077 {only available when compiled with the |+perl/dyn| | |
| 6078 feature} | |
| 6079 Specifies the name of the Perl shared library. The default is | |
| 6080 DYNAMIC_PERL_DLL, which was specified at compile time. | |
| 6081 Environment variables are expanded |:set_env|. | |
| 6082 This option cannot be set from a |modeline| or in the |sandbox|, for | |
| 6083 security reasons. | |
| 6084 | |
| 7 | 6085 *'preserveindent'* *'pi'* *'nopreserveindent'* *'nopi'* |
| 6086 'preserveindent' 'pi' boolean (default off) | |
| 6087 local to buffer | |
| 6088 When changing the indent of the current line, preserve as much of the | |
| 6089 indent structure as possible. Normally the indent is replaced by a | |
| 6090 series of tabs followed by spaces as required (unless |'expandtab'| is | |
| 6091 enabled, in which case only spaces are used). Enabling this option | |
| 6092 means the indent will preserve as many existing characters as possible | |
| 6093 for indenting, and only add additional tabs or spaces as required. | |
| 1621 | 6094 'expandtab' does not apply to the preserved white space, a Tab remains |
| 6095 a Tab. | |
| 7 | 6096 NOTE: When using ">>" multiple times the resulting indent is a mix of |
| 6097 tabs and spaces. You might not like this. | |
| 11160 | 6098 NOTE: This option is reset when 'compatible' is set. |
| 7 | 6099 Also see 'copyindent'. |
| 6100 Use |:retab| to clean up white space. | |
| 6101 | |
| 6102 *'previewheight'* *'pvh'* | |
| 6103 'previewheight' 'pvh' number (default 12) | |
| 6104 global | |
|
17771
4bd21046902b
patch 8.1.1882: cannot specify properties of the info popup window
Bram Moolenaar <Bram@vim.org>
parents:
17767
diff
changeset
|
6105 {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
|
6106 feature} |
| 7 | 6107 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
|
6108 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
|
6109 '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
|
6110 |
|
ce35cdbe9f74
patch 8.1.1714: cannot preview a file in a popup window
Bram Moolenaar <Bram@vim.org>
parents:
17372
diff
changeset
|
6111 *'previewpopup'* *'pvp'* |
|
ce35cdbe9f74
patch 8.1.1714: cannot preview a file in a popup window
Bram Moolenaar <Bram@vim.org>
parents:
17372
diff
changeset
|
6112 '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
|
6113 global |
|
17771
4bd21046902b
patch 8.1.1882: cannot specify properties of the info popup window
Bram Moolenaar <Bram@vim.org>
parents:
17767
diff
changeset
|
6114 {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
|
6115 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
|
6116 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
|
6117 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
|
6118 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
|
6119 'completeopt' for that. |
| 7 | 6120 |
| 6121 *'previewwindow'* *'nopreviewwindow'* | |
| 6122 *'pvw'* *'nopvw'* *E590* | |
| 6123 'previewwindow' 'pvw' boolean (default off) | |
| 6124 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
|
6125 {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
|
6126 feature} |
| 10 | 6127 Identifies the preview window. Only one window can have this option |
| 7 | 6128 set. It's normally not set directly, but by using one of the commands |
| 6129 |:ptag|, |:pedit|, etc. | |
| 6130 | |
| 6131 *'printdevice'* *'pdev'* | |
| 6132 'printdevice' 'pdev' string (default empty) | |
| 6133 global | |
| 6134 {only available when compiled with the |+printer| | |
| 6135 feature} | |
| 15 | 6136 The name of the printer to be used for |:hardcopy|. |
| 6137 See |pdev-option|. | |
| 36 | 6138 This option cannot be set from a |modeline| or in the |sandbox|, for |
| 6139 security reasons. | |
| 15 | 6140 |
| 6141 *'printencoding'* *'penc'* | |
| 14864 | 6142 'printencoding' 'penc' string (default empty, except for some systems) |
| 7 | 6143 global |
| 6144 {only available when compiled with the |+printer| | |
| 6145 and |+postscript| features} | |
| 15 | 6146 Sets the character encoding used when printing. |
| 6147 See |penc-option|. | |
| 7 | 6148 |
| 6149 *'printexpr'* *'pexpr'* | |
| 14864 | 6150 'printexpr' 'pexpr' string (default: see below) |
| 7 | 6151 global |
| 6152 {only available when compiled with the |+printer| | |
| 6153 and |+postscript| features} | |
| 15 | 6154 Expression used to print the PostScript produced with |:hardcopy|. |
| 6155 See |pexpr-option|. | |
|
10449
222b1432814e
commit https://github.com/vim/vim/commit/5162822914372fc916a93f85848c0c82209e7cec
Christian Brabandt <cb@256bit.org>
parents:
10272
diff
changeset
|
6156 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
|
6157 security reasons. |
| 15 | 6158 |
| 6159 *'printfont'* *'pfn'* | |
| 7 | 6160 'printfont' 'pfn' string (default "courier") |
| 6161 global | |
| 6162 {only available when compiled with the |+printer| | |
| 6163 feature} | |
| 15 | 6164 The name of the font that will be used for |:hardcopy|. |
| 6165 See |pfn-option|. | |
| 7 | 6166 |
| 6167 *'printheader'* *'pheader'* | |
| 6168 'printheader' 'pheader' string (default "%<%f%h%m%=Page %N") | |
| 6169 global | |
| 6170 {only available when compiled with the |+printer| | |
| 6171 feature} | |
| 15 | 6172 The format of the header produced in |:hardcopy| output. |
| 6173 See |pheader-option|. | |
| 6174 | |
| 6175 *'printmbcharset'* *'pmbcs'* | |
| 6176 'printmbcharset' 'pmbcs' string (default "") | |
| 6177 global | |
| 15878 | 6178 {only available when compiled with the |+printer| |
| 6179 and |+postscript| features} | |
| 15 | 6180 The CJK character set to be used for CJK output from |:hardcopy|. |
| 6181 See |pmbcs-option|. | |
| 6182 | |
| 6183 *'printmbfont'* *'pmbfn'* | |
| 6184 'printmbfont' 'pmbfn' string (default "") | |
| 6185 global | |
| 15878 | 6186 {only available when compiled with the |+printer| |
| 6187 and |+postscript| features} | |
| 15 | 6188 List of font names to be used for CJK output from |:hardcopy|. |
| 6189 See |pmbfn-option|. | |
| 7 | 6190 |
| 6191 *'printoptions'* *'popt'* | |
| 6192 'printoptions' 'popt' string (default "") | |
| 6193 global | |
| 6194 {only available when compiled with |+printer| feature} | |
| 15 | 6195 List of items that control the format of the output of |:hardcopy|. |
| 6196 See |popt-option|. | |
| 6197 | |
| 168 | 6198 *'prompt'* *'noprompt'* |
| 6199 'prompt' boolean (default on) | |
| 6200 global | |
| 6201 When on a ":" prompt is used in Ex mode. | |
| 6202 | |
| 766 | 6203 *'pumheight'* *'ph'* |
| 6204 'pumheight' 'ph' number (default 0) | |
| 6205 global | |
| 853 | 6206 Determines the maximum number of items to show in the popup menu for |
| 6207 Insert mode completion. When zero as much space as available is used. | |
| 766 | 6208 |ins-completion-menu|. |
| 6209 | |
|
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
|
6210 *'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
|
6211 '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
|
6212 global |
|
13341
acd7eaa13d2b
Updated runtime files.
Christian Brabandt <cb@256bit.org>
parents:
13314
diff
changeset
|
6213 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
|
6214 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
|
6215 |
|
7228
873eae260c97
commit https://github.com/vim/vim/commit/b4ff518d95aa57c2f8c0568c915035bef849581b
Christian Brabandt <cb@256bit.org>
parents:
7218
diff
changeset
|
6216 *'pythondll'* |
|
8629
54ac275e3fc4
commit https://github.com/vim/vim/commit/3848e00e0177abdb31bc600234967863ec487233
Christian Brabandt <cb@256bit.org>
parents:
8560
diff
changeset
|
6217 '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
|
6218 global |
|
7228
873eae260c97
commit https://github.com/vim/vim/commit/b4ff518d95aa57c2f8c0568c915035bef849581b
Christian Brabandt <cb@256bit.org>
parents:
7218
diff
changeset
|
6219 {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
|
6220 feature} |
|
7528
53163e4d9e4f
commit https://github.com/vim/vim/commit/25e4fcde767084d1a79e0926bc301c92987c0cce
Christian Brabandt <cb@256bit.org>
parents:
7477
diff
changeset
|
6221 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
|
6222 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
|
6223 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
|
6224 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
|
6225 security reasons. |
|
873eae260c97
commit https://github.com/vim/vim/commit/b4ff518d95aa57c2f8c0568c915035bef849581b
Christian Brabandt <cb@256bit.org>
parents:
7218
diff
changeset
|
6226 |
|
13154
53cc7ea77c54
patch 8.0.1451: difficult to set the python home directories properly
Christian Brabandt <cb@256bit.org>
parents:
13150
diff
changeset
|
6227 *'pythonhome'* |
|
53cc7ea77c54
patch 8.0.1451: difficult to set the python home directories properly
Christian Brabandt <cb@256bit.org>
parents:
13150
diff
changeset
|
6228 '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
|
6229 global |
|
53cc7ea77c54
patch 8.0.1451: difficult to set the python home directories properly
Christian Brabandt <cb@256bit.org>
parents:
13150
diff
changeset
|
6230 {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
|
6231 feature} |
|
53cc7ea77c54
patch 8.0.1451: difficult to set the python home directories properly
Christian Brabandt <cb@256bit.org>
parents:
13150
diff
changeset
|
6232 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
|
6233 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
|
6234 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
|
6235 home directory. |
|
53cc7ea77c54
patch 8.0.1451: difficult to set the python home directories properly
Christian Brabandt <cb@256bit.org>
parents:
13150
diff
changeset
|
6236 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
|
6237 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
|
6238 security reasons. |
|
53cc7ea77c54
patch 8.0.1451: difficult to set the python home directories properly
Christian Brabandt <cb@256bit.org>
parents:
13150
diff
changeset
|
6239 |
|
7218
36dc8df8560f
commit https://github.com/vim/vim/commit/0796c0625fa4b9eb2f47fe8c976b78523924e1fb
Christian Brabandt <cb@256bit.org>
parents:
7196
diff
changeset
|
6240 *'pythonthreedll'* |
|
7528
53163e4d9e4f
commit https://github.com/vim/vim/commit/25e4fcde767084d1a79e0926bc301c92987c0cce
Christian Brabandt <cb@256bit.org>
parents:
7477
diff
changeset
|
6241 '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
|
6242 global |
|
7196
42717d048817
commit https://github.com/vim/vim/commit/d94464ee294a351ce7b6ba18e8bd3f24f1bef920
Christian Brabandt <cb@256bit.org>
parents:
7147
diff
changeset
|
6243 {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
|
6244 feature} |
|
7528
53163e4d9e4f
commit https://github.com/vim/vim/commit/25e4fcde767084d1a79e0926bc301c92987c0cce
Christian Brabandt <cb@256bit.org>
parents:
7477
diff
changeset
|
6245 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
|
6246 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
|
6247 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
|
6248 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
|
6249 security reasons. |
|
42717d048817
commit https://github.com/vim/vim/commit/d94464ee294a351ce7b6ba18e8bd3f24f1bef920
Christian Brabandt <cb@256bit.org>
parents:
7147
diff
changeset
|
6250 |
|
13154
53cc7ea77c54
patch 8.0.1451: difficult to set the python home directories properly
Christian Brabandt <cb@256bit.org>
parents:
13150
diff
changeset
|
6251 *'pythonthreehome'* |
|
53cc7ea77c54
patch 8.0.1451: difficult to set the python home directories properly
Christian Brabandt <cb@256bit.org>
parents:
13150
diff
changeset
|
6252 '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
|
6253 global |
|
53cc7ea77c54
patch 8.0.1451: difficult to set the python home directories properly
Christian Brabandt <cb@256bit.org>
parents:
13150
diff
changeset
|
6254 {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
|
6255 feature} |
|
53cc7ea77c54
patch 8.0.1451: difficult to set the python home directories properly
Christian Brabandt <cb@256bit.org>
parents:
13150
diff
changeset
|
6256 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
|
6257 '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
|
6258 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
|
6259 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
|
6260 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
|
6261 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
|
6262 security reasons. |
|
53cc7ea77c54
patch 8.0.1451: difficult to set the python home directories properly
Christian Brabandt <cb@256bit.org>
parents:
13150
diff
changeset
|
6263 |
|
10722
7598ce51bf2a
patch 8.0.0251: not easy to select Python 2 or 3
Christian Brabandt <cb@256bit.org>
parents:
10617
diff
changeset
|
6264 *'pyxversion'* *'pyx'* |
|
7598ce51bf2a
patch 8.0.0251: not easy to select Python 2 or 3
Christian Brabandt <cb@256bit.org>
parents:
10617
diff
changeset
|
6265 '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
|
6266 global |
|
7598ce51bf2a
patch 8.0.0251: not easy to select Python 2 or 3
Christian Brabandt <cb@256bit.org>
parents:
10617
diff
changeset
|
6267 {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
|
6268 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
|
6269 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
|
6270 |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
|
6271 |
|
7598ce51bf2a
patch 8.0.0251: not easy to select Python 2 or 3
Christian Brabandt <cb@256bit.org>
parents:
10617
diff
changeset
|
6272 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
|
6273 |+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
|
6274 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
|
6275 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
|
6276 |
|
7598ce51bf2a
patch 8.0.0251: not easy to select Python 2 or 3
Christian Brabandt <cb@256bit.org>
parents:
10617
diff
changeset
|
6277 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
|
6278 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
|
6279 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
|
6280 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
|
6281 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
|
6282 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
|
6283 |
|
7598ce51bf2a
patch 8.0.0251: not easy to select Python 2 or 3
Christian Brabandt <cb@256bit.org>
parents:
10617
diff
changeset
|
6284 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
|
6285 '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
|
6286 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
|
6287 |
|
7598ce51bf2a
patch 8.0.0251: not easy to select Python 2 or 3
Christian Brabandt <cb@256bit.org>
parents:
10617
diff
changeset
|
6288 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
|
6289 security reasons. |
|
7598ce51bf2a
patch 8.0.0251: not easy to select Python 2 or 3
Christian Brabandt <cb@256bit.org>
parents:
10617
diff
changeset
|
6290 |
|
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
|
6291 *'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
|
6292 '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
|
6293 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
|
6294 {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
|
6295 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
|
6296 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
|
6297 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
|
6298 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
|
6299 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
|
6300 |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
|
6301 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
|
6302 |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
|
6303 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
|
6304 |
|
d6827bd31d1d
patch 8.2.0869: it is not possible to customize the quickfix window contents
Bram Moolenaar <Bram@vim.org>
parents:
20613
diff
changeset
|
6305 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
|
6306 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
|
6307 |
| 140 | 6308 *'quoteescape'* *'qe'* |
| 12 | 6309 'quoteescape' 'qe' string (default "\") |
| 6310 local to buffer | |
| 6311 The characters that are used to escape quotes in a string. Used for | |
| 6312 objects like a', a" and a` |a'|. | |
| 6313 When one of the characters in this option is found inside a string, | |
| 6314 the following character will be skipped. The default value makes the | |
| 6315 text "foo\"bar\\" considered to be one string. | |
| 6316 | |
| 7 | 6317 *'readonly'* *'ro'* *'noreadonly'* *'noro'* |
| 6318 'readonly' 'ro' boolean (default off) | |
| 6319 local to buffer | |
| 6320 If on, writes fail unless you use a '!'. Protects you from | |
| 6321 accidentally overwriting a file. Default on when Vim is started | |
| 6322 in read-only mode ("vim -R") or when the executable is called "view". | |
| 164 | 6323 When using ":w!" the 'readonly' option is reset for the current |
| 6324 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
|
6325 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
|
6326 newly edited buffer. |
| 10617 | 6327 See 'modifiable' for disallowing changes to the buffer. |
| 7 | 6328 |
| 1521 | 6329 *'redrawtime'* *'rdt'* |
| 6330 'redrawtime' 'rdt' number (default 2000) | |
| 6331 global | |
| 6332 {only available when compiled with the |+reltime| | |
| 6333 feature} | |
| 6334 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
|
6335 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
|
6336 highlighting. |
| 1521 | 6337 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
|
6338 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
|
6339 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
|
6340 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
|
6341 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
|
6342 pattern. |
| 1521 | 6343 |
|
4681
2eb30f341e8d
Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents:
4502
diff
changeset
|
6344 *'regexpengine'* *'re'* |
|
4502
605c9ce57ec3
Updated runtime files, language files and translations.
Bram Moolenaar <bram@vim.org>
parents:
4358
diff
changeset
|
6345 'regexpengine' 're' number (default 0) |
|
605c9ce57ec3
Updated runtime files, language files and translations.
Bram Moolenaar <bram@vim.org>
parents:
4358
diff
changeset
|
6346 global |
|
605c9ce57ec3
Updated runtime files, language files and translations.
Bram Moolenaar <bram@vim.org>
parents:
4358
diff
changeset
|
6347 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
|
6348 The possible values are: |
|
605c9ce57ec3
Updated runtime files, language files and translations.
Bram Moolenaar <bram@vim.org>
parents:
4358
diff
changeset
|
6349 0 automatic selection |
|
605c9ce57ec3
Updated runtime files, language files and translations.
Bram Moolenaar <bram@vim.org>
parents:
4358
diff
changeset
|
6350 1 old engine |
|
605c9ce57ec3
Updated runtime files, language files and translations.
Bram Moolenaar <bram@vim.org>
parents:
4358
diff
changeset
|
6351 2 NFA engine |
|
605c9ce57ec3
Updated runtime files, language files and translations.
Bram Moolenaar <bram@vim.org>
parents:
4358
diff
changeset
|
6352 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
|
6353 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
|
6354 for debugging the regexp engine. |
| 6328 | 6355 Using automatic selection enables Vim to switch the engine, if the |
| 6356 default engine becomes too costly. E.g., when the NFA engine uses too | |
| 6357 many states. This should prevent Vim from hanging on a combination of | |
| 6358 a complex pattern with long text. | |
|
4502
605c9ce57ec3
Updated runtime files, language files and translations.
Bram Moolenaar <bram@vim.org>
parents:
4358
diff
changeset
|
6359 |
|
2178
c6f1aa1e9f32
Add 'relativenumber' patch from Markus Heidelberg.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
6360 *'relativenumber'* *'rnu'* *'norelativenumber'* *'nornu'* |
|
c6f1aa1e9f32
Add 'relativenumber' patch from Markus Heidelberg.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
6361 'relativenumber' 'rnu' boolean (default off) |
|
c6f1aa1e9f32
Add 'relativenumber' patch from Markus Heidelberg.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
6362 local to window |
|
c6f1aa1e9f32
Add 'relativenumber' patch from Markus Heidelberg.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
6363 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
|
6364 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
|
6365 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
|
6366 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
|
6367 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
|
6368 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
|
6369 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
|
6370 'compatible' isn't set). |
|
c6f1aa1e9f32
Add 'relativenumber' patch from Markus Heidelberg.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
6371 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
|
6372 number. |
|
c6f1aa1e9f32
Add 'relativenumber' patch from Markus Heidelberg.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
6373 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
|
6374 characters are put before the number. |
| 3445 | 6375 See |hl-LineNr| and |hl-CursorLineNr| for the highlighting used for |
| 6376 the number. | |
|
13341
acd7eaa13d2b
Updated runtime files.
Christian Brabandt <cb@256bit.org>
parents:
13314
diff
changeset
|
6377 |
| 4780 | 6378 The number in front of the cursor line also depends on the value of |
| 6379 'number', see |number_relativenumber| for all combinations of the two | |
| 6380 options. | |
|
2178
c6f1aa1e9f32
Add 'relativenumber' patch from Markus Heidelberg.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
6381 |
| 7 | 6382 *'remap'* *'noremap'* |
| 6383 'remap' boolean (default on) | |
| 6384 global | |
| 6385 Allows for mappings to work recursively. If you do not want this for | |
| 6386 a single entry, use the :noremap[!] command. | |
| 717 | 6387 NOTE: To avoid portability problems with Vim scripts, always keep |
| 6388 this option at the default "on". Only switch it off when working with | |
| 6389 old Vi scripts. | |
| 7 | 6390 |
| 6110 | 6391 *'renderoptions'* *'rop'* |
| 6392 'renderoptions' 'rop' string (default: empty) | |
| 6393 global | |
| 6394 {only available when compiled with GUI and DIRECTX on | |
| 6395 MS-Windows} | |
| 6396 Select a text renderer and set its options. The options depend on the | |
| 6397 renderer. | |
| 6398 | |
| 6399 Syntax: > | |
| 6400 set rop=type:{renderer}(,{name}:{value})* | |
| 6401 < | |
| 6402 Currently, only one optional renderer is available. | |
| 6403 | |
| 6404 render behavior ~ | |
| 6405 directx Vim will draw text using DirectX (DirectWrite). It makes | |
| 6406 drawn glyphs more beautiful than default GDI. | |
| 6407 It requires 'encoding' is "utf-8", and only works on | |
| 6408 MS-Windows Vista or newer version. | |
| 6409 | |
| 6410 Options: | |
| 6411 name meaning type value ~ | |
| 6412 gamma gamma float 1.0 - 2.2 (maybe) | |
| 6413 contrast enhancedContrast float (unknown) | |
| 6414 level clearTypeLevel float (unknown) | |
| 6415 geom pixelGeometry int 0 - 2 (see below) | |
| 6416 renmode renderingMode int 0 - 6 (see below) | |
| 6417 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
|
6418 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
|
6419 |
|
18e6f4addce9
patch 8.0.1369: MS-Windows: drawing underline slow, mFallbackDC not updated
Christian Brabandt <cb@256bit.org>
parents:
12971
diff
changeset
|
6420 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
|
6421 https://msdn.microsoft.com/en-us/library/dd368190.aspx |
| 6110 | 6422 |
| 6423 For geom: structure of a device pixel. | |
| 6424 0 - DWRITE_PIXEL_GEOMETRY_FLAT | |
| 6425 1 - DWRITE_PIXEL_GEOMETRY_RGB | |
| 6426 2 - DWRITE_PIXEL_GEOMETRY_BGR | |
| 6427 | |
| 6428 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
|
6429 https://msdn.microsoft.com/en-us/library/dd368114.aspx |
| 6110 | 6430 |
| 6431 For renmode: method of rendering glyphs. | |
| 6432 0 - DWRITE_RENDERING_MODE_DEFAULT | |
| 6433 1 - DWRITE_RENDERING_MODE_ALIASED | |
| 6434 2 - DWRITE_RENDERING_MODE_GDI_CLASSIC | |
| 6435 3 - DWRITE_RENDERING_MODE_GDI_NATURAL | |
| 6436 4 - DWRITE_RENDERING_MODE_NATURAL | |
| 6437 5 - DWRITE_RENDERING_MODE_NATURAL_SYMMETRIC | |
| 6438 6 - DWRITE_RENDERING_MODE_OUTLINE | |
| 6439 | |
| 6440 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
|
6441 https://msdn.microsoft.com/en-us/library/dd368118.aspx |
| 6110 | 6442 |
| 6443 For taamode: antialiasing mode used for drawing text. | |
| 6444 0 - D2D1_TEXT_ANTIALIAS_MODE_DEFAULT | |
| 6445 1 - D2D1_TEXT_ANTIALIAS_MODE_CLEARTYPE | |
| 6446 2 - D2D1_TEXT_ANTIALIAS_MODE_GRAYSCALE | |
| 6447 3 - D2D1_TEXT_ANTIALIAS_MODE_ALIASED | |
| 6448 | |
| 6449 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
|
6450 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
|
6451 |
|
13150
808625d4b71b
patch 8.0.1449: slow redrawing with DirectX
Christian Brabandt <cb@256bit.org>
parents:
13100
diff
changeset
|
6452 For scrlines: |
|
808625d4b71b
patch 8.0.1449: slow redrawing with DirectX
Christian Brabandt <cb@256bit.org>
parents:
13100
diff
changeset
|
6453 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
|
6454 is now deprecated. If specified, it is simply ignored. |
| 6110 | 6455 |
| 6456 Example: > | |
| 6457 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
|
6458 set gfn=Ricty_Diminished:h12 |
| 6110 | 6459 set rop=type:directx |
| 6460 < | |
|
12934
2ebc3df65ca2
patch 8.0.1343: MS-Windows: does not show colored emojis
Christian Brabandt <cb@256bit.org>
parents:
12930
diff
changeset
|
6461 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
|
6462 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
|
6463 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
|
6464 |
|
2ebc3df65ca2
patch 8.0.1343: MS-Windows: does not show colored emojis
Christian Brabandt <cb@256bit.org>
parents:
12930
diff
changeset
|
6465 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
|
6466 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
|
6467 |
|
12986
18e6f4addce9
patch 8.0.1369: MS-Windows: drawing underline slow, mFallbackDC not updated
Christian Brabandt <cb@256bit.org>
parents:
12971
diff
changeset
|
6468 - '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
|
6469 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
|
6470 bitmap glyphs). |
|
2ebc3df65ca2
patch 8.0.1343: MS-Windows: does not show colored emojis
Christian Brabandt <cb@256bit.org>
parents:
12930
diff
changeset
|
6471 - '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
|
6472 |
|
2ebc3df65ca2
patch 8.0.1343: MS-Windows: does not show colored emojis
Christian Brabandt <cb@256bit.org>
parents:
12930
diff
changeset
|
6473 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
|
6474 (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
|
6475 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
|
6476 |
|
2ebc3df65ca2
patch 8.0.1343: MS-Windows: does not show colored emojis
Christian Brabandt <cb@256bit.org>
parents:
12930
diff
changeset
|
6477 - 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
|
6478 be used. |
|
2ebc3df65ca2
patch 8.0.1343: MS-Windows: does not show colored emojis
Christian Brabandt <cb@256bit.org>
parents:
12930
diff
changeset
|
6479 - 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
|
6480 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
|
6481 will be used. |
|
2ebc3df65ca2
patch 8.0.1343: MS-Windows: does not show colored emojis
Christian Brabandt <cb@256bit.org>
parents:
12930
diff
changeset
|
6482 - 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
|
6483 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
|
6484 cell. |
| 6110 | 6485 |
| 6486 Other render types are currently not supported. | |
| 6487 | |
| 7 | 6488 *'report'* |
| 6489 'report' number (default 2) | |
| 6490 global | |
| 6491 Threshold for reporting number of lines changed. When the number of | |
| 6492 changed lines is more than 'report' a message will be given for most | |
| 6493 ":" commands. If you want it always, set 'report' to 0. | |
| 6494 For the ":substitute" command the number of substitutions is used | |
| 6495 instead of the number of lines. | |
| 6496 | |
| 6497 *'restorescreen'* *'rs'* *'norestorescreen'* *'nors'* | |
| 6498 'restorescreen' 'rs' boolean (default on) | |
| 6499 global | |
| 19116 | 6500 {only in MS-Windows console version} |
| 7 | 6501 When set, the screen contents is restored when exiting Vim. This also |
| 6502 happens when executing external commands. | |
| 6503 | |
| 6504 For non-Windows Vim: You can set or reset the 't_ti' and 't_te' | |
| 6505 options in your .vimrc. To disable restoring: | |
| 6506 set t_ti= t_te= | |
| 6507 To enable restoring (for an xterm): | |
| 6508 set t_ti=^[7^[[r^[[?47h t_te=^[[?47l^[8 | |
| 6509 (Where ^[ is an <Esc>, type CTRL-V <Esc> to insert it) | |
| 6510 | |
| 6511 *'revins'* *'ri'* *'norevins'* *'nori'* | |
| 6512 'revins' 'ri' boolean (default off) | |
| 6513 global | |
| 6514 {only available when compiled with the |+rightleft| | |
| 6515 feature} | |
| 6516 Inserting characters in Insert mode will work backwards. See "typing | |
| 6517 backwards" |ins-reverse|. This option can be toggled with the CTRL-_ | |
| 6518 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
|
6519 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
|
6520 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
|
6521 reset. |
| 7 | 6522 |
| 6523 *'rightleft'* *'rl'* *'norightleft'* *'norl'* | |
| 6524 'rightleft' 'rl' boolean (default off) | |
| 6525 local to window | |
| 6526 {only available when compiled with the |+rightleft| | |
| 6527 feature} | |
| 6528 When on, display orientation becomes right-to-left, i.e., characters | |
| 6529 that are stored in the file appear from the right to the left. | |
| 6530 Using this option, it is possible to edit files for languages that | |
| 6531 are written from the right to the left such as Hebrew and Arabic. | |
| 6532 This option is per window, so it is possible to edit mixed files | |
| 6533 simultaneously, or to view the same file in both ways (this is | |
| 6534 useful whenever you have a mixed text file with both right-to-left | |
| 6535 and left-to-right strings so that both sets are displayed properly | |
| 6536 in different windows). Also see |rileft.txt|. | |
| 6537 | |
| 2341 | 6538 *'rightleftcmd'* *'rlc'* |
| 7 | 6539 'rightleftcmd' 'rlc' string (default "search") |
| 6540 local to window | |
| 6541 {only available when compiled with the |+rightleft| | |
| 6542 feature} | |
| 6543 Each word in this option enables the command line editing to work in | |
| 6544 right-to-left mode for a group of commands: | |
| 6545 | |
| 6546 search "/" and "?" commands | |
| 6547 | |
| 6548 This is useful for languages such as Hebrew, Arabic and Farsi. | |
| 6549 The 'rightleft' option must be set for 'rightleftcmd' to take effect. | |
| 6550 | |
|
7196
42717d048817
commit https://github.com/vim/vim/commit/d94464ee294a351ce7b6ba18e8bd3f24f1bef920
Christian Brabandt <cb@256bit.org>
parents:
7147
diff
changeset
|
6551 *'rubydll'* |
|
8629
54ac275e3fc4
commit https://github.com/vim/vim/commit/3848e00e0177abdb31bc600234967863ec487233
Christian Brabandt <cb@256bit.org>
parents:
8560
diff
changeset
|
6552 '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
|
6553 global |
|
7196
42717d048817
commit https://github.com/vim/vim/commit/d94464ee294a351ce7b6ba18e8bd3f24f1bef920
Christian Brabandt <cb@256bit.org>
parents:
7147
diff
changeset
|
6554 {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
|
6555 feature} |
|
7528
53163e4d9e4f
commit https://github.com/vim/vim/commit/25e4fcde767084d1a79e0926bc301c92987c0cce
Christian Brabandt <cb@256bit.org>
parents:
7477
diff
changeset
|
6556 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
|
6557 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
|
6558 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
|
6559 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
|
6560 security reasons. |
|
42717d048817
commit https://github.com/vim/vim/commit/d94464ee294a351ce7b6ba18e8bd3f24f1bef920
Christian Brabandt <cb@256bit.org>
parents:
7147
diff
changeset
|
6561 |
| 7 | 6562 *'ruler'* *'ru'* *'noruler'* *'noru'* |
|
9669
284b4eb307fc
commit https://github.com/vim/vim/commit/8c08b5b569e2a9e9f63dea514591ecfa2d3bb392
Christian Brabandt <cb@256bit.org>
parents:
9665
diff
changeset
|
6563 'ruler' 'ru' boolean (default off, set in |defaults.vim|) |
| 7 | 6564 global |
| 6565 Show the line and column number of the cursor position, separated by a | |
| 10 | 6566 comma. When there is room, the relative position of the displayed |
| 7 | 6567 text in the file is shown on the far right: |
| 6568 Top first line is visible | |
| 6569 Bot last line is visible | |
| 6570 All first and last line are visible | |
| 6571 45% relative position in the file | |
| 6572 If 'rulerformat' is set, it will determine the contents of the ruler. | |
| 10 | 6573 Each window has its own ruler. If a window has a status line, the |
|
30005
bb0e525e1393
patch 9.0.0340: the 'cmdheight' zero support causes too much trouble
Bram Moolenaar <Bram@vim.org>
parents:
29900
diff
changeset
|
6574 ruler is shown there. Otherwise it is shown in the last line of the |
|
bb0e525e1393
patch 9.0.0340: the 'cmdheight' zero support causes too much trouble
Bram Moolenaar <Bram@vim.org>
parents:
29900
diff
changeset
|
6575 screen. If the statusline is given by 'statusline' (i.e. not empty), |
|
bb0e525e1393
patch 9.0.0340: the 'cmdheight' zero support causes too much trouble
Bram Moolenaar <Bram@vim.org>
parents:
29900
diff
changeset
|
6576 this option takes precedence over 'ruler' and 'rulerformat'. |
| 7 | 6577 If the number of characters displayed is different from the number of |
| 21991 | 6578 bytes in the text (e.g., for a TAB or a multibyte character), both |
| 7 | 6579 the text column (byte number) and the screen column are shown, |
| 6580 separated with a dash. | |
| 6581 For an empty line "0-1" is shown. | |
| 6582 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
|
6583 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
|
6584 reset. |
| 7 | 6585 If you don't want to see the ruler all the time but want to know where |
| 6586 you are, use "g CTRL-G" |g_CTRL-G|. | |
| 6587 NOTE: This option is reset when 'compatible' is set. | |
| 6588 | |
| 6589 *'rulerformat'* *'ruf'* | |
| 6590 'rulerformat' 'ruf' string (default empty) | |
| 6591 global | |
| 6592 {not available when compiled without the |+statusline| | |
| 6593 feature} | |
| 6594 When this option is not empty, it determines the content of the ruler | |
| 6595 string, as displayed for the 'ruler' option. | |
| 692 | 6596 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
|
6597 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
|
6598 |
| 7 | 6599 The default ruler width is 17 characters. To make the ruler 15 |
| 6600 characters wide, put "%15(" at the start and "%)" at the end. | |
| 6601 Example: > | |
| 6602 :set rulerformat=%15(%c%V\ %p%%%) | |
| 6603 < | |
| 6604 *'runtimepath'* *'rtp'* *vimfiles* | |
| 6605 'runtimepath' 'rtp' string (default: | |
| 23931 | 6606 Unix: "$HOME/.vim, |
| 7 | 6607 $VIM/vimfiles, |
| 6608 $VIMRUNTIME, | |
| 6609 $VIM/vimfiles/after, | |
| 6610 $HOME/.vim/after" | |
| 6611 Amiga: "home:vimfiles, | |
| 6612 $VIM/vimfiles, | |
| 6613 $VIMRUNTIME, | |
| 6614 $VIM/vimfiles/after, | |
| 6615 home:vimfiles/after" | |
| 23931 | 6616 MS-Windows: "$HOME/vimfiles, |
| 7 | 6617 $VIM/vimfiles, |
| 6618 $VIMRUNTIME, | |
| 6619 $VIM/vimfiles/after, | |
| 6620 $HOME/vimfiles/after" | |
| 21825 | 6621 macOS: "$VIM:vimfiles, |
| 7 | 6622 $VIMRUNTIME, |
| 6623 $VIM:vimfiles:after" | |
|
19526
22f0dda71638
patch 8.2.0320: no Haiku support
Bram Moolenaar <Bram@vim.org>
parents:
19404
diff
changeset
|
6624 Haiku: "$BE_USER_SETTINGS/vim, |
|
22f0dda71638
patch 8.2.0320: no Haiku support
Bram Moolenaar <Bram@vim.org>
parents:
19404
diff
changeset
|
6625 $VIM/vimfiles, |
|
22f0dda71638
patch 8.2.0320: no Haiku support
Bram Moolenaar <Bram@vim.org>
parents:
19404
diff
changeset
|
6626 $VIMRUNTIME, |
|
22f0dda71638
patch 8.2.0320: no Haiku support
Bram Moolenaar <Bram@vim.org>
parents:
19404
diff
changeset
|
6627 $VIM/vimfiles/after, |
| 23931 | 6628 $BE_USER_SETTINGS/vim/after" |
| 6629 VMS: "sys$login:vimfiles, | |
| 7 | 6630 $VIM/vimfiles, |
| 6631 $VIMRUNTIME, | |
| 6632 $VIM/vimfiles/after, | |
| 233 | 6633 sys$login:vimfiles/after") |
| 7 | 6634 global |
| 6635 This is a list of directories which will be searched for runtime | |
| 6636 files: | |
| 6637 filetype.vim filetypes by file name |new-filetype| | |
| 6638 scripts.vim filetypes by file contents |new-filetype-scripts| | |
| 164 | 6639 autoload/ automatically loaded scripts |autoload-functions| |
| 7 | 6640 colors/ color scheme files |:colorscheme| |
| 6641 compiler/ compiler files |:compiler| | |
| 6642 doc/ documentation |write-local-help| | |
| 6643 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
|
6644 import/ files that are found by `:import` |
| 7 | 6645 indent/ indent scripts |indent-expression| |
| 6646 keymap/ key mapping files |mbyte-keymap| | |
| 6647 lang/ menu translations |:menutrans| | |
| 6648 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
|
6649 pack/ packages |:packadd| |
| 7 | 6650 plugin/ plugin scripts |write-plugin| |
| 6651 print/ files for printing |postscript-print-encoding| | |
| 650 | 6652 spell/ spell checking files |spell| |
| 7 | 6653 syntax/ syntax files |mysyntaxfile| |
| 6654 tutor/ files for vimtutor |tutor| | |
| 6655 | |
| 6656 And any other file searched for with the |:runtime| command. | |
| 6657 | |
| 6658 The defaults for most systems are setup to search five locations: | |
| 6659 1. In your home directory, for your personal preferences. | |
| 6660 2. In a system-wide Vim directory, for preferences from the system | |
| 6661 administrator. | |
| 6662 3. In $VIMRUNTIME, for files distributed with Vim. | |
| 6663 *after-directory* | |
| 6664 4. In the "after" directory in the system-wide Vim directory. This is | |
| 6665 for the system administrator to overrule or add to the distributed | |
| 6666 defaults (rarely needed) | |
| 6667 5. In the "after" directory in your home directory. This is for | |
| 6668 personal preferences to overrule or add to the distributed defaults | |
| 6669 or system-wide settings (rarely needed). | |
| 6670 | |
|
10211
b7da8d4c594c
commit https://github.com/vim/vim/commit/d07969093a9b3051511c478d71c36de6fc33c0d6
Christian Brabandt <cb@256bit.org>
parents:
10198
diff
changeset
|
6671 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
|
6672 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
|
6673 string. |
|
9116
bc38030aec7d
commit https://github.com/vim/vim/commit/26852128a2b713ef49341a0c18daba928444e7eb
Christian Brabandt <cb@256bit.org>
parents:
9098
diff
changeset
|
6674 |
| 7 | 6675 Note that, unlike 'path', no wildcards like "**" are allowed. Normal |
| 6676 wildcards are allowed, but can significantly slow down searching for | |
| 10 | 6677 runtime files. For speed, use as few items as possible and avoid |
| 7 | 6678 wildcards. |
| 6679 See |:runtime|. | |
| 6680 Example: > | |
| 6681 :set runtimepath=~/vimruntime,/mygroup/vim,$VIMRUNTIME | |
| 6682 < This will use the directory "~/vimruntime" first (containing your | |
| 6683 personal Vim runtime files), then "/mygroup/vim" (shared between a | |
| 6684 group of people) and finally "$VIMRUNTIME" (the distributed runtime | |
| 6685 files). | |
| 6686 You probably should always include $VIMRUNTIME somewhere, to use the | |
| 6687 distributed runtime files. You can put a directory before $VIMRUNTIME | |
| 6688 to find files which replace a distributed runtime files. You can put | |
| 6689 a directory after $VIMRUNTIME to find files which add to distributed | |
| 6690 runtime files. | |
| 13437 | 6691 When Vim is started with |--clean| the home directory entries are not |
| 6692 included. | |
| 7 | 6693 This option cannot be set from a |modeline| or in the |sandbox|, for |
| 6694 security reasons. | |
| 6695 | |
| 6696 *'scroll'* *'scr'* | |
| 6697 'scroll' 'scr' number (default: half the window height) | |
| 6698 local to window | |
| 6699 Number of lines to scroll with CTRL-U and CTRL-D commands. Will be | |
| 6700 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
|
6701 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
|
6702 '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
|
6703 If you give a count to the CTRL-U or CTRL-D command it will |
| 10 | 6704 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
|
6705 height with ":set scroll=0". |
| 7 | 6706 |
| 6707 *'scrollbind'* *'scb'* *'noscrollbind'* *'noscb'* | |
| 6708 'scrollbind' 'scb' boolean (default off) | |
| 6709 local to window | |
| 6710 See also |scroll-binding|. When this option is set, the current | |
| 6711 window scrolls as other scrollbind windows (windows that also have | |
| 6712 this option set) scroll. This option is useful for viewing the | |
| 6713 differences between two versions of a file, see 'diff'. | |
| 6714 See |'scrollopt'| for options that determine how this option should be | |
| 6715 interpreted. | |
| 6716 This option is mostly reset when splitting a window to edit another | |
| 6717 file. This means that ":split | edit file" results in two windows | |
| 6718 with scroll-binding, but ":split file" does not. | |
| 6719 | |
|
18526
334b1f897f3a
patch 8.1.2257: MS-Windows GUI: scroll wheel always uses current window
Bram Moolenaar <Bram@vim.org>
parents:
18489
diff
changeset
|
6720 *'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
|
6721 '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
|
6722 global |
|
334b1f897f3a
patch 8.1.2257: MS-Windows GUI: scroll wheel always uses current window
Bram Moolenaar <Bram@vim.org>
parents:
18489
diff
changeset
|
6723 {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
|
6724 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
|
6725 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
|
6726 window is scrolled. |
| 18594 | 6727 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
|
6728 |
| 7 | 6729 *'scrolljump'* *'sj'* |
| 6730 'scrolljump' 'sj' number (default 1) | |
| 6731 global | |
| 6732 Minimal number of lines to scroll when the cursor gets off the | |
| 6733 screen (e.g., with "j"). Not used for scroll commands (e.g., CTRL-E, | |
| 6734 CTRL-D). Useful if your terminal scrolls very slowly. | |
| 532 | 6735 When set to a negative number from -1 to -100 this is used as the |
| 6736 percentage of the window height. Thus -50 scrolls half the window | |
| 6737 height. | |
| 7 | 6738 NOTE: This option is set to 1 when 'compatible' is set. |
| 6739 | |
| 6740 *'scrolloff'* *'so'* | |
|
10218
584c835a2de1
commit https://github.com/vim/vim/commit/50ba526fbf3e9e5e0e6b0b3086a4d5df581ebc7e
Christian Brabandt <cb@256bit.org>
parents:
10211
diff
changeset
|
6741 '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
|
6742 global or local to window |global-local| |
| 7 | 6743 Minimal number of screen lines to keep above and below the cursor. |
| 6744 This will make some context visible around where you are working. If | |
| 6745 you set it to a very large value (999) the cursor line will always be | |
| 6746 in the middle of the window (except at the start or end of the file or | |
| 6747 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
|
6748 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
|
6749 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
|
6750 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
|
6751 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
|
6752 < For scrolling horizontally see 'sidescrolloff'. |
| 7 | 6753 NOTE: This option is set to 0 when 'compatible' is set. |
| 6754 | |
| 6755 *'scrollopt'* *'sbo'* | |
| 6756 'scrollopt' 'sbo' string (default "ver,jump") | |
| 6757 global | |
| 6758 This is a comma-separated list of words that specifies how | |
| 236 | 6759 'scrollbind' windows should behave. 'sbo' stands for ScrollBind |
| 6760 Options. | |
| 7 | 6761 The following words are available: |
| 6762 ver Bind vertical scrolling for 'scrollbind' windows | |
| 6763 hor Bind horizontal scrolling for 'scrollbind' windows | |
| 6764 jump Applies to the offset between two windows for vertical | |
| 6765 scrolling. This offset is the difference in the first | |
| 6766 displayed line of the bound windows. When moving | |
| 6767 around in a window, another 'scrollbind' window may | |
| 6768 reach a position before the start or after the end of | |
| 6769 the buffer. The offset is not changed though, when | |
| 6770 moving back the 'scrollbind' window will try to scroll | |
| 6771 to the desired position when possible. | |
| 6772 When now making that window the current one, two | |
| 6773 things can be done with the relative offset: | |
| 6774 1. When "jump" is not included, the relative offset is | |
| 6775 adjusted for the scroll position in the new current | |
| 6776 window. When going back to the other window, the | |
| 1152 | 6777 new relative offset will be used. |
| 7 | 6778 2. When "jump" is included, the other windows are |
| 6779 scrolled to keep the same relative offset. When | |
| 6780 going back to the other window, it still uses the | |
| 6781 same relative offset. | |
| 6782 Also see |scroll-binding|. | |
| 819 | 6783 When 'diff' mode is active there always is vertical scroll binding, |
| 6784 even when "ver" isn't there. | |
| 7 | 6785 |
| 6786 *'sections'* *'sect'* | |
| 6787 'sections' 'sect' string (default "SHNHH HUnhsh") | |
| 6788 global | |
| 6789 Specifies the nroff macros that separate sections. These are pairs of | |
| 6790 two letters (See |object-motions|). The default makes a section start | |
| 6791 at the nroff macros ".SH", ".NH", ".H", ".HU", ".nh" and ".sh". | |
| 6792 | |
| 6793 *'secure'* *'nosecure'* *E523* | |
| 6794 'secure' boolean (default off) | |
| 6795 global | |
| 6796 When on, ":autocmd", shell and write commands are not allowed in | |
| 6797 ".vimrc" and ".exrc" in the current directory and map commands are | |
| 6798 displayed. Switch it off only if you know that you will not run into | |
| 6799 problems, or when the 'exrc' option is off. On Unix this option is | |
| 6800 only used if the ".vimrc" or ".exrc" is not owned by you. This can be | |
| 10 | 6801 dangerous if the systems allows users to do a "chown". You better set |
| 7 | 6802 'secure' at the end of your ~/.vimrc then. |
| 6803 This option cannot be set from a |modeline| or in the |sandbox|, for | |
| 6804 security reasons. | |
| 6805 | |
| 6806 *'selection'* *'sel'* | |
| 6807 'selection' 'sel' string (default "inclusive") | |
| 6808 global | |
| 6809 This option defines the behavior of the selection. It is only used | |
| 6810 in Visual and Select mode. | |
| 6811 Possible values: | |
| 6812 value past line inclusive ~ | |
| 6813 old no yes | |
| 6814 inclusive yes yes | |
| 6815 exclusive yes no | |
| 6816 "past line" means that the cursor is allowed to be positioned one | |
| 6817 character past the line. | |
| 6818 "inclusive" means that the last character of the selection is included | |
| 6819 in an operation. For example, when "x" is used to delete the | |
| 6820 selection. | |
|
9975
03fa8a51e9dc
commit https://github.com/vim/vim/commit/e4a3bcf28d92d0bde9ca227ccb40d401038185e5
Christian Brabandt <cb@256bit.org>
parents:
9913
diff
changeset
|
6821 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
|
6822 the end of line the line break still isn't included. |
| 7 | 6823 Note that when "exclusive" is used and selecting from the end |
| 6824 backwards, you cannot include the last character of a line, when | |
| 6825 starting in Normal mode and 'virtualedit' empty. | |
| 6826 | |
| 6827 The 'selection' option is set by the |:behave| command. | |
| 6828 | |
| 6829 *'selectmode'* *'slm'* | |
| 6830 'selectmode' 'slm' string (default "") | |
| 6831 global | |
| 28379 | 6832 This is a comma-separated list of words, which specifies when to start |
| 7 | 6833 Select mode instead of Visual mode, when a selection is started. |
| 6834 Possible values: | |
| 6835 mouse when using the mouse | |
| 6836 key when using shifted special keys | |
| 6837 cmd when using "v", "V" or CTRL-V | |
| 6838 See |Select-mode|. | |
| 6839 The 'selectmode' option is set by the |:behave| command. | |
| 6840 | |
| 6841 *'sessionoptions'* *'ssop'* | |
| 6842 'sessionoptions' 'ssop' string (default: "blank,buffers,curdir,folds, | |
| 13437 | 6843 help,options,tabpages,winsize,terminal") |
| 7 | 6844 global |
|
2570
71b56b4e7785
Make the references to features in the help more consistent. (Sylvain Hitier)
Bram Moolenaar <bram@vim.org>
parents:
2561
diff
changeset
|
6845 {not available when compiled without the |+mksession| |
| 7 | 6846 feature} |
| 6847 Changes the effect of the |:mksession| command. It is a comma | |
| 6848 separated list of words. Each word enables saving and restoring | |
| 6849 something: | |
| 6850 word save and restore ~ | |
| 6851 blank empty windows | |
| 6852 buffers hidden and unloaded buffers, not just those in windows | |
| 6853 curdir the current directory | |
| 6854 folds manually created folds, opened/closed folds and local | |
| 6855 fold options | |
| 6856 globals global variables that start with an uppercase letter | |
| 75 | 6857 and contain at least one lowercase letter. Only |
| 6858 String and Number types are stored. | |
| 7 | 6859 help the help window |
| 6860 localoptions options and mappings local to a window or buffer (not | |
| 6861 global values for local options) | |
| 6862 options all options and mappings (also global values for local | |
| 6863 options) | |
|
24476
e79d1475fc89
patch 8.2.2778: problem restoring 'packpath' in session
Bram Moolenaar <Bram@vim.org>
parents:
24468
diff
changeset
|
6864 skiprtp exclude 'runtimepath' and 'packpath' from the options |
| 7 | 6865 resize size of the Vim window: 'lines' and 'columns' |
| 6866 sesdir the directory in which the session file is located | |
| 6867 will become the current directory (useful with | |
| 6868 projects accessed over a network from different | |
| 6869 systems) | |
| 6870 slash backslashes in file names replaced with forward | |
| 6871 slashes | |
| 827 | 6872 tabpages all tab pages; without this only the current tab page |
| 6873 is restored, so that you can make a session for each | |
| 6874 tab page separately | |
| 14519 | 6875 terminal include terminal windows where the command can be |
| 6876 restored | |
| 7 | 6877 unix with Unix end-of-line format (single <NL>), even when |
| 6878 on Windows or DOS | |
| 6879 winpos position of the whole Vim window | |
| 6880 winsize window sizes | |
| 6881 | |
| 6882 Don't include both "curdir" and "sesdir". | |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
6883 When neither "curdir" nor "sesdir" is included, file names are stored |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
6884 with absolute paths. |
| 27036 | 6885 If you leave out "options" many things won't work well after restoring |
| 6886 the session. | |
| 7 | 6887 "slash" and "unix" are useful on Windows when sharing session files |
| 6888 with Unix. The Unix version of Vim cannot source dos format scripts, | |
| 6889 but the Windows version of Vim can source unix format scripts. | |
| 6890 | |
| 6891 *'shell'* *'sh'* *E91* | |
| 18928 | 6892 'shell' 'sh' string (default $SHELL or "sh", Win32: "cmd.exe") |
| 7 | 6893 global |
| 6894 Name of the shell to use for ! and :! commands. When changing the | |
| 6895 value also check these options: 'shelltype', 'shellpipe', 'shellslash' | |
| 6896 'shellredir', 'shellquote', 'shellxquote' and 'shellcmdflag'. | |
| 10 | 6897 It is allowed to give an argument to the command, e.g. "csh -f". |
| 7 | 6898 See |option-backslash| about including spaces and backslashes. |
| 6899 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
|
6900 |
| 27537 | 6901 In |restricted-mode| shell commands will not be possible. This mode |
| 6902 is used if the value of $SHELL ends in "false" or "nologin". | |
| 6903 | |
| 18489 | 6904 If the name of the shell contains a space, you need to enclose it in |
| 18594 | 6905 quotes and escape the space. Example with quotes: > |
| 7 | 6906 :set shell=\"c:\program\ files\unix\sh.exe\"\ -f |
| 6907 < Note the backslash before each quote (to avoid starting a comment) and | |
| 10 | 6908 each space (to avoid ending the option value). Also note that the |
| 7 | 6909 "-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
|
6910 name. Vim automagically recognizes the backslashes that are path |
| 7 | 6911 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
|
6912 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
|
6913 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
|
6914 :set shell=/bin/with\\\ space/sh |
| 14519 | 6915 < 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
|
6916 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
|
6917 |
| 7 | 6918 Under MS-Windows, when the executable ends in ".com" it must be |
| 6919 included. Thus setting the shell to "command.com" or "4dos.com" | |
| 6920 works, but "command" and "4dos" do not work for all commands (e.g., | |
| 6921 filtering). | |
| 6922 For unknown reasons, when using "4dos.com" the current directory is | |
| 6923 changed to "C:\". To avoid this set 'shell' like this: > | |
| 6924 :set shell=command.com\ /c\ 4dos | |
| 6925 < This option cannot be set from a |modeline| or in the |sandbox|, for | |
| 6926 security reasons. | |
| 6927 | |
| 6928 *'shellcmdflag'* *'shcf'* | |
| 3356 | 6929 '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
|
6930 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
|
6931 "-Command", or when it does not contain "sh" |
| 18972 | 6932 somewhere: "/c") |
| 7 | 6933 global |
| 6934 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
|
6935 "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
|
6936 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
|
6937 to reduce the need to set this option by the user. |
| 3082 | 6938 On Unix it can have more than one flag. Each white space separated |
| 6939 part is passed as an argument to the shell command. | |
| 6940 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
|
6941 Also see |dos-shell| and |dos-powershell| for MS-Windows. |
| 7 | 6942 This option cannot be set from a |modeline| or in the |sandbox|, for |
| 6943 security reasons. | |
| 6944 | |
| 6945 *'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
|
6946 '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
|
6947 "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
|
6948 "2>&1 | Out-File -Encoding default") |
| 7 | 6949 global |
| 6950 {not available when compiled without the |+quickfix| | |
| 6951 feature} | |
| 6952 String to be used to put the output of the ":make" command in the | |
| 10 | 6953 error file. See also |:make_makeprg|. See |option-backslash| about |
| 7 | 6954 including spaces and backslashes. |
| 6955 The name of the temporary file can be represented by "%s" if necessary | |
| 6956 (the file name is appended automatically if no %s appears in the value | |
| 6957 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
|
6958 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
|
6959 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
|
6960 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
|
6961 to the screen. |
| 22171 | 6962 For Unix the default is "| tee". The stdout of the compiler is saved |
| 7 | 6963 in a file and echoed to the screen. If the 'shell' option is "csh" or |
| 6964 "tcsh" after initializations, the default becomes "|& tee". If the | |
| 18456 | 6965 '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
|
6966 "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
|
6967 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
|
6968 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
|
6969 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
|
6970 becomes ">%s 2>&1" and the output is not echoed to the screen. |
| 7 | 6971 The initialization of this option is done after reading the ".vimrc" |
| 6972 and the other initializations, so that when the 'shell' option is set | |
| 6973 there, the 'shellpipe' option changes automatically, unless it was | |
| 6974 explicitly set before. | |
| 6975 When 'shellpipe' is set to an empty string, no redirection of the | |
| 6976 ":make" output will be done. This is useful if you use a 'makeprg' | |
| 6977 that writes to 'makeef' by itself. If you want no piping, but do | |
| 6978 want to include the 'makeef', set 'shellpipe' to a single space. | |
| 6979 Don't forget to precede the space with a backslash: ":set sp=\ ". | |
| 6980 In the future pipes may be used for filtering and this option will | |
| 6981 become obsolete (at least for Unix). | |
| 6982 This option cannot be set from a |modeline| or in the |sandbox|, for | |
| 6983 security reasons. | |
| 6984 | |
| 6985 *'shellquote'* *'shq'* | |
|
25084
beff72446e2e
patch 8.2.3079: Powershell core not supported by default
Bram Moolenaar <Bram@vim.org>
parents:
25068
diff
changeset
|
6986 'shellquote' 'shq' string (default: "") |
| 7 | 6987 global |
| 6988 Quoting character(s), put around the command passed to the shell, for | |
| 6989 the "!" and ":!" commands. The redirection is kept outside of the | |
| 6990 quoting. See 'shellxquote' to include the redirection. It's | |
| 6991 probably not useful to set both options. | |
| 6992 This is an empty string by default. Only known to be useful for | |
| 18972 | 6993 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
|
6994 Shell or bash, where it should be "\"". See |dos-shell|. |
| 7 | 6995 This option cannot be set from a |modeline| or in the |sandbox|, for |
| 6996 security reasons. | |
| 6997 | |
| 6998 *'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
|
6999 '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
|
7000 "2>&1 | Out-File -Encoding default") |
| 7 | 7001 global |
| 7002 String to be used to put the output of a filter command in a temporary | |
| 7003 file. See also |:!|. See |option-backslash| about including spaces | |
| 7004 and backslashes. | |
| 7005 The name of the temporary file can be represented by "%s" if necessary | |
| 7006 (the file name is appended automatically if no %s appears in the value | |
| 7007 of this option). | |
| 18456 | 7008 The default is ">". For Unix, if the 'shell' option is "csh" or |
| 7009 "tcsh" during initializations, the default becomes ">&". If the | |
| 18719 | 7010 '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
|
7011 "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
|
7012 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
|
7013 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
|
7014 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
|
7015 "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
|
7016 same names with ".exe" appended are checked for. |
| 7 | 7017 The initialization of this option is done after reading the ".vimrc" |
| 7018 and the other initializations, so that when the 'shell' option is set | |
| 7019 there, the 'shellredir' option changes automatically unless it was | |
| 7020 explicitly set before. | |
| 7021 In the future pipes may be used for filtering and this option will | |
| 7022 become obsolete (at least for Unix). | |
| 7023 This option cannot be set from a |modeline| or in the |sandbox|, for | |
| 7024 security reasons. | |
| 7025 | |
| 7026 *'shellslash'* *'ssl'* *'noshellslash'* *'nossl'* | |
| 7027 'shellslash' 'ssl' boolean (default off) | |
| 7028 global | |
|
18912
ccd16426a1f9
patch 8.2.0017: OS/2 and MS-DOS are still mentioned
Bram Moolenaar <Bram@vim.org>
parents:
18879
diff
changeset
|
7029 {only for MS-Windows} |
| 7 | 7030 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
|
7031 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
|
7032 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
|
7033 changed to forward slashes by Vim. |
| 7 | 7034 Note that setting or resetting this option has no effect for some |
| 7035 existing file names, thus this option needs to be set before opening | |
| 7036 any file for best results. This might change in the future. | |
| 7037 'shellslash' only works when a backslash can be used as a path | |
| 7038 separator. To test if this is so use: > | |
| 7039 if exists('+shellslash') | |
|
17543
77c3f6428b6c
patch 8.1.1769: 'shellslash' is also used for completion
Bram Moolenaar <Bram@vim.org>
parents:
17433
diff
changeset
|
7040 < Also see 'completeslash'. |
|
77c3f6428b6c
patch 8.1.1769: 'shellslash' is also used for completion
Bram Moolenaar <Bram@vim.org>
parents:
17433
diff
changeset
|
7041 |
| 168 | 7042 *'shelltemp'* *'stmp'* *'noshelltemp'* *'nostmp'* |
| 7043 'shelltemp' 'stmp' boolean (Vi default off, Vim default on) | |
| 7044 global | |
| 7045 When on, use temp files for shell commands. When off use a pipe. | |
| 7046 When using a pipe is not possible temp files are used anyway. | |
| 2965 | 7047 Currently a pipe is only supported on Unix and MS-Windows 2K and |
| 7048 later. You can check it with: > | |
| 168 | 7049 :if has("filterpipe") |
| 7050 < The advantage of using a pipe is that nobody can read the temp file | |
| 7051 and the 'shell' command does not need to support redirection. | |
| 7052 The advantage of using a temp file is that the file type and encoding | |
| 7053 can be detected. | |
| 7054 The |FilterReadPre|, |FilterReadPost| and |FilterWritePre|, | |
| 7055 |FilterWritePost| autocommands event are not triggered when | |
| 7056 'shelltemp' is off. | |
|
9533
9f921133ee90
commit https://github.com/vim/vim/commit/269f595f9eef584937e7eae70fde68cdd7da5bcf
Christian Brabandt <cb@256bit.org>
parents:
9464
diff
changeset
|
7057 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
|
7058 temp files. |
| 11160 | 7059 NOTE: This option is set to the Vim default value when 'compatible' |
| 7060 is reset. | |
| 168 | 7061 |
| 7 | 7062 *'shelltype'* *'st'* |
| 7063 'shelltype' 'st' number (default 0) | |
| 7064 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
|
7065 {only for the Amiga} |
| 7 | 7066 On the Amiga this option influences the way how the commands work |
| 7067 which use a shell. | |
| 7068 0 and 1: always use the shell | |
| 7069 2 and 3: use the shell only to filter lines | |
| 7070 4 and 5: use shell only for ':sh' command | |
| 7071 When not using the shell, the command is executed directly. | |
| 7072 | |
| 7073 0 and 2: use "shell 'shellcmdflag' cmd" to start external commands | |
| 7074 1 and 3: use "shell cmd" to start external commands | |
| 7075 | |
| 3371 | 7076 *'shellxescape'* *'sxe'* |
| 7077 'shellxescape' 'sxe' string (default: ""; | |
| 18972 | 7078 for MS-Windows: "\"&|<>()@^") |
| 3371 | 7079 global |
| 7080 When 'shellxquote' is set to "(" then the characters listed in this | |
| 7081 option will be escaped with a '^' character. This makes it possible | |
| 7082 to execute most external commands with cmd.exe. | |
| 7083 | |
| 7 | 7084 *'shellxquote'* *'sxq'* |
| 7085 'shellxquote' 'sxq' string (default: ""; | |
| 3359 | 7086 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
|
7087 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
|
7088 powershell.exe: "\"" |
| 3359 | 7089 for Win32, when 'shell' contains "sh" |
| 7090 somewhere: "\"" | |
| 7 | 7091 for Unix, when using system(): "\"") |
| 7092 global | |
| 7093 Quoting character(s), put around the command passed to the shell, for | |
| 7094 the "!" and ":!" commands. Includes the redirection. See | |
| 7095 'shellquote' to exclude the redirection. It's probably not useful | |
| 7096 to set both options. | |
| 3359 | 7097 When the value is '(' then ')' is appended. When the value is '"(' |
| 7098 then ')"' is appended. | |
| 7099 When the value is '(' then also see 'shellxescape'. | |
| 3352 | 7100 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
|
7101 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
|
7102 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
|
7103 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
|
7104 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
|
7105 '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
|
7106 |dos-shell|. |
| 7 | 7107 This option cannot be set from a |modeline| or in the |sandbox|, for |
| 7108 security reasons. | |
| 7109 | |
| 7110 *'shiftround'* *'sr'* *'noshiftround'* *'nosr'* | |
| 7111 'shiftround' 'sr' boolean (default off) | |
| 7112 global | |
| 7113 Round indent to multiple of 'shiftwidth'. Applies to > and < | |
| 7114 commands. CTRL-T and CTRL-D in Insert mode always round the indent to | |
| 7115 a multiple of 'shiftwidth' (this is Vi compatible). | |
| 7116 NOTE: This option is reset when 'compatible' is set. | |
| 7117 | |
| 7118 *'shiftwidth'* *'sw'* | |
| 7119 'shiftwidth' 'sw' number (default 8) | |
| 7120 local to buffer | |
| 10 | 7121 Number of spaces to use for each step of (auto)indent. Used for |
| 7 | 7122 |'cindent'|, |>>|, |<<|, etc. |
| 3893 | 7123 When zero the 'ts' value will be used. Use the |shiftwidth()| |
| 7124 function to get the effective shiftwidth value. | |
| 7 | 7125 |
| 7126 *'shortmess'* *'shm'* | |
|
16533
5e25171e0e75
patch 8.1.1270: cannot see current match position
Bram Moolenaar <Bram@vim.org>
parents:
16447
diff
changeset
|
7127 '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
|
7128 POSIX default: "AS") |
| 31579 | 7129 global *E1336* |
| 7 | 7130 This option helps to avoid all the |hit-enter| prompts caused by file |
| 7131 messages, for example with CTRL-G, and to avoid some other messages. | |
| 7132 It is a list of flags: | |
| 7133 flag meaning when present ~ | |
| 31430 | 7134 f use "(3 of 5)" instead of "(file 3 of 5)" *shm-f* |
| 7135 i use "[noeol]" instead of "[Incomplete last line]" *shm-i* | |
| 7136 l use "999L, 888B" instead of "999 lines, 888 bytes" *shm-l* | |
| 7137 m use "[+]" instead of "[Modified]" *shm-m* | |
| 7138 n use "[New]" instead of "[New File]" *shm-n* | |
| 7139 r use "[RO]" instead of "[readonly]" *shm-r* | |
| 7140 w use "[w]" instead of "written" for file write message *shm-w* | |
| 7 | 7141 and "[a]" instead of "appended" for ':w >> file' command |
| 31430 | 7142 x use "[dos]" instead of "[dos format]", "[unix]" *shm-x* |
| 7143 instead of "[unix format]" and "[mac]" instead of "[mac | |
| 31579 | 7144 format]" |
| 31430 | 7145 a all of the above abbreviations *shm-a* |
| 7146 | |
| 7147 o overwrite message for writing a file with subsequent *shm-o* | |
| 7148 message for reading a file (useful for ":wn" or when | |
| 7149 'autowrite' on) | |
| 31579 | 7150 O message for reading a file overwrites any previous *shm-O* |
| 7151 message; also for quickfix message (e.g., ":cn") | |
| 31430 | 7152 s don't give "search hit BOTTOM, continuing at TOP" or *shm-s* |
| 7153 "search hit TOP, continuing at BOTTOM" messages; when using | |
| 7154 the search count do not show "W" after the count message (see | |
| 7155 S below) | |
| 7156 t truncate file message at the start if it is too long *shm-t* | |
| 7157 to fit on the command-line, "<" will appear in the left most | |
| 31579 | 7158 column; ignored in Ex mode |
| 31430 | 7159 T truncate other messages in the middle if they are too *shm-T* |
| 31579 | 7160 long to fit on the command line; "..." will appear in the |
| 7161 middle; ignored in Ex mode | |
| 31430 | 7162 W don't give "written" or "[w]" when writing a file *shm-W* |
| 7163 A don't give the "ATTENTION" message when an existing *shm-A* | |
| 31579 | 7164 swap file is found |
| 31430 | 7165 I don't give the intro message when starting Vim, *shm-I* |
| 32004 | 7166 see |:intro| |
| 31579 | 7167 c don't give |ins-completion-menu| messages; for *shm-c* |
| 31430 | 7168 example, "-- XXX completion (YYY)", "match 1 of 2", "The only |
| 7169 match", "Pattern not found", "Back at original", etc. | |
| 7170 C don't give messages while scanning for ins-completion *shm-C* | |
| 7171 items, for instance "scanning tags" | |
| 7172 q use "recording" instead of "recording @a" *shm-q* | |
| 7173 F don't give the file info when editing a file, like *shm-F* | |
| 7174 `:silent` was used for the command; note that this also | |
| 7175 affects messages from autocommands | |
| 32004 | 7176 S do not show search count message when searching, e.g. *shm-S* |
| 7177 "[1/5]" | |
| 7 | 7178 |
| 7179 This gives you the opportunity to avoid that a change between buffers | |
| 7180 requires you to hit <Enter>, but still gives as useful a message as | |
| 7181 possible for the space available. To get the whole message that you | |
| 7182 would have got with 'shm' empty, use ":file!" | |
| 7183 Useful values: | |
| 7184 shm= No abbreviation of message. | |
| 7185 shm=a Abbreviation, but no loss of information. | |
| 7186 shm=at Abbreviation, and truncate message when necessary. | |
| 7187 | |
| 7188 NOTE: This option is set to the Vi default value when 'compatible' is | |
| 7189 set and to the Vim default value when 'compatible' is reset. | |
| 7190 | |
| 7191 *'shortname'* *'sn'* *'noshortname'* *'nosn'* | |
| 7192 'shortname' 'sn' boolean (default off) | |
| 7193 local to buffer | |
| 7194 Filenames are assumed to be 8 characters plus one extension of 3 | |
| 7195 characters. Multiple dots in file names are not allowed. When this | |
| 7196 option is on, dots in file names are replaced with underscores when | |
| 18972 | 7197 adding an extension (".~" or ".swp"). This option is useful |
| 7 | 7198 when editing files on an MS-DOS compatible filesystem, e.g., messydos |
| 19163 | 7199 or crossdos. |
| 7 | 7200 |
| 7201 *'showbreak'* *'sbr'* *E595* | |
| 7202 '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
|
7203 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
|
7204 {not available when compiled without the |+linebreak| |
| 7 | 7205 feature} |
| 7206 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
|
7207 values are "> " or "+++ ": > |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
7208 :set showbreak=>\ |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
7209 < 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
|
7210 this: > |
|
2314
233eb4412f5d
Added 'colorcolumn' option. Partly by Gregor Uhlenheuer.
Bram Moolenaar <bram@vim.org>
parents:
2302
diff
changeset
|
7211 :let &showbreak = '+++ ' |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
7212 < Only printable single-cell characters are allowed, excluding <Tab> and |
| 7 | 7213 comma (in a future version the comma might be used to separate the |
| 7214 part that is shown at the end and at the start of a line). | |
| 7215 The characters are highlighted according to the '@' flag in | |
| 7216 'highlight'. | |
| 7217 Note that tabs after the showbreak will be displayed differently. | |
| 7218 If you want the 'showbreak' to appear in between line numbers, add the | |
| 7219 "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
|
7220 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
|
7221 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
|
7222 :setlocal showbreak=NONE |
|
8b0114ffde2b
patch 8.1.2281: 'showbreak' cannot be set for one window
Bram Moolenaar <Bram@vim.org>
parents:
18526
diff
changeset
|
7223 < |
| 7 | 7224 *'showcmd'* *'sc'* *'noshowcmd'* *'nosc'* |
|
9669
284b4eb307fc
commit https://github.com/vim/vim/commit/8c08b5b569e2a9e9f63dea514591ecfa2d3bb392
Christian Brabandt <cb@256bit.org>
parents:
9665
diff
changeset
|
7225 '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
|
7226 Vi default: off, set in |defaults.vim|) |
| 7 | 7227 global |
| 1152 | 7228 Show (partial) command in the last line of the screen. Set this |
| 7229 option off if your terminal is slow. | |
| 7 | 7230 In Visual mode the size of the selected area is shown: |
| 7231 - 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
|
7232 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
|
7233 means two characters and six bytes. |
| 7 | 7234 - When selecting more than one line, the number of lines. |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
7235 - When selecting a block, the size in screen characters: |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
7236 {lines}x{columns}. |
|
31457
bb797331e21b
patch 9.0.1061: cannot display 'showcmd' somewhere else
Bram Moolenaar <Bram@vim.org>
parents:
31430
diff
changeset
|
7237 This information can be displayed in an alternative location using the |
|
bb797331e21b
patch 9.0.1061: cannot display 'showcmd' somewhere else
Bram Moolenaar <Bram@vim.org>
parents:
31430
diff
changeset
|
7238 'showcmdloc' option. |
| 7 | 7239 NOTE: This option is set to the Vi default value when 'compatible' is |
| 7240 set and to the Vim default value when 'compatible' is reset. | |
| 7241 | |
|
31457
bb797331e21b
patch 9.0.1061: cannot display 'showcmd' somewhere else
Bram Moolenaar <Bram@vim.org>
parents:
31430
diff
changeset
|
7242 *'showcmdloc'* *'sloc'* |
|
bb797331e21b
patch 9.0.1061: cannot display 'showcmd' somewhere else
Bram Moolenaar <Bram@vim.org>
parents:
31430
diff
changeset
|
7243 'showcmdloc' 'sloc' string (default "last") |
| 31579 | 7244 global |
|
31457
bb797331e21b
patch 9.0.1061: cannot display 'showcmd' somewhere else
Bram Moolenaar <Bram@vim.org>
parents:
31430
diff
changeset
|
7245 This option can be used to display the (partially) entered command in |
|
bb797331e21b
patch 9.0.1061: cannot display 'showcmd' somewhere else
Bram Moolenaar <Bram@vim.org>
parents:
31430
diff
changeset
|
7246 another location. Possible values are: |
|
bb797331e21b
patch 9.0.1061: cannot display 'showcmd' somewhere else
Bram Moolenaar <Bram@vim.org>
parents:
31430
diff
changeset
|
7247 last Last line of the screen (default). |
|
bb797331e21b
patch 9.0.1061: cannot display 'showcmd' somewhere else
Bram Moolenaar <Bram@vim.org>
parents:
31430
diff
changeset
|
7248 statusline Status line of the current window. |
| 31579 | 7249 tabline First line of the screen if 'showtabline' is enabled. |
|
31457
bb797331e21b
patch 9.0.1061: cannot display 'showcmd' somewhere else
Bram Moolenaar <Bram@vim.org>
parents:
31430
diff
changeset
|
7250 Setting this option to "statusline" or "tabline" means that these will |
|
bb797331e21b
patch 9.0.1061: cannot display 'showcmd' somewhere else
Bram Moolenaar <Bram@vim.org>
parents:
31430
diff
changeset
|
7251 be redrawn whenever the command changes, which can be on every key |
|
bb797331e21b
patch 9.0.1061: cannot display 'showcmd' somewhere else
Bram Moolenaar <Bram@vim.org>
parents:
31430
diff
changeset
|
7252 pressed. |
|
bb797331e21b
patch 9.0.1061: cannot display 'showcmd' somewhere else
Bram Moolenaar <Bram@vim.org>
parents:
31430
diff
changeset
|
7253 The %S 'statusline' item can be used in 'statusline' or 'tabline' to |
|
bb797331e21b
patch 9.0.1061: cannot display 'showcmd' somewhere else
Bram Moolenaar <Bram@vim.org>
parents:
31430
diff
changeset
|
7254 place the text. Without a custom 'statusline' or 'tabline' it will be |
|
bb797331e21b
patch 9.0.1061: cannot display 'showcmd' somewhere else
Bram Moolenaar <Bram@vim.org>
parents:
31430
diff
changeset
|
7255 displayed in a convenient location. |
|
bb797331e21b
patch 9.0.1061: cannot display 'showcmd' somewhere else
Bram Moolenaar <Bram@vim.org>
parents:
31430
diff
changeset
|
7256 |
| 7 | 7257 *'showfulltag'* *'sft'* *'noshowfulltag'* *'nosft'* |
| 7258 'showfulltag' 'sft' boolean (default off) | |
| 7259 global | |
| 7260 When completing a word in insert mode (see |ins-completion|) from the | |
| 7261 tags file, show both the tag name and a tidied-up form of the search | |
| 10 | 7262 pattern (if there is one) as possible matches. Thus, if you have |
| 7 | 7263 matched a C function, you can see a template for what arguments are |
| 7264 required (coding style permitting). | |
| 1621 | 7265 Note that this doesn't work well together with having "longest" in |
| 7266 'completeopt', because the completion from the search pattern may not | |
| 7267 match the typed text. | |
| 7 | 7268 |
| 7269 *'showmatch'* *'sm'* *'noshowmatch'* *'nosm'* | |
| 7270 'showmatch' 'sm' boolean (default off) | |
| 7271 global | |
| 7272 When a bracket is inserted, briefly jump to the matching one. The | |
| 7273 jump is only done if the match can be seen on the screen. The time to | |
| 7274 show the match can be set with 'matchtime'. | |
| 7275 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
|
7276 seen or not). |
|
c590de398af9
commit https://github.com/vim/vim/commit/ca63501fbcd1cf9c8aa9ff12c093c95b62a89ed7
Christian Brabandt <cb@256bit.org>
parents:
7080
diff
changeset
|
7277 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
|
7278 reset. |
| 7 | 7279 When the 'm' flag is not included in 'cpoptions', typing a character |
| 7280 will immediately move the cursor back to where it belongs. | |
| 7281 See the "sm" field in 'guicursor' for setting the cursor shape and | |
| 7282 blinking when showing the match. | |
| 7283 The 'matchpairs' option can be used to specify the characters to show | |
| 7284 matches for. 'rightleft' and 'revins' are used to look for opposite | |
| 7285 matches. | |
| 699 | 7286 Also see the matchparen plugin for highlighting the match when moving |
| 7287 around |pi_paren.txt|. | |
| 7288 Note: Use of the short form is rated PG. | |
| 7 | 7289 |
| 7290 *'showmode'* *'smd'* *'noshowmode'* *'nosmd'* | |
| 7291 'showmode' 'smd' boolean (Vim default: on, Vi default: off) | |
| 7292 global | |
| 7293 If in Insert, Replace or Visual mode put a message on the last line. | |
| 7294 Use the 'M' flag in 'highlight' to set the type of highlighting for | |
| 7295 this message. | |
| 10 | 7296 When |XIM| may be used the message will include "XIM". But this |
| 7 | 7297 doesn't mean XIM is really active, especially when 'imactivatekey' is |
| 7298 not set. | |
| 7299 NOTE: This option is set to the Vi default value when 'compatible' is | |
| 7300 set and to the Vim default value when 'compatible' is reset. | |
| 7301 | |
| 677 | 7302 *'showtabline'* *'stal'* |
| 7303 'showtabline' 'stal' number (default 1) | |
| 7304 global | |
| 7305 The value of this option specifies when the line with tab page labels | |
| 7306 will be displayed: | |
| 7307 0: never | |
| 7308 1: only if there are at least two tab pages | |
| 7309 2: always | |
| 7310 This is both for the GUI and non-GUI implementation of the tab pages | |
| 7311 line. | |
| 7312 See |tab-page| for more information about tab pages. | |
| 7313 | |
| 7 | 7314 *'sidescroll'* *'ss'* |
| 7315 'sidescroll' 'ss' number (default 0) | |
| 7316 global | |
| 7317 The minimal number of columns to scroll horizontally. Used only when | |
| 7318 the 'wrap' option is off and the cursor is moved off of the screen. | |
| 7319 When it is zero the cursor will be put in the middle of the screen. | |
| 7320 When using a slow terminal set it to a large number or 0. When using | |
| 7321 a fast terminal use a small number or 1. Not used for "zh" and "zl" | |
| 7322 commands. | |
| 7323 | |
| 7324 *'sidescrolloff'* *'siso'* | |
| 7325 '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
|
7326 global or local to window |global-local| |
| 7 | 7327 The minimal number of screen columns to keep to the left and to the |
| 534 | 7328 right of the cursor if 'nowrap' is set. Setting this option to a |
| 7329 value greater than 0 while having |'sidescroll'| also at a non-zero | |
| 7330 value makes some context visible in the line you are scrolling in | |
| 7331 horizontally (except at beginning of the line). Setting this option | |
| 7332 to a large value (like 999) has the effect of keeping the cursor | |
| 7333 horizontally centered in the window, as long as one does not come too | |
| 7334 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
|
7335 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
|
7336 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
|
7337 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
|
7338 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
|
7339 < NOTE: This option is set to 0 when 'compatible' is set. |
| 7 | 7340 |
| 7341 Example: Try this together with 'sidescroll' and 'listchars' as | |
| 7342 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
|
7343 onto the "extends" character: > |
| 7 | 7344 |
| 7345 :set nowrap sidescroll=1 listchars=extends:>,precedes:< | |
| 7346 :set sidescrolloff=1 | |
|
9852
4eea48b76d03
commit https://github.com/vim/vim/commit/95ec9d6a6ab3117d60ff638670a803d43974ba51
Christian Brabandt <cb@256bit.org>
parents:
9737
diff
changeset
|
7347 < |
|
4eea48b76d03
commit https://github.com/vim/vim/commit/95ec9d6a6ab3117d60ff638670a803d43974ba51
Christian Brabandt <cb@256bit.org>
parents:
9737
diff
changeset
|
7348 *'signcolumn'* *'scl'* |
|
4eea48b76d03
commit https://github.com/vim/vim/commit/95ec9d6a6ab3117d60ff638670a803d43974ba51
Christian Brabandt <cb@256bit.org>
parents:
9737
diff
changeset
|
7349 'signcolumn' 'scl' string (default "auto") |
|
4eea48b76d03
commit https://github.com/vim/vim/commit/95ec9d6a6ab3117d60ff638670a803d43974ba51
Christian Brabandt <cb@256bit.org>
parents:
9737
diff
changeset
|
7350 local to window |
|
4eea48b76d03
commit https://github.com/vim/vim/commit/95ec9d6a6ab3117d60ff638670a803d43974ba51
Christian Brabandt <cb@256bit.org>
parents:
9737
diff
changeset
|
7351 {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
|
7352 feature} |
|
9860
9eaf8ef656e9
commit https://github.com/vim/vim/commit/0952131376a517fc12dc5ae908a97018b4ee23f0
Christian Brabandt <cb@256bit.org>
parents:
9852
diff
changeset
|
7353 Whether or not to draw the signcolumn. Valid values are: |
| 32004 | 7354 "auto" only when there is a sign to display |
| 7355 "no" never | |
| 7356 "yes" always | |
|
17129
4fb68abc770f
patch 8.1.1564: sign column takes up space
Bram Moolenaar <Bram@vim.org>
parents:
16808
diff
changeset
|
7357 "number" display signs in the 'number' column. If the number |
| 17161 | 7358 column is not present, then behaves like "auto". |
| 7 | 7359 |
| 7360 | |
| 7361 *'smartcase'* *'scs'* *'nosmartcase'* *'noscs'* | |
| 7362 'smartcase' 'scs' boolean (default off) | |
| 7363 global | |
| 7364 Override the 'ignorecase' option if the search pattern contains upper | |
| 7365 case characters. Only used when the search pattern is typed and | |
| 7366 'ignorecase' option is on. Used for the commands "/", "?", "n", "N", | |
| 3557 | 7367 ":g" and ":s". Not used for "*", "#", "gd", tag search, etc. After |
| 7 | 7368 "*" and "#" you can make 'smartcase' used by doing a "/" command, |
| 7369 recalling the search pattern from history and hitting <Enter>. | |
| 7370 NOTE: This option is reset when 'compatible' is set. | |
| 7371 | |
| 7372 *'smartindent'* *'si'* *'nosmartindent'* *'nosi'* | |
| 7373 'smartindent' 'si' boolean (default off) | |
| 7374 local to buffer | |
| 7375 Do smart autoindenting when starting a new line. Works for C-like | |
| 7376 programs, but can also be used for other languages. 'cindent' does | |
| 7377 something like this, works better in most cases, but is more strict, | |
| 2662 | 7378 see |C-indenting|. When 'cindent' is on or 'indentexpr' is set, |
| 2642 | 7379 setting 'si' has no effect. 'indentexpr' is a more advanced |
| 7380 alternative. | |
| 7 | 7381 Normally 'autoindent' should also be on when using 'smartindent'. |
| 7382 An indent is automatically inserted: | |
| 7383 - After a line ending in '{'. | |
| 7384 - After a line starting with a keyword from 'cinwords'. | |
| 7385 - Before a line starting with '}' (only with the "O" command). | |
| 7386 When typing '}' as the first character in a new line, that line is | |
| 7387 given the same indent as the matching '{'. | |
| 7388 When typing '#' as the first character in a new line, the indent for | |
| 7389 that line is removed, the '#' is put in the first column. The indent | |
| 10 | 7390 is restored for the next line. If you don't want this, use this |
| 7 | 7391 mapping: ":inoremap # X^H#", where ^H is entered with CTRL-V CTRL-H. |
| 7392 When using the ">>" command, lines starting with '#' are not shifted | |
| 7393 right. | |
| 11160 | 7394 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
|
7395 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
|
7396 reset. |
| 7 | 7397 |
| 7398 *'smarttab'* *'sta'* *'nosmarttab'* *'nosta'* | |
| 7399 'smarttab' 'sta' boolean (default off) | |
| 7400 global | |
| 7401 When on, a <Tab> in front of a line inserts blanks according to | |
| 648 | 7402 'shiftwidth'. 'tabstop' or 'softtabstop' is used in other places. A |
| 7403 <BS> will delete a 'shiftwidth' worth of space at the start of the | |
| 7404 line. | |
| 650 | 7405 When off, a <Tab> always inserts blanks according to 'tabstop' or |
| 648 | 7406 'softtabstop'. 'shiftwidth' is only used for shifting text left or |
| 7407 right |shift-left-right|. | |
| 1263 | 7408 What gets inserted (a <Tab> or spaces) depends on the 'expandtab' |
| 7 | 7409 option. Also see |ins-expandtab|. When 'expandtab' is not set, the |
| 11 | 7410 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
|
7411 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
|
7412 reset. |
| 7 | 7413 NOTE: This option is reset when 'compatible' is set. |
| 7414 | |
|
30610
6c6ac189a05f
patch 9.0.0640: cannot scroll by screen line if a line wraps
Bram Moolenaar <Bram@vim.org>
parents:
30598
diff
changeset
|
7415 *'smoothscroll'* *'sms'* *'nosmoothscroll'* *'nosms'* |
|
6c6ac189a05f
patch 9.0.0640: cannot scroll by screen line if a line wraps
Bram Moolenaar <Bram@vim.org>
parents:
30598
diff
changeset
|
7416 'smoothscroll' 'sms' boolean (default off) |
|
6c6ac189a05f
patch 9.0.0640: cannot scroll by screen line if a line wraps
Bram Moolenaar <Bram@vim.org>
parents:
30598
diff
changeset
|
7417 local to window |
|
6c6ac189a05f
patch 9.0.0640: cannot scroll by screen line if a line wraps
Bram Moolenaar <Bram@vim.org>
parents:
30598
diff
changeset
|
7418 Scrolling works with screen lines. When 'wrap' is set and the first |
|
6c6ac189a05f
patch 9.0.0640: cannot scroll by screen line if a line wraps
Bram Moolenaar <Bram@vim.org>
parents:
30598
diff
changeset
|
7419 line in the window wraps part of it may not be visible, as if it is |
| 30634 | 7420 above the window. "<<<" is displayed at the start of the first line, |
| 7421 highlighted with |hl-NonText|. | |
| 7422 NOTE: only partly implemented, currently works with CTRL-E, CTRL-Y | |
| 7423 and scrolling with the mouse. | |
|
30610
6c6ac189a05f
patch 9.0.0640: cannot scroll by screen line if a line wraps
Bram Moolenaar <Bram@vim.org>
parents:
30598
diff
changeset
|
7424 |
| 7 | 7425 *'softtabstop'* *'sts'* |
| 7426 'softtabstop' 'sts' number (default 0) | |
| 7427 local to buffer | |
| 7428 Number of spaces that a <Tab> counts for while performing editing | |
| 7429 operations, like inserting a <Tab> or using <BS>. It "feels" like | |
| 7430 <Tab>s are being inserted, while in fact a mix of spaces and <Tab>s is | |
| 7431 used. This is useful to keep the 'ts' setting at its standard value | |
| 7432 of 8, while being able to edit like it is set to 'sts'. However, | |
| 7433 commands like "x" still work on the actual characters. | |
| 7434 When 'sts' is zero, this feature is off. | |
| 3893 | 7435 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
|
7436 '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
|
7437 when 'paste' is reset. |
| 7 | 7438 See also |ins-expandtab|. When 'expandtab' is not set, the number of |
| 7439 spaces is minimized by using <Tab>s. | |
| 7440 The 'L' flag in 'cpoptions' changes how tabs are used when 'list' is | |
| 7441 set. | |
| 7442 NOTE: This option is set to 0 when 'compatible' is set. | |
| 7443 | |
|
14175
2ad722003b36
patch 8.1.0105: all tab stops are the same
Christian Brabandt <cb@256bit.org>
parents:
14019
diff
changeset
|
7444 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
|
7445 '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
|
7446 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
|
7447 |
| 221 | 7448 *'spell'* *'nospell'* |
| 7449 'spell' boolean (default off) | |
| 7450 local to window | |
| 7451 {not available when compiled without the |+syntax| | |
| 7452 feature} | |
| 7453 When on spell checking will be done. See |spell|. | |
| 236 | 7454 The languages are specified with 'spelllang'. |
| 221 | 7455 |
| 386 | 7456 *'spellcapcheck'* *'spc'* |
| 389 | 7457 'spellcapcheck' 'spc' string (default "[.?!]\_[\])'" \t]\+") |
| 386 | 7458 local to buffer |
| 7459 {not available when compiled without the |+syntax| | |
| 7460 feature} | |
| 7461 Pattern to locate the end of a sentence. The following word will be | |
| 7462 checked to start with a capital letter. If not then it is highlighted | |
| 484 | 7463 with SpellCap |hl-SpellCap| (unless the word is also badly spelled). |
| 386 | 7464 When this check is not wanted make this option empty. |
| 7465 Only used when 'spell' is set. | |
| 389 | 7466 Be careful with special characters, see |option-backslash| about |
| 7467 including spaces and backslashes. | |
| 480 | 7468 To set this option automatically depending on the language, see |
| 7469 |set-spc-auto|. | |
| 386 | 7470 |
| 314 | 7471 *'spellfile'* *'spf'* |
| 7472 'spellfile' 'spf' string (default empty) | |
| 7473 local to buffer | |
| 7474 {not available when compiled without the |+syntax| | |
| 7475 feature} | |
| 7476 Name of the word list file where words are added for the |zg| and |zw| | |
| 401 | 7477 commands. It must end in ".{encoding}.add". You need to include the |
| 7478 path, otherwise the file is placed in the current directory. | |
| 29659 | 7479 The path may include characters from 'isfname', space, comma and '@'. |
| 386 | 7480 *E765* |
| 28379 | 7481 It may also be a comma-separated list of names. A count before the |
| 386 | 7482 |zg| and |zw| commands can be used to access each. This allows using |
| 7483 a personal word list file and a project word list file. | |
| 314 | 7484 When a word is added while this option is empty Vim will set it for |
| 819 | 7485 you: Using the first directory in 'runtimepath' that is writable. If |
| 7486 there is no "spell" directory yet it will be created. For the file | |
| 7487 name the first language name that appears in 'spelllang' is used, | |
| 353 | 7488 ignoring the region. |
| 7489 The resulting ".spl" file will be used for spell checking, it does not | |
| 7490 have to appear in 'spelllang'. | |
| 7491 Normally one file is used for all regions, but you can add the region | |
| 7492 name if you want to. However, it will then only be used when | |
| 7493 'spellfile' is set to it, for entries in 'spelllang' only files | |
| 7494 without region name will be found. | |
| 336 | 7495 This option cannot be set from a |modeline| or in the |sandbox|, for |
| 7496 security reasons. | |
| 314 | 7497 |
| 221 | 7498 *'spelllang'* *'spl'* |
| 314 | 7499 'spelllang' 'spl' string (default "en") |
| 221 | 7500 local to buffer |
| 7501 {not available when compiled without the |+syntax| | |
| 7502 feature} | |
| 28379 | 7503 A comma-separated list of word list names. When the 'spell' option is |
| 353 | 7504 on spellchecking will be done for these languages. Example: > |
| 7505 set spelllang=en_us,nl,medical | |
| 7506 < This means US English, Dutch and medical words are recognized. Words | |
| 7507 that are not recognized will be highlighted. | |
| 16380 | 7508 The word list name must consist of alphanumeric characters, a dash or |
| 7509 an underscore. It should not include a comma or dot. Using a dash is | |
| 353 | 7510 recommended to separate the two letter language name from a |
| 7511 specification. Thus "en-rare" is used for rare English words. | |
| 7512 A region name must come last and have the form "_xx", where "xx" is | |
| 7513 the two-letter, lower case region name. You can use more than one | |
| 7514 region by listing them: "en_us,en_ca" supports both US and Canadian | |
| 7515 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
|
7516 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
|
7517 en_ca, en_gb and en_us). |
| 5477 | 7518 If the name "cjk" is included East Asian characters are excluded from |
| 7519 spell checking. This is useful when editing text that also has Asian | |
| 7520 words. | |
| 25773 | 7521 Note that the "medical" dictionary does not exist, it is just an |
| 7522 example of a longer name. | |
| 484 | 7523 *E757* |
| 419 | 7524 As a special case the name of a .spl file can be given as-is. The |
| 7525 first "_xx" in the name is removed and used as the region name | |
| 7526 (_xx is an underscore, two letters and followed by a non-letter). | |
| 7527 This is mainly for testing purposes. You must make sure the correct | |
| 7528 encoding is used, Vim doesn't check it. | |
| 236 | 7529 When 'encoding' is set the word lists are reloaded. Thus it's a good |
| 419 | 7530 idea to set 'spelllang' after setting 'encoding' to avoid loading the |
| 7531 files twice. | |
| 353 | 7532 How the related spell files are found is explained here: |spell-load|. |
| 221 | 7533 |
| 653 | 7534 If the |spellfile.vim| plugin is active and you use a language name |
| 7535 for which Vim cannot find the .spl file in 'runtimepath' the plugin | |
| 7536 will ask you if you want to download the file. | |
| 7537 | |
| 480 | 7538 After this option has been set successfully, Vim will source the files |
| 7539 "spell/LANG.vim" in 'runtimepath'. "LANG" is the value of 'spelllang' | |
| 15068 | 7540 up to the first character that is not an ASCII letter or number and |
| 7541 not a dash. Also see |set-spc-auto|. | |
| 480 | 7542 |
|
20802
ed00f0fbdaef
patch 8.2.0953: spell checking doesn't work for CamelCased words
Bram Moolenaar <Bram@vim.org>
parents:
20758
diff
changeset
|
7543 *'spelloptions'* *'spo'* |
|
ed00f0fbdaef
patch 8.2.0953: spell checking doesn't work for CamelCased words
Bram Moolenaar <Bram@vim.org>
parents:
20758
diff
changeset
|
7544 '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
|
7545 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
|
7546 {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
|
7547 feature} |
| 28379 | 7548 A comma-separated list of options for spell checking: |
|
20802
ed00f0fbdaef
patch 8.2.0953: spell checking doesn't work for CamelCased words
Bram Moolenaar <Bram@vim.org>
parents:
20758
diff
changeset
|
7549 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
|
7550 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
|
7551 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
|
7552 start of a new word. |
| 480 | 7553 |
| 344 | 7554 *'spellsuggest'* *'sps'* |
| 7555 'spellsuggest' 'sps' string (default "best") | |
| 7556 global | |
| 7557 {not available when compiled without the |+syntax| | |
| 7558 feature} | |
| 593 | 7559 Methods used for spelling suggestions. Both for the |z=| command and |
| 374 | 7560 the |spellsuggest()| function. This is a comma-separated list of |
| 7561 items: | |
| 7562 | |
| 7563 best Internal method that works best for English. Finds | |
| 7564 changes like "fast" and uses a bit of sound-a-like | |
| 7565 scoring to improve the ordering. | |
| 7566 | |
| 7567 double Internal method that uses two methods and mixes the | |
| 7568 results. The first method is "fast", the other method | |
| 344 | 7569 computes how much the suggestion sounds like the bad |
| 374 | 7570 word. That only works when the language specifies |
| 7571 sound folding. Can be slow and doesn't always give | |
| 7572 better results. | |
| 7573 | |
| 7574 fast Internal method that only checks for simple changes: | |
| 7575 character inserts/deletes/swaps. Works well for | |
| 7576 simple typing mistakes. | |
| 7577 | |
| 593 | 7578 {number} The maximum number of suggestions listed for |z=|. |
| 484 | 7579 Not used for |spellsuggest()|. The number of |
| 7580 suggestions is never more than the value of 'lines' | |
| 7581 minus two. | |
| 7582 | |
|
27441
674240fcf6de
patch 8.2.4249: the timeout limit for spell suggestions is always 5000
Bram Moolenaar <Bram@vim.org>
parents:
27321
diff
changeset
|
7583 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
|
7584 {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
|
7585 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
|
7586 negative there is no limit. {only works when built |
| 29290 | 7587 with the |+reltime| feature} |
|
27441
674240fcf6de
patch 8.2.4249: the timeout limit for spell suggestions is always 5000
Bram Moolenaar <Bram@vim.org>
parents:
27321
diff
changeset
|
7588 |
| 374 | 7589 file:{filename} Read file {filename}, which must have two columns, |
| 7590 separated by a slash. The first column contains the | |
| 7591 bad word, the second column the suggested good word. | |
| 7592 Example: | |
| 7593 theribal/terrible ~ | |
| 7594 Use this for common mistakes that do not appear at the | |
| 7595 top of the suggestion list with the internal methods. | |
| 7596 Lines without a slash are ignored, use this for | |
| 7597 comments. | |
| 5862 | 7598 The word in the second column must be correct, |
| 7599 otherwise it will not be used. Add the word to an | |
| 7600 ".add" file if it is currently flagged as a spelling | |
| 7601 mistake. | |
| 374 | 7602 The file is used for all languages. |
| 7603 | |
| 7604 expr:{expr} Evaluate expression {expr}. Use a function to avoid | |
|
30598
37aa9fd2ed72
patch 9.0.0634: evaluating "expr" options has more overhead than needed
Bram Moolenaar <Bram@vim.org>
parents:
30547
diff
changeset
|
7605 trouble with spaces. Best is to call a function |
|
37aa9fd2ed72
patch 9.0.0634: evaluating "expr" options has more overhead than needed
Bram Moolenaar <Bram@vim.org>
parents:
30547
diff
changeset
|
7606 without arguments, see |expr-option-function|. |
|
37aa9fd2ed72
patch 9.0.0634: evaluating "expr" options has more overhead than needed
Bram Moolenaar <Bram@vim.org>
parents:
30547
diff
changeset
|
7607 |v:val| holds the badly spelled word. The expression |
|
37aa9fd2ed72
patch 9.0.0634: evaluating "expr" options has more overhead than needed
Bram Moolenaar <Bram@vim.org>
parents:
30547
diff
changeset
|
7608 must evaluate to a List of Lists, each with a |
|
37aa9fd2ed72
patch 9.0.0634: evaluating "expr" options has more overhead than needed
Bram Moolenaar <Bram@vim.org>
parents:
30547
diff
changeset
|
7609 suggestion and a score. |
| 374 | 7610 Example: |
| 11062 | 7611 [['the', 33], ['that', 44]] ~ |
| 593 | 7612 Set 'verbose' and use |z=| to see the scores that the |
| 374 | 7613 internal methods use. A lower score is better. |
| 7614 This may invoke |spellsuggest()| if you temporarily | |
| 7615 set 'spellsuggest' to exclude the "expr:" part. | |
| 7616 Errors are silently ignored, unless you set the | |
| 7617 'verbose' option to a non-zero value. | |
| 7618 | |
| 7619 Only one of "best", "double" or "fast" may be used. The others may | |
| 7620 appear several times in any order. Example: > | |
| 7621 :set sps=file:~/.vim/sugg,best,expr:MySuggest() | |
| 7622 < | |
| 7623 This option cannot be set from a |modeline| or in the |sandbox|, for | |
| 7624 security reasons. | |
| 344 | 7625 |
| 7626 | |
| 7 | 7627 *'splitbelow'* *'sb'* *'nosplitbelow'* *'nosb'* |
| 7628 'splitbelow' 'sb' boolean (default off) | |
| 7629 global | |
| 7630 When on, splitting a window will put the new window below the current | |
| 7631 one. |:split| | |
| 7632 | |
| 30875 | 7633 *'splitkeep'* *'spk'* |
|
30624
f2f35161d75a
patch 9.0.0647: the 'splitscroll' option is not a good name
Bram Moolenaar <Bram@vim.org>
parents:
30610
diff
changeset
|
7634 'splitkeep' 'spk' string (default "cursor") |
|
f2f35161d75a
patch 9.0.0647: the 'splitscroll' option is not a good name
Bram Moolenaar <Bram@vim.org>
parents:
30610
diff
changeset
|
7635 global |
|
f2f35161d75a
patch 9.0.0647: the 'splitscroll' option is not a good name
Bram Moolenaar <Bram@vim.org>
parents:
30610
diff
changeset
|
7636 The value of this option determines the scroll behavior when opening, |
|
f2f35161d75a
patch 9.0.0647: the 'splitscroll' option is not a good name
Bram Moolenaar <Bram@vim.org>
parents:
30610
diff
changeset
|
7637 closing or resizing horizontal splits. |
|
f2f35161d75a
patch 9.0.0647: the 'splitscroll' option is not a good name
Bram Moolenaar <Bram@vim.org>
parents:
30610
diff
changeset
|
7638 |
|
f2f35161d75a
patch 9.0.0647: the 'splitscroll' option is not a good name
Bram Moolenaar <Bram@vim.org>
parents:
30610
diff
changeset
|
7639 Possible values are: |
|
f2f35161d75a
patch 9.0.0647: the 'splitscroll' option is not a good name
Bram Moolenaar <Bram@vim.org>
parents:
30610
diff
changeset
|
7640 cursor Keep the same relative cursor position. |
|
f2f35161d75a
patch 9.0.0647: the 'splitscroll' option is not a good name
Bram Moolenaar <Bram@vim.org>
parents:
30610
diff
changeset
|
7641 screen Keep the text on the same screen line. |
|
f2f35161d75a
patch 9.0.0647: the 'splitscroll' option is not a good name
Bram Moolenaar <Bram@vim.org>
parents:
30610
diff
changeset
|
7642 topline Keep the topline the same. |
|
f2f35161d75a
patch 9.0.0647: the 'splitscroll' option is not a good name
Bram Moolenaar <Bram@vim.org>
parents:
30610
diff
changeset
|
7643 |
|
f2f35161d75a
patch 9.0.0647: the 'splitscroll' option is not a good name
Bram Moolenaar <Bram@vim.org>
parents:
30610
diff
changeset
|
7644 For the "screen" and "topline" values, the cursor position will be |
|
f2f35161d75a
patch 9.0.0647: the 'splitscroll' option is not a good name
Bram Moolenaar <Bram@vim.org>
parents:
30610
diff
changeset
|
7645 changed when necessary. In this case, the jumplist will be populated |
|
f2f35161d75a
patch 9.0.0647: the 'splitscroll' option is not a good name
Bram Moolenaar <Bram@vim.org>
parents:
30610
diff
changeset
|
7646 with the previous cursor position. For "screen", the text cannot always |
| 30875 | 7647 be kept on the same screen line when 'wrap' is enabled. |
|
30624
f2f35161d75a
patch 9.0.0647: the 'splitscroll' option is not a good name
Bram Moolenaar <Bram@vim.org>
parents:
30610
diff
changeset
|
7648 |
| 7 | 7649 *'splitright'* *'spr'* *'nosplitright'* *'nospr'* |
| 7650 'splitright' 'spr' boolean (default off) | |
| 7651 global | |
| 7652 When on, splitting a window will put the new window right of the | |
| 7653 current one. |:vsplit| | |
| 7654 | |
| 7655 *'startofline'* *'sol'* *'nostartofline'* *'nosol'* | |
| 7656 'startofline' 'sol' boolean (default on) | |
| 7657 global | |
| 7658 When "on" the commands listed below move the cursor to the first | |
| 11 | 7659 non-blank of the line. When off the cursor is kept in the same column |
| 10 | 7660 (if possible). This applies to the commands: CTRL-D, CTRL-U, CTRL-B, |
| 11 | 7661 CTRL-F, "G", "H", "M", "L", gg, and to the commands "d", "<<" and ">>" |
| 7 | 7662 with a linewise operator, with "%" with a count and to buffer changing |
| 7663 commands (CTRL-^, :bnext, :bNext, etc.). Also for an Ex command that | |
| 7664 only has a line number, e.g., ":25" or ":+". | |
| 7665 In case of buffer changing commands the cursor is placed at the column | |
| 7666 where it was the last time the buffer was edited. | |
| 7667 NOTE: This option is set when 'compatible' is set. | |
| 7668 | |
| 2709 | 7669 *'statusline'* *'stl'* *E540* *E542* |
| 7 | 7670 'statusline' 'stl' string (default empty) |
| 40 | 7671 global or local to window |global-local| |
| 7 | 7672 {not available when compiled without the |+statusline| |
| 7673 feature} | |
| 27804 | 7674 When non-empty, this option determines the content of the status line. |
| 7 | 7675 Also see |status-line|. |
| 7676 | |
| 7677 The option consists of printf style '%' items interspersed with | |
| 7678 normal text. Each status line item is of the form: | |
| 7679 %-0{minwid}.{maxwid}{item} | |
|
7876
93f747af7b58
commit https://github.com/vim/vim/commit/5e9b2fa9bb0e6061cf18457c173cd141a5dc9c92
Christian Brabandt <cb@256bit.org>
parents:
7687
diff
changeset
|
7680 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
|
7681 be given as "%%". |
| 7 | 7682 |
| 680 | 7683 When the option starts with "%!" then it is used as an expression, |
| 7684 evaluated and the result is used as the option value. Example: > | |
| 7685 :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
|
7686 < 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
|
7687 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
|
7688 The result can contain %{} items that will be evaluated too. |
| 3445 | 7689 Note that the "%!" expression is evaluated in the context of the |
| 7690 current window and buffer, while %{} items are evaluated in the | |
| 7691 context of the window that the statusline belongs to. | |
| 680 | 7692 |
| 7693 When there is error while evaluating the option then it will be made | |
| 7694 empty to avoid further errors. Otherwise screen updating would loop. | |
| 31671 | 7695 When the result contains unprintable characters the result is |
| 7696 unpredictable. | |
| 680 | 7697 |
| 7 | 7698 Note that the only effect of 'ruler' when this option is set (and |
| 7699 'laststatus' is 2) is controlling the output of |CTRL-G|. | |
| 7700 | |
| 7701 field meaning ~ | |
| 233 | 7702 - Left justify the item. The default is right justified |
| 7 | 7703 when minwid is larger than the length of the item. |
| 233 | 7704 0 Leading zeroes in numeric items. Overridden by '-'. |
| 7 | 7705 minwid Minimum width of the item, padding as set by '-' & '0'. |
| 7706 Value must be 50 or less. | |
| 10 | 7707 maxwid Maximum width of the item. Truncation occurs with a '<' |
| 7 | 7708 on the left for text items. Numeric items will be |
| 7709 shifted down to maxwid-2 digits followed by '>'number | |
| 7710 where number is the amount of missing digits, much like | |
| 7711 an exponential notation. | |
| 7712 item A one letter code as described below. | |
| 7713 | |
| 7714 Following is a description of the possible statusline items. The | |
| 7715 second character in "item" is the type: | |
| 7716 N for number | |
| 7717 S for string | |
| 7718 F for flags as described below | |
| 7719 - not applicable | |
| 7720 | |
| 7721 item meaning ~ | |
| 1152 | 7722 f S Path to the file in the buffer, as typed or relative to current |
| 7723 directory. | |
| 7 | 7724 F S Full path to the file in the buffer. |
| 7725 t S File name (tail) of file in the buffer. | |
| 1698 | 7726 m F Modified flag, text is "[+]"; "[-]" if 'modifiable' is off. |
| 7 | 7727 M F Modified flag, text is ",+" or ",-". |
| 1698 | 7728 r F Readonly flag, text is "[RO]". |
| 7 | 7729 R F Readonly flag, text is ",RO". |
| 1698 | 7730 h F Help buffer flag, text is "[help]". |
| 7 | 7731 H F Help buffer flag, text is ",HLP". |
| 1698 | 7732 w F Preview window flag, text is "[Preview]". |
| 7 | 7733 W F Preview window flag, text is ",PRV". |
| 1698 | 7734 y F Type of file in the buffer, e.g., "[vim]". See 'filetype'. |
| 7 | 7735 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
|
7736 q S "[Quickfix List]", "[Location List]" or empty. |
| 7 | 7737 k S Value of "b:keymap_name" or 'keymap' when |:lmap| mappings are |
| 7738 being used: "<keymap>" | |
| 7739 n N Buffer number. | |
| 2709 | 7740 b N Value of character under cursor. |
| 7 | 7741 B N As above, in hexadecimal. |
| 7742 o N Byte number in file of byte under cursor, first byte is 1. | |
| 7743 Mnemonic: Offset from start of file (with one added) | |
| 7744 {not available when compiled without |+byte_offset| feature} | |
| 7745 O N As above, in hexadecimal. | |
| 233 | 7746 N N Printer page number. (Only works in the 'printheader' option.) |
| 7 | 7747 l N Line number. |
| 7748 L N Number of lines in buffer. | |
| 22328 | 7749 c N Column number (byte index). |
| 7750 v N Virtual column number (screen column). | |
| 10 | 7751 V N Virtual column number as -{num}. Not displayed if equal to 'c'. |
| 7 | 7752 p N Percentage through file in lines as in |CTRL-G|. |
| 7753 P S Percentage through file of displayed window. This is like the | |
| 5055 | 7754 percentage described for 'ruler'. Always 3 in length, unless |
| 7755 translated. | |
|
31457
bb797331e21b
patch 9.0.1061: cannot display 'showcmd' somewhere else
Bram Moolenaar <Bram@vim.org>
parents:
31430
diff
changeset
|
7756 S S 'showcmd' content, see 'showcmdloc'. |
| 233 | 7757 a S Argument list status as in default title. ({current} of {max}) |
| 7 | 7758 Empty if the argument file count is zero or one. |
| 680 | 7759 { 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
|
7760 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
|
7761 expression cannot contain a '}' character, call a function to |
| 18719 | 7762 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
|
7763 {% - 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
|
7764 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
|
7765 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
|
7766 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
|
7767 expression is denoted by %}. |
| 25973 | 7768 For example: > |
|
24630
4cf4d7a71fac
patch 8.2.2854: custom statusline cannot contain % items
Bram Moolenaar <Bram@vim.org>
parents:
24600
diff
changeset
|
7769 func! Stl_filename() abort |
|
4cf4d7a71fac
patch 8.2.2854: custom statusline cannot contain % items
Bram Moolenaar <Bram@vim.org>
parents:
24600
diff
changeset
|
7770 return "%t" |
|
4cf4d7a71fac
patch 8.2.2854: custom statusline cannot contain % items
Bram Moolenaar <Bram@vim.org>
parents:
24600
diff
changeset
|
7771 endfunc |
|
4cf4d7a71fac
patch 8.2.2854: custom statusline cannot contain % items
Bram Moolenaar <Bram@vim.org>
parents:
24600
diff
changeset
|
7772 < `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
|
7773 `stl=%{%Stl_filename()%}` results in `"Name of current file"` |
| 25973 | 7774 %} - End of `{%` expression |
| 7 | 7775 ( - Start of item group. Can be used for setting the width and |
| 7776 alignment of a section. Must be followed by %) somewhere. | |
| 7777 ) - End of item group. No width fields allowed. | |
| 681 | 7778 T N For 'tabline': start of tab page N label. Use %T after the last |
| 7779 label. This information is used for mouse clicks. | |
| 7780 X N For 'tabline': start of close tab N label. Use %X after the | |
| 7781 label, e.g.: %3Xclose%X. Use %999X for a "close current tab" | |
| 7782 mark. This information is used for mouse clicks. | |
| 7 | 7783 < - Where to truncate line if too long. Default is at the start. |
| 7784 No width fields allowed. | |
|
31936
82da100c0e45
patch 9.0.1300: 'statusline' only supports one "%=" item
Bram Moolenaar <Bram@vim.org>
parents:
31885
diff
changeset
|
7785 = - Separation point between alignment sections. Each section will |
|
82da100c0e45
patch 9.0.1300: 'statusline' only supports one "%=" item
Bram Moolenaar <Bram@vim.org>
parents:
31885
diff
changeset
|
7786 be separated by an equal number of spaces. With one %= what |
|
82da100c0e45
patch 9.0.1300: 'statusline' only supports one "%=" item
Bram Moolenaar <Bram@vim.org>
parents:
31885
diff
changeset
|
7787 comes after it will be right-aligned. With two %= there is a |
|
82da100c0e45
patch 9.0.1300: 'statusline' only supports one "%=" item
Bram Moolenaar <Bram@vim.org>
parents:
31885
diff
changeset
|
7788 middle part, with white space left and right of it. |
| 7 | 7789 No width fields allowed. |
| 680 | 7790 # - Set highlight group. The name must follow and then a # again. |
| 7791 Thus use %#HLname# for highlight group HLname. The same | |
| 7792 highlighting is used, also for the statusline of non-current | |
| 7793 windows. | |
| 7 | 7794 * - Set highlight group to User{N}, where {N} is taken from the |
| 233 | 7795 minwid field, e.g. %1*. Restore normal highlight with %* or %0*. |
| 31885 | 7796 The difference between User{N} and StatusLine will be applied to |
| 7797 StatusLineNC for the statusline of non-current windows. | |
| 7 | 7798 The number N must be between 1 and 9. See |hl-User1..9| |
| 7799 | |
| 1698 | 7800 When displaying a flag, Vim removes the leading comma, if any, when |
| 7801 that flag comes right after plaintext. This will make a nice display | |
| 7802 when flags are used like in the examples below. | |
| 7 | 7803 |
| 233 | 7804 When all items in a group becomes an empty string (i.e. flags that are |
| 7 | 7805 not set) and a minwid is not set for the group, the whole group will |
| 7806 become empty. This will make a group like the following disappear | |
| 7807 completely from the statusline when none of the flags are set. > | |
| 7808 :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
|
7809 < 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
|
7810 line is displayed. |
| 18719 | 7811 *stl-%{* *g:actual_curbuf* *g:actual_curwin* |
| 19163 | 7812 While evaluating %{} the current buffer and current window will be set |
| 7813 temporarily to that of the window (and buffer) whose statusline is | |
| 18719 | 7814 currently being drawn. The expression will evaluate in this context. |
| 7815 The variable "g:actual_curbuf" is set to the `bufnr()` number of the | |
| 7816 real current buffer and "g:actual_curwin" to the |window-ID| of the | |
| 7817 real current window. These values are strings. | |
| 634 | 7818 |
| 3682 | 7819 The 'statusline' option will be evaluated in the |sandbox| if set from |
| 7820 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
|
7821 This option cannot be set in a modeline when 'modelineexpr' is off. |
| 634 | 7822 |
| 7823 It is not allowed to change text or jump to another window while | |
| 7824 evaluating 'statusline' |textlock|. | |
| 7 | 7825 |
| 7826 If the statusline is not updated when you want it (e.g., after setting | |
| 7827 a variable that's used in an expression), you can force an update by | |
| 29066 | 7828 using `:redrawstatus`. |
| 7829 | |
| 7830 A result of all digits is regarded a number for display purposes. | |
| 7 | 7831 Otherwise the result is taken as flag text and applied to the rules |
| 7832 described above. | |
| 7833 | |
| 199 | 7834 Watch out for errors in expressions. They may render Vim unusable! |
| 7 | 7835 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
|
7836 edit your .vimrc or whatever with "vim --clean" to get it right. |
| 7 | 7837 |
| 7838 Examples: | |
| 7839 Emulate standard status line with 'ruler' set > | |
| 7840 :set statusline=%<%f\ %h%m%r%=%-14.(%l,%c%V%)\ %P | |
| 7841 < Similar, but add ASCII value of char under the cursor (like "ga") > | |
| 7842 :set statusline=%<%f%h%m%r%=%b\ 0x%B\ \ %l,%c%V\ %P | |
| 7843 < Display byte count and byte value, modified flag in red. > | |
| 7844 :set statusline=%<%f%=\ [%1*%M%*%n%R%H]\ %-19(%3l,%02c%03V%)%O'%02b' | |
| 7845 :hi User1 term=inverse,bold cterm=inverse,bold ctermfg=red | |
| 7846 < Display a ,GZ flag if a compressed file is loaded > | |
| 7847 :set statusline=...%r%{VarExists('b:gzflag','\ [GZ]')}%h... | |
| 7848 < In the |:autocmd|'s: > | |
| 7849 :let b:gzflag = 1 | |
| 7850 < And: > | |
| 7851 :unlet b:gzflag | |
| 7852 < And define this function: > | |
| 7853 :function VarExists(var, val) | |
| 7854 : if exists(a:var) | return a:val | else | return '' | endif | |
| 7855 :endfunction | |
| 7856 < | |
| 7857 *'suffixes'* *'su'* | |
| 7858 'suffixes' 'su' string (default ".bak,~,.o,.h,.info,.swp,.obj") | |
| 7859 global | |
| 7860 Files with these suffixes get a lower priority when multiple files | |
| 7861 match a wildcard. See |suffixes|. Commas can be used to separate the | |
| 10 | 7862 suffixes. Spaces after the comma are ignored. A dot is also seen as |
| 7863 the start of a suffix. To avoid a dot or comma being recognized as a | |
| 7 | 7864 separator, precede it with a backslash (see |option-backslash| about |
| 7865 including spaces and backslashes). | |
| 7866 See 'wildignore' for completely ignoring files. | |
| 7867 The use of |:set+=| and |:set-=| is preferred when adding or removing | |
| 7868 suffixes from the list. This avoids problems when a future version | |
| 7869 uses another default. | |
| 7870 | |
| 7871 *'suffixesadd'* *'sua'* | |
| 7872 'suffixesadd' 'sua' string (default "") | |
| 7873 local to buffer | |
| 28379 | 7874 Comma-separated list of suffixes, which are used when searching for a |
| 7 | 7875 file for the "gf", "[I", etc. commands. Example: > |
| 7876 :set suffixesadd=.java | |
| 7877 < | |
| 7878 *'swapfile'* *'swf'* *'noswapfile'* *'noswf'* | |
| 7879 'swapfile' 'swf' boolean (default on) | |
| 7880 local to buffer | |
| 10 | 7881 Use a swapfile for the buffer. This option can be reset when a |
| 7 | 7882 swapfile is not wanted for a specific buffer. For example, with |
| 7883 confidential information that even root must not be able to access. | |
| 7884 Careful: All text will be in memory: | |
| 7885 - Don't use this for big files. | |
| 7886 - Recovery will be impossible! | |
| 7887 A swapfile will only be present when |'updatecount'| is non-zero and | |
| 7888 'swapfile' is set. | |
| 7889 When 'swapfile' is reset, the swap file for the current buffer is | |
| 7890 immediately deleted. When 'swapfile' is set, and 'updatecount' is | |
| 7891 non-zero, a swap file is immediately created. | |
| 7892 Also see |swap-file| and |'swapsync'|. | |
| 5763 | 7893 If you want to open a new buffer without creating a swap file for it, |
| 7894 use the |:noswapfile| modifier. | |
|
13341
acd7eaa13d2b
Updated runtime files.
Christian Brabandt <cb@256bit.org>
parents:
13314
diff
changeset
|
7895 See 'directory' for where the swap file is created. |
| 7 | 7896 |
| 7897 This option is used together with 'bufhidden' and 'buftype' to | |
| 7898 specify special kinds of buffers. See |special-buffers|. | |
| 7899 | |
| 7900 *'swapsync'* *'sws'* | |
| 7901 'swapsync' 'sws' string (default "fsync") | |
| 7902 global | |
| 7903 When this option is not empty a swap file is synced to disk after | |
| 10 | 7904 writing to it. This takes some time, especially on busy unix systems. |
| 7 | 7905 When this option is empty parts of the swap file may be in memory and |
| 7906 not written to disk. When the system crashes you may lose more work. | |
| 7907 On Unix the system does a sync now and then without Vim asking for it, | |
| 7908 so the disadvantage of setting this option off is small. On some | |
| 7909 systems the swap file will not be written at all. For a unix system | |
| 7910 setting it to "sync" will use the sync() call instead of the default | |
| 7911 fsync(), which may work better on some systems. | |
| 36 | 7912 The 'fsync' option is used for the actual file. |
| 7 | 7913 |
| 7914 *'switchbuf'* *'swb'* | |
| 7915 'switchbuf' 'swb' string (default "") | |
| 7916 global | |
| 7917 This option controls the behavior when switching between buffers. | |
| 24751 | 7918 Mostly for |quickfix| commands some values are also used for other |
| 7919 commands, as mentioned below. | |
| 28379 | 7920 Possible values (comma-separated list): |
| 7 | 7921 useopen If included, jump to the first open window that |
| 7922 contains the specified buffer (if there is one). | |
| 7923 Otherwise: Do not examine other windows. | |
| 7924 This setting is checked with |quickfix| commands, when | |
| 7925 jumping to errors (":cc", ":cn", "cp", etc.). It is | |
| 7926 also used in all buffer related split commands, for | |
| 7927 example ":sbuffer", ":sbnext", or ":sbrewind". | |
| 825 | 7928 usetab Like "useopen", but also consider windows in other tab |
| 856 | 7929 pages. |
| 7 | 7930 split If included, split the current window before loading |
| 3153 | 7931 a buffer for a |quickfix| command that display errors. |
| 16086 | 7932 Otherwise: do not split, use current window (when used |
| 7933 in the quickfix window: the previously used window or | |
| 7934 split if there is no other window). | |
| 6843 | 7935 vsplit Just like "split" but split vertically. |
| 1621 | 7936 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
|
7937 "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
|
7938 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
|
7939 jumping to errors with |quickfix| commands. |
| 7 | 7940 |
| 410 | 7941 *'synmaxcol'* *'smc'* |
| 7942 'synmaxcol' 'smc' number (default 3000) | |
| 7943 local to buffer | |
| 7944 {not available when compiled without the |+syntax| | |
| 7945 feature} | |
| 419 | 7946 Maximum column in which to search for syntax items. In long lines the |
| 7947 text after this column is not highlighted and following lines may not | |
| 7948 be highlighted correctly, because the syntax state is cleared. | |
| 410 | 7949 This helps to avoid very slow redrawing for an XML file that is one |
| 7950 long line. | |
| 7951 Set to zero to remove the limit. | |
| 7952 | |
| 7 | 7953 *'syntax'* *'syn'* |
| 7954 'syntax' 'syn' string (default empty) | |
| 7955 local to buffer | |
| 7956 {not available when compiled without the |+syntax| | |
| 7957 feature} | |
| 7958 When this option is set, the syntax with this name is loaded, unless | |
| 7959 syntax highlighting has been switched off with ":syntax off". | |
| 7960 Otherwise this option does not always reflect the current syntax (the | |
| 7961 b:current_syntax variable does). | |
| 7962 This option is most useful in a modeline, for a file which syntax is | |
| 782 | 7963 not automatically recognized. Example, in an IDL file: |
| 7964 /* vim: set syntax=idl : */ ~ | |
| 7965 When a dot appears in the value then this separates two filetype | |
| 7966 names. Example: | |
| 7967 /* vim: set syntax=c.doxygen : */ ~ | |
| 7968 This will use the "c" syntax first, then the "doxygen" syntax. | |
| 7969 Note that the second one must be prepared to be loaded as an addition, | |
| 7970 otherwise it will be skipped. More than one dot may appear. | |
| 7971 To switch off syntax highlighting for the current file, use: > | |
| 7 | 7972 :set syntax=OFF |
| 7973 < To switch syntax highlighting on according to the current value of the | |
| 7974 'filetype' option: > | |
| 7975 :set syntax=ON | |
| 7976 < What actually happens when setting the 'syntax' option is that the | |
| 7977 Syntax autocommand event is triggered with the value as argument. | |
| 7978 This option is not copied to another buffer, independent of the 's' or | |
| 7979 'S' flag in 'cpoptions'. | |
| 36 | 7980 Only normal file name characters can be used, "/\*?[|<>" are illegal. |
| 7 | 7981 |
| 699 | 7982 *'tabline'* *'tal'* |
| 677 | 7983 'tabline' 'tal' string (default empty) |
| 674 | 7984 global |
| 27804 | 7985 When non-empty, this option determines the content of the tab pages |
| 677 | 7986 line at the top of the Vim window. When empty Vim will use a default |
| 681 | 7987 tab pages line. See |setting-tabline| for more info. |
| 677 | 7988 |
| 7989 The tab pages line only appears as specified with the 'showtabline' | |
| 688 | 7990 option and only when there is no GUI tab line. When 'e' is in |
| 7991 '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
|
7992 instead. Note that the two tab pages lines are very different. |
| 677 | 7993 |
| 7994 The value is evaluated like with 'statusline'. You can use | |
| 7995 |tabpagenr()|, |tabpagewinnr()| and |tabpagebuflist()| to figure out | |
| 681 | 7996 the text to be displayed. Use "%1T" for the first label, "%2T" for |
| 7997 the second one, etc. Use "%X" items for closing labels. | |
| 677 | 7998 |
|
15396
325e4a8ba1b6
patch 8.1.0706: tabline is not always redrawn
Bram Moolenaar <Bram@vim.org>
parents:
15281
diff
changeset
|
7999 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
|
8000 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
|
8001 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
|
8002 |
| 677 | 8003 Keep in mind that only one of the tab pages is the current one, others |
| 8004 are invisible and you can't jump to their windows. | |
| 8005 | |
| 674 | 8006 |
| 699 | 8007 *'tabpagemax'* *'tpm'* |
| 8008 'tabpagemax' 'tpm' number (default 10) | |
| 8009 global | |
| 8010 Maximum number of tab pages to be opened by the |-p| command line | |
| 8011 argument or the ":tab all" command. |tabpage| | |
| 8012 | |
| 8013 | |
| 8014 *'tabstop'* *'ts'* | |
| 7 | 8015 'tabstop' 'ts' number (default 8) |
| 8016 local to buffer | |
| 8017 Number of spaces that a <Tab> in the file counts for. Also see | |
| 27459 | 8018 the |:retab| command, and the 'softtabstop' option. |
| 7 | 8019 |
| 8020 Note: Setting 'tabstop' to any other value than 8 can make your file | |
| 27459 | 8021 appear wrong in many places, e.g., when printing it. |
| 8022 The value must be more than 0 and less than 10000. | |
| 7 | 8023 |
| 8024 There are four main ways to use tabs in Vim: | |
| 8025 1. Always keep 'tabstop' at 8, set 'softtabstop' and 'shiftwidth' to 4 | |
| 8026 (or 3 or whatever you prefer) and use 'noexpandtab'. Then Vim | |
| 1263 | 8027 will use a mix of tabs and spaces, but typing <Tab> and <BS> will |
| 7 | 8028 behave like a tab appears every 4 (or 3) characters. |
| 8029 2. Set 'tabstop' and 'shiftwidth' to whatever you prefer and use | |
| 8030 'expandtab'. This way you will always insert spaces. The | |
| 8031 formatting will never be messed up when 'tabstop' is changed. | |
| 8032 3. Set 'tabstop' and 'shiftwidth' to whatever you prefer and use a | |
| 10 | 8033 |modeline| to set these values when editing the file again. Only |
| 7 | 8034 works when using Vim to edit the file. |
| 8035 4. Always set 'tabstop' and 'shiftwidth' to the same value, and | |
| 8036 'noexpandtab'. This should then work (for initial indents only) | |
| 8037 for any tabstop setting that people use. It might be nice to have | |
| 8038 tabs after the first non-blank inserted as spaces if you do this | |
| 8039 though. Otherwise aligned comments will be wrong when 'tabstop' is | |
| 8040 changed. | |
| 8041 | |
|
14175
2ad722003b36
patch 8.1.0105: all tab stops are the same
Christian Brabandt <cb@256bit.org>
parents:
14019
diff
changeset
|
8042 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
|
8043 '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
|
8044 than an empty string. |
|
2ad722003b36
patch 8.1.0105: all tab stops are the same
Christian Brabandt <cb@256bit.org>
parents:
14019
diff
changeset
|
8045 |
| 7 | 8046 *'tagbsearch'* *'tbs'* *'notagbsearch'* *'notbs'* |
| 8047 'tagbsearch' 'tbs' boolean (default on) | |
| 8048 global | |
| 8049 When searching for a tag (e.g., for the |:ta| command), Vim can either | |
| 10 | 8050 use a binary search or a linear search in a tags file. Binary |
| 7 | 8051 searching makes searching for a tag a LOT faster, but a linear search |
| 8052 will find more tags if the tags file wasn't properly sorted. | |
| 8053 Vim normally assumes that your tags files are sorted, or indicate that | |
| 8054 they are not sorted. Only when this is not the case does the | |
| 8055 'tagbsearch' option need to be switched off. | |
| 8056 | |
| 8057 When 'tagbsearch' is on, binary searching is first used in the tags | |
| 10 | 8058 files. In certain situations, Vim will do a linear search instead for |
| 7 | 8059 certain files, or retry all files with a linear search. When |
| 8060 'tagbsearch' is off, only a linear search is done. | |
| 8061 | |
| 8062 Linear searching is done anyway, for one file, when Vim finds a line | |
| 8063 at the start of the file indicating that it's not sorted: > | |
| 1621 | 8064 !_TAG_FILE_SORTED 0 /some comment/ |
| 7 | 8065 < [The whitespace before and after the '0' must be a single <Tab>] |
| 8066 | |
| 8067 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
|
8068 files listed in 'tags', and case is ignored or a pattern is used |
| 7 | 8069 instead of a normal tag name, a retry is done with a linear search. |
| 8070 Tags in unsorted tags files, and matches with different case will only | |
| 8071 be found in the retry. | |
| 8072 | |
| 22 | 8073 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
|
8074 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
|
8075 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
|
8076 sorted with the -f switch to "sort" in most unices, as in the command: |
| 28141 | 8077 "sort -f -o tags tags". For Universal ctags and Exuberant ctags |
| 8078 version 5.x or higher (at least 5.5) the --sort=foldcase switch can be | |
| 8079 used for this as well. Note that case must be folded to uppercase for | |
| 8080 this to work. | |
|
7266
6ba7182fb7bd
commit https://github.com/vim/vim/commit/0f6562e9036f889185dff49a75c7fc5ffb28b307
Christian Brabandt <cb@256bit.org>
parents:
7245
diff
changeset
|
8081 |
|
6ba7182fb7bd
commit https://github.com/vim/vim/commit/0f6562e9036f889185dff49a75c7fc5ffb28b307
Christian Brabandt <cb@256bit.org>
parents:
7245
diff
changeset
|
8082 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
|
8083 '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
|
8084 "ignore". |
|
9913
bb00c661b3a4
commit https://github.com/vim/vim/commit/66e29d7112e437b2b50efe1f82c7e892736d23e4
Christian Brabandt <cb@256bit.org>
parents:
9887
diff
changeset
|
8085 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
|
8086 '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
|
8087 characters. |
| 7 | 8088 |
| 8089 When 'tagbsearch' is off, tags searching is slower when a full match | |
| 8090 exists, but faster when no full match exists. Tags in unsorted tags | |
| 8091 files may only be found with 'tagbsearch' off. | |
| 8092 When the tags file is not sorted, or sorted in a wrong way (not on | |
| 8093 ASCII byte value), 'tagbsearch' should be off, or the line given above | |
| 8094 must be included in the tags file. | |
| 8095 This option doesn't affect commands that find all matching tags (e.g., | |
| 8096 command-line completion and ":help"). | |
| 8097 | |
|
7266
6ba7182fb7bd
commit https://github.com/vim/vim/commit/0f6562e9036f889185dff49a75c7fc5ffb28b307
Christian Brabandt <cb@256bit.org>
parents:
7245
diff
changeset
|
8098 *'tagcase'* *'tc'* |
|
6ba7182fb7bd
commit https://github.com/vim/vim/commit/0f6562e9036f889185dff49a75c7fc5ffb28b307
Christian Brabandt <cb@256bit.org>
parents:
7245
diff
changeset
|
8099 'tagcase' 'tc' string (default "followic") |
|
6ba7182fb7bd
commit https://github.com/vim/vim/commit/0f6562e9036f889185dff49a75c7fc5ffb28b307
Christian Brabandt <cb@256bit.org>
parents:
7245
diff
changeset
|
8100 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
|
8101 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
|
8102 file: |
|
6ba7182fb7bd
commit https://github.com/vim/vim/commit/0f6562e9036f889185dff49a75c7fc5ffb28b307
Christian Brabandt <cb@256bit.org>
parents:
7245
diff
changeset
|
8103 followic Follow the 'ignorecase' option |
|
9913
bb00c661b3a4
commit https://github.com/vim/vim/commit/66e29d7112e437b2b50efe1f82c7e892736d23e4
Christian Brabandt <cb@256bit.org>
parents:
9887
diff
changeset
|
8104 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
|
8105 ignore Ignore case |
|
6ba7182fb7bd
commit https://github.com/vim/vim/commit/0f6562e9036f889185dff49a75c7fc5ffb28b307
Christian Brabandt <cb@256bit.org>
parents:
7245
diff
changeset
|
8106 match Match case |
|
9913
bb00c661b3a4
commit https://github.com/vim/vim/commit/66e29d7112e437b2b50efe1f82c7e892736d23e4
Christian Brabandt <cb@256bit.org>
parents:
9887
diff
changeset
|
8107 smart Ignore case unless an upper case letter is used |
| 11160 | 8108 NOTE: This option is set to the Vi default value when 'compatible' is |
| 8109 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
|
8110 |
|
16447
54ffc82f38a8
patch 8.1.1228: not possible to process tags with a function
Bram Moolenaar <Bram@vim.org>
parents:
16443
diff
changeset
|
8111 *'tagfunc'* *'tfu'* |
|
54ffc82f38a8
patch 8.1.1228: not possible to process tags with a function
Bram Moolenaar <Bram@vim.org>
parents:
16443
diff
changeset
|
8112 '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
|
8113 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
|
8114 {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
|
8115 feature} |
|
54ffc82f38a8
patch 8.1.1228: not possible to process tags with a function
Bram Moolenaar <Bram@vim.org>
parents:
16443
diff
changeset
|
8116 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
|
8117 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
|
8118 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
|
8119 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
|
8120 |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
|
8121 information. |
|
16447
54ffc82f38a8
patch 8.1.1228: not possible to process tags with a function
Bram Moolenaar <Bram@vim.org>
parents:
16443
diff
changeset
|
8122 |
| 7 | 8123 *'taglength'* *'tl'* |
| 8124 'taglength' 'tl' number (default 0) | |
| 8125 global | |
| 8126 If non-zero, tags are significant up to this number of characters. | |
| 8127 | |
| 8128 *'tagrelative'* *'tr'* *'notagrelative'* *'notr'* | |
| 8129 'tagrelative' 'tr' boolean (Vim default: on, Vi default: off) | |
| 8130 global | |
| 824 | 8131 If on and using a tags file in another directory, file names in that |
| 8132 tags file are relative to the directory where the tags file is. | |
| 7 | 8133 NOTE: This option is set to the Vi default value when 'compatible' is |
| 8134 set and to the Vim default value when 'compatible' is reset. | |
| 8135 | |
| 8136 *'tags'* *'tag'* *E433* | |
| 8137 'tags' 'tag' string (default "./tags,tags", when compiled with | |
| 8138 |+emacs_tags|: "./tags,./TAGS,tags,TAGS") | |
| 8139 global or local to buffer |global-local| | |
| 8140 Filenames for the tag command, separated by spaces or commas. To | |
| 8141 include a space or comma in a file name, precede it with a backslash | |
| 8142 (see |option-backslash| about including spaces and backslashes). | |
| 8143 When a file name starts with "./", the '.' is replaced with the path | |
| 8144 of the current file. But only when the 'd' flag is not included in | |
| 8145 'cpoptions'. Environment variables are expanded |:set_env|. Also see | |
| 8146 |tags-option|. | |
| 8147 "*", "**" 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
|
8148 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
|
8149 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
|
8150 contain wildcards, it is used as-is. E.g., "/lib/**/tags?" will find |
|
29863
62350f19d4ed
patch 9.0.0270: some values of 'path' and 'tags' invalid in the tiny version
Bram Moolenaar <Bram@vim.org>
parents:
29853
diff
changeset
|
8151 files called "tags?". |
| 515 | 8152 The |tagfiles()| function can be used to get a list of the file names |
| 8153 actually used. | |
| 7 | 8154 If Vim was compiled with the |+emacs_tags| feature, Emacs-style tag |
| 8155 files are also supported. They are automatically recognized. The | |
| 8156 default value becomes "./tags,./TAGS,tags,TAGS", unless case | |
| 8157 differences are ignored (MS-Windows). |emacs-tags| | |
| 8158 The use of |:set+=| and |:set-=| is preferred when adding or removing | |
| 8159 file names from the list. This avoids problems when a future version | |
| 8160 uses another default. | |
| 8161 | |
| 8162 *'tagstack'* *'tgst'* *'notagstack'* *'notgst'* | |
| 8163 'tagstack' 'tgst' boolean (default on) | |
| 8164 global | |
| 8165 When on, the |tagstack| is used normally. When off, a ":tag" or | |
| 8166 ":tselect" command with an argument will not push the tag onto the | |
| 8167 tagstack. A following ":tag" without an argument, a ":pop" command or | |
| 8168 any other command that uses the tagstack will use the unmodified | |
| 8169 tagstack, but does change the pointer to the active entry. | |
| 8170 Resetting this option is useful when using a ":tag" command in a | |
| 8171 mapping which should not change the tagstack. | |
| 8172 | |
|
7538
c9fc24b76293
commit https://github.com/vim/vim/commit/8a5115cf18751022387af2085f374d38c60dde83
Christian Brabandt <cb@256bit.org>
parents:
7528
diff
changeset
|
8173 *'tcldll'* |
|
8629
54ac275e3fc4
commit https://github.com/vim/vim/commit/3848e00e0177abdb31bc600234967863ec487233
Christian Brabandt <cb@256bit.org>
parents:
8560
diff
changeset
|
8174 '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
|
8175 global |
|
c9fc24b76293
commit https://github.com/vim/vim/commit/8a5115cf18751022387af2085f374d38c60dde83
Christian Brabandt <cb@256bit.org>
parents:
7528
diff
changeset
|
8176 {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
|
8177 feature} |
|
c9fc24b76293
commit https://github.com/vim/vim/commit/8a5115cf18751022387af2085f374d38c60dde83
Christian Brabandt <cb@256bit.org>
parents:
7528
diff
changeset
|
8178 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
|
8179 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
|
8180 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
|
8181 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
|
8182 security reasons. |
|
c9fc24b76293
commit https://github.com/vim/vim/commit/8a5115cf18751022387af2085f374d38c60dde83
Christian Brabandt <cb@256bit.org>
parents:
7528
diff
changeset
|
8183 |
| 7 | 8184 *'term'* *E529* *E530* *E531* |
| 8185 'term' string (default is $TERM, if that fails: | |
| 8186 in the GUI: "builtin_gui" | |
| 8187 on Amiga: "amiga" | |
|
19526
22f0dda71638
patch 8.2.0320: no Haiku support
Bram Moolenaar <Bram@vim.org>
parents:
19404
diff
changeset
|
8188 on Haiku: "xterm" |
| 7 | 8189 on Mac: "mac-ansi" |
| 8190 on Unix: "ansi" | |
| 8191 on VMS: "ansi" | |
| 8192 on Win 32: "win32") | |
| 8193 global | |
| 8194 Name of the terminal. Used for choosing the terminal control | |
| 8195 characters. Environment variables are expanded |:set_env|. | |
| 8196 For example: > | |
| 8197 :set term=$TERM | |
| 8198 < See |termcap|. | |
| 8199 | |
| 8200 *'termbidi'* *'tbidi'* | |
| 8201 *'notermbidi'* *'notbidi'* | |
| 8202 'termbidi' 'tbidi' boolean (default off, on for "mlterm") | |
| 8203 global | |
| 8204 {only available when compiled with the |+arabic| | |
| 8205 feature} | |
| 8206 The terminal is in charge of Bi-directionality of text (as specified | |
| 8207 by Unicode). The terminal is also expected to do the required shaping | |
| 8208 that some languages (such as Arabic) require. | |
| 8209 Setting this option implies that 'rightleft' will not be set when | |
| 8210 'arabic' is set and the value of 'arabicshape' will be ignored. | |
| 8211 Note that setting 'termbidi' has the immediate effect that | |
| 8212 'arabicshape' is ignored, but 'rightleft' isn't changed automatically. | |
| 8213 This option is reset when the GUI is started. | |
| 8214 For further details see |arabic.txt|. | |
| 8215 | |
| 8216 *'termencoding'* *'tenc'* | |
| 21825 | 8217 'termencoding' 'tenc' string (default ""; with GTK+ GUI: "utf-8") |
| 7 | 8218 global |
| 8219 Encoding used for the terminal. This specifies what character | |
| 8220 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
|
8221 the GUI it only applies to the keyboard ('encoding' is used for the |
| 21825 | 8222 display). |
|
19027
d72b30bf3a80
patch 8.2.0074: Python 3 unicode test someitmes fails
Bram Moolenaar <Bram@vim.org>
parents:
18972
diff
changeset
|
8223 *E617* *E950* |
|
10895
c391bfbdb452
Updated runtime files.
Christian Brabandt <cb@256bit.org>
parents:
10734
diff
changeset
|
8224 Note: This does not apply to the GTK+ GUI. After the GUI has been |
| 7 | 8225 successfully initialized, 'termencoding' is forcibly set to "utf-8". |
| 8226 Any attempts to set a different value will be rejected, and an error | |
| 8227 message is shown. | |
|
7080
1a34f5272977
commit https://github.com/vim/vim/commit/ac360bf2ca293735fc7c6654dc2b3066f4c62488
Christian Brabandt <cb@256bit.org>
parents:
7051
diff
changeset
|
8228 For the Win32 GUI and console versions 'termencoding' is not used, |
| 7 | 8229 because the Win32 system always passes Unicode characters. |
| 8230 When empty, the same encoding is used as for the 'encoding' option. | |
| 8231 This is the normal value. | |
| 8232 Not all combinations for 'termencoding' and 'encoding' are valid. See | |
| 8233 |encoding-table|. | |
| 8234 The value for this option must be supported by internal conversions or | |
| 8235 iconv(). When this is not possible no conversion will be done and you | |
| 8236 will probably experience problems with non-ASCII characters. | |
| 8237 Example: You are working with the locale set to euc-jp (Japanese) and | |
| 8238 want to edit a UTF-8 file: > | |
| 8239 :let &termencoding = &encoding | |
| 8240 :set encoding=utf-8 | |
| 8241 < You need to do this when your system has no locale support for UTF-8. | |
| 8242 | |
| 32004 | 8243 *'termguicolors'* *'tgc'* *'notermguicolors'* *'notgc'* *E954* |
|
9027
773d627cac0b
commit https://github.com/vim/vim/commit/61be73bb0f965a895bfb064ea3e55476ac175162
Christian Brabandt <cb@256bit.org>
parents:
8969
diff
changeset
|
8244 'termguicolors' 'tgc' boolean (default off) |
|
773d627cac0b
commit https://github.com/vim/vim/commit/61be73bb0f965a895bfb064ea3e55476ac175162
Christian Brabandt <cb@256bit.org>
parents:
8969
diff
changeset
|
8245 global |
|
773d627cac0b
commit https://github.com/vim/vim/commit/61be73bb0f965a895bfb064ea3e55476ac175162
Christian Brabandt <cb@256bit.org>
parents:
8969
diff
changeset
|
8246 {not available when compiled without the |
|
773d627cac0b
commit https://github.com/vim/vim/commit/61be73bb0f965a895bfb064ea3e55476ac175162
Christian Brabandt <cb@256bit.org>
parents:
8969
diff
changeset
|
8247 |+termguicolors| feature} |
|
773d627cac0b
commit https://github.com/vim/vim/commit/61be73bb0f965a895bfb064ea3e55476ac175162
Christian Brabandt <cb@256bit.org>
parents:
8969
diff
changeset
|
8248 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
|
8249 the terminal (thus using 24-bit color). |
|
13341
acd7eaa13d2b
Updated runtime files.
Christian Brabandt <cb@256bit.org>
parents:
13314
diff
changeset
|
8250 |
|
13314
65c3e8259124
patch 8.0.1531: cannot use 24 bit colors in MS-Windows console
Christian Brabandt <cb@256bit.org>
parents:
13234
diff
changeset
|
8251 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
|
8252 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
|
8253 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
|
8254 |
|
65c3e8259124
patch 8.0.1531: cannot use 24 bit colors in MS-Windows console
Christian Brabandt <cb@256bit.org>
parents:
13234
diff
changeset
|
8255 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
|
8256 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
|
8257 if has('vcon') |
|
13341
acd7eaa13d2b
Updated runtime files.
Christian Brabandt <cb@256bit.org>
parents:
13314
diff
changeset
|
8258 < This requires Vim to be built with the |+vtp| feature. |
|
acd7eaa13d2b
Updated runtime files.
Christian Brabandt <cb@256bit.org>
parents:
13314
diff
changeset
|
8259 |
| 11473 | 8260 Note that the "cterm" attributes are still used, not the "gui" ones. |
|
28763
b01bca69b1d5
patch 8.2.4906: MS-Windows: cannot use transparent background
Bram Moolenaar <Bram@vim.org>
parents:
28716
diff
changeset
|
8261 |
|
b01bca69b1d5
patch 8.2.4906: MS-Windows: cannot use transparent background
Bram Moolenaar <Bram@vim.org>
parents:
28716
diff
changeset
|
8262 When using Vim with Windows Terminal, the background of Windows |
|
b01bca69b1d5
patch 8.2.4906: MS-Windows: cannot use transparent background
Bram Moolenaar <Bram@vim.org>
parents:
28716
diff
changeset
|
8263 Terminal is normally filled with the Vim background color. Setting |
|
b01bca69b1d5
patch 8.2.4906: MS-Windows: cannot use transparent background
Bram Moolenaar <Bram@vim.org>
parents:
28716
diff
changeset
|
8264 'termguicolors' and the guibg of the Normal highlight group to NONE |
|
b01bca69b1d5
patch 8.2.4906: MS-Windows: cannot use transparent background
Bram Moolenaar <Bram@vim.org>
parents:
28716
diff
changeset
|
8265 will make the background transparent: > |
|
b01bca69b1d5
patch 8.2.4906: MS-Windows: cannot use transparent background
Bram Moolenaar <Bram@vim.org>
parents:
28716
diff
changeset
|
8266 :hi Normal guibg=NONE |
|
b01bca69b1d5
patch 8.2.4906: MS-Windows: cannot use transparent background
Bram Moolenaar <Bram@vim.org>
parents:
28716
diff
changeset
|
8267 < |
| 11160 | 8268 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
|
8269 |
| 13735 | 8270 *'termwinkey'* *'twk'* |
| 8271 'termwinkey' 'twk' string (default "") | |
|
11659
49c12c93abf3
Updated runtime files and translations.
Christian Brabandt <cb@256bit.org>
parents:
11529
diff
changeset
|
8272 local to window |
| 11914 | 8273 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
|
8274 are sent to the job running in the window. |
| 11914 | 8275 The <> notation can be used, e.g.: > |
| 13735 | 8276 :set termwinkey=<C-L> |
| 11914 | 8277 < The string must be one key stroke but can be multiple bytes. |
| 8278 When not set CTRL-W is used, so that CTRL-W : gets you to the command | |
| 13735 | 8279 line. If 'termwinkey' is set to CTRL-L then CTRL-L : gets you to the |
| 11914 | 8280 command line. |
|
11659
49c12c93abf3
Updated runtime files and translations.
Christian Brabandt <cb@256bit.org>
parents:
11529
diff
changeset
|
8281 |
|
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
|
8282 *'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
|
8283 '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
|
8284 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
|
8285 {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
|
8286 |+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
|
8287 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
|
8288 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
|
8289 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
|
8290 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
|
8291 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
|
8292 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
|
8293 |
| 13735 | 8294 *'termwinsize'* *'tws'* |
| 8295 'termwinsize' 'tws' string (default "") | |
|
11659
49c12c93abf3
Updated runtime files and translations.
Christian Brabandt <cb@256bit.org>
parents:
11529
diff
changeset
|
8296 local to window |
| 22171 | 8297 Size used when opening the |terminal| window. Format: |
| 8298 {rows}x{columns} or {rows}*{columns}. | |
|
11659
49c12c93abf3
Updated runtime files and translations.
Christian Brabandt <cb@256bit.org>
parents:
11529
diff
changeset
|
8299 - 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
|
8300 - 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
|
8301 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
|
8302 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
|
8303 - 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
|
8304 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
|
8305 columns. |
|
b28d679b1843
patch 8.0.1722: cannot specify a minimal size for a terminal window
Christian Brabandt <cb@256bit.org>
parents:
13680
diff
changeset
|
8306 - 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
|
8307 - 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
|
8308 - Using "0x0" or "0*0" is the same as empty. |
| 22171 | 8309 - Can be overruled in the |term_start()| options with "term_rows" and |
| 8310 "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
|
8311 |
|
b28d679b1843
patch 8.0.1722: cannot specify a minimal size for a terminal window
Christian Brabandt <cb@256bit.org>
parents:
13680
diff
changeset
|
8312 Examples: |
|
b28d679b1843
patch 8.0.1722: cannot specify a minimal size for a terminal window
Christian Brabandt <cb@256bit.org>
parents:
13680
diff
changeset
|
8313 "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
|
8314 "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
|
8315 "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
|
8316 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
|
8317 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
|
8318 adjusted to that size, if possible. |
|
11659
49c12c93abf3
Updated runtime files and translations.
Christian Brabandt <cb@256bit.org>
parents:
11529
diff
changeset
|
8319 |
|
15746
c017195b121b
patch 8.1.0880: MS-Windows: inconsistent selection of winpty/conpty
Bram Moolenaar <Bram@vim.org>
parents:
15729
diff
changeset
|
8320 *'termwintype'* *'twt'* |
|
c017195b121b
patch 8.1.0880: MS-Windows: inconsistent selection of winpty/conpty
Bram Moolenaar <Bram@vim.org>
parents:
15729
diff
changeset
|
8321 '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
|
8322 global |
|
c017195b121b
patch 8.1.0880: MS-Windows: inconsistent selection of winpty/conpty
Bram Moolenaar <Bram@vim.org>
parents:
15729
diff
changeset
|
8323 {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
|
8324 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
|
8325 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
|
8326 window. |
|
c017195b121b
patch 8.1.0880: MS-Windows: inconsistent selection of winpty/conpty
Bram Moolenaar <Bram@vim.org>
parents:
15729
diff
changeset
|
8327 |
|
c017195b121b
patch 8.1.0880: MS-Windows: inconsistent selection of winpty/conpty
Bram Moolenaar <Bram@vim.org>
parents:
15729
diff
changeset
|
8328 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
|
8329 "" 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
|
8330 "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
|
8331 "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
|
8332 |
|
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
|
8333 |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
|
8334 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
|
8335 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
|
8336 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
|
8337 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
|
8338 |
| 7 | 8339 *'terse'* *'noterse'* |
| 8340 'terse' boolean (default off) | |
| 8341 global | |
| 8342 When set: Add 's' flag to 'shortmess' option (this makes the message | |
| 8343 for a search that hits the start or end of the file not being | |
| 8344 displayed). When reset: Remove 's' flag from 'shortmess' option. {Vi | |
| 8345 shortens a lot of messages} | |
| 8346 | |
| 8347 *'textauto'* *'ta'* *'notextauto'* *'nota'* | |
| 8348 'textauto' 'ta' boolean (Vim default: on, Vi default: off) | |
| 8349 global | |
| 8350 This option is obsolete. Use 'fileformats'. | |
| 8351 For backwards compatibility, when 'textauto' is set, 'fileformats' is | |
| 8352 set to the default value for the current system. When 'textauto' is | |
| 8353 reset, 'fileformats' is made empty. | |
| 8354 NOTE: This option is set to the Vi default value when 'compatible' is | |
| 8355 set and to the Vim default value when 'compatible' is reset. | |
| 8356 | |
| 8357 *'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
|
8358 'textmode' 'tx' boolean (Win32: default on, |
| 7 | 8359 others: default off) |
| 8360 local to buffer | |
| 8361 This option is obsolete. Use 'fileformat'. | |
| 8362 For backwards compatibility, when 'textmode' is set, 'fileformat' is | |
| 8363 set to "dos". When 'textmode' is reset, 'fileformat' is set to | |
| 8364 "unix". | |
| 8365 | |
| 8366 *'textwidth'* *'tw'* | |
| 8367 'textwidth' 'tw' number (default 0) | |
| 8368 local to buffer | |
| 8369 Maximum width of text that is being inserted. A longer line will be | |
| 8370 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
|
8371 this. |
|
c590de398af9
commit https://github.com/vim/vim/commit/ca63501fbcd1cf9c8aa9ff12c093c95b62a89ed7
Christian Brabandt <cb@256bit.org>
parents:
7080
diff
changeset
|
8372 '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
|
8373 when 'paste' is reset. |
|
c590de398af9
commit https://github.com/vim/vim/commit/ca63501fbcd1cf9c8aa9ff12c093c95b62a89ed7
Christian Brabandt <cb@256bit.org>
parents:
7080
diff
changeset
|
8374 When 'textwidth' is zero, 'wrapmargin' may be used. See also |
| 7 | 8375 'formatoptions' and |ins-textwidth|. |
| 838 | 8376 When 'formatexpr' is set it will be used to break the line. |
| 7 | 8377 NOTE: This option is set to 0 when 'compatible' is set. |
| 8378 | |
| 8379 *'thesaurus'* *'tsr'* | |
| 8380 'thesaurus' 'tsr' string (default "") | |
| 8381 global or local to buffer |global-local| | |
| 8382 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
|
8383 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
|
8384 |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
|
8385 |
|
ac330e2fecc4
patch 8.2.3528: 'thesaurus' and 'thesaurusfunc' do not have the same scope
Bram Moolenaar <Bram@vim.org>
parents:
25982
diff
changeset
|
8386 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
|
8387 buffer or globally. |
| 15033 | 8388 |
| 10 | 8389 To include a comma in a file name precede it with a backslash. Spaces |
| 7 | 8390 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
|
8391 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
|
8392 |: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
|
8393 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
|
8394 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
|
8395 reasons. |
| 7 | 8396 |
| 27036 | 8397 *'thesaurusfunc'* *'tsrfu'* |
|
25974
416237f1de22
patch 8.2.3520: cannot define a function for thesaurus completion
Bram Moolenaar <Bram@vim.org>
parents:
25973
diff
changeset
|
8398 '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
|
8399 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
|
8400 {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
|
8401 feature} |
|
416237f1de22
patch 8.2.3520: cannot define a function for thesaurus completion
Bram Moolenaar <Bram@vim.org>
parents:
25973
diff
changeset
|
8402 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
|
8403 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
|
8404 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
|
8405 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
|
8406 |
|
25974
416237f1de22
patch 8.2.3520: cannot define a function for thesaurus completion
Bram Moolenaar <Bram@vim.org>
parents:
25973
diff
changeset
|
8407 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
|
8408 security reasons. |
|
416237f1de22
patch 8.2.3520: cannot define a function for thesaurus completion
Bram Moolenaar <Bram@vim.org>
parents:
25973
diff
changeset
|
8409 |
| 7 | 8410 *'tildeop'* *'top'* *'notildeop'* *'notop'* |
| 8411 'tildeop' 'top' boolean (default off) | |
| 8412 global | |
| 8413 When on: The tilde command "~" behaves like an operator. | |
| 8414 NOTE: This option is reset when 'compatible' is set. | |
| 8415 | |
| 8416 *'timeout'* *'to'* *'notimeout'* *'noto'* | |
| 8417 'timeout' 'to' boolean (default on) | |
| 8418 global | |
| 8419 *'ttimeout'* *'nottimeout'* | |
|
11400
0f8713fe20dc
Updated runtime files.
Christian Brabandt <cb@256bit.org>
parents:
11262
diff
changeset
|
8420 'ttimeout' boolean (default off, set in |defaults.vim|) |
| 7 | 8421 global |
| 8422 These two options together determine the behavior when part of a | |
| 8423 mapped key sequence or keyboard code has been received: | |
| 8424 | |
| 8425 'timeout' 'ttimeout' action ~ | |
| 8426 off off do not time out | |
| 8427 on on or off time out on :mappings and key codes | |
| 8428 off on time out on key codes | |
| 8429 | |
| 8430 If both options are off, Vim will wait until either the complete | |
| 8431 mapping or key sequence has been received, or it is clear that there | |
| 8432 is no mapping or key sequence for the received characters. For | |
| 8433 example: if you have mapped "vl" and Vim has received 'v', the next | |
| 8434 character is needed to see if the 'v' is followed by an 'l'. | |
| 8435 When one of the options is on, Vim will wait for about 1 second for | |
| 8436 the next character to arrive. After that the already received | |
| 8437 characters are interpreted as single characters. The waiting time can | |
| 8438 be changed with the 'timeoutlen' option. | |
| 8439 On slow terminals or very busy systems timing out may cause | |
| 8440 malfunctioning cursor keys. If both options are off, Vim waits | |
| 8441 forever after an entered <Esc> if there are key codes that start | |
| 8442 with <Esc>. You will have to type <Esc> twice. If you do not have | |
| 8443 problems with key codes, but would like to have :mapped key | |
| 8444 sequences not timing out in 1 second, set the 'ttimeout' option and | |
| 8445 reset the 'timeout' option. | |
| 8446 | |
| 8447 NOTE: 'ttimeout' is reset when 'compatible' is set. | |
| 8448 | |
| 8449 *'timeoutlen'* *'tm'* | |
| 8450 'timeoutlen' 'tm' number (default 1000) | |
| 8451 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
|
8452 |
| 7 | 8453 *'ttimeoutlen'* *'ttm'* |
|
11400
0f8713fe20dc
Updated runtime files.
Christian Brabandt <cb@256bit.org>
parents:
11262
diff
changeset
|
8454 'ttimeoutlen' 'ttm' number (default -1, set to 100 in |defaults.vim|) |
| 7 | 8455 global |
| 8456 The time in milliseconds that is waited for a key code or mapped key | |
| 8457 sequence to complete. Also used for CTRL-\ CTRL-N and CTRL-\ CTRL-G | |
| 8458 when part of a command has been typed. | |
| 8459 Normally only 'timeoutlen' is used and 'ttimeoutlen' is -1. When a | |
| 8460 different timeout value for key codes is desired set 'ttimeoutlen' to | |
| 8461 a non-negative number. | |
| 8462 | |
| 8463 ttimeoutlen mapping delay key code delay ~ | |
| 8464 < 0 'timeoutlen' 'timeoutlen' | |
| 8465 >= 0 'timeoutlen' 'ttimeoutlen' | |
| 8466 | |
| 8467 The timeout only happens when the 'timeout' and 'ttimeout' options | |
| 8468 tell so. A useful setting would be > | |
| 8469 :set timeout timeoutlen=3000 ttimeoutlen=100 | |
| 8470 < (time out on mapping after three seconds, time out on key codes after | |
| 8471 a tenth of a second). | |
| 8472 | |
| 8473 *'title'* *'notitle'* | |
| 8474 'title' boolean (default off, on when title can be restored) | |
| 8475 global | |
| 8476 When on, the title of the window will be set to the value of | |
| 8477 'titlestring' (if it is not empty), or to: | |
| 8478 filename [+=-] (path) - VIM | |
| 8479 Where: | |
| 8480 filename the name of the file being edited | |
| 8481 - indicates the file cannot be modified, 'ma' off | |
| 8482 + indicates the file was modified | |
| 8483 = indicates the file is read-only | |
| 8484 =+ indicates the file is read-only and modified | |
| 8485 (path) is the path of the file being edited | |
| 8486 - VIM the server name |v:servername| or "VIM" | |
| 8487 Only works if the terminal supports setting window titles | |
| 8488 (currently Amiga console, Win32 console, all GUI versions and | |
| 19968 | 8489 terminals with a non-empty 't_ts' option - these are Unix xterm and |
| 7 | 8490 iris-ansi by default, where 't_ts' is taken from the builtin termcap). |
| 8491 *X11* | |
| 8492 When Vim was compiled with HAVE_X11 defined, the original title will | |
| 8493 be restored if possible. The output of ":version" will include "+X11" | |
| 8494 when HAVE_X11 was defined, otherwise it will be "-X11". This also | |
| 8495 works for the icon name |'icon'|. | |
| 8496 But: When Vim was started with the |-X| argument, restoring the title | |
| 8497 will not work (except in the GUI). | |
| 8498 If the title cannot be restored, it is set to the value of 'titleold'. | |
| 8499 You might want to restore the title outside of Vim then. | |
| 8500 When using an xterm from a remote machine you can use this command: | |
| 8501 rsh machine_name xterm -display $DISPLAY & | |
| 8502 then the WINDOWID environment variable should be inherited and the | |
| 8503 title of the window should change back to what it should be after | |
| 8504 exiting Vim. | |
| 8505 | |
| 8506 *'titlelen'* | |
| 8507 'titlelen' number (default 85) | |
| 8508 global | |
| 8509 Gives the percentage of 'columns' to use for the length of the window | |
| 10 | 8510 title. When the title is longer, only the end of the path name is |
| 8511 shown. A '<' character before the path name is used to indicate this. | |
| 7 | 8512 Using a percentage makes this adapt to the width of the window. But |
| 8513 it won't work perfectly, because the actual number of characters | |
| 8514 available also depends on the font used and other things in the title | |
| 8515 bar. When 'titlelen' is zero the full path is used. Otherwise, | |
| 8516 values from 1 to 30000 percent can be used. | |
| 8517 'titlelen' is also used for the 'titlestring' option. | |
| 8518 | |
| 8519 *'titleold'* | |
| 8520 'titleold' string (default "Thanks for flying Vim") | |
| 8521 global | |
| 8522 This option will be used for the window title when exiting Vim if the | |
| 8523 original title cannot be restored. Only happens if 'title' is on or | |
| 8524 'titlestring' is not empty. | |
| 36 | 8525 This option cannot be set from a |modeline| or in the |sandbox|, for |
| 8526 security reasons. | |
| 7 | 8527 *'titlestring'* |
| 8528 'titlestring' string (default "") | |
| 8529 global | |
| 8530 When this option is not empty, it will be used for the title of the | |
| 8531 window. This happens only when the 'title' option is on. | |
| 8532 Only works if the terminal supports setting window titles (currently | |
| 8533 Amiga console, Win32 console, all GUI versions and terminals with a | |
| 8534 non-empty 't_ts' option). | |
| 8535 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
|
8536 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
|
8537 |
| 7 | 8538 When this option contains printf-style '%' items, they will be |
| 8539 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
|
8540 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
|
8541 |
| 7 | 8542 Example: > |
| 27903 | 8543 :auto BufEnter * let &titlestring = hostname() .. "/" .. expand("%:p") |
| 7 | 8544 :set title titlestring=%<%F%=%l/%L-%P titlelen=70 |
| 8545 < The value of 'titlelen' is used to align items in the middle or right | |
| 8546 of the available space. | |
| 8547 Some people prefer to have the file name first: > | |
| 8548 :set titlestring=%t%(\ %M%)%(\ (%{expand(\"%:~:.:h\")})%)%(\ %a%) | |
| 8549 < Note the use of "%{ }" and an expression to get the path of the file, | |
| 10 | 8550 without the file name. The "%( %)" constructs are used to add a |
| 7 | 8551 separating space only when needed. |
| 8552 NOTE: Use of special characters in 'titlestring' may cause the display | |
| 8553 to be garbled (e.g., when it contains a CR or NL character). | |
| 8554 {not available when compiled without the |+statusline| feature} | |
| 8555 | |
| 8556 *'toolbar'* *'tb'* | |
| 8557 'toolbar' 'tb' string (default "icons,tooltips") | |
| 8558 global | |
| 28379 | 8559 {only for |+GUI_GTK|, |+GUI_Motif| and |+GUI_Photon|} |
| 10 | 8560 The contents of this option controls various toolbar settings. The |
| 7 | 8561 possible values are: |
| 8562 icons Toolbar buttons are shown with icons. | |
| 8563 text Toolbar buttons shown with text. | |
| 8564 horiz Icon and text of a toolbar button are | |
| 10 | 8565 horizontally arranged. {only in GTK+ 2 GUI} |
| 7 | 8566 tooltips Tooltips are active for toolbar buttons. |
| 8567 Tooltips refer to the popup help text which appears after the mouse | |
| 8568 cursor is placed over a toolbar button for a brief moment. | |
| 8569 | |
| 8570 If you want the toolbar to be shown with icons as well as text, do the | |
| 8571 following: > | |
| 8572 :set tb=icons,text | |
| 28379 | 8573 < Motif cannot display icons and text at the same time. They |
| 7 | 8574 will show icons if both are requested. |
| 8575 | |
| 8576 If none of the strings specified in 'toolbar' are valid or if | |
| 8577 'toolbar' is empty, this option is ignored. If you want to disable | |
| 8578 the toolbar, you need to set the 'guioptions' option. For example: > | |
| 8579 :set guioptions-=T | |
| 8580 < Also see |gui-toolbar|. | |
| 8581 | |
| 8582 *'toolbariconsize'* *'tbis'* | |
| 8583 'toolbariconsize' 'tbis' string (default "small") | |
| 8584 global | |
|
10895
c391bfbdb452
Updated runtime files.
Christian Brabandt <cb@256bit.org>
parents:
10734
diff
changeset
|
8585 {only in the GTK+ GUI} |
| 7 | 8586 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
|
8587 tiny Use tiny icons. |
|
da01d5da2cfa
commit https://github.com/vim/vim/commit/77cdfd10382e01cc51f4ba1a9177032351843151
Christian Brabandt <cb@256bit.org>
parents:
8246
diff
changeset
|
8588 small Use small icons (default). |
|
da01d5da2cfa
commit https://github.com/vim/vim/commit/77cdfd10382e01cc51f4ba1a9177032351843151
Christian Brabandt <cb@256bit.org>
parents:
8246
diff
changeset
|
8589 medium Use medium-sized icons. |
|
da01d5da2cfa
commit https://github.com/vim/vim/commit/77cdfd10382e01cc51f4ba1a9177032351843151
Christian Brabandt <cb@256bit.org>
parents:
8246
diff
changeset
|
8590 large Use large icons. |
|
da01d5da2cfa
commit https://github.com/vim/vim/commit/77cdfd10382e01cc51f4ba1a9177032351843151
Christian Brabandt <cb@256bit.org>
parents:
8246
diff
changeset
|
8591 huge Use even larger icons. |
|
da01d5da2cfa
commit https://github.com/vim/vim/commit/77cdfd10382e01cc51f4ba1a9177032351843151
Christian Brabandt <cb@256bit.org>
parents:
8246
diff
changeset
|
8592 giant Use very big icons. |
| 7 | 8593 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
|
8594 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
|
8595 large=24x24, medium=24x24, small=20x20 and tiny=16x16. |
| 7 | 8596 |
| 8597 If 'toolbariconsize' is empty, the global default size as determined | |
| 8598 by user preferences or the current theme is used. | |
| 8599 | |
| 8600 *'ttybuiltin'* *'tbi'* *'nottybuiltin'* *'notbi'* | |
| 8601 'ttybuiltin' 'tbi' boolean (default on) | |
| 8602 global | |
| 8603 When on, the builtin termcaps are searched before the external ones. | |
| 8604 When off the builtin termcaps are searched after the external ones. | |
| 8605 When this option is changed, you should set the 'term' option next for | |
| 8606 the change to take effect, for example: > | |
| 8607 :set notbi term=$TERM | |
| 8608 < See also |termcap|. | |
| 8609 Rationale: The default for this option is "on", because the builtin | |
| 8610 termcap entries are generally better (many systems contain faulty | |
| 8611 xterm entries...). | |
| 8612 | |
| 8613 *'ttyfast'* *'tf'* *'nottyfast'* *'notf'* | |
|
31229
5b71c3884a2a
patch 9.0.0948: 'ttyfast' is set for arbitrary terminals
Bram Moolenaar <Bram@vim.org>
parents:
31200
diff
changeset
|
8614 'ttyfast' 'tf' boolean (default on) |
| 7 | 8615 global |
| 8616 Indicates a fast terminal connection. More characters will be sent to | |
| 8617 the screen for redrawing, instead of using insert/delete line | |
| 8618 commands. Improves smoothness of redrawing when there are multiple | |
| 8619 windows and the terminal does not support a scrolling region. | |
| 8620 Also enables the extra writing of characters at the end of each screen | |
| 8621 line for lines that wrap. This helps when using copy/paste with the | |
| 8622 mouse in an xterm and other terminals. | |
| 8623 | |
|
31229
5b71c3884a2a
patch 9.0.0948: 'ttyfast' is set for arbitrary terminals
Bram Moolenaar <Bram@vim.org>
parents:
31200
diff
changeset
|
8624 The default used to be set only for some terminal names, but these |
|
5b71c3884a2a
patch 9.0.0948: 'ttyfast' is set for arbitrary terminals
Bram Moolenaar <Bram@vim.org>
parents:
31200
diff
changeset
|
8625 days nearly all terminals are fast, therefore the default is now "on". |
|
5b71c3884a2a
patch 9.0.0948: 'ttyfast' is set for arbitrary terminals
Bram Moolenaar <Bram@vim.org>
parents:
31200
diff
changeset
|
8626 If you have a slow connection you may want to set this option off, |
|
5b71c3884a2a
patch 9.0.0948: 'ttyfast' is set for arbitrary terminals
Bram Moolenaar <Bram@vim.org>
parents:
31200
diff
changeset
|
8627 e.g. depending on the host name: > |
|
5b71c3884a2a
patch 9.0.0948: 'ttyfast' is set for arbitrary terminals
Bram Moolenaar <Bram@vim.org>
parents:
31200
diff
changeset
|
8628 if hostname() =~ 'faraway' |
|
5b71c3884a2a
patch 9.0.0948: 'ttyfast' is set for arbitrary terminals
Bram Moolenaar <Bram@vim.org>
parents:
31200
diff
changeset
|
8629 set nottyfast |
|
5b71c3884a2a
patch 9.0.0948: 'ttyfast' is set for arbitrary terminals
Bram Moolenaar <Bram@vim.org>
parents:
31200
diff
changeset
|
8630 endif |
|
5b71c3884a2a
patch 9.0.0948: 'ttyfast' is set for arbitrary terminals
Bram Moolenaar <Bram@vim.org>
parents:
31200
diff
changeset
|
8631 < |
| 7 | 8632 *'ttymouse'* *'ttym'* |
| 8633 'ttymouse' 'ttym' string (default depends on 'term') | |
| 8634 global | |
| 8635 {only in Unix and VMS, doesn't work in the GUI; not | |
| 8636 available when compiled without |+mouse|} | |
| 8637 Name of the terminal type for which mouse codes are to be recognized. | |
| 1213 | 8638 Currently these strings are valid: |
| 7 | 8639 *xterm-mouse* |
| 8640 xterm xterm-like mouse handling. The mouse generates | |
| 8641 "<Esc>[Mscr", where "scr" is three bytes: | |
| 8642 "s" = button state | |
| 8643 "c" = column plus 33 | |
| 8644 "r" = row plus 33 | |
| 5908 | 8645 This only works up to 223 columns! See "dec", |
| 8646 "urxvt", and "sgr" for solutions. | |
| 7 | 8647 xterm2 Works like "xterm", but with the xterm reporting the |
| 8648 mouse position while the mouse is dragged. This works | |
| 8649 much faster and more precise. Your xterm must at | |
| 180 | 8650 least at patchlevel 88 / XFree 3.3.3 for this to |
| 7 | 8651 work. See below for how Vim detects this |
| 8652 automatically. | |
| 8653 *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
|
8654 netterm NetTerm mouse handling. A left mouse click generates |
| 7 | 8655 "<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
|
8656 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
|
8657 supported. |
| 7 | 8658 *dec-mouse* |
| 8659 dec DEC terminal mouse handling. The mouse generates a | |
| 8660 rather complex sequence, starting with "<Esc>[". | |
| 189 | 8661 This is also available for an Xterm, if it was |
| 8662 configured with "--enable-dec-locator". | |
| 7 | 8663 *jsbterm-mouse* |
| 8664 jsbterm JSB term mouse handling. | |
| 8665 *pterm-mouse* | |
| 8666 pterm QNX pterm mouse handling. | |
| 3224 | 8667 *urxvt-mouse* |
| 8668 urxvt Mouse handling for the urxvt (rxvt-unicode) terminal. | |
| 5908 | 8669 The mouse works only if the terminal supports this |
| 8670 encoding style, but it does not have 223 columns limit | |
| 8671 unlike "xterm" or "xterm2". | |
| 3750 | 8672 *sgr-mouse* |
| 8673 sgr Mouse handling for the terminal that emits SGR-styled | |
| 5908 | 8674 mouse reporting. The mouse works even in columns |
| 8675 beyond 223. This option is backward compatible with | |
| 8676 "xterm2" because it can also decode "xterm2" style | |
| 8677 mouse codes. | |
| 7 | 8678 |
| 8679 The mouse handling must be enabled at compile time |+mouse_xterm| | |
| 5908 | 8680 |+mouse_dec| |+mouse_netterm| |+mouse_jsbterm| |+mouse_urxvt| |
| 8681 |+mouse_sgr|. | |
| 7 | 8682 Only "xterm"(2) is really recognized. NetTerm mouse codes are always |
| 8683 recognized, if enabled at compile time. DEC terminal mouse codes | |
| 8684 are recognized if enabled at compile time, and 'ttymouse' is not | |
| 5908 | 8685 "xterm", "xterm2", "urxvt" or "sgr" (because dec mouse codes conflict |
| 8686 with them). | |
| 7 | 8687 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
|
8688 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
|
8689 "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
|
8690 already. |
|
31672
9dc48932db8e
patch 9.0.1168: code to enable/disable mouse is not from terminfo/termcap
Bram Moolenaar <Bram@vim.org>
parents:
31671
diff
changeset
|
8691 If the terminfo/termcap entry "XM" exists and the first number is |
|
9dc48932db8e
patch 9.0.1168: code to enable/disable mouse is not from terminfo/termcap
Bram Moolenaar <Bram@vim.org>
parents:
31671
diff
changeset
|
8692 "1006" then 'ttymouse' will be set to "sgr". This works for many |
|
9dc48932db8e
patch 9.0.1168: code to enable/disable mouse is not from terminfo/termcap
Bram Moolenaar <Bram@vim.org>
parents:
31671
diff
changeset
|
8693 modern terminals. |
| 5908 | 8694 Additionally, if vim is compiled with the |+termresponse| feature and |
| 8695 |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
|
8696 number, more intelligent detection is done. |
| 7 | 8697 The "xterm2" value will be set if the xterm version is reported to be |
| 15131 | 8698 from 95 to 276. The "sgr" value will be set if Vim detects Mac |
| 8699 Terminal.app, iTerm2 or mintty, and when the xterm version is 277 or | |
| 8700 higher. | |
| 5908 | 8701 If you do not want 'ttymouse' to be set to "xterm2" or "sgr" |
| 8702 automatically, set t_RV to an empty string: > | |
| 7 | 8703 :set t_RV= |
| 8704 < | |
| 8705 *'ttyscroll'* *'tsl'* | |
| 8706 'ttyscroll' 'tsl' number (default 999) | |
| 8707 global | |
| 8708 Maximum number of lines to scroll the screen. If there are more lines | |
| 8709 to scroll the window is redrawn. For terminals where scrolling is | |
| 8710 very slow and redrawing is not slow this can be set to a small number, | |
| 8711 e.g., 3, to speed up displaying. | |
| 8712 | |
| 8713 *'ttytype'* *'tty'* | |
| 8714 'ttytype' 'tty' string (default from $TERM) | |
| 8715 global | |
| 8716 Alias for 'term', see above. | |
| 8717 | |
|
2214
f8222d1f9a73
Included patch for persistent undo. Lots of changes and added test.
Bram Moolenaar <bram@vim.org>
parents:
2209
diff
changeset
|
8718 *'undodir'* *'udir'* |
|
f8222d1f9a73
Included patch for persistent undo. Lots of changes and added test.
Bram Moolenaar <bram@vim.org>
parents:
2209
diff
changeset
|
8719 '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
|
8720 global |
|
2570
71b56b4e7785
Make the references to features in the help more consistent. (Sylvain Hitier)
Bram Moolenaar <bram@vim.org>
parents:
2561
diff
changeset
|
8721 {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
|
8722 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
|
8723 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
|
8724 "." 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
|
8725 "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
|
8726 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
|
8727 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
|
8728 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
|
8729 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
|
8730 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
|
8731 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
|
8732 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
|
8733 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
|
8734 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
|
8735 security reasons. |
|
2214
f8222d1f9a73
Included patch for persistent undo. Lots of changes and added test.
Bram Moolenaar <bram@vim.org>
parents:
2209
diff
changeset
|
8736 |
|
4681
2eb30f341e8d
Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents:
4502
diff
changeset
|
8737 *'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
|
8738 '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
|
8739 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
|
8740 {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
|
8741 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
|
8742 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
|
8743 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
|
8744 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
|
8745 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
|
8746 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
|
8747 before a reload to be saved for undo. |
| 3920 | 8748 When 'undofile' is turned off the undo file is NOT deleted. |
| 11160 | 8749 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
|
8750 |
| 7 | 8751 *'undolevels'* *'ul'* |
| 19116 | 8752 'undolevels' 'ul' number (default 100, 1000 for Unix, VMS and Win32) |
| 5446 | 8753 global or local to buffer |global-local| |
| 7 | 8754 Maximum number of changes that can be undone. Since undo information |
| 18186 | 8755 is kept in memory, higher numbers will cause more memory to be used. |
| 8756 Nevertheless, a single change can already use a large amount of memory. | |
| 7 | 8757 Set to 0 for Vi compatibility: One level of undo and "u" undoes |
| 8758 itself: > | |
| 8759 set ul=0 | |
| 8760 < But you can also get Vi compatibility by including the 'u' flag in | |
| 8761 '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
|
8762 Also see |undo-two-ways|. |
| 5446 | 8763 Set to -1 for no undo at all. You might want to do this only for the |
| 8764 current buffer: > | |
| 8765 setlocal ul=-1 | |
| 7 | 8766 < This helps when you run out of memory for a single change. |
| 6336 | 8767 |
| 8768 The local value is set to -123456 when the global value is to be used. | |
| 8769 | |
|
2249
6d3d35ff2c2b
Use full path in undofile(). Updated docs.
Bram Moolenaar <bram@vim.org>
parents:
2240
diff
changeset
|
8770 Also see |clear-undo|. |
| 7 | 8771 |
|
2394
a3aca345aafa
Add the 'undoreload' option to be able to undo a file reload.
Bram Moolenaar <bram@vim.org>
parents:
2382
diff
changeset
|
8772 *'undoreload'* *'ur'* |
|
a3aca345aafa
Add the 'undoreload' option to be able to undo a file reload.
Bram Moolenaar <bram@vim.org>
parents:
2382
diff
changeset
|
8773 '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
|
8774 global |
|
a3aca345aafa
Add the 'undoreload' option to be able to undo a file reload.
Bram Moolenaar <bram@vim.org>
parents:
2382
diff
changeset
|
8775 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
|
8776 ":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
|
8777 Vim. |FileChangedShell| |
| 12559 | 8778 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
|
8779 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
|
8780 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
|
8781 |
|
a3aca345aafa
Add the 'undoreload' option to be able to undo a file reload.
Bram Moolenaar <bram@vim.org>
parents:
2382
diff
changeset
|
8782 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
|
8783 |
|
a3aca345aafa
Add the 'undoreload' option to be able to undo a file reload.
Bram Moolenaar <bram@vim.org>
parents:
2382
diff
changeset
|
8784 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
|
8785 this option to a lower value if you run out of memory. |
| 7 | 8786 |
| 8787 *'updatecount'* *'uc'* | |
| 8788 'updatecount' 'uc' number (default: 200) | |
| 8789 global | |
| 8790 After typing this many characters the swap file will be written to | |
| 8791 disk. When zero, no swap file will be created at all (see chapter on | |
| 8792 recovery |crash-recovery|). 'updatecount' is set to zero by starting | |
| 8793 Vim with the "-n" option, see |startup|. When editing in readonly | |
| 8794 mode this option will be initialized to 10000. | |
| 8795 The swapfile can be disabled per buffer with |'swapfile'|. | |
| 8796 When 'updatecount' is set from zero to non-zero, swap files are | |
| 8797 created for all buffers that have 'swapfile' set. When 'updatecount' | |
| 8798 is set to zero, existing swap files are not deleted. | |
| 8799 Also see |'swapsync'|. | |
| 8800 This option has no meaning in buffers where |'buftype'| is "nofile" | |
| 8801 or "nowrite". | |
| 8802 | |
| 8803 *'updatetime'* *'ut'* | |
| 8804 'updatetime' 'ut' number (default 4000) | |
| 8805 global | |
| 8806 If this many milliseconds nothing is typed the swap file will be | |
| 8807 written to disk (see |crash-recovery|). Also used for the | |
| 8808 |CursorHold| autocommand event. | |
| 8809 | |
|
14175
2ad722003b36
patch 8.1.0105: all tab stops are the same
Christian Brabandt <cb@256bit.org>
parents:
14019
diff
changeset
|
8810 *'varsofttabstop'* *'vsts'* |
|
2ad722003b36
patch 8.1.0105: all tab stops are the same
Christian Brabandt <cb@256bit.org>
parents:
14019
diff
changeset
|
8811 'varsofttabstop' 'vsts' string (default "") |
|
2ad722003b36
patch 8.1.0105: all tab stops are the same
Christian Brabandt <cb@256bit.org>
parents:
14019
diff
changeset
|
8812 local to buffer |
|
2ad722003b36
patch 8.1.0105: all tab stops are the same
Christian Brabandt <cb@256bit.org>
parents:
14019
diff
changeset
|
8813 {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
|
8814 feature} |
|
2ad722003b36
patch 8.1.0105: all tab stops are the same
Christian Brabandt <cb@256bit.org>
parents:
14019
diff
changeset
|
8815 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
|
8816 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
|
8817 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
|
8818 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
|
8819 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
|
8820 |
|
2ad722003b36
patch 8.1.0105: all tab stops are the same
Christian Brabandt <cb@256bit.org>
parents:
14019
diff
changeset
|
8821 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
|
8822 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
|
8823 to use the following: > |
|
2ad722003b36
patch 8.1.0105: all tab stops are the same
Christian Brabandt <cb@256bit.org>
parents:
14019
diff
changeset
|
8824 :set varsofttabstop=8,32,8 |
|
14249
4543777545a3
Updated runtime and language files.
Christian Brabandt <cb@256bit.org>
parents:
14175
diff
changeset
|
8825 < 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
|
8826 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
|
8827 |
|
2ad722003b36
patch 8.1.0105: all tab stops are the same
Christian Brabandt <cb@256bit.org>
parents:
14019
diff
changeset
|
8828 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
|
8829 'varsofttabstop' is set. |
|
2ad722003b36
patch 8.1.0105: all tab stops are the same
Christian Brabandt <cb@256bit.org>
parents:
14019
diff
changeset
|
8830 |
|
2ad722003b36
patch 8.1.0105: all tab stops are the same
Christian Brabandt <cb@256bit.org>
parents:
14019
diff
changeset
|
8831 *'vartabstop'* *'vts'* |
|
2ad722003b36
patch 8.1.0105: all tab stops are the same
Christian Brabandt <cb@256bit.org>
parents:
14019
diff
changeset
|
8832 'vartabstop' 'vts' string (default "") |
|
2ad722003b36
patch 8.1.0105: all tab stops are the same
Christian Brabandt <cb@256bit.org>
parents:
14019
diff
changeset
|
8833 local to buffer |
|
2ad722003b36
patch 8.1.0105: all tab stops are the same
Christian Brabandt <cb@256bit.org>
parents:
14019
diff
changeset
|
8834 {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
|
8835 feature} |
|
2ad722003b36
patch 8.1.0105: all tab stops are the same
Christian Brabandt <cb@256bit.org>
parents:
14019
diff
changeset
|
8836 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
|
8837 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
|
8838 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
|
8839 :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
|
8840 < 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
|
8841 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
|
8842 |
|
2ad722003b36
patch 8.1.0105: all tab stops are the same
Christian Brabandt <cb@256bit.org>
parents:
14019
diff
changeset
|
8843 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
|
8844 is set. |
|
2ad722003b36
patch 8.1.0105: all tab stops are the same
Christian Brabandt <cb@256bit.org>
parents:
14019
diff
changeset
|
8845 |
| 7 | 8846 *'verbose'* *'vbs'* |
| 8847 'verbose' 'vbs' number (default 0) | |
| 8848 global | |
| 8849 When bigger than zero, Vim will give messages about what it is doing. | |
| 8850 Currently, these messages are given: | |
| 8851 >= 1 When the viminfo file is read or written. | |
| 8852 >= 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
|
8853 >= 4 Shell commands. |
| 712 | 8854 >= 5 Every searched tags file and include file. |
| 7 | 8855 >= 8 Files for which a group of autocommands is executed. |
| 8856 >= 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
|
8857 >= 11 Finding items in a path |
| 7 | 8858 >= 12 Every executed function. |
| 8859 >= 13 When an exception is thrown, caught, finished, or discarded. | |
| 8860 >= 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
|
8861 >= 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
|
8862 characters). |
| 21676 | 8863 >= 16 Every executed Ex command. |
| 7 | 8864 |
| 8865 This option can also be set with the "-V" argument. See |-V|. | |
| 8866 This option is also set by the |:verbose| command. | |
| 8867 | |
| 293 | 8868 When the 'verbosefile' option is set then the verbose messages are not |
| 8869 displayed. | |
| 8870 | |
| 8871 *'verbosefile'* *'vfile'* | |
| 8872 'verbosefile' 'vfile' string (default empty) | |
| 8873 global | |
| 8874 When not empty all messages are written in a file with this name. | |
| 8875 When the file exists messages are appended. | |
| 8876 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
|
8877 empty. Writes are buffered, thus may not show up for some time. |
| 293 | 8878 Setting 'verbosefile' to a new value is like making it empty first. |
| 8879 The difference with |:redir| is that verbose messages are not | |
| 8880 displayed when 'verbosefile' is set. | |
| 8881 | |
| 7 | 8882 *'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
|
8883 'viewdir' 'vdir' string (default for Amiga and Win32: |
| 7 | 8884 "$VIM/vimfiles/view", |
| 8885 for Unix: "~/.vim/view", | |
| 21825 | 8886 for macOS: "$VIM:vimfiles:view" |
| 18972 | 8887 for VMS: "sys$login:vimfiles/view") |
| 7 | 8888 global |
|
2570
71b56b4e7785
Make the references to features in the help more consistent. (Sylvain Hitier)
Bram Moolenaar <bram@vim.org>
parents:
2561
diff
changeset
|
8889 {not available when compiled without the |+mksession| |
| 7 | 8890 feature} |
| 8891 Name of the directory where to store files for |:mkview|. | |
| 8892 This option cannot be set from a |modeline| or in the |sandbox|, for | |
| 8893 security reasons. | |
| 8894 | |
| 8895 *'viewoptions'* *'vop'* | |
|
12824
79a754456110
patch 8.0.1289: mkview always includes the local directory
Christian Brabandt <cb@256bit.org>
parents:
12802
diff
changeset
|
8896 'viewoptions' 'vop' string (default: "folds,options,cursor,curdir") |
| 7 | 8897 global |
|
2570
71b56b4e7785
Make the references to features in the help more consistent. (Sylvain Hitier)
Bram Moolenaar <bram@vim.org>
parents:
2561
diff
changeset
|
8898 {not available when compiled without the |+mksession| |
| 7 | 8899 feature} |
| 28379 | 8900 Changes the effect of the |:mkview| command. It is a comma-separated |
| 10 | 8901 list of words. Each word enables saving and restoring something: |
| 7 | 8902 word save and restore ~ |
| 8903 cursor cursor position in file and in window | |
| 8904 folds manually created folds, opened/closed folds and local | |
| 8905 fold options | |
| 8906 options options and mappings local to a window or buffer (not | |
| 8907 global values for local options) | |
| 6213 | 8908 localoptions same as "options" |
| 7 | 8909 slash backslashes in file names replaced with forward |
| 8910 slashes | |
| 8911 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
|
8912 on MS-Windows |
|
12824
79a754456110
patch 8.0.1289: mkview always includes the local directory
Christian Brabandt <cb@256bit.org>
parents:
12802
diff
changeset
|
8913 curdir the window-local directory, if set with `:lcd` |
| 7 | 8914 |
|
18912
ccd16426a1f9
patch 8.2.0017: OS/2 and MS-DOS are still mentioned
Bram Moolenaar <Bram@vim.org>
parents:
18879
diff
changeset
|
8915 "slash" and "unix" are useful on MS-Windows when sharing view files |
| 7 | 8916 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
|
8917 but the MS-Windows version of Vim can source unix format scripts. |
| 7 | 8918 |
| 8919 *'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
|
8920 '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
|
8921 MS-Windows: '100,<50,s10,h,rA:,rB:, |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
8922 for Amiga: '100,<50,s10,h,rdf0:,rdf1:,rdf2: |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
8923 for others: '100,<50,s10,h) |
| 7 | 8924 global |
|
2570
71b56b4e7785
Make the references to features in the help more consistent. (Sylvain Hitier)
Bram Moolenaar <bram@vim.org>
parents:
2561
diff
changeset
|
8925 {not available when compiled without the |+viminfo| |
| 7 | 8926 feature} |
| 8927 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
|
8928 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
|
8929 "NONE". |
| 28379 | 8930 The string should be a comma-separated list of parameters, each |
|
11666
5cd9ba96561d
patch 8.0.0716: not easy to start Vim cleanly
Christian Brabandt <cb@256bit.org>
parents:
11659
diff
changeset
|
8931 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
|
8932 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
|
8933 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
|
8934 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
|
8935 identifying characters and the effect of their value. |
| 7 | 8936 CHAR VALUE ~ |
| 3224 | 8937 *viminfo-!* |
| 7 | 8938 ! When included, save and restore global variables that start |
| 8939 with an uppercase letter, and don't contain a lowercase | |
| 8940 letter. Thus "KEEPTHIS and "K_L_M" are stored, but "KeepThis" | |
| 2607 | 8941 and "_K_L_M" are not. Nested List and Dict items may not be |
| 2642 | 8942 read back correctly, you end up with an empty item. |
| 3224 | 8943 *viminfo-quote* |
| 7 | 8944 " Maximum number of lines saved for each register. Old name of |
| 8945 the '<' item, with the disadvantage that you need to put a | |
| 8946 backslash before the ", otherwise it will be recognized as the | |
| 8947 start of a comment! | |
| 3224 | 8948 *viminfo-%* |
| 7 | 8949 % When included, save and restore the buffer list. If Vim is |
| 8950 started with a file name argument, the buffer list is not | |
| 8951 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
|
8952 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
|
8953 ('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
|
8954 removable media (|viminfo-r|) are not saved. |
| 23 | 8955 When followed by a number, the number specifies the maximum |
| 8956 number of buffers that are stored. Without a number all | |
| 8957 buffers are stored. | |
| 3224 | 8958 *viminfo-'* |
| 7 | 8959 ' Maximum number of previously edited files for which the marks |
| 8960 are remembered. This parameter must always be included when | |
| 8961 'viminfo' is non-empty. | |
| 8962 Including this item also means that the |jumplist| and the | |
| 8963 |changelist| are stored in the viminfo file. | |
| 3224 | 8964 *viminfo-/* |
| 7 | 8965 / Maximum number of items in the search pattern history to be |
| 10 | 8966 saved. If non-zero, then the previous search and substitute |
| 7 | 8967 patterns are also saved. When not included, the value of |
| 8968 'history' is used. | |
| 3224 | 8969 *viminfo-:* |
| 7 | 8970 : Maximum number of items in the command-line history to be |
| 10 | 8971 saved. When not included, the value of 'history' is used. |
| 3224 | 8972 *viminfo-<* |
| 7 | 8973 < Maximum number of lines saved for each register. If zero then |
| 8974 registers are not saved. When not included, all lines are | |
| 8975 saved. '"' is the old name for this item. | |
| 8976 Also see the 's' item below: limit specified in Kbyte. | |
| 3224 | 8977 *viminfo-@* |
| 7 | 8978 @ Maximum number of items in the input-line history to be |
| 10 | 8979 saved. When not included, the value of 'history' is used. |
| 3224 | 8980 *viminfo-c* |
| 7 | 8981 c When included, convert the text in the viminfo file from the |
| 8982 'encoding' used when writing the file to the current | |
| 233 | 8983 'encoding'. See |viminfo-encoding|. |
| 3224 | 8984 *viminfo-f* |
| 7 | 8985 f Whether file marks need to be stored. If zero, file marks ('0 |
| 8986 to '9, 'A to 'Z) are not stored. When not present or when | |
| 10 | 8987 non-zero, they are all stored. '0 is used for the current |
| 7 | 8988 cursor position (when exiting or when doing ":wviminfo"). |
| 3224 | 8989 *viminfo-h* |
| 7 | 8990 h Disable the effect of 'hlsearch' when loading the viminfo |
| 8991 file. When not included, it depends on whether ":nohlsearch" | |
| 8992 has been used since the last search command. | |
| 3224 | 8993 *viminfo-n* |
| 7 | 8994 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
|
8995 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
|
8996 '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
|
8997 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
|
8998 expanded when opening the file, not when setting the option. |
| 3224 | 8999 *viminfo-r* |
| 7 | 9000 r Removable media. The argument is a string (up to the next |
| 9001 ','). This parameter can be given several times. Each | |
| 9002 specifies the start of a path for which no marks will be | |
| 18972 | 9003 stored. This is to avoid removable media. For MS-Windows you |
| 7 | 9004 could use "ra:,rb:", for Amiga "rdf0:,rdf1:,rdf2:". You can |
| 9005 also use it for temp files, e.g., for Unix: "r/tmp". Case is | |
| 9006 ignored. Maximum length of each 'r' argument is 50 | |
| 9007 characters. | |
| 3224 | 9008 *viminfo-s* |
| 7 | 9009 s Maximum size of an item in Kbyte. If zero then registers are |
| 9010 not saved. Currently only applies to registers. The default | |
| 9011 "s10" will exclude registers with more than 10 Kbyte of text. | |
| 9012 Also see the '<' item above: line count limit. | |
| 9013 | |
| 9014 Example: > | |
| 9015 :set viminfo='50,<1000,s100,:0,n~/vim/viminfo | |
| 9016 < | |
| 9017 '50 Marks will be remembered for the last 50 files you | |
| 9018 edited. | |
| 9019 <1000 Contents of registers (up to 1000 lines each) will be | |
| 9020 remembered. | |
| 9021 s100 Registers with more than 100 Kbyte text are skipped. | |
| 9022 :0 Command-line history will not be saved. | |
| 9023 n~/vim/viminfo The name of the file to use is "~/vim/viminfo". | |
| 9024 no / Since '/' is not specified, the default will be used, | |
| 9025 that is, save all of the search history, and also the | |
| 9026 previous search and substitute patterns. | |
| 9027 no % The buffer list will not be saved nor read back. | |
| 9028 no h 'hlsearch' highlighting will be restored. | |
| 9029 | |
| 9030 When setting 'viminfo' from an empty value you can use |:rviminfo| to | |
| 9031 load the contents of the file, this is not done automatically. | |
| 9032 | |
| 9033 This option cannot be set from a |modeline| or in the |sandbox|, for | |
| 9034 security reasons. | |
| 11160 | 9035 NOTE: This option is set to the Vim default value when 'compatible' |
| 9036 is reset. | |
| 7 | 9037 |
|
11666
5cd9ba96561d
patch 8.0.0716: not easy to start Vim cleanly
Christian Brabandt <cb@256bit.org>
parents:
11659
diff
changeset
|
9038 *'viminfofile'* *'vif'* |
|
5cd9ba96561d
patch 8.0.0716: not easy to start Vim cleanly
Christian Brabandt <cb@256bit.org>
parents:
11659
diff
changeset
|
9039 'viminfofile' 'vif' string (default: "") |
|
5cd9ba96561d
patch 8.0.0716: not easy to start Vim cleanly
Christian Brabandt <cb@256bit.org>
parents:
11659
diff
changeset
|
9040 global |
|
5cd9ba96561d
patch 8.0.0716: not easy to start Vim cleanly
Christian Brabandt <cb@256bit.org>
parents:
11659
diff
changeset
|
9041 {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
|
9042 feature} |
|
5cd9ba96561d
patch 8.0.0716: not easy to start Vim cleanly
Christian Brabandt <cb@256bit.org>
parents:
11659
diff
changeset
|
9043 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
|
9044 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
|
9045 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
|
9046 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
|
9047 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
|
9048 security reasons. |
|
11666
5cd9ba96561d
patch 8.0.0716: not easy to start Vim cleanly
Christian Brabandt <cb@256bit.org>
parents:
11659
diff
changeset
|
9049 |
| 7 | 9050 *'virtualedit'* *'ve'* |
| 9051 '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
|
9052 global or local to window |global-local| |
| 28379 | 9053 A comma-separated list of these words: |
| 7 | 9054 block Allow virtual editing in Visual block mode. |
| 9055 insert Allow virtual editing in Insert mode. | |
| 9056 all Allow virtual editing in all modes. | |
| 772 | 9057 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
|
9058 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
|
9059 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
|
9060 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
|
9061 NONE Alternative spelling of "none". |
| 782 | 9062 |
| 7 | 9063 Virtual editing means that the cursor can be positioned where there is |
| 1263 | 9064 no actual character. This can be halfway into a tab or beyond the end |
| 7 | 9065 of the line. Useful for selecting a rectangle in Visual mode and |
| 9066 editing a table. | |
| 772 | 9067 "onemore" is not the same, it will only allow moving the cursor just |
| 9068 after the last character of the line. This makes some commands more | |
| 9069 consistent. Previously the cursor was always past the end of the line | |
| 9070 if the line was empty. But it is far from Vi compatible. It may also | |
| 782 | 9071 break some plugins or Vim scripts. For example because |l| can move |
| 9072 the cursor after the last character. Use with care! | |
| 5220 | 9073 Using the `$` command will move to the last character in the line, not |
| 782 | 9074 past it. This may actually move the cursor to the left! |
| 5220 | 9075 The `g$` command will move to the end of the screen line. |
| 772 | 9076 It doesn't make sense to combine "all" with "onemore", but you will |
| 9077 not get a warning for it. | |
| 25402 | 9078 When combined with other words, "none" is ignored. |
| 11160 | 9079 NOTE: This option is set to "" when 'compatible' is set. |
| 7 | 9080 |
| 9081 *'visualbell'* *'vb'* *'novisualbell'* *'novb'* *beep* | |
| 9082 'visualbell' 'vb' boolean (default off) | |
| 9083 global | |
|
11659
49c12c93abf3
Updated runtime files and translations.
Christian Brabandt <cb@256bit.org>
parents:
11529
diff
changeset
|
9084 Use a visual bell instead of beeping. The terminal code to display the |
| 7 | 9085 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
|
9086 use: > |
|
49c12c93abf3
Updated runtime files and translations.
Christian Brabandt <cb@256bit.org>
parents:
11529
diff
changeset
|
9087 :set vb t_vb= |
|
49c12c93abf3
Updated runtime files and translations.
Christian Brabandt <cb@256bit.org>
parents:
11529
diff
changeset
|
9088 < 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
|
9089 :set vb t_vb=[?5h$<100>[?5l |
|
49c12c93abf3
Updated runtime files and translations.
Christian Brabandt <cb@256bit.org>
parents:
11529
diff
changeset
|
9090 < 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
|
9091 to get a shorter or longer flash. |
|
49c12c93abf3
Updated runtime files and translations.
Christian Brabandt <cb@256bit.org>
parents:
11529
diff
changeset
|
9092 |
|
49c12c93abf3
Updated runtime files and translations.
Christian Brabandt <cb@256bit.org>
parents:
11529
diff
changeset
|
9093 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
|
9094 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
|
9095 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
|
9096 set. |
|
49c12c93abf3
Updated runtime files and translations.
Christian Brabandt <cb@256bit.org>
parents:
11529
diff
changeset
|
9097 |
| 7 | 9098 In the GUI, 't_vb' defaults to "<Esc>|f", which inverts the display |
| 9099 for 20 msec. If you want to use a different time, use "<Esc>|40f", | |
| 9100 where 40 is the time in msec. | |
|
11659
49c12c93abf3
Updated runtime files and translations.
Christian Brabandt <cb@256bit.org>
parents:
11529
diff
changeset
|
9101 |
|
49c12c93abf3
Updated runtime files and translations.
Christian Brabandt <cb@256bit.org>
parents:
11529
diff
changeset
|
9102 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
|
9103 might want to set it again in your |gvimrc|. |
|
49c12c93abf3
Updated runtime files and translations.
Christian Brabandt <cb@256bit.org>
parents:
11529
diff
changeset
|
9104 |
| 7 | 9105 Does not work on the Amiga, you always get a screen flash. |
| 9106 Also see 'errorbells'. | |
| 9107 | |
| 9108 *'warn'* *'nowarn'* | |
| 9109 'warn' boolean (default on) | |
| 9110 global | |
| 9111 Give a warning message when a shell command is used while the buffer | |
| 9112 has been changed. | |
| 9113 | |
| 9114 *'weirdinvert'* *'wiv'* *'noweirdinvert'* *'nowiv'* | |
| 9115 'weirdinvert' 'wiv' boolean (default off) | |
| 9116 global | |
| 667 | 9117 This option has the same effect as the 't_xs' terminal option. |
| 7 | 9118 It is provided for backwards compatibility with version 4.x. |
| 9119 Setting 'weirdinvert' has the effect of making 't_xs' non-empty, and | |
| 9120 vice versa. Has no effect when the GUI is running. | |
| 9121 | |
| 9122 *'whichwrap'* *'ww'* | |
| 9123 'whichwrap' 'ww' string (Vim default: "b,s", Vi default: "") | |
| 9124 global | |
| 9125 Allow specified keys that move the cursor left/right to move to the | |
| 9126 previous/next line when the cursor is on the first/last character in | |
| 9127 the line. Concatenate characters to allow this for these keys: | |
| 9128 char key mode ~ | |
| 9129 b <BS> Normal and Visual | |
| 9130 s <Space> Normal and Visual | |
| 712 | 9131 h "h" Normal and Visual (not recommended) |
| 9132 l "l" Normal and Visual (not recommended) | |
| 7 | 9133 < <Left> Normal and Visual |
| 9134 > <Right> Normal and Visual | |
| 9135 ~ "~" Normal | |
| 9136 [ <Left> Insert and Replace | |
| 9137 ] <Right> Insert and Replace | |
| 9138 For example: > | |
| 9139 :set ww=<,>,[,] | |
| 9140 < allows wrap only when cursor keys are used. | |
| 9141 When the movement keys are used in combination with a delete or change | |
| 9142 operator, the <EOL> also counts for a character. This makes "3h" | |
| 9143 different from "3dh" when the cursor crosses the end of a line. This | |
| 9144 is also true for "x" and "X", because they do the same as "dl" and | |
| 9145 "dh". If you use this, you may also want to use the mapping | |
| 9146 ":map <BS> X" to make backspace delete the character in front of the | |
| 9147 cursor. | |
| 714 | 9148 When 'l' is included and it is used after an operator at the end of a |
| 18130 | 9149 line (not an empty line) then it will not move to the next line. This |
| 9150 makes "dl", "cl", "yl" etc. work normally. | |
| 7 | 9151 NOTE: This option is set to the Vi default value when 'compatible' is |
| 9152 set and to the Vim default value when 'compatible' is reset. | |
| 9153 | |
| 9154 *'wildchar'* *'wc'* | |
| 9155 'wildchar' 'wc' number (Vim default: <Tab>, Vi default: CTRL-E) | |
| 9156 global | |
| 9157 Character you have to type to start wildcard expansion in the | |
| 9158 command-line, as specified with 'wildmode'. | |
| 1621 | 9159 More info here: |cmdline-completion|. |
| 7 | 9160 The character is not recognized when used inside a macro. See |
| 9161 'wildcharm' for that. | |
| 25836 | 9162 Some keys will not work, such as CTRL-C, <CR> and Enter. |
| 7 | 9163 Although 'wc' is a number option, you can set it to a special key: > |
| 25836 | 9164 :set wc=<Tab> |
| 7 | 9165 < NOTE: This option is set to the Vi default value when 'compatible' is |
| 9166 set and to the Vim default value when 'compatible' is reset. | |
| 9167 | |
| 9168 *'wildcharm'* *'wcm'* | |
| 9169 'wildcharm' 'wcm' number (default: none (0)) | |
| 9170 global | |
| 9171 'wildcharm' works exactly like 'wildchar', except that it is | |
| 233 | 9172 recognized when used inside a macro. You can find "spare" command-line |
| 9173 keys suitable for this option by looking at |ex-edit-index|. Normally | |
| 7 | 9174 you'll never actually type 'wildcharm', just use it in mappings that |
| 9175 automatically invoke completion mode, e.g.: > | |
| 9176 :set wcm=<C-Z> | |
| 1621 | 9177 :cnoremap ss so $vim/sessions/*.vim<C-Z> |
| 7 | 9178 < Then after typing :ss you can use CTRL-P & CTRL-N. |
| 9179 | |
| 9180 *'wildignore'* *'wig'* | |
| 9181 'wildignore' 'wig' string (default "") | |
| 9182 global | |
| 9183 A list of file patterns. A file that matches with one of these | |
| 3682 | 9184 patterns is ignored when expanding |wildcards|, completing file or |
| 9185 directory names, and influences the result of |expand()|, |glob()| and | |
| 9186 |globpath()| unless a flag is passed to disable this. | |
| 7 | 9187 The pattern is used like with |:autocmd|, see |autocmd-patterns|. |
| 9188 Also see 'suffixes'. | |
| 9189 Example: > | |
| 9190 :set wildignore=*.o,*.obj | |
| 9191 < The use of |:set+=| and |:set-=| is preferred when adding or removing | |
| 9192 a pattern from the list. This avoids problems when a future version | |
| 9193 uses another default. | |
| 9194 | |
| 2652 | 9195 |
| 2662 | 9196 *'wildignorecase'* *'wic'* *'nowildignorecase'* *'nowic'* |
| 2652 | 9197 'wildignorecase' 'wic' boolean (default off) |
| 9198 global | |
| 9199 When set case is ignored when completing file names and directories. | |
| 4242 | 9200 Has no effect when 'fileignorecase' is set. |
| 2652 | 9201 Does not apply when the shell is used to expand wildcards, which |
| 9202 happens when there are special characters. | |
| 9203 | |
| 9204 | |
| 7 | 9205 *'wildmenu'* *'wmnu'* *'nowildmenu'* *'nowmnu'* |
|
9669
284b4eb307fc
commit https://github.com/vim/vim/commit/8c08b5b569e2a9e9f63dea514591ecfa2d3bb392
Christian Brabandt <cb@256bit.org>
parents:
9665
diff
changeset
|
9206 'wildmenu' 'wmnu' boolean (default off, set in |defaults.vim|) |
| 7 | 9207 global |
| 9208 When 'wildmenu' is on, command-line completion operates in an enhanced | |
| 9209 mode. On pressing 'wildchar' (usually <Tab>) to invoke completion, | |
|
29881
0cc9a3001717
patch 9.0.0279: the tiny version has the popup menu but not 'wildmenu'
Bram Moolenaar <Bram@vim.org>
parents:
29879
diff
changeset
|
9210 the possible matches are shown. |
|
0cc9a3001717
patch 9.0.0279: the tiny version has the popup menu but not 'wildmenu'
Bram Moolenaar <Bram@vim.org>
parents:
29879
diff
changeset
|
9211 When 'wildoptions' contains "pum", then the completion matches are |
|
0cc9a3001717
patch 9.0.0279: the tiny version has the popup menu but not 'wildmenu'
Bram Moolenaar <Bram@vim.org>
parents:
29879
diff
changeset
|
9212 shown in a popup menu. Otherwise they are displayed just above the |
|
0cc9a3001717
patch 9.0.0279: the tiny version has the popup menu but not 'wildmenu'
Bram Moolenaar <Bram@vim.org>
parents:
29879
diff
changeset
|
9213 command line, with the first match highlighted (overwriting the status |
|
0cc9a3001717
patch 9.0.0279: the tiny version has the popup menu but not 'wildmenu'
Bram Moolenaar <Bram@vim.org>
parents:
29879
diff
changeset
|
9214 line, if there is one). |
|
27597
4eb2bf8b2f27
patch 8.2.4325: 'wildmenu' only shows few matches
Bram Moolenaar <Bram@vim.org>
parents:
27537
diff
changeset
|
9215 Keys that show the previous/next match, such as <Tab> or |
| 7 | 9216 CTRL-P/CTRL-N, cause the highlight to move to the appropriate match. |
| 9217 When 'wildmode' is used, "wildmenu" mode is used where "full" is | |
| 9218 specified. "longest" and "list" do not start "wildmenu" mode. | |
| 4159 | 9219 You can check the current mode with |wildmenumode()|. |
| 7 | 9220 If there are more matches than can fit in the line, a ">" is shown on |
| 9221 the right and/or a "<" is shown on the left. The status line scrolls | |
| 9222 as needed. | |
| 9223 The "wildmenu" mode is abandoned when a key is hit that is not used | |
| 9224 for selecting a completion. | |
|
27597
4eb2bf8b2f27
patch 8.2.4325: 'wildmenu' only shows few matches
Bram Moolenaar <Bram@vim.org>
parents:
27537
diff
changeset
|
9225 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
|
9226 following keys have special meanings: |
| 7 | 9227 |
| 9228 <Left> <Right> - select previous/next match (like CTRL-P/CTRL-N) | |
| 9229 <Down> - in filename/menu name completion: move into a | |
| 9230 subdirectory or submenu. | |
| 9231 <CR> - in menu completion, when the cursor is just after a | |
| 9232 dot: move into a submenu. | |
| 9233 <Up> - in filename/menu name completion: move up into | |
| 9234 parent directory or parent menu. | |
| 9235 | |
|
27597
4eb2bf8b2f27
patch 8.2.4325: 'wildmenu' only shows few matches
Bram Moolenaar <Bram@vim.org>
parents:
27537
diff
changeset
|
9236 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
|
9237 keys have special meanings: |
|
4eb2bf8b2f27
patch 8.2.4325: 'wildmenu' only shows few matches
Bram Moolenaar <Bram@vim.org>
parents:
27537
diff
changeset
|
9238 <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
|
9239 <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
|
9240 parent directory or parent menu. |
|
4eb2bf8b2f27
patch 8.2.4325: 'wildmenu' only shows few matches
Bram Moolenaar <Bram@vim.org>
parents:
27537
diff
changeset
|
9241 <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
|
9242 subdirectory or submenu. |
|
4eb2bf8b2f27
patch 8.2.4325: 'wildmenu' only shows few matches
Bram Moolenaar <Bram@vim.org>
parents:
27537
diff
changeset
|
9243 <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
|
9244 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
|
9245 selecting a match. |
|
4eb2bf8b2f27
patch 8.2.4325: 'wildmenu' only shows few matches
Bram Moolenaar <Bram@vim.org>
parents:
27537
diff
changeset
|
9246 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
|
9247 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
|
9248 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
|
9249 completion. |
|
4eb2bf8b2f27
patch 8.2.4325: 'wildmenu' only shows few matches
Bram Moolenaar <Bram@vim.org>
parents:
27537
diff
changeset
|
9250 |
| 7 | 9251 This makes the menus accessible from the console |console-menus|. |
| 9252 | |
| 9253 If you prefer the <Left> and <Right> keys to move the cursor instead | |
| 9254 of selecting a different match, use this: > | |
| 9255 :cnoremap <Left> <Space><BS><Left> | |
| 9256 :cnoremap <Right> <Space><BS><Right> | |
| 9257 < | |
| 9258 The "WildMenu" highlighting is used for displaying the current match | |
| 9259 |hl-WildMenu|. | |
| 9260 | |
| 9261 *'wildmode'* *'wim'* | |
| 9262 'wildmode' 'wim' string (Vim default: "full") | |
| 9263 global | |
| 9264 Completion mode that is used for the character specified with | |
| 28379 | 9265 'wildchar'. It is a comma-separated list of up to four parts. Each |
| 1152 | 9266 part specifies what to do for each consecutive use of 'wildchar'. The |
| 7 | 9267 first part specifies the behavior for the first use of 'wildchar', |
| 9268 The second part for the second use, etc. | |
| 24387 | 9269 |
| 9270 Each part consists of a colon separated list consisting of the | |
| 9271 following possible values: | |
| 7 | 9272 "" Complete only the first match. |
| 9273 "full" Complete the next full match. After the last match, | |
| 9274 the original string is used and then the first match | |
| 24387 | 9275 again. Will also start 'wildmenu' if it is enabled. |
| 7 | 9276 "longest" Complete till longest common string. If this doesn't |
| 9277 result in a longer string, use the next part. | |
| 24387 | 9278 "list" When more than one match, list all matches. |
| 9279 "lastused" When completing buffer names and more than one buffer | |
| 9280 matches, sort buffers by time last used (other than | |
| 9281 the current buffer). | |
| 9282 When there is only a single match, it is fully completed in all cases. | |
| 9283 | |
| 9284 Examples of useful colon-separated values: | |
| 7 | 9285 "longest:full" Like "longest", but also start 'wildmenu' if it is |
| 24387 | 9286 enabled. Will not complete to the next full match. |
| 7 | 9287 "list:full" When more than one match, list all matches and |
| 9288 complete first match. | |
| 9289 "list:longest" When more than one match, list all matches and | |
| 9290 complete till longest common string. | |
| 24387 | 9291 "list:lastused" When more than one buffer matches, list all matches |
| 9292 and sort buffers by time last used (other than the | |
| 9293 current buffer). | |
| 7 | 9294 |
| 9295 Examples: > | |
| 9296 :set wildmode=full | |
| 233 | 9297 < Complete first full match, next match, etc. (the default) > |
| 7 | 9298 :set wildmode=longest,full |
| 9299 < Complete longest common string, then each full match > | |
| 9300 :set wildmode=list:full | |
| 9301 < List all matches and complete each full match > | |
| 9302 :set wildmode=list,full | |
| 9303 < List all matches without completing, then each full match > | |
| 9304 :set wildmode=longest,list | |
| 9305 < Complete longest common string, then list alternatives. | |
| 1621 | 9306 More info here: |cmdline-completion|. |
| 7 | 9307 |
| 40 | 9308 *'wildoptions'* *'wop'* |
| 9309 'wildoptions' 'wop' string (default "") | |
| 9310 global | |
|
27597
4eb2bf8b2f27
patch 8.2.4325: 'wildmenu' only shows few matches
Bram Moolenaar <Bram@vim.org>
parents:
27537
diff
changeset
|
9311 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
|
9312 The following values are supported: |
| 28010 | 9313 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
|
9314 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
|
9315 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
|
9316 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
|
9317 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
|
9318 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
|
9319 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
|
9320 instead wildcard expansion is used. |
| 29290 | 9321 pum Display the completion matches using the popup menu |
|
27597
4eb2bf8b2f27
patch 8.2.4325: 'wildmenu' only shows few matches
Bram Moolenaar <Bram@vim.org>
parents:
27537
diff
changeset
|
9322 in the same style as the |ins-completion-menu|. |
| 40 | 9323 tagfile When using CTRL-D to list matching tags, the kind of |
| 856 | 9324 tag and the file of the tag is listed. Only one match |
| 40 | 9325 is displayed per line. Often used tag kinds are: |
| 9326 d #define | |
| 9327 f function | |
| 9328 | |
| 7 | 9329 *'winaltkeys'* *'wak'* |
| 9330 'winaltkeys' 'wak' string (default "menu") | |
| 9331 global | |
| 9332 {only used in Win32, Motif, GTK and Photon GUI} | |
| 9333 Some GUI versions allow the access to menu entries by using the ALT | |
| 9334 key in combination with a character that appears underlined in the | |
| 9335 menu. This conflicts with the use of the ALT key for mappings and | |
| 9336 entering special characters. This option tells what to do: | |
| 9337 no Don't use ALT keys for menus. ALT key combinations can be | |
| 9338 mapped, but there is no automatic handling. This can then be | |
| 9339 done with the |:simalt| command. | |
| 9340 yes ALT key handling is done by the windowing system. ALT key | |
| 9341 combinations cannot be mapped. | |
| 9342 menu Using ALT in combination with a character that is a menu | |
| 10 | 9343 shortcut key, will be handled by the windowing system. Other |
| 7 | 9344 keys can be mapped. |
| 9345 If the menu is disabled by excluding 'm' from 'guioptions', the ALT | |
| 9346 key is never used for the menu. | |
| 36 | 9347 This option is not used for <F10>; on Win32 and with GTK <F10> will |
| 9348 select the menu, unless it has been mapped. | |
| 7 | 9349 |
|
16778
eda4d65f232c
patch 8.1.1391: no popup window support
Bram Moolenaar <Bram@vim.org>
parents:
16740
diff
changeset
|
9350 *'wincolor'* *'wcr'* |
|
eda4d65f232c
patch 8.1.1391: no popup window support
Bram Moolenaar <Bram@vim.org>
parents:
16740
diff
changeset
|
9351 'wincolor' 'wcr' string (default empty) |
|
eda4d65f232c
patch 8.1.1391: no popup window support
Bram Moolenaar <Bram@vim.org>
parents:
16740
diff
changeset
|
9352 local to window |
|
eda4d65f232c
patch 8.1.1391: no popup window support
Bram Moolenaar <Bram@vim.org>
parents:
16740
diff
changeset
|
9353 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
|
9354 color |hl-Normal|. |
|
eda4d65f232c
patch 8.1.1391: no popup window support
Bram Moolenaar <Bram@vim.org>
parents:
16740
diff
changeset
|
9355 |
| 164 | 9356 *'window'* *'wi'* |
| 9357 'window' 'wi' number (default screen height - 1) | |
| 9358 global | |
| 24278 | 9359 Window height used for |CTRL-F| and |CTRL-B| when there is only one |
| 9360 window and the value is smaller than 'lines' minus one. The screen | |
| 9361 will scroll 'window' minus two lines, with a minimum of one. | |
| 164 | 9362 When 'window' is equal to 'lines' minus one CTRL-F and CTRL-B scroll |
| 9363 in a much smarter way, taking care of wrapping lines. | |
| 9364 When resizing the Vim window, the value is smaller than 1 or more than | |
| 9365 or equal to 'lines' it will be set to 'lines' minus 1. | |
| 24278 | 9366 Note: Do not confuse this with the height of the Vim window, use |
| 9367 'lines' for that. | |
| 164 | 9368 |
| 7 | 9369 *'winheight'* *'wh'* *E591* |
| 9370 'winheight' 'wh' number (default 1) | |
| 9371 global | |
| 9372 Minimal number of lines for the current window. This is not a hard | |
| 10 | 9373 minimum, Vim will use fewer lines if there is not enough room. If the |
| 1621 | 9374 focus goes to a window that is smaller, its size is increased, at the |
| 9375 cost of the height of other windows. | |
| 9376 Set 'winheight' to a small number for normal editing. | |
| 9377 Set it to 999 to make the current window fill most of the screen. | |
| 9378 Other windows will be only 'winminheight' high. This has the drawback | |
| 9379 that ":all" will create only two windows. To avoid "vim -o 1 2 3 4" | |
| 9380 to create only two windows, set the option after startup is done, | |
| 9381 using the |VimEnter| event: > | |
| 9382 au VimEnter * set winheight=999 | |
| 9383 < Minimum value is 1. | |
| 9384 The height is not adjusted after one of the commands that change the | |
| 7 | 9385 height of the current window. |
| 9386 'winheight' applies to the current window. Use 'winminheight' to set | |
| 9387 the minimal height for other windows. | |
| 9388 | |
| 9389 *'winfixheight'* *'wfh'* *'nowinfixheight'* *'nowfh'* | |
| 9390 'winfixheight' 'wfh' boolean (default off) | |
| 9391 local to window | |
| 9392 Keep the window height when windows are opened or closed and | |
| 1152 | 9393 'equalalways' is set. Also for |CTRL-W_=|. Set by default for the |
| 9394 |preview-window| and |quickfix-window|. | |
| 7 | 9395 The height may be changed anyway when running out of room. |
| 9396 | |
| 782 | 9397 *'winfixwidth'* *'wfw'* *'nowinfixwidth'* *'nowfw'* |
| 9398 'winfixwidth' 'wfw' boolean (default off) | |
| 9399 local to window | |
| 9400 Keep the window width when windows are opened or closed and | |
| 1152 | 9401 'equalalways' is set. Also for |CTRL-W_=|. |
| 782 | 9402 The width may be changed anyway when running out of room. |
| 9403 | |
| 7 | 9404 *'winminheight'* *'wmh'* |
| 9405 'winminheight' 'wmh' number (default 1) | |
| 9406 global | |
| 9407 The minimal height of a window, when it's not the current window. | |
| 9408 This is a hard minimum, windows will never become smaller. | |
| 9409 When set to zero, windows may be "squashed" to zero lines (i.e. just a | |
| 9410 status bar) if necessary. They will return to at least one line when | |
| 9411 they become active (since the cursor has to have somewhere to go.) | |
| 9412 Use 'winheight' to set the minimal height of the current window. | |
| 9413 This option is only checked when making a window smaller. Don't use a | |
| 9414 large number, it will cause errors when opening more than a few | |
| 9415 windows. A value of 0 to 3 is reasonable. | |
| 9416 | |
| 9417 *'winminwidth'* *'wmw'* | |
| 9418 'winminwidth' 'wmw' number (default 1) | |
| 9419 global | |
| 9420 The minimal width of a window, when it's not the current window. | |
| 9421 This is a hard minimum, windows will never become smaller. | |
| 9422 When set to zero, windows may be "squashed" to zero columns (i.e. just | |
| 9423 a vertical separator) if necessary. They will return to at least one | |
| 9424 line when they become active (since the cursor has to have somewhere | |
| 9425 to go.) | |
| 9426 Use 'winwidth' to set the minimal width of the current window. | |
| 9427 This option is only checked when making a window smaller. Don't use a | |
| 9428 large number, it will cause errors when opening more than a few | |
| 9429 windows. A value of 0 to 12 is reasonable. | |
| 9430 | |
|
12138
bee3751f3d4e
patch 8.0.0949: winpty.dll name is fixed
Christian Brabandt <cb@256bit.org>
parents:
11914
diff
changeset
|
9431 *'winptydll'* |
|
bee3751f3d4e
patch 8.0.0949: winpty.dll name is fixed
Christian Brabandt <cb@256bit.org>
parents:
11914
diff
changeset
|
9432 '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
|
9433 global |
|
bee3751f3d4e
patch 8.0.0949: winpty.dll name is fixed
Christian Brabandt <cb@256bit.org>
parents:
11914
diff
changeset
|
9434 {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
|
9435 feature on MS-Windows} |
|
bee3751f3d4e
patch 8.0.0949: winpty.dll name is fixed
Christian Brabandt <cb@256bit.org>
parents:
11914
diff
changeset
|
9436 Specifies the name of the winpty shared library, used for the |
| 21676 | 9437 |:terminal| command. The default depends on whether Vim was built as a |
| 12254 | 9438 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
|
9439 a fallback. |
|
bee3751f3d4e
patch 8.0.0949: winpty.dll name is fixed
Christian Brabandt <cb@256bit.org>
parents:
11914
diff
changeset
|
9440 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
|
9441 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
|
9442 security reasons. |
|
bee3751f3d4e
patch 8.0.0949: winpty.dll name is fixed
Christian Brabandt <cb@256bit.org>
parents:
11914
diff
changeset
|
9443 |
| 7 | 9444 *'winwidth'* *'wiw'* *E592* |
| 9445 'winwidth' 'wiw' number (default 20) | |
| 9446 global | |
| 9447 Minimal number of columns for the current window. This is not a hard | |
| 9448 minimum, Vim will use fewer columns if there is not enough room. If | |
| 9449 the current window is smaller, its size is increased, at the cost of | |
| 9450 the width of other windows. Set it to 999 to make the current window | |
| 9451 always fill the screen. Set it to a small number for normal editing. | |
| 9452 The width is not adjusted after one of the commands to change the | |
| 9453 width of the current window. | |
| 9454 'winwidth' applies to the current window. Use 'winminwidth' to set | |
| 9455 the minimal width for other windows. | |
| 9456 | |
| 9457 *'wrap'* *'nowrap'* | |
| 9458 'wrap' boolean (default on) | |
| 9459 local to window | |
| 9460 This option changes how text is displayed. It doesn't change the text | |
| 9461 in the buffer, see 'textwidth' for that. | |
| 9462 When on, lines longer than the width of the window will wrap and | |
| 10 | 9463 displaying continues on the next line. When off lines will not wrap |
| 9464 and only part of long lines will be displayed. When the cursor is | |
| 7 | 9465 moved to a part that is not shown, the screen will scroll |
| 9466 horizontally. | |
| 9467 The line will be broken in the middle of a word if necessary. See | |
| 9468 'linebreak' to get the break at a word boundary. | |
| 9469 To make scrolling horizontally a bit more useful, try this: > | |
| 9470 :set sidescroll=5 | |
| 9471 :set listchars+=precedes:<,extends:> | |
| 9472 < See 'sidescroll', 'listchars' and |wrap-off|. | |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
9473 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
|
9474 on. |
| 7 | 9475 |
| 9476 *'wrapmargin'* *'wm'* | |
| 9477 'wrapmargin' 'wm' number (default 0) | |
| 9478 local to buffer | |
| 9479 Number of characters from the right window border where wrapping | |
| 9480 starts. When typing text beyond this limit, an <EOL> will be inserted | |
| 9481 and inserting continues on the next line. | |
| 9482 Options that add a margin, such as 'number' and 'foldcolumn', cause | |
| 9483 the text width to be further reduced. This is Vi compatible. | |
| 9484 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
|
9485 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
|
9486 is reset. |
| 16610 | 9487 See also 'formatoptions' and |ins-textwidth|. |
| 7 | 9488 |
| 9489 *'wrapscan'* *'ws'* *'nowrapscan'* *'nows'* | |
| 9490 'wrapscan' 'ws' boolean (default on) *E384* *E385* | |
| 9491 global | |
| 500 | 9492 Searches wrap around the end of the file. Also applies to |]s| and |
| 9493 |[s|, searching for spelling mistakes. | |
| 7 | 9494 |
| 9495 *'write'* *'nowrite'* | |
| 9496 'write' boolean (default on) | |
| 9497 global | |
| 9498 Allows writing files. When not set, writing a file is not allowed. | |
| 9499 Can be used for a view-only mode, where modifications to the text are | |
| 10 | 9500 still allowed. Can be reset with the |-m| or |-M| command line |
| 7 | 9501 argument. Filtering text is still possible, even though this requires |
| 9502 writing a temporary file. | |
| 9503 | |
| 9504 *'writeany'* *'wa'* *'nowriteany'* *'nowa'* | |
| 9505 'writeany' 'wa' boolean (default off) | |
| 9506 global | |
| 9507 Allows writing to any file with no need for "!" override. | |
| 9508 | |
| 9509 *'writebackup'* *'wb'* *'nowritebackup'* *'nowb'* | |
| 9510 'writebackup' 'wb' boolean (default on with |+writebackup| feature, off | |
| 9511 otherwise) | |
| 9512 global | |
| 9513 Make a backup before overwriting a file. The backup is removed after | |
| 9514 the file was successfully written, unless the 'backup' option is | |
| 3513 | 9515 also on. |
| 9516 WARNING: Switching this option off means that when Vim fails to write | |
| 9517 your buffer correctly and then, for whatever reason, Vim exits, you | |
| 9518 lose both the original file and what you were writing. Only reset | |
| 9519 this option if your file system is almost full and it makes the write | |
| 9520 fail (and make sure not to exit Vim until the write was successful). | |
| 9521 See |backup-table| for another explanation. | |
| 7 | 9522 When the 'backupskip' pattern matches, a backup is not made anyway. |
| 18719 | 9523 Depending on 'backupcopy' the backup is a new file or the original |
| 9524 file renamed (and a new file is written). | |
| 7 | 9525 NOTE: This option is set to the default value when 'compatible' is |
| 9526 set. | |
| 9527 | |
| 9528 *'writedelay'* *'wd'* | |
| 9529 'writedelay' 'wd' number (default 0) | |
| 9530 global | |
|
9344
33c1b85d408c
commit https://github.com/vim/vim/commit/802a0d902fca423acb15f835d7b09183883d79a0
Christian Brabandt <cb@256bit.org>
parents:
9286
diff
changeset
|
9531 The number of milliseconds to wait for each character sent to the |
| 7 | 9532 screen. When non-zero, characters are sent to the terminal one by |
| 18972 | 9533 one. For debugging purposes. |
| 7 | 9534 |
|
26670
a77b661439f9
patch 8.2.3864: cannot disable requesting key codes from xterm
Bram Moolenaar <Bram@vim.org>
parents:
26508
diff
changeset
|
9535 *'xtermcodes'* *'noxtermcodes'* |
|
a77b661439f9
patch 8.2.3864: cannot disable requesting key codes from xterm
Bram Moolenaar <Bram@vim.org>
parents:
26508
diff
changeset
|
9536 '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
|
9537 global |
|
a77b661439f9
patch 8.2.3864: cannot disable requesting key codes from xterm
Bram Moolenaar <Bram@vim.org>
parents:
26508
diff
changeset
|
9538 When detecting xterm patchlevel 141 or higher with the termresponse |
| 26708 | 9539 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
|
9540 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
|
9541 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
|
9542 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
|
9543 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
|
9544 display. |
|
a77b661439f9
patch 8.2.3864: cannot disable requesting key codes from xterm
Bram Moolenaar <Bram@vim.org>
parents:
26508
diff
changeset
|
9545 |
|
a77b661439f9
patch 8.2.3864: cannot disable requesting key codes from xterm
Bram Moolenaar <Bram@vim.org>
parents:
26508
diff
changeset
|
9546 |
| 14421 | 9547 vim:tw=78:ts=8:noet:ft=help:norl: |