Mercurial > vim
annotate runtime/doc/options.txt @ 28763:b01bca69b1d5 v8.2.4906
patch 8.2.4906: MS-Windows: cannot use transparent background
Commit: https://github.com/vim/vim/commit/aa04e1b0be343ff606e25a48d59bc057edcc6e87
Author: Yasuhiro Matsumoto <mattn.jp@gmail.com>
Date: Sat May 7 14:09:19 2022 +0100
patch 8.2.4906: MS-Windows: cannot use transparent background
Problem: MS-Windows: cannot use transparent background.
Solution: Make transparent background work with 'termguicolors' and NONE
background color. (Yasuhiro Matsumoto, closes #10310, closes #7162)
| author | Bram Moolenaar <Bram@vim.org> |
|---|---|
| date | Sat, 07 May 2022 15:15:03 +0200 |
| parents | 2bd5cb054180 |
| children | b96ceb97e896 |
| rev | line source |
|---|---|
| 28517 | 1 *options.txt* For Vim version 8.2. Last change: 2022 Apr 13 |
| 7 | 2 |
| 3 | |
| 4 VIM REFERENCE MANUAL by Bram Moolenaar | |
| 5 | |
| 6 | |
| 7 Options *options* | |
| 8 | |
| 9 1. Setting options |set-option| | |
| 10 2. Automatically setting options |auto-setting| | |
| 11 3. Options summary |option-summary| | |
| 12 | |
|
10244
876fbdd84e52
commit https://github.com/vim/vim/commit/2ec618c9feac4573b154510236ad8121c77d0eca
Christian Brabandt <cb@256bit.org>
parents:
10218
diff
changeset
|
13 For an overview of options see quickref.txt |option-list|. |
| 7 | 14 |
| 15 Vim has a number of internal variables and switches which can be set to | |
| 16 achieve special effects. These options come in three forms: | |
| 17 boolean can only be on or off *boolean* *toggle* | |
| 18 number has a numeric value | |
| 19 string has a string value | |
| 20 | |
| 21 ============================================================================== | |
| 523 | 22 1. Setting options *set-option* *E764* |
| 7 | 23 |
| 24 *:se* *:set* | |
|
19137
69f0e9b5c107
patch 8.2.0128: cannot list options one per line
Bram Moolenaar <Bram@vim.org>
parents:
19116
diff
changeset
|
25 :se[t][!] Show all options that differ from their default value. |
|
69f0e9b5c107
patch 8.2.0128: cannot list options one per line
Bram Moolenaar <Bram@vim.org>
parents:
19116
diff
changeset
|
26 When [!] is present every option is on a separate |
|
69f0e9b5c107
patch 8.2.0128: cannot list options one per line
Bram Moolenaar <Bram@vim.org>
parents:
19116
diff
changeset
|
27 line. |
|
69f0e9b5c107
patch 8.2.0128: cannot list options one per line
Bram Moolenaar <Bram@vim.org>
parents:
19116
diff
changeset
|
28 |
|
69f0e9b5c107
patch 8.2.0128: cannot list options one per line
Bram Moolenaar <Bram@vim.org>
parents:
19116
diff
changeset
|
29 :se[t][!] all Show all but terminal options. |
|
69f0e9b5c107
patch 8.2.0128: cannot list options one per line
Bram Moolenaar <Bram@vim.org>
parents:
19116
diff
changeset
|
30 When [!] is present every option is on a separate |
|
69f0e9b5c107
patch 8.2.0128: cannot list options one per line
Bram Moolenaar <Bram@vim.org>
parents:
19116
diff
changeset
|
31 line. |
| 7 | 32 |
| 33 :se[t] termcap Show all terminal options. Note that in the GUI the | |
| 34 key codes are not shown, because they are generated | |
| 35 internally and can't be changed. Changing the terminal | |
| 36 codes in the GUI is not useful either... | |
| 37 | |
| 26438 | 38 :se[t]! termcap Idem, but don't use multiple columns. |
| 39 | |
| 7 | 40 *E518* *E519* |
| 41 :se[t] {option}? Show value of {option}. | |
| 42 | |
| 43 :se[t] {option} Toggle option: set, switch it on. | |
| 44 Number option: show value. | |
| 45 String option: show value. | |
| 46 | |
| 47 :se[t] no{option} Toggle option: Reset, switch it off. | |
| 48 | |
| 2152 | 49 *:set-!* *:set-inv* |
| 7 | 50 :se[t] {option}! or |
|
16443
32a543152dc0
patch 8.1.1226: {not in Vi} remarks get in the way of useful help text
Bram Moolenaar <Bram@vim.org>
parents:
16439
diff
changeset
|
51 :se[t] inv{option} Toggle option: Invert value. |
| 7 | 52 |
| 53 *:set-default* *:set-&* *:set-&vi* *:set-&vim* | |
| 54 :se[t] {option}& Reset option to its default value. May depend on the | |
|
16443
32a543152dc0
patch 8.1.1226: {not in Vi} remarks get in the way of useful help text
Bram Moolenaar <Bram@vim.org>
parents:
16439
diff
changeset
|
55 current value of 'compatible'. |
|
32a543152dc0
patch 8.1.1226: {not in Vi} remarks get in the way of useful help text
Bram Moolenaar <Bram@vim.org>
parents:
16439
diff
changeset
|
56 :se[t] {option}&vi Reset option to its Vi default value. |
|
32a543152dc0
patch 8.1.1226: {not in Vi} remarks get in the way of useful help text
Bram Moolenaar <Bram@vim.org>
parents:
16439
diff
changeset
|
57 :se[t] {option}&vim Reset option to its Vim default value. |
| 7 | 58 |
|
13341
acd7eaa13d2b
Updated runtime files.
Christian Brabandt <cb@256bit.org>
parents:
13314
diff
changeset
|
59 :se[t] all& Set all options to their default value. The values of |
|
7051
eff26a8620ce
commit https://github.com/vim/vim/commit/88774fdd23f08355297bb8cda78856859051d3c7
Christian Brabandt <cb@256bit.org>
parents:
6949
diff
changeset
|
60 these options are not changed: |
|
eff26a8620ce
commit https://github.com/vim/vim/commit/88774fdd23f08355297bb8cda78856859051d3c7
Christian Brabandt <cb@256bit.org>
parents:
6949
diff
changeset
|
61 all terminal options, starting with t_ |
|
eff26a8620ce
commit https://github.com/vim/vim/commit/88774fdd23f08355297bb8cda78856859051d3c7
Christian Brabandt <cb@256bit.org>
parents:
6949
diff
changeset
|
62 'columns' |
|
eff26a8620ce
commit https://github.com/vim/vim/commit/88774fdd23f08355297bb8cda78856859051d3c7
Christian Brabandt <cb@256bit.org>
parents:
6949
diff
changeset
|
63 'cryptmethod' |
|
eff26a8620ce
commit https://github.com/vim/vim/commit/88774fdd23f08355297bb8cda78856859051d3c7
Christian Brabandt <cb@256bit.org>
parents:
6949
diff
changeset
|
64 'encoding' |
|
eff26a8620ce
commit https://github.com/vim/vim/commit/88774fdd23f08355297bb8cda78856859051d3c7
Christian Brabandt <cb@256bit.org>
parents:
6949
diff
changeset
|
65 'key' |
|
eff26a8620ce
commit https://github.com/vim/vim/commit/88774fdd23f08355297bb8cda78856859051d3c7
Christian Brabandt <cb@256bit.org>
parents:
6949
diff
changeset
|
66 'lines' |
|
eff26a8620ce
commit https://github.com/vim/vim/commit/88774fdd23f08355297bb8cda78856859051d3c7
Christian Brabandt <cb@256bit.org>
parents:
6949
diff
changeset
|
67 'term' |
|
eff26a8620ce
commit https://github.com/vim/vim/commit/88774fdd23f08355297bb8cda78856859051d3c7
Christian Brabandt <cb@256bit.org>
parents:
6949
diff
changeset
|
68 'ttymouse' |
|
eff26a8620ce
commit https://github.com/vim/vim/commit/88774fdd23f08355297bb8cda78856859051d3c7
Christian Brabandt <cb@256bit.org>
parents:
6949
diff
changeset
|
69 'ttytype' |
|
eff26a8620ce
commit https://github.com/vim/vim/commit/88774fdd23f08355297bb8cda78856859051d3c7
Christian Brabandt <cb@256bit.org>
parents:
6949
diff
changeset
|
70 Warning: This may have a lot of side effects. |
| 7 | 71 |
| 72 *:set-args* *E487* *E521* | |
| 73 :se[t] {option}={value} or | |
| 74 :se[t] {option}:{value} | |
| 75 Set string or number option to {value}. | |
| 76 For numeric options the value can be given in decimal, | |
|
8629
54ac275e3fc4
commit https://github.com/vim/vim/commit/3848e00e0177abdb31bc600234967863ec487233
Christian Brabandt <cb@256bit.org>
parents:
8560
diff
changeset
|
77 hex (preceded with 0x) or octal (preceded with '0'). |
| 7 | 78 The old value can be inserted by typing 'wildchar' (by |
| 79 default this is a <Tab> or CTRL-E if 'compatible' is | |
| 80 set). See |cmdline-completion|. | |
| 81 White space between {option} and '=' is allowed and | |
| 82 will be ignored. White space between '=' and {value} | |
| 83 is not allowed. | |
| 84 See |option-backslash| for using white space and | |
| 85 backslashes in {value}. | |
| 86 | |
| 87 :se[t] {option}+={value} *:set+=* | |
| 88 Add the {value} to a number option, or append the | |
| 89 {value} to a string option. When the option is a | |
| 28379 | 90 comma-separated list, a comma is added, unless the |
| 7 | 91 value was empty. |
| 92 If the option is a list of flags, superfluous flags | |
| 557 | 93 are removed. When adding a flag that was already |
| 94 present the option value doesn't change. | |
| 809 | 95 Also see |:set-args| above. |
| 7 | 96 |
| 97 :se[t] {option}^={value} *:set^=* | |
| 98 Multiply the {value} to a number option, or prepend | |
| 99 the {value} to a string option. When the option is a | |
| 28379 | 100 comma-separated list, a comma is added, unless the |
| 7 | 101 value was empty. |
| 102 Also see |:set-args| above. | |
| 103 | |
| 104 :se[t] {option}-={value} *:set-=* | |
| 105 Subtract the {value} from a number option, or remove | |
| 106 the {value} from a string option, if it is there. | |
| 107 If the {value} is not found in a string option, there | |
| 108 is no error or warning. When the option is a comma | |
| 109 separated list, a comma is deleted, unless the option | |
| 110 becomes empty. | |
| 111 When the option is a list of flags, {value} must be | |
| 112 exactly as they appear in the option. Remove flags | |
| 113 one by one to avoid problems. | |
| 114 Also see |:set-args| above. | |
| 115 | |
| 116 The {option} arguments to ":set" may be repeated. For example: > | |
| 117 :set ai nosi sw=3 ts=3 | |
| 118 If you make an error in one of the arguments, an error message will be given | |
| 119 and the following arguments will be ignored. | |
| 120 | |
| 121 *:set-verbose* | |
| 122 When 'verbose' is non-zero, displaying an option value will also tell where it | |
| 123 was last set. Example: > | |
| 124 :verbose set shiftwidth cindent? | |
| 14864 | 125 < shiftwidth=4 ~ |
| 126 Last set from modeline line 1 ~ | |
| 127 cindent ~ | |
| 128 Last set from /usr/local/share/vim/vim60/ftplugin/c.vim line 30 ~ | |
| 1621 | 129 This is only done when specific option values are requested, not for ":verbose |
| 130 set all" or ":verbose set" without an argument. | |
| 131 When the option was set by hand there is no "Last set" message. | |
| 7 | 132 When the option was set while executing a function, user command or |
| 133 autocommand, the script in which it was defined is reported. | |
| 134 Note that an option may also have been set as a side effect of setting | |
| 135 'compatible'. | |
| 1621 | 136 A few special texts: |
| 14864 | 137 Last set from modeline line 1 ~ |
| 1621 | 138 Option was set in a |modeline|. |
| 139 Last set from --cmd argument ~ | |
| 140 Option was set with command line argument |--cmd| or +. | |
| 141 Last set from -c argument ~ | |
| 142 Option was set with command line argument |-c|, +, |-S| or | |
| 143 |-q|. | |
| 144 Last set from environment variable ~ | |
| 145 Option was set from an environment variable, $VIMINIT, | |
| 146 $GVIMINIT or $EXINIT. | |
| 147 Last set from error handler ~ | |
| 148 Option was cleared when evaluating it resulted in an error. | |
| 149 | |
|
2570
71b56b4e7785
Make the references to features in the help more consistent. (Sylvain Hitier)
Bram Moolenaar <bram@vim.org>
parents:
2561
diff
changeset
|
150 {not available when compiled without the |+eval| feature} |
| 7 | 151 |
| 152 *:set-termcap* *E522* | |
| 667 | 153 For {option} the form "t_xx" may be used to set a terminal option. This will |
| 7 | 154 override the value from the termcap. You can then use it in a mapping. If |
| 155 the "xx" part contains special characters, use the <t_xx> form: > | |
| 156 :set <t_#4>=^[Ot | |
| 157 This can also be used to translate a special code for a normal key. For | |
| 158 example, if Alt-b produces <Esc>b, use this: > | |
| 159 :set <M-b>=^[b | |
| 160 (the ^[ is a real <Esc> here, use CTRL-V <Esc> to enter it) | |
| 161 The advantage over a mapping is that it works in all situations. | |
| 162 | |
| 2726 | 163 You can define any key codes, e.g.: > |
| 164 :set t_xy=^[foo; | |
| 165 There is no warning for using a name that isn't recognized. You can map these | |
| 166 codes as you like: > | |
| 167 :map <t_xy> something | |
| 168 < *E846* | |
| 169 When a key code is not set, it's like it does not exist. Trying to get its | |
| 170 value will result in an error: > | |
| 171 :set t_kb= | |
| 172 :set t_kb | |
| 27321 | 173 < E846: Key code not set: t_kb ~ |
| 2726 | 174 |
| 36 | 175 The t_xx options cannot be set from a |modeline| or in the |sandbox|, for |
| 176 security reasons. | |
| 177 | |
| 7 | 178 The listing from ":set" looks different from Vi. Long string options are put |
| 10 | 179 at the end of the list. The number of options is quite large. The output of |
| 7 | 180 "set all" probably does not fit on the screen, causing Vim to give the |
| 181 |more-prompt|. | |
| 182 | |
| 183 *option-backslash* | |
| 184 To include white space in a string option value it has to be preceded with a | |
| 185 backslash. To include a backslash you have to use two. Effectively this | |
| 186 means that the number of backslashes in an option value is halved (rounded | |
| 187 down). | |
| 188 A few examples: > | |
| 189 :set tags=tags\ /usr/tags results in "tags /usr/tags" | |
| 190 :set tags=tags\\,file results in "tags\,file" | |
| 191 :set tags=tags\\\ file results in "tags\ file" | |
| 192 | |
| 10 | 193 The "|" character separates a ":set" command from a following command. To |
| 194 include the "|" in the option value, use "\|" instead. This example sets the | |
| 7 | 195 'titlestring' option to "hi|there": > |
| 196 :set titlestring=hi\|there | |
| 197 This sets the 'titlestring' option to "hi" and 'iconstring' to "there": > | |
| 198 :set titlestring=hi|set iconstring=there | |
| 199 | |
| 25700 | 200 Similarly, in legacy script the double quote character starts a comment. To |
| 201 include the '"' in the option value, use '\"' instead. This example sets the | |
| 202 'titlestring' option to 'hi "there"': > | |
| 642 | 203 :set titlestring=hi\ \"there\" |
| 204 | |
| 25700 | 205 In |Vim9| script it's simpler, comments start with a '#' character, and only |
| 206 when preceded by white space. A backslash is needed less often: > | |
| 207 vim9script | |
| 208 set titlestring=hi\ "there" | |
| 209 set titlestring=hi#there# | |
| 210 set titlestring=hi\ \#there# | |
| 211 | |
| 18972 | 212 For Win32 backslashes in file names are mostly not removed. More precise: For |
| 213 options that expect a file name (those where environment variables are | |
| 214 expanded) a backslash before a normal file name character is not removed. But | |
| 215 a backslash before a special character (space, backslash, comma, etc.) is used | |
| 216 like explained above. | |
| 7 | 217 There is one special situation, when the value starts with "\\": > |
| 218 :set dir=\\machine\path results in "\\machine\path" | |
| 219 :set dir=\\\\machine\\path results in "\\machine\path" | |
| 220 :set dir=\\path\\file results in "\\path\file" (wrong!) | |
| 221 For the first one the start is kept, but for the second one the backslashes | |
| 222 are halved. This makes sure it works both when you expect backslashes to be | |
| 10 | 223 halved and when you expect the backslashes to be kept. The third gives a |
| 7 | 224 result which is probably not what you want. Avoid it. |
| 225 | |
| 226 *add-option-flags* *remove-option-flags* | |
| 227 *E539* *E550* *E551* *E552* | |
| 228 Some options are a list of flags. When you want to add a flag to such an | |
| 229 option, without changing the existing ones, you can do it like this: > | |
| 230 :set guioptions+=a | |
| 231 Remove a flag from an option like this: > | |
| 232 :set guioptions-=a | |
| 233 This removes the 'a' flag from 'guioptions'. | |
| 10 | 234 Note that you should add or remove one flag at a time. If 'guioptions' has |
| 7 | 235 the value "ab", using "set guioptions-=ba" won't work, because the string "ba" |
| 236 doesn't appear. | |
| 237 | |
| 238 *:set_env* *expand-env* *expand-environment-var* | |
| 22 | 239 Environment variables in specific string options will be expanded. If the |
| 7 | 240 environment variable exists the '$' and the following environment variable |
| 241 name is replaced with its value. If it does not exist the '$' and the name | |
| 242 are not modified. Any non-id character (not a letter, digit or '_') may | |
| 243 follow the environment variable name. That character and what follows is | |
| 244 appended to the value of the environment variable. Examples: > | |
| 245 :set term=$TERM.new | |
| 246 :set path=/usr/$INCLUDE,$HOME/include,. | |
| 247 When adding or removing a string from an option with ":set opt-=val" or ":set | |
| 248 opt+=val" the expansion is done before the adding or removing. | |
| 249 | |
| 250 | |
| 251 Handling of local options *local-options* | |
| 252 | |
| 253 Some of the options only apply to a window or buffer. Each window or buffer | |
|
10449
222b1432814e
commit https://github.com/vim/vim/commit/5162822914372fc916a93f85848c0c82209e7cec
Christian Brabandt <cb@256bit.org>
parents:
10272
diff
changeset
|
254 has its own copy of this option, thus each can have its own value. This |
| 7 | 255 allows you to set 'list' in one window but not in another. And set |
| 256 'shiftwidth' to 3 in one buffer and 4 in another. | |
| 257 | |
| 258 The following explains what happens to these local options in specific | |
| 259 situations. You don't really need to know all of this, since Vim mostly uses | |
| 260 the option values you would expect. Unfortunately, doing what the user | |
| 261 expects is a bit complicated... | |
| 262 | |
| 263 When splitting a window, the local options are copied to the new window. Thus | |
| 264 right after the split the contents of the two windows look the same. | |
| 265 | |
| 266 When editing a new buffer, its local option values must be initialized. Since | |
| 267 the local options of the current buffer might be specifically for that buffer, | |
| 268 these are not used. Instead, for each buffer-local option there also is a | |
| 269 global value, which is used for new buffers. With ":set" both the local and | |
| 270 global value is changed. With "setlocal" only the local value is changed, | |
| 271 thus this value is not used when editing a new buffer. | |
| 272 | |
|
9852
4eea48b76d03
commit https://github.com/vim/vim/commit/95ec9d6a6ab3117d60ff638670a803d43974ba51
Christian Brabandt <cb@256bit.org>
parents:
9737
diff
changeset
|
273 When editing a buffer that has been edited before, the options from the window |
|
4eea48b76d03
commit https://github.com/vim/vim/commit/95ec9d6a6ab3117d60ff638670a803d43974ba51
Christian Brabandt <cb@256bit.org>
parents:
9737
diff
changeset
|
274 that was last closed are used again. If this buffer has been edited in this |
|
4eea48b76d03
commit https://github.com/vim/vim/commit/95ec9d6a6ab3117d60ff638670a803d43974ba51
Christian Brabandt <cb@256bit.org>
parents:
9737
diff
changeset
|
275 window, the values from back then are used. Otherwise the values from the |
|
4eea48b76d03
commit https://github.com/vim/vim/commit/95ec9d6a6ab3117d60ff638670a803d43974ba51
Christian Brabandt <cb@256bit.org>
parents:
9737
diff
changeset
|
276 last closed window where the buffer was edited last are used. |
| 7 | 277 |
| 278 It's possible to set a local window option specifically for a type of buffer. | |
| 279 When you edit another buffer in the same window, you don't want to keep | |
| 280 using these local window options. Therefore Vim keeps a global value of the | |
| 281 local window options, which is used when editing another buffer. Each window | |
| 282 has its own copy of these values. Thus these are local to the window, but | |
| 283 global to all buffers in the window. With this you can do: > | |
| 284 :e one | |
| 285 :set list | |
| 286 :e two | |
| 287 Now the 'list' option will also be set in "two", since with the ":set list" | |
| 288 command you have also set the global value. > | |
| 289 :set nolist | |
| 290 :e one | |
| 291 :setlocal list | |
| 292 :e two | |
| 293 Now the 'list' option is not set, because ":set nolist" resets the global | |
| 294 value, ":setlocal list" only changes the local value and ":e two" gets the | |
| 295 global value. Note that if you do this next: > | |
| 296 :e one | |
| 4358 | 297 You will get back the 'list' value as it was the last time you edited "one". |
| 298 The options local to a window are remembered for each buffer. This also | |
| 299 happens when the buffer is not loaded, but they are lost when the buffer is | |
| 300 wiped out |:bwipe|. | |
| 7 | 301 |
| 302 *:setl* *:setlocal* | |
|
19137
69f0e9b5c107
patch 8.2.0128: cannot list options one per line
Bram Moolenaar <Bram@vim.org>
parents:
19116
diff
changeset
|
303 :setl[ocal][!] ... Like ":set" but set only the value local to the |
| 7 | 304 current buffer or window. Not all options have a |
| 305 local value. If the option does not have a local | |
| 306 value the global value is set. | |
| 2413 | 307 With the "all" argument: display local values for all |
| 308 local options. | |
| 309 Without argument: Display local values for all local | |
| 310 options which are different from the default. | |
| 7 | 311 When displaying a specific local option, show the |
| 1621 | 312 local value. For a global/local boolean option, when |
| 313 the global value is being used, "--" is displayed | |
| 314 before the option name. | |
| 315 For a global option the global value is | |
| 7 | 316 shown (but that might change in the future). |
| 317 | |
| 809 | 318 :setl[ocal] {option}< Set the local value of {option} to its global value by |
| 319 copying the value. | |
| 320 | |
| 3281 | 321 :se[t] {option}< For |global-local| options: Remove the local value of |
| 322 {option}, so that the global value will be used. | |
| 7 | 323 |
| 324 *:setg* *:setglobal* | |
|
19137
69f0e9b5c107
patch 8.2.0128: cannot list options one per line
Bram Moolenaar <Bram@vim.org>
parents:
19116
diff
changeset
|
325 :setg[lobal][!] ... Like ":set" but set only the global value for a local |
| 7 | 326 option without changing the local value. |
| 327 When displaying an option, the global value is shown. | |
| 2413 | 328 With the "all" argument: display global values for all |
| 329 local options. | |
| 330 Without argument: display global values for all local | |
| 331 options which are different from the default. | |
| 7 | 332 |
| 333 For buffer-local and window-local options: | |
| 334 Command global value local value ~ | |
| 335 :set option=value set set | |
| 336 :setlocal option=value - set | |
| 337 :setglobal option=value set - | |
| 338 :set option? - display | |
| 339 :setlocal option? - display | |
| 340 :setglobal option? display - | |
| 341 | |
| 342 | |
| 343 Global options with a local value *global-local* | |
| 344 | |
| 40 | 345 Options are global when you mostly use one value for all buffers and windows. |
| 346 For some global options it's useful to sometimes have a different local value. | |
| 347 You can set the local value with ":setlocal". That buffer or window will then | |
| 348 use the local value, while other buffers and windows continue using the global | |
| 349 value. | |
| 7 | 350 |
| 351 For example, you have two windows, both on C source code. They use the global | |
| 352 'makeprg' option. If you do this in one of the two windows: > | |
| 353 :set makeprg=gmake | |
| 354 then the other window will switch to the same value. There is no need to set | |
| 355 the 'makeprg' option in the other C source window too. | |
| 356 However, if you start editing a Perl file in a new window, you want to use | |
| 1152 | 357 another 'makeprg' for it, without changing the value used for the C source |
| 10 | 358 files. You use this command: > |
| 7 | 359 :setlocal makeprg=perlmake |
| 360 You can switch back to using the global value by making the local value empty: > | |
| 361 :setlocal makeprg= | |
| 15729 | 362 This only works for a string option. For a number or boolean option you need |
| 363 to use the "<" flag, like this: > | |
| 7 | 364 :setlocal autoread< |
| 15729 | 365 Note that for non-boolean and non-number options using "<" copies the global |
| 366 value to the local value, it doesn't switch back to using the global value | |
| 367 (that matters when the global value changes later). You can also use: > | |
| 809 | 368 :set path< |
| 369 This will make the local value of 'path' empty, so that the global value is | |
| 370 used. Thus it does the same as: > | |
| 371 :setlocal path= | |
| 27036 | 372 Note: In the future more global options can be made |global-local|. Using |
| 7 | 373 ":setlocal" on a global option might work differently then. |
| 374 | |
| 375 | |
|
26175
6b4f017d7005
patch 8.2.3619: cannot use a lambda for 'operatorfunc'
Bram Moolenaar <Bram@vim.org>
parents:
26148
diff
changeset
|
376 *option-value-function* |
|
6b4f017d7005
patch 8.2.3619: cannot use a lambda for 'operatorfunc'
Bram Moolenaar <Bram@vim.org>
parents:
26148
diff
changeset
|
377 Some options ('completefunc', 'imactivatefunc', 'imstatusfunc', 'omnifunc', |
|
26388
8aba638e91eb
patch 8.2.3725: cannot use a lambda for 'completefunc' and 'omnifunc'
Bram Moolenaar <Bram@vim.org>
parents:
26362
diff
changeset
|
378 'operatorfunc', 'quickfixtextfunc', 'tagfunc' and 'thesaurusfunc') are set to |
|
26441
65ab0b035dd8
patch 8.2.3751: cannot assign a lambda to an option that takes a function
Bram Moolenaar <Bram@vim.org>
parents:
26438
diff
changeset
|
379 a function name or a function reference or a lambda function. When using a |
|
65ab0b035dd8
patch 8.2.3751: cannot assign a lambda to an option that takes a function
Bram Moolenaar <Bram@vim.org>
parents:
26438
diff
changeset
|
380 lambda it will be converted to the name, e.g. "<lambda>123". Examples: |
|
26175
6b4f017d7005
patch 8.2.3619: cannot use a lambda for 'operatorfunc'
Bram Moolenaar <Bram@vim.org>
parents:
26148
diff
changeset
|
381 > |
|
6b4f017d7005
patch 8.2.3619: cannot use a lambda for 'operatorfunc'
Bram Moolenaar <Bram@vim.org>
parents:
26148
diff
changeset
|
382 set opfunc=MyOpFunc |
|
26268
3aa48d4e3dc8
patch 8.2.3665: cannot use a lambda for 'tagfunc'
Bram Moolenaar <Bram@vim.org>
parents:
26219
diff
changeset
|
383 set opfunc=function('MyOpFunc') |
|
3aa48d4e3dc8
patch 8.2.3665: cannot use a lambda for 'tagfunc'
Bram Moolenaar <Bram@vim.org>
parents:
26219
diff
changeset
|
384 set opfunc=funcref('MyOpFunc') |
|
26362
dbe615b75f15
patch 8.2.3712: cannot use Vim9 lambda for 'tagfunc'
Bram Moolenaar <Bram@vim.org>
parents:
26336
diff
changeset
|
385 set opfunc={a\ ->\ MyOpFunc(a)} |
|
27780
f1d5822ca0d7
patch 8.2.4416: Vim9: using a script-local function requires using "s:"
Bram Moolenaar <Bram@vim.org>
parents:
27623
diff
changeset
|
386 |
|
f1d5822ca0d7
patch 8.2.4416: Vim9: using a script-local function requires using "s:"
Bram Moolenaar <Bram@vim.org>
parents:
27623
diff
changeset
|
387 Set to a script-local function: > |
|
f1d5822ca0d7
patch 8.2.4416: Vim9: using a script-local function requires using "s:"
Bram Moolenaar <Bram@vim.org>
parents:
27623
diff
changeset
|
388 set opfunc=s:MyLocalFunc |
|
f1d5822ca0d7
patch 8.2.4416: Vim9: using a script-local function requires using "s:"
Bram Moolenaar <Bram@vim.org>
parents:
27623
diff
changeset
|
389 set opfunc=<SID>MyLocalFunc |
|
f1d5822ca0d7
patch 8.2.4416: Vim9: using a script-local function requires using "s:"
Bram Moolenaar <Bram@vim.org>
parents:
27623
diff
changeset
|
390 In |Vim9| script the "s:" and "<SID>" can be omitted if the function exists in |
|
f1d5822ca0d7
patch 8.2.4416: Vim9: using a script-local function requires using "s:"
Bram Moolenaar <Bram@vim.org>
parents:
27623
diff
changeset
|
391 the script: > |
|
f1d5822ca0d7
patch 8.2.4416: Vim9: using a script-local function requires using "s:"
Bram Moolenaar <Bram@vim.org>
parents:
27623
diff
changeset
|
392 set opfunc=MyLocalFunc |
|
f1d5822ca0d7
patch 8.2.4416: Vim9: using a script-local function requires using "s:"
Bram Moolenaar <Bram@vim.org>
parents:
27623
diff
changeset
|
393 |
|
f1d5822ca0d7
patch 8.2.4416: Vim9: using a script-local function requires using "s:"
Bram Moolenaar <Bram@vim.org>
parents:
27623
diff
changeset
|
394 Set using a funcref variable: > |
|
26362
dbe615b75f15
patch 8.2.3712: cannot use Vim9 lambda for 'tagfunc'
Bram Moolenaar <Bram@vim.org>
parents:
26336
diff
changeset
|
395 let Fn = function('MyTagFunc') |
| 26708 | 396 let &tagfunc = Fn |
|
27780
f1d5822ca0d7
patch 8.2.4416: Vim9: using a script-local function requires using "s:"
Bram Moolenaar <Bram@vim.org>
parents:
27623
diff
changeset
|
397 |
|
f1d5822ca0d7
patch 8.2.4416: Vim9: using a script-local function requires using "s:"
Bram Moolenaar <Bram@vim.org>
parents:
27623
diff
changeset
|
398 Set using a lambda expression: > |
|
26441
65ab0b035dd8
patch 8.2.3751: cannot assign a lambda to an option that takes a function
Bram Moolenaar <Bram@vim.org>
parents:
26438
diff
changeset
|
399 let &tagfunc = {t -> MyTagFunc(t)} |
|
27780
f1d5822ca0d7
patch 8.2.4416: Vim9: using a script-local function requires using "s:"
Bram Moolenaar <Bram@vim.org>
parents:
27623
diff
changeset
|
400 |
|
f1d5822ca0d7
patch 8.2.4416: Vim9: using a script-local function requires using "s:"
Bram Moolenaar <Bram@vim.org>
parents:
27623
diff
changeset
|
401 Set using a variable with lambda expression: > |
|
26362
dbe615b75f15
patch 8.2.3712: cannot use Vim9 lambda for 'tagfunc'
Bram Moolenaar <Bram@vim.org>
parents:
26336
diff
changeset
|
402 let L = {a, b, c -> MyTagFunc(a, b , c)} |
|
26441
65ab0b035dd8
patch 8.2.3751: cannot assign a lambda to an option that takes a function
Bram Moolenaar <Bram@vim.org>
parents:
26438
diff
changeset
|
403 let &tagfunc = L |
|
26508
a0bc10e83cf8
patch 8.2.3784: the help for options is outdated
Bram Moolenaar <Bram@vim.org>
parents:
26441
diff
changeset
|
404 |
|
a0bc10e83cf8
patch 8.2.3784: the help for options is outdated
Bram Moolenaar <Bram@vim.org>
parents:
26441
diff
changeset
|
405 In Vim9 script, in a compiled function, you can use a lambda, but a |
|
a0bc10e83cf8
patch 8.2.3784: the help for options is outdated
Bram Moolenaar <Bram@vim.org>
parents:
26441
diff
changeset
|
406 closured does not work, because the function will be called without the |
|
a0bc10e83cf8
patch 8.2.3784: the help for options is outdated
Bram Moolenaar <Bram@vim.org>
parents:
26441
diff
changeset
|
407 context of where it was defined. |
|
a0bc10e83cf8
patch 8.2.3784: the help for options is outdated
Bram Moolenaar <Bram@vim.org>
parents:
26441
diff
changeset
|
408 |
|
26175
6b4f017d7005
patch 8.2.3619: cannot use a lambda for 'operatorfunc'
Bram Moolenaar <Bram@vim.org>
parents:
26148
diff
changeset
|
409 |
| 7 | 410 Setting the filetype |
| 411 | |
| 11473 | 412 :setf[iletype] [FALLBACK] {filetype} *:setf* *:setfiletype* |
| 7 | 413 Set the 'filetype' option to {filetype}, but only if |
| 414 not done yet in a sequence of (nested) autocommands. | |
| 415 This is short for: > | |
| 416 :if !did_filetype() | |
| 417 : setlocal filetype={filetype} | |
| 418 :endif | |
| 419 < This command is used in a filetype.vim file to avoid | |
| 420 setting the 'filetype' option twice, causing different | |
| 421 settings and syntax files to be loaded. | |
| 11473 | 422 |
| 423 When the optional FALLBACK argument is present, a | |
| 424 later :setfiletype command will override the | |
| 16023 | 425 'filetype'. This is to be used for filetype |
| 426 detections that are just a guess. |did_filetype()| | |
| 427 will return false after this command. | |
| 11473 | 428 |
|
2698
b6471224d2af
Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents:
2681
diff
changeset
|
429 *option-window* *optwin* |
| 7 | 430 :bro[wse] se[t] *:set-browse* *:browse-set* *:opt* *:options* |
| 431 :opt[ions] Open a window for viewing and setting all options. | |
| 432 Options are grouped by function. | |
| 433 Offers short help for each option. Hit <CR> on the | |
| 434 short help to open a help window with more help for | |
| 435 the option. | |
| 436 Modify the value of the option and hit <CR> on the | |
| 437 "set" line to set the new value. For window and | |
| 438 buffer specific options, the last accessed window is | |
| 439 used to set the option value in, unless this is a help | |
| 440 window, in which case the window below help window is | |
| 441 used (skipping the option-window). | |
| 13437 | 442 {not available when compiled without the |+eval| |
| 443 feature} | |
| 7 | 444 |
| 445 *$HOME* | |
| 446 Using "~" is like using "$HOME", but it is only recognized at the start of an | |
| 447 option and after a space or comma. | |
| 448 | |
| 449 On Unix systems "~user" can be used too. It is replaced by the home directory | |
| 450 of user "user". Example: > | |
| 451 :set path=~mool/include,/usr/include,. | |
| 452 | |
| 453 On Unix systems the form "${HOME}" can be used too. The name between {} can | |
| 454 contain non-id characters then. Note that if you want to use this for the | |
| 455 "gf" command, you need to add the '{' and '}' characters to 'isfname'. | |
| 456 | |
| 12254 | 457 NOTE: expanding environment variables and "~/" is only done with the ":set" |
| 458 command, not when assigning a value to an option with ":let". | |
| 459 | |
| 460 *$HOME-windows* | |
| 3224 | 461 On MS-Windows, if $HOME is not defined as an environment variable, then |
| 462 at runtime Vim will set it to the expansion of $HOMEDRIVE$HOMEPATH. | |
| 12499 | 463 If $HOMEDRIVE is not set then $USERPROFILE is used. |
| 464 | |
| 465 This expanded value is not exported to the environment, this matters when | |
| 466 running an external command: > | |
| 467 :echo system('set | findstr ^HOME=') | |
| 468 and > | |
| 469 :echo luaeval('os.getenv("HOME")') | |
| 470 should echo nothing (an empty string) despite exists('$HOME') being true. | |
| 471 When setting $HOME to a non-empty string it will be exported to the | |
| 472 subprocesses. | |
| 3224 | 473 |
| 7 | 474 |
| 475 Note the maximum length of an expanded option is limited. How much depends on | |
| 476 the system, mostly it is something like 256 or 1024 characters. | |
| 477 | |
| 478 *:fix* *:fixdel* | |
| 479 :fix[del] Set the value of 't_kD': | |
| 480 't_kb' is 't_kD' becomes ~ | |
| 481 CTRL-? CTRL-H | |
| 482 not CTRL-? CTRL-? | |
| 483 | |
| 23573 | 484 (CTRL-? is 0o177 octal, 0x7f hex) |
| 7 | 485 |
| 486 If your delete key terminal code is wrong, but the | |
| 487 code for backspace is alright, you can put this in | |
| 488 your .vimrc: > | |
| 489 :fixdel | |
| 490 < This works no matter what the actual code for | |
| 491 backspace is. | |
| 492 | |
| 493 If the backspace key terminal code is wrong you can | |
| 494 use this: > | |
| 495 :if &term == "termname" | |
| 496 : set t_kb=^V<BS> | |
| 497 : fixdel | |
| 498 :endif | |
| 499 < Where "^V" is CTRL-V and "<BS>" is the backspace key | |
| 10 | 500 (don't type four characters!). Replace "termname" |
| 7 | 501 with your terminal name. |
| 502 | |
| 503 If your <Delete> key sends a strange key sequence (not | |
| 504 CTRL-? or CTRL-H) you cannot use ":fixdel". Then use: > | |
| 505 :if &term == "termname" | |
| 506 : set t_kD=^V<Delete> | |
| 507 :endif | |
| 508 < Where "^V" is CTRL-V and "<Delete>" is the delete key | |
| 509 (don't type eight characters!). Replace "termname" | |
| 510 with your terminal name. | |
| 511 | |
| 512 *Linux-backspace* | |
| 513 Note about Linux: By default the backspace key | |
| 514 produces CTRL-?, which is wrong. You can fix it by | |
| 515 putting this line in your rc.local: > | |
| 516 echo "keycode 14 = BackSpace" | loadkeys | |
| 517 < | |
| 518 *NetBSD-backspace* | |
| 519 Note about NetBSD: If your backspace doesn't produce | |
| 520 the right code, try this: > | |
| 521 xmodmap -e "keycode 22 = BackSpace" | |
| 522 < If this works, add this in your .Xmodmap file: > | |
| 523 keysym 22 = BackSpace | |
| 524 < You need to restart for this to take effect. | |
| 525 | |
| 526 ============================================================================== | |
| 527 2. Automatically setting options *auto-setting* | |
| 528 | |
| 529 Besides changing options with the ":set" command, there are three alternatives | |
| 530 to set options automatically for one or more files: | |
| 531 | |
| 532 1. When starting Vim initializations are read from various places. See | |
| 533 |initialization|. Most of them are performed for all editing sessions, | |
| 534 and some of them depend on the directory where Vim is started. | |
| 535 You can create an initialization file with |:mkvimrc|, |:mkview| and | |
| 536 |:mksession|. | |
| 537 2. If you start editing a new file, the automatic commands are executed. | |
| 538 This can be used to set options for files matching a particular pattern and | |
| 539 many other things. See |autocommand|. | |
| 540 3. If you start editing a new file, and the 'modeline' option is on, a | |
| 541 number of lines at the beginning and end of the file are checked for | |
| 542 modelines. This is explained here. | |
| 543 | |
| 544 *modeline* *vim:* *vi:* *ex:* *E520* | |
| 545 There are two forms of modelines. The first form: | |
| 18831 | 546 [text{white}]{vi:|vim:|ex:}[white]{options} |
| 547 | |
| 548 [text{white}] empty or any text followed by at least one blank | |
| 549 character (<Space> or <Tab>); "ex:" always requires at | |
| 550 least one blank character | |
| 5055 | 551 {vi:|vim:|ex:} the string "vi:", "vim:" or "ex:" |
|
5024
7a2ffd685c0e
Update runtime files. Remove duplicate tags in help.
Bram Moolenaar <bram@vim.org>
parents:
5008
diff
changeset
|
552 [white] optional white space |
|
7a2ffd685c0e
Update runtime files. Remove duplicate tags in help.
Bram Moolenaar <bram@vim.org>
parents:
5008
diff
changeset
|
553 {options} a list of option settings, separated with white space |
|
7a2ffd685c0e
Update runtime files. Remove duplicate tags in help.
Bram Moolenaar <bram@vim.org>
parents:
5008
diff
changeset
|
554 or ':', where each part between ':' is the argument |
|
7a2ffd685c0e
Update runtime files. Remove duplicate tags in help.
Bram Moolenaar <bram@vim.org>
parents:
5008
diff
changeset
|
555 for a ":set" command (can be empty) |
| 7 | 556 |
| 5055 | 557 Examples: |
| 782 | 558 vi:noai:sw=3 ts=6 ~ |
| 5055 | 559 vim: tw=77 ~ |
| 7 | 560 |
| 561 The second form (this is compatible with some versions of Vi): | |
| 562 | |
| 19163 | 563 [text{white}]{vi:|vim:|Vim:|ex:}[white]se[t] {options}:[text] |
| 564 | |
| 565 [text{white}] empty or any text followed by at least one blank | |
| 566 character (<Space> or <Tab>); "ex:" always requires at | |
| 567 least one blank character | |
|
5024
7a2ffd685c0e
Update runtime files. Remove duplicate tags in help.
Bram Moolenaar <bram@vim.org>
parents:
5008
diff
changeset
|
568 {vi:|vim:|Vim:|ex:} the string "vi:", "vim:", "Vim:" or "ex:" |
|
7a2ffd685c0e
Update runtime files. Remove duplicate tags in help.
Bram Moolenaar <bram@vim.org>
parents:
5008
diff
changeset
|
569 [white] optional white space |
| 5055 | 570 se[t] the string "set " or "se " (note the space); When |
| 571 "Vim" is used it must be "set". | |
|
5024
7a2ffd685c0e
Update runtime files. Remove duplicate tags in help.
Bram Moolenaar <bram@vim.org>
parents:
5008
diff
changeset
|
572 {options} a list of options, separated with white space, which |
|
7a2ffd685c0e
Update runtime files. Remove duplicate tags in help.
Bram Moolenaar <bram@vim.org>
parents:
5008
diff
changeset
|
573 is the argument for a ":set" command |
|
7a2ffd685c0e
Update runtime files. Remove duplicate tags in help.
Bram Moolenaar <bram@vim.org>
parents:
5008
diff
changeset
|
574 : a colon |
|
7a2ffd685c0e
Update runtime files. Remove duplicate tags in help.
Bram Moolenaar <bram@vim.org>
parents:
5008
diff
changeset
|
575 [text] any text or empty |
| 7 | 576 |
| 5055 | 577 Examples: |
| 782 | 578 /* vim: set ai tw=75: */ ~ |
| 5055 | 579 /* Vim: set ai tw=75: */ ~ |
| 7 | 580 |
|
5024
7a2ffd685c0e
Update runtime files. Remove duplicate tags in help.
Bram Moolenaar <bram@vim.org>
parents:
5008
diff
changeset
|
581 The white space before {vi:|vim:|Vim:|ex:} is required. This minimizes the |
|
7a2ffd685c0e
Update runtime files. Remove duplicate tags in help.
Bram Moolenaar <bram@vim.org>
parents:
5008
diff
changeset
|
582 chance that a normal word like "lex:" is caught. There is one exception: |
|
7a2ffd685c0e
Update runtime files. Remove duplicate tags in help.
Bram Moolenaar <bram@vim.org>
parents:
5008
diff
changeset
|
583 "vi:" and "vim:" can also be at the start of the line (for compatibility with |
|
7a2ffd685c0e
Update runtime files. Remove duplicate tags in help.
Bram Moolenaar <bram@vim.org>
parents:
5008
diff
changeset
|
584 version 3.0). Using "ex:" at the start of the line will be ignored (this |
|
7a2ffd685c0e
Update runtime files. Remove duplicate tags in help.
Bram Moolenaar <bram@vim.org>
parents:
5008
diff
changeset
|
585 could be short for "example:"). |
| 7 | 586 |
|
25696
64fa341cc33b
patch 8.2.3384: cannot disable modeline for an individual file
Bram Moolenaar <Bram@vim.org>
parents:
25487
diff
changeset
|
587 If the modeline is disabled within a modeline, subsequent modelines will be |
|
64fa341cc33b
patch 8.2.3384: cannot disable modeline for an individual file
Bram Moolenaar <Bram@vim.org>
parents:
25487
diff
changeset
|
588 ignored. This is to allow turning off modeline on a per-file basis. This is |
|
64fa341cc33b
patch 8.2.3384: cannot disable modeline for an individual file
Bram Moolenaar <Bram@vim.org>
parents:
25487
diff
changeset
|
589 useful when a line looks like a modeline but isn't. For example, it would be |
|
64fa341cc33b
patch 8.2.3384: cannot disable modeline for an individual file
Bram Moolenaar <Bram@vim.org>
parents:
25487
diff
changeset
|
590 good to start a YAML file containing strings like "vim:" with |
|
64fa341cc33b
patch 8.2.3384: cannot disable modeline for an individual file
Bram Moolenaar <Bram@vim.org>
parents:
25487
diff
changeset
|
591 # vim: nomodeline ~ |
|
64fa341cc33b
patch 8.2.3384: cannot disable modeline for an individual file
Bram Moolenaar <Bram@vim.org>
parents:
25487
diff
changeset
|
592 so as to avoid modeline misdetection. Following options on the same line |
|
64fa341cc33b
patch 8.2.3384: cannot disable modeline for an individual file
Bram Moolenaar <Bram@vim.org>
parents:
25487
diff
changeset
|
593 after modeline deactivation, if any, are still evaluated (but you would |
|
64fa341cc33b
patch 8.2.3384: cannot disable modeline for an individual file
Bram Moolenaar <Bram@vim.org>
parents:
25487
diff
changeset
|
594 normally not have any). |
|
64fa341cc33b
patch 8.2.3384: cannot disable modeline for an individual file
Bram Moolenaar <Bram@vim.org>
parents:
25487
diff
changeset
|
595 |
| 7 | 596 *modeline-local* |
| 597 The options are set like with ":setlocal": The new value only applies to the | |
| 11 | 598 buffer and window that contain the file. Although it's possible to set global |
| 599 options from a modeline, this is unusual. If you have two windows open and | |
| 600 the files in it set the same global option to a different value, the result | |
| 601 depends on which one was opened last. | |
| 7 | 602 |
| 23 | 603 When editing a file that was already loaded, only the window-local options |
| 604 from the modeline are used. Thus if you manually changed a buffer-local | |
| 605 option after opening the file, it won't be changed if you edit the same buffer | |
| 606 in another window. But window-local options will be set. | |
| 607 | |
| 7 | 608 *modeline-version* |
| 609 If the modeline is only to be used for some versions of Vim, the version | |
|
5024
7a2ffd685c0e
Update runtime files. Remove duplicate tags in help.
Bram Moolenaar <bram@vim.org>
parents:
5008
diff
changeset
|
610 number can be specified where "vim:" or "Vim:" is used: |
| 7 | 611 vim{vers}: version {vers} or later |
| 612 vim<{vers}: version before {vers} | |
| 613 vim={vers}: version {vers} | |
| 614 vim>{vers}: version after {vers} | |
| 6647 | 615 {vers} is 700 for Vim 7.0 (hundred times the major version plus minor). |
| 616 For example, to use a modeline only for Vim 7.0: | |
| 617 /* vim700: set foldmethod=marker */ ~ | |
| 618 To use a modeline for Vim after version 7.2: | |
| 619 /* vim>702: set cole=2: */ ~ | |
| 7 | 620 There can be no blanks between "vim" and the ":". |
| 621 | |
| 622 | |
| 623 The number of lines that are checked can be set with the 'modelines' option. | |
| 624 If 'modeline' is off or 'modelines' is 0 no lines are checked. | |
| 625 | |
| 626 Note that for the first form all of the rest of the line is used, thus a line | |
| 782 | 627 like: |
| 628 /* vi:ts=4: */ ~ | |
| 629 will give an error message for the trailing "*/". This line is OK: | |
| 630 /* vi:set ts=4: */ ~ | |
| 7 | 631 |
| 632 If an error is detected the rest of the line is skipped. | |
| 633 | |
| 634 If you want to include a ':' in a set command precede it with a '\'. The | |
| 782 | 635 backslash in front of the ':' will be removed. Example: |
| 18928 | 636 /* vi:set fillchars=stl\:^,vert\:\|: */ ~ |
| 637 This sets the 'fillchars' option to "stl:^,vert:\|". Only a single backslash | |
| 638 before the ':' is removed. Thus to include "\:" you have to specify "\\:". | |
|
16728
e55c26aaf484
patch 8.1.1366: using expressions in a modeline is unsafe
Bram Moolenaar <Bram@vim.org>
parents:
16610
diff
changeset
|
639 *E992* |
| 7 | 640 No other commands than "set" are supported, for security reasons (somebody |
| 1111 | 641 might create a Trojan horse text file with modelines). And not all options |
|
16728
e55c26aaf484
patch 8.1.1366: using expressions in a modeline is unsafe
Bram Moolenaar <Bram@vim.org>
parents:
16610
diff
changeset
|
642 can be set. For some options a flag is set, so that when the value is used |
|
e55c26aaf484
patch 8.1.1366: using expressions in a modeline is unsafe
Bram Moolenaar <Bram@vim.org>
parents:
16610
diff
changeset
|
643 the |sandbox| is effective. Some options can only be set from the modeline |
|
e55c26aaf484
patch 8.1.1366: using expressions in a modeline is unsafe
Bram Moolenaar <Bram@vim.org>
parents:
16610
diff
changeset
|
644 when 'modelineexpr' is set (the default is off). |
|
e55c26aaf484
patch 8.1.1366: using expressions in a modeline is unsafe
Bram Moolenaar <Bram@vim.org>
parents:
16610
diff
changeset
|
645 |
|
e55c26aaf484
patch 8.1.1366: using expressions in a modeline is unsafe
Bram Moolenaar <Bram@vim.org>
parents:
16610
diff
changeset
|
646 Still, there is always a small risk that a modeline causes trouble. E.g., |
|
e55c26aaf484
patch 8.1.1366: using expressions in a modeline is unsafe
Bram Moolenaar <Bram@vim.org>
parents:
16610
diff
changeset
|
647 when some joker sets 'textwidth' to 5 all your lines are wrapped unexpectedly. |
|
e55c26aaf484
patch 8.1.1366: using expressions in a modeline is unsafe
Bram Moolenaar <Bram@vim.org>
parents:
16610
diff
changeset
|
648 So disable modelines before editing untrusted text. The mail ftplugin does |
|
e55c26aaf484
patch 8.1.1366: using expressions in a modeline is unsafe
Bram Moolenaar <Bram@vim.org>
parents:
16610
diff
changeset
|
649 this, for example. |
| 7 | 650 |
| 651 Hint: If you would like to do something else than setting an option, you could | |
| 652 define an autocommand that checks the file for a specific string. For | |
| 653 example: > | |
| 654 au BufReadPost * if getline(1) =~ "VAR" | call SetVar() | endif | |
| 655 And define a function SetVar() that does something with the line containing | |
| 656 "VAR". | |
| 657 | |
| 658 ============================================================================== | |
| 659 3. Options summary *option-summary* | |
| 660 | |
| 661 In the list below all the options are mentioned with their full name and with | |
| 662 an abbreviation if there is one. Both forms may be used. | |
| 663 | |
| 664 In this document when a boolean option is "set" that means that ":set option" | |
| 665 is entered. When an option is "reset", ":set nooption" is used. | |
| 666 | |
| 667 For some options there are two default values: The "Vim default", which is | |
| 668 used when 'compatible' is not set, and the "Vi default", which is used when | |
| 669 'compatible' is set. | |
| 670 | |
| 671 Most options are the same in all windows and buffers. There are a few that | |
| 10 | 672 are specific to how the text is presented in a window. These can be set to a |
| 7 | 673 different value in each window. For example the 'list' option can be set in |
| 674 one window and reset in another for the same text, giving both types of view | |
| 675 at the same time. There are a few options that are specific to a certain | |
| 676 file. These can have a different value for each file or buffer. For example | |
| 677 the 'textwidth' option can be 78 for a normal text file and 0 for a C | |
| 678 program. | |
| 679 | |
| 680 global one option for all buffers and windows | |
| 681 local to window each window has its own copy of this option | |
| 682 local to buffer each buffer has its own copy of this option | |
| 683 | |
| 684 When creating a new window the option values from the currently active window | |
| 685 are used as a default value for the window-specific options. For the | |
| 686 buffer-specific options this depends on the 's' and 'S' flags in the | |
| 687 'cpoptions' option. If 's' is included (which is the default) the values for | |
| 688 buffer options are copied from the currently active buffer when a buffer is | |
| 10 | 689 first entered. If 'S' is present the options are copied each time the buffer |
| 690 is entered, this is almost like having global options. If 's' and 'S' are not | |
| 7 | 691 present, the options are copied from the currently active buffer when the |
| 692 buffer is created. | |
| 693 | |
| 519 | 694 Hidden options *hidden-options* |
| 695 | |
| 696 Not all options are supported in all versions. This depends on the supported | |
| 697 features and sometimes on the system. A remark about this is in curly braces | |
| 698 below. When an option is not supported it may still be set without getting an | |
| 699 error, this is called a hidden option. You can't get the value of a hidden | |
| 700 option though, it is not stored. | |
| 701 | |
| 702 To test if option "foo" can be used with ":set" use something like this: > | |
| 703 if exists('&foo') | |
| 704 This also returns true for a hidden option. To test if option "foo" is really | |
| 705 supported use something like this: > | |
| 706 if exists('+foo') | |
| 707 < | |
| 7 | 708 *E355* |
| 709 A jump table for the options with a short description can be found at |Q_op|. | |
| 710 | |
| 711 *'aleph'* *'al'* *aleph* *Aleph* | |
| 18972 | 712 'aleph' 'al' number (default 128 for MS-Windows, 224 otherwise) |
| 7 | 713 global |
| 714 {only available when compiled with the |+rightleft| | |
| 715 feature} | |
| 716 The ASCII code for the first letter of the Hebrew alphabet. The | |
| 717 routine that maps the keyboard in Hebrew mode, both in Insert mode | |
| 718 (when hkmap is set) and on the command-line (when hitting CTRL-_) | |
| 719 outputs the Hebrew characters in the range [aleph..aleph+26]. | |
| 720 aleph=128 applies to PC code, and aleph=224 applies to ISO 8859-8. | |
| 721 See |rileft.txt|. | |
| 722 | |
| 723 *'allowrevins'* *'ari'* *'noallowrevins'* *'noari'* | |
| 724 'allowrevins' 'ari' boolean (default off) | |
| 725 global | |
| 726 {only available when compiled with the |+rightleft| | |
| 727 feature} | |
| 728 Allow CTRL-_ in Insert and Command-line mode. This is default off, to | |
| 729 avoid that users that accidentally type CTRL-_ instead of SHIFT-_ get | |
| 730 into reverse Insert mode, and don't know how to get out. See | |
| 731 'revins'. | |
| 732 NOTE: This option is reset when 'compatible' is set. | |
| 733 | |
| 734 *'altkeymap'* *'akm'* *'noaltkeymap'* *'noakm'* | |
| 735 'altkeymap' 'akm' boolean (default off) | |
| 736 global | |
| 737 {only available when compiled with the |+farsi| | |
| 738 feature} | |
|
15850
a6ca8cf07a98
patch 8.1.0932: Farsi support is outdated and unused
Bram Moolenaar <Bram@vim.org>
parents:
15840
diff
changeset
|
739 This option was for using Farsi, which has been removed. See |
|
a6ca8cf07a98
patch 8.1.0932: Farsi support is outdated and unused
Bram Moolenaar <Bram@vim.org>
parents:
15840
diff
changeset
|
740 |farsi.txt|. |
| 7 | 741 |
| 742 *'ambiwidth'* *'ambw'* | |
| 743 'ambiwidth' 'ambw' string (default: "single") | |
| 744 global | |
| 745 Only effective when 'encoding' is "utf-8" or another Unicode encoding. | |
| 746 Tells Vim what to do with characters with East Asian Width Class | |
| 747 Ambiguous (such as Euro, Registered Sign, Copyright Sign, Greek | |
| 748 letters, Cyrillic letters). | |
| 749 | |
| 750 There are currently two possible values: | |
| 233 | 751 "single": Use the same width as characters in US-ASCII. This is |
| 7 | 752 expected by most users. |
| 753 "double": Use twice the width of ASCII characters. | |
|
2492
c945fdb34ce3
Disallow setting 'ambiwidth' to "double" when 'listchars' or 'fillchars'
Bram Moolenaar <bram@vim.org>
parents:
2490
diff
changeset
|
754 *E834* *E835* |
|
c945fdb34ce3
Disallow setting 'ambiwidth' to "double" when 'listchars' or 'fillchars'
Bram Moolenaar <bram@vim.org>
parents:
2490
diff
changeset
|
755 The value "double" cannot be used if 'listchars' or 'fillchars' |
| 26050 | 756 contains a character that would be double width. These errors may |
| 757 also be given when calling setcellwidths(). | |
|
21971
0bc43a704f56
patch 8.2.1535: it is not possible to specify cell widths of characters
Bram Moolenaar <Bram@vim.org>
parents:
21825
diff
changeset
|
758 |
|
0bc43a704f56
patch 8.2.1535: it is not possible to specify cell widths of characters
Bram Moolenaar <Bram@vim.org>
parents:
21825
diff
changeset
|
759 The values are overruled for characters specified with |
|
0bc43a704f56
patch 8.2.1535: it is not possible to specify cell widths of characters
Bram Moolenaar <Bram@vim.org>
parents:
21825
diff
changeset
|
760 |setcellwidths()|. |
| 7 | 761 |
| 762 There are a number of CJK fonts for which the width of glyphs for | |
| 763 those characters are solely based on how many octets they take in | |
| 764 legacy/traditional CJK encodings. In those encodings, Euro, | |
| 765 Registered sign, Greek/Cyrillic letters are represented by two octets, | |
| 233 | 766 therefore those fonts have "wide" glyphs for them. This is also |
| 7 | 767 true of some line drawing characters used to make tables in text |
| 233 | 768 file. Therefore, when a CJK font is used for GUI Vim or |
| 7 | 769 Vim is running inside a terminal (emulators) that uses a CJK font |
| 770 (or Vim is run inside an xterm invoked with "-cjkwidth" option.), | |
| 771 this option should be set to "double" to match the width perceived | |
| 772 by Vim with the width of glyphs in the font. Perhaps it also has | |
| 19116 | 773 to be set to "double" under CJK MS-Windows when the system locale is |
| 774 set to one of CJK locales. See Unicode Standard Annex #11 | |
| 775 (http://www.unicode.org/reports/tr11). | |
| 7 | 776 |
| 4229 | 777 Vim may set this option automatically at startup time when Vim is |
| 778 compiled with the |+termresponse| feature and if |t_u7| is set to the | |
| 12499 | 779 escape sequence to request cursor position report. The response can |
| 780 be found in |v:termu7resp|. | |
| 4229 | 781 |
| 7 | 782 *'antialias'* *'anti'* *'noantialias'* *'noanti'* |
| 783 'antialias' 'anti' boolean (default: off) | |
| 784 global | |
| 785 {only available when compiled with GUI enabled | |
| 21825 | 786 on macOS} |
| 787 This option only has an effect in the GUI version of Vim on macOS | |
| 7 | 788 v10.2 or later. When on, Vim will use smooth ("antialiased") fonts, |
| 789 which can be easier to read at certain sizes on certain displays. | |
| 790 Setting this option can sometimes cause problems if 'guifont' is set | |
| 791 to its default (empty string). | |
| 11160 | 792 NOTE: This option is reset when 'compatible' is set. |
| 7 | 793 |
| 794 *'autochdir'* *'acd'* *'noautochdir'* *'noacd'* | |
| 795 'autochdir' 'acd' boolean (default off) | |
| 796 global | |
| 2152 | 797 {only available when compiled with it, use |
| 798 exists("+autochdir") to check} | |
| 438 | 799 When on, Vim will change the current working directory whenever you |
| 800 open a file, switch buffers, delete a buffer or open/close a window. | |
| 801 It will change to the directory containing the file which was opened | |
| 802 or selected. | |
| 819 | 803 Note: When this option is on some plugins may not work. |
| 7 | 804 |
|
24268
9257f3980f4a
patch 8.2.2675: directory change in a terminal window shell is not followed
Bram Moolenaar <Bram@vim.org>
parents:
24055
diff
changeset
|
805 *'autoshelldir'* *'asd'* *'noautoshelldir'* *'noasd'* |
|
9257f3980f4a
patch 8.2.2675: directory change in a terminal window shell is not followed
Bram Moolenaar <Bram@vim.org>
parents:
24055
diff
changeset
|
806 'autoshelldir' 'asd' boolean (default off) |
|
9257f3980f4a
patch 8.2.2675: directory change in a terminal window shell is not followed
Bram Moolenaar <Bram@vim.org>
parents:
24055
diff
changeset
|
807 global |
|
9257f3980f4a
patch 8.2.2675: directory change in a terminal window shell is not followed
Bram Moolenaar <Bram@vim.org>
parents:
24055
diff
changeset
|
808 When on, Vim will change the current working directory whenever you |
|
9257f3980f4a
patch 8.2.2675: directory change in a terminal window shell is not followed
Bram Moolenaar <Bram@vim.org>
parents:
24055
diff
changeset
|
809 change the directory of the shell running in a terminal window. You |
|
9257f3980f4a
patch 8.2.2675: directory change in a terminal window shell is not followed
Bram Moolenaar <Bram@vim.org>
parents:
24055
diff
changeset
|
810 need proper setting-up, so whenever the shell's pwd changes an OSC 7 |
|
9257f3980f4a
patch 8.2.2675: directory change in a terminal window shell is not followed
Bram Moolenaar <Bram@vim.org>
parents:
24055
diff
changeset
|
811 escape sequence will be emitted. For example, on Linux, you can source |
|
9257f3980f4a
patch 8.2.2675: directory change in a terminal window shell is not followed
Bram Moolenaar <Bram@vim.org>
parents:
24055
diff
changeset
|
812 /etc/profile.d/vte.sh in your shell profile if you use bash or zsh. |
| 27537 | 813 When the parsing of the OSC sequence fails you get *E1179* . |
|
24268
9257f3980f4a
patch 8.2.2675: directory change in a terminal window shell is not followed
Bram Moolenaar <Bram@vim.org>
parents:
24055
diff
changeset
|
814 |
| 7 | 815 *'arabic'* *'arab'* *'noarabic'* *'noarab'* |
| 816 'arabic' 'arab' boolean (default off) | |
| 817 local to window | |
| 818 {only available when compiled with the |+arabic| | |
| 819 feature} | |
| 820 This option can be set to start editing Arabic text. | |
| 821 Setting this option will: | |
| 822 - Set the 'rightleft' option, unless 'termbidi' is set. | |
| 823 - Set the 'arabicshape' option, unless 'termbidi' is set. | |
| 824 - Set the 'keymap' option to "arabic"; in Insert mode CTRL-^ toggles | |
| 825 between typing English and Arabic key mapping. | |
| 826 - Set the 'delcombine' option | |
| 827 Note that 'encoding' must be "utf-8" for working with Arabic text. | |
| 828 | |
| 829 Resetting this option will: | |
| 830 - Reset the 'rightleft' option. | |
| 831 - Disable the use of 'keymap' (without changing its value). | |
| 832 Note that 'arabicshape' and 'delcombine' are not reset (it is a global | |
| 3557 | 833 option). |
| 11160 | 834 NOTE: This option is reset when 'compatible' is set. |
| 7 | 835 Also see |arabic.txt|. |
| 836 | |
| 837 *'arabicshape'* *'arshape'* | |
| 838 *'noarabicshape'* *'noarshape'* | |
| 839 'arabicshape' 'arshape' boolean (default on) | |
| 840 global | |
| 841 {only available when compiled with the |+arabic| | |
| 842 feature} | |
| 843 When on and 'termbidi' is off, the required visual character | |
| 844 corrections that need to take place for displaying the Arabic language | |
| 3893 | 845 take effect. Shaping, in essence, gets enabled; the term is a broad |
| 7 | 846 one which encompasses: |
| 847 a) the changing/morphing of characters based on their location | |
| 848 within a word (initial, medial, final and stand-alone). | |
| 849 b) the enabling of the ability to compose characters | |
| 850 c) the enabling of the required combining of some characters | |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
851 When disabled the display shows each character's true stand-alone |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
852 form. |
| 7 | 853 Arabic is a complex language which requires other settings, for |
| 854 further details see |arabic.txt|. | |
| 11160 | 855 NOTE: This option is set when 'compatible' is set. |
| 7 | 856 |
| 857 *'autoindent'* *'ai'* *'noautoindent'* *'noai'* | |
| 858 'autoindent' 'ai' boolean (default off) | |
| 859 local to buffer | |
| 860 Copy indent from current line when starting a new line (typing <CR> | |
| 861 in Insert mode or when using the "o" or "O" command). If you do not | |
| 862 type anything on the new line except <BS> or CTRL-D and then type | |
| 1152 | 863 <Esc>, CTRL-O or <CR>, the indent is deleted again. Moving the cursor |
| 864 to another line has the same effect, unless the 'I' flag is included | |
| 865 in 'cpoptions'. | |
| 10 | 866 When autoindent is on, formatting (with the "gq" command or when you |
| 867 reach 'textwidth' in Insert mode) uses the indentation of the first | |
| 868 line. | |
| 7 | 869 When 'smartindent' or 'cindent' is on the indent is changed in |
| 870 a different way. | |
|
7147
c590de398af9
commit https://github.com/vim/vim/commit/ca63501fbcd1cf9c8aa9ff12c093c95b62a89ed7
Christian Brabandt <cb@256bit.org>
parents:
7080
diff
changeset
|
871 The 'autoindent' option is reset when the 'paste' option is set and |
|
c590de398af9
commit https://github.com/vim/vim/commit/ca63501fbcd1cf9c8aa9ff12c093c95b62a89ed7
Christian Brabandt <cb@256bit.org>
parents:
7080
diff
changeset
|
872 restored when 'paste' is reset. |
| 7 | 873 |
| 874 *'autoread'* *'ar'* *'noautoread'* *'noar'* | |
| 875 'autoread' 'ar' boolean (default off) | |
| 876 global or local to buffer |global-local| | |
| 877 When a file has been detected to have been changed outside of Vim and | |
| 878 it has not been changed inside of Vim, automatically read it again. | |
|
14298
4a588e3afd4a
Update runtime files, add Danish translations.
Christian Brabandt <cb@256bit.org>
parents:
14249
diff
changeset
|
879 When the file has been deleted this is not done, so you have the text |
|
4a588e3afd4a
Update runtime files, add Danish translations.
Christian Brabandt <cb@256bit.org>
parents:
14249
diff
changeset
|
880 from before it was deleted. When it appears again then it is read. |
|
4a588e3afd4a
Update runtime files, add Danish translations.
Christian Brabandt <cb@256bit.org>
parents:
14249
diff
changeset
|
881 |timestamp| |
| 7 | 882 If this option has a local value, use this command to switch back to |
| 883 using the global value: > | |
| 884 :set autoread< | |
| 885 < | |
| 886 *'autowrite'* *'aw'* *'noautowrite'* *'noaw'* | |
| 887 'autowrite' 'aw' boolean (default off) | |
| 888 global | |
| 889 Write the contents of the file, if it has been modified, on each | |
| 26438 | 890 `:next`, `:rewind`, `:last`, `:first`, `:previous`, `:stop`, |
| 27036 | 891 `:suspend`, `:tag`, `:!`, `:make`, CTRL-] and CTRL-^ command; and when |
| 892 a `:buffer`, CTRL-O, CTRL-I, '{A-Z0-9}, or `{A-Z0-9} command takes one | |
| 26438 | 893 to another file. |
| 894 A buffer is not written if it becomes hidden, e.g. when 'bufhidden' is | |
| 27036 | 895 set to "hide" and `:next` is used. |
| 7 | 896 Note that for some commands the 'autowrite' option is not used, see |
| 897 'autowriteall' for that. | |
| 14695 | 898 Some buffers will not be written, specifically when 'buftype' is |
| 14668 | 899 "nowrite", "nofile", "terminal" or "prompt". |
| 7 | 900 |
| 901 *'autowriteall'* *'awa'* *'noautowriteall'* *'noawa'* | |
| 902 'autowriteall' 'awa' boolean (default off) | |
| 903 global | |
| 904 Like 'autowrite', but also used for commands ":edit", ":enew", ":quit", | |
| 905 ":qall", ":exit", ":xit", ":recover" and closing the Vim window. | |
| 906 Setting this option also implies that Vim behaves like 'autowrite' has | |
| 907 been set. | |
| 908 | |
| 909 *'background'* *'bg'* | |
| 2826 | 910 'background' 'bg' string (default "dark" or "light", see below) |
| 7 | 911 global |
| 912 When set to "dark", Vim will try to use colors that look good on a | |
| 913 dark background. When set to "light", Vim will try to use colors that | |
| 914 look good on a light background. Any other value is illegal. | |
| 915 Vim tries to set the default value according to the terminal used. | |
| 916 This will not always be correct. | |
| 917 Setting this option does not change the background color, it tells Vim | |
| 918 what the background color looks like. For changing the background | |
| 919 color, see |:hi-normal|. | |
| 920 | |
| 921 When 'background' is set Vim will adjust the default color groups for | |
| 10 | 922 the new value. But the colors used for syntax highlighting will not |
| 1621 | 923 change. *g:colors_name* |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
924 When a color scheme is loaded (the "g:colors_name" variable is set) |
| 7 | 925 setting 'background' will cause the color scheme to be reloaded. If |
| 926 the color scheme adjusts to the value of 'background' this will work. | |
| 927 However, if the color scheme sets 'background' itself the effect may | |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
928 be undone. First delete the "g:colors_name" variable when needed. |
| 7 | 929 |
| 930 When setting 'background' to the default value with: > | |
| 931 :set background& | |
| 932 < Vim will guess the value. In the GUI this should work correctly, | |
| 933 in other cases Vim might not be able to guess the right value. | |
| 18343 | 934 If the GUI supports a dark theme, you can use the "d" flag in |
|
18078
5ae41d0ea397
patch 8.1.2034: dark them of GTK 3 not supported
Bram Moolenaar <Bram@vim.org>
parents:
18068
diff
changeset
|
935 'guioptions', see 'go-d'. |
| 7 | 936 |
| 12499 | 937 When the |t_RB| option is set, Vim will use it to request the background |
| 11442 | 938 color from the terminal. If the returned RGB value is dark/light and |
| 939 'background' is not dark/light, 'background' will be set and the | |
| 940 screen is redrawn. This may have side effects, make t_BG empty in | |
| 12499 | 941 your .vimrc if you suspect this problem. The response to |t_RB| can |
|
12756
3b26420fc639
Long overdue runtime update.
Christian Brabandt <cb@256bit.org>
parents:
12744
diff
changeset
|
942 be found in |v:termrbgresp|. |
| 11442 | 943 |
| 7 | 944 When starting the GUI, the default value for 'background' will be |
| 945 "light". When the value is not set in the .gvimrc, and Vim detects | |
| 946 that the background is actually quite dark, 'background' is set to | |
| 947 "dark". But this happens only AFTER the .gvimrc file has been read | |
| 948 (because the window needs to be opened to find the actual background | |
| 949 color). To get around this, force the GUI window to be opened by | |
| 950 putting a ":gui" command in the .gvimrc file, before where the value | |
| 951 of 'background' is used (e.g., before ":syntax on"). | |
| 2826 | 952 |
|
18912
ccd16426a1f9
patch 8.2.0017: OS/2 and MS-DOS are still mentioned
Bram Moolenaar <Bram@vim.org>
parents:
18879
diff
changeset
|
953 For MS-Windows the default is "dark". |
| 2826 | 954 For other systems "dark" is used when 'term' is "linux", |
| 955 "screen.linux", "cygwin" or "putty", or $COLORFGBG suggests a dark | |
| 956 background. Otherwise the default is "light". | |
| 957 | |
| 12254 | 958 The |:terminal| command and the |term_start()| function use the |
| 959 'background' value to decide whether the terminal window will start | |
| 960 with a white or black background. | |
| 961 | |
| 7 | 962 Normally this option would be set in the .vimrc file. Possibly |
| 963 depending on the terminal name. Example: > | |
| 964 :if &term == "pcterm" | |
| 965 : set background=dark | |
| 966 :endif | |
| 967 < When this option is set, the default settings for the highlight groups | |
| 968 will change. To use other settings, place ":highlight" commands AFTER | |
| 969 the setting of the 'background' option. | |
| 970 This option is also used in the "$VIMRUNTIME/syntax/syntax.vim" file | |
| 971 to select the colors for syntax highlighting. After changing this | |
| 972 option, you must load syntax.vim again to see the result. This can be | |
| 973 done with ":syntax on". | |
| 974 | |
| 975 *'backspace'* *'bs'* | |
|
9669
284b4eb307fc
commit https://github.com/vim/vim/commit/8c08b5b569e2a9e9f63dea514591ecfa2d3bb392
Christian Brabandt <cb@256bit.org>
parents:
9665
diff
changeset
|
976 'backspace' 'bs' string (default "", set to "indent,eol,start" |
|
284b4eb307fc
commit https://github.com/vim/vim/commit/8c08b5b569e2a9e9f63dea514591ecfa2d3bb392
Christian Brabandt <cb@256bit.org>
parents:
9665
diff
changeset
|
977 in |defaults.vim|) |
| 7 | 978 global |
| 979 Influences the working of <BS>, <Del>, CTRL-W and CTRL-U in Insert | |
| 980 mode. This is a list of items, separated by commas. Each item allows | |
| 981 a way to backspace over something: | |
| 982 value effect ~ | |
| 983 indent allow backspacing over autoindent | |
| 984 eol allow backspacing over line breaks (join lines) | |
| 985 start allow backspacing over the start of insert; CTRL-W and CTRL-U | |
| 986 stop once at the start of insert. | |
|
20069
9a67d41708d2
patch 8.2.0590: no 'backspace' value allows ignoring the insertion point
Bram Moolenaar <Bram@vim.org>
parents:
19968
diff
changeset
|
987 nostop like start, except CTRL-W and CTRL-U do not stop at the start of |
|
9a67d41708d2
patch 8.2.0590: no 'backspace' value allows ignoring the insertion point
Bram Moolenaar <Bram@vim.org>
parents:
19968
diff
changeset
|
988 insert. |
| 7 | 989 |
| 28246 | 990 When the value is empty, Vi compatible backspacing is used, none of |
| 991 the ways mentioned for the items above are possible. | |
| 7 | 992 |
| 993 For backwards compatibility with version 5.4 and earlier: | |
| 994 value effect ~ | |
| 995 0 same as ":set backspace=" (Vi compatible) | |
| 996 1 same as ":set backspace=indent,eol" | |
| 997 2 same as ":set backspace=indent,eol,start" | |
|
20069
9a67d41708d2
patch 8.2.0590: no 'backspace' value allows ignoring the insertion point
Bram Moolenaar <Bram@vim.org>
parents:
19968
diff
changeset
|
998 3 same as ":set backspace=indent,eol,nostop" |
| 7 | 999 |
| 1000 See |:fixdel| if your <BS> or <Del> key does not do what you want. | |
| 1001 NOTE: This option is set to "" when 'compatible' is set. | |
| 1002 | |
| 1003 *'backup'* *'bk'* *'nobackup'* *'nobk'* | |
| 1004 'backup' 'bk' boolean (default off) | |
| 1005 global | |
| 1006 Make a backup before overwriting a file. Leave it around after the | |
| 1007 file has been successfully written. If you do not want to keep the | |
| 1008 backup file, but you do want a backup while the file is being | |
| 1009 written, reset this option and set the 'writebackup' option (this is | |
| 1010 the default). If you do not want a backup file at all reset both | |
| 10 | 1011 options (use this if your file system is almost full). See the |
| 7 | 1012 |backup-table| for more explanations. |
| 1013 When the 'backupskip' pattern matches, a backup is not made anyway. | |
| 1014 When 'patchmode' is set, the backup may be renamed to become the | |
| 1015 oldest version of a file. | |
| 1016 NOTE: This option is reset when 'compatible' is set. | |
| 1017 | |
| 1018 *'backupcopy'* *'bkc'* | |
| 1019 'backupcopy' 'bkc' string (Vi default for Unix: "yes", otherwise: "auto") | |
| 6243 | 1020 global or local to buffer |global-local| |
| 7 | 1021 When writing a file and a backup is made, this option tells how it's |
| 28379 | 1022 done. This is a comma-separated list of words. |
| 7 | 1023 |
| 1024 The main values are: | |
| 1025 "yes" make a copy of the file and overwrite the original one | |
| 1026 "no" rename the file and write a new one | |
| 1027 "auto" one of the previous, what works best | |
| 1028 | |
| 1029 Extra values that can be combined with the ones above are: | |
| 1030 "breaksymlink" always break symlinks when writing | |
| 1031 "breakhardlink" always break hardlinks when writing | |
| 1032 | |
| 1033 Making a copy and overwriting the original file: | |
| 1034 - Takes extra time to copy the file. | |
| 1035 + When the file has special attributes, is a (hard/symbolic) link or | |
| 1036 has a resource fork, all this is preserved. | |
| 1037 - When the file is a link the backup will have the name of the link, | |
| 1038 not of the real file. | |
| 1039 | |
| 1040 Renaming the file and writing a new one: | |
| 1041 + It's fast. | |
| 1042 - Sometimes not all attributes of the file can be copied to the new | |
| 1043 file. | |
| 1044 - When the file is a link the new file will not be a link. | |
| 1045 | |
| 28379 | 1046 The "auto" value is the middle way: When Vim sees that renaming the |
| 1047 file is possible without side effects (the attributes can be passed on | |
| 1048 and the file is not a link) that is used. When problems are expected, | |
| 1049 a copy will be made. | |
| 7 | 1050 |
| 1051 The "breaksymlink" and "breakhardlink" values can be used in | |
| 1052 combination with any of "yes", "no" and "auto". When included, they | |
| 1053 force Vim to always break either symbolic or hard links by doing | |
| 1054 exactly what the "no" option does, renaming the original file to | |
| 1055 become the backup and writing a new file in its place. This can be | |
| 1056 useful for example in source trees where all the files are symbolic or | |
| 1057 hard links and any changes should stay in the local source tree, not | |
| 1058 be propagated back to the original source. | |
| 1059 *crontab* | |
| 1060 One situation where "no" and "auto" will cause problems: A program | |
| 1061 that opens a file, invokes Vim to edit that file, and then tests if | |
| 1062 the open file was changed (through the file descriptor) will check the | |
| 10 | 1063 backup file instead of the newly created file. "crontab -e" is an |
| 7 | 1064 example. |
| 1065 | |
| 1066 When a copy is made, the original file is truncated and then filled | |
| 1067 with the new text. This means that protection bits, owner and | |
| 28379 | 1068 symbolic links of the original file are unmodified. The backup file, |
| 10 | 1069 however, is a new file, owned by the user who edited the file. The |
| 7 | 1070 group of the backup is set to the group of the original file. If this |
| 1071 fails, the protection bits for the group are made the same as for | |
| 1072 others. | |
| 1073 | |
| 28379 | 1074 When the file is renamed, this is the other way around: The backup has |
| 7 | 1075 the same attributes of the original file, and the newly written file |
| 1076 is owned by the current user. When the file was a (hard/symbolic) | |
| 1077 link, the new file will not! That's why the "auto" value doesn't | |
| 1078 rename when the file is a link. The owner and group of the newly | |
| 1079 written file will be set to the same ones as the original file, but | |
| 1080 the system may refuse to do this. In that case the "auto" value will | |
| 1081 again not rename the file. | |
| 1082 | |
| 11160 | 1083 NOTE: This option is set to the Vi default value when 'compatible' is |
| 1084 set and to the Vim default value when 'compatible' is reset. | |
| 1085 | |
| 7 | 1086 *'backupdir'* *'bdir'* |
| 1087 'backupdir' 'bdir' string (default for Amiga: ".,t:", | |
| 18972 | 1088 for Win32: ".,$TEMP,c:/tmp,c:/temp" |
| 7 | 1089 for Unix: ".,~/tmp,~/") |
| 1090 global | |
| 1091 List of directories for the backup file, separated with commas. | |
| 1092 - The backup file will be created in the first directory in the list | |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
1093 where this is possible. The directory must exist, Vim will not |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
1094 create it for you. |
|
8629
54ac275e3fc4
commit https://github.com/vim/vim/commit/3848e00e0177abdb31bc600234967863ec487233
Christian Brabandt <cb@256bit.org>
parents:
8560
diff
changeset
|
1095 - Empty means that no backup file will be created ('patchmode' is |
| 7 | 1096 impossible!). Writing may fail because of this. |
| 1097 - A directory "." means to put the backup file in the same directory | |
| 1098 as the edited file. | |
| 19116 | 1099 - A directory starting with "./" (or ".\" for MS-Windows) means to put |
| 1100 the backup file relative to where the edited file is. The leading | |
| 1101 "." is replaced with the path name of the edited file. | |
| 7 | 1102 ("." inside a directory name has no special meaning). |
| 1103 - Spaces after the comma are ignored, other spaces are considered part | |
| 1104 of the directory name. To have a space at the start of a directory | |
| 1105 name, precede it with a backslash. | |
| 1106 - To include a comma in a directory name precede it with a backslash. | |
| 1107 - A directory name may end in an '/'. | |
|
14475
dddba3937532
patch 8.1.0251: using full path is not supported for 'backupdir'
Christian Brabandt <cb@256bit.org>
parents:
14421
diff
changeset
|
1108 - For Unix and Win32, if a directory ends in two path separators "//", |
| 15033 | 1109 the backup file name will be built from the complete path to the |
| 1110 file with all path separators changed to percent '%' signs. This | |
| 1111 will ensure file name uniqueness in the backup directory. | |
|
14475
dddba3937532
patch 8.1.0251: using full path is not supported for 'backupdir'
Christian Brabandt <cb@256bit.org>
parents:
14421
diff
changeset
|
1112 On Win32, it is also possible to end with "\\". However, When a |
|
dddba3937532
patch 8.1.0251: using full path is not supported for 'backupdir'
Christian Brabandt <cb@256bit.org>
parents:
14421
diff
changeset
|
1113 separating comma is following, you must use "//", since "\\" will |
|
dddba3937532
patch 8.1.0251: using full path is not supported for 'backupdir'
Christian Brabandt <cb@256bit.org>
parents:
14421
diff
changeset
|
1114 include the comma in the file name. Therefore it is recommended to |
|
dddba3937532
patch 8.1.0251: using full path is not supported for 'backupdir'
Christian Brabandt <cb@256bit.org>
parents:
14421
diff
changeset
|
1115 use '//', instead of '\\'. |
| 7 | 1116 - Environment variables are expanded |:set_env|. |
| 1117 - Careful with '\' characters, type one before a space, type two to | |
| 1118 get one in the option (see |option-backslash|), for example: > | |
| 1119 :set bdir=c:\\tmp,\ dir\\,with\\,commas,\\\ dir\ with\ spaces | |
| 1120 < - For backwards compatibility with Vim version 3.0 a '>' at the start | |
| 1121 of the option is removed. | |
| 1122 See also 'backup' and 'writebackup' options. | |
| 1123 If you want to hide your backup files on Unix, consider this value: > | |
| 1124 :set backupdir=./.backup,~/.backup,.,/tmp | |
| 1125 < You must create a ".backup" directory in each directory and in your | |
| 1126 home directory for this to work properly. | |
| 1127 The use of |:set+=| and |:set-=| is preferred when adding or removing | |
| 1128 directories from the list. This avoids problems when a future version | |
| 1129 uses another default. | |
| 1130 This option cannot be set from a |modeline| or in the |sandbox|, for | |
| 1131 security reasons. | |
| 1132 | |
| 1133 *'backupext'* *'bex'* *E589* | |
| 1134 'backupext' 'bex' string (default "~", for VMS: "_") | |
| 1135 global | |
| 1136 String which is appended to a file name to make the name of the | |
| 1137 backup file. The default is quite unusual, because this avoids | |
| 1138 accidentally overwriting existing files with a backup file. You might | |
| 1139 prefer using ".bak", but make sure that you don't have files with | |
| 1140 ".bak" that you want to keep. | |
| 28379 | 1141 Only normal file name characters can be used; "/\*?[|<>" are illegal. |
| 7 | 1142 |
| 26 | 1143 If you like to keep a lot of backups, you could use a BufWritePre |
| 1144 autocommand to change 'backupext' just before writing the file to | |
| 1145 include a timestamp. > | |
| 27903 | 1146 :au BufWritePre * let &bex = '-' .. strftime("%Y%b%d%X") .. '~' |
| 26 | 1147 < Use 'backupdir' to put the backup in a different directory. |
| 1148 | |
| 7 | 1149 *'backupskip'* *'bsk'* |
|
13664
f64c5e636c9f
patch 8.0.1704: 'backupskip' default doesn't work for Mac
Christian Brabandt <cb@256bit.org>
parents:
13482
diff
changeset
|
1150 'backupskip' 'bsk' string (default: "$TMPDIR/*,$TMP/*,$TEMP/*" |
|
f64c5e636c9f
patch 8.0.1704: 'backupskip' default doesn't work for Mac
Christian Brabandt <cb@256bit.org>
parents:
13482
diff
changeset
|
1151 Unix: "/tmp/*,$TMPDIR/*,$TMP/*,$TEMP/*" |
|
f64c5e636c9f
patch 8.0.1704: 'backupskip' default doesn't work for Mac
Christian Brabandt <cb@256bit.org>
parents:
13482
diff
changeset
|
1152 Mac: "/private/tmp/*,$TMPDIR/*,$TMP/*,$TEMP/*") |
| 7 | 1153 global |
| 1154 {not available when compiled without the |+wildignore| | |
| 1155 feature} | |
| 1156 A list of file patterns. When one of the patterns matches with the | |
| 1157 name of the file which is written, no backup file is created. Both | |
| 1158 the specified file name and the full path name of the file are used. | |
| 1159 The pattern is used like with |:autocmd|, see |autocmd-patterns|. | |
| 1160 Watch out for special characters, see |option-backslash|. | |
| 1161 When $TMPDIR, $TMP or $TEMP is not defined, it is not used for the | |
| 233 | 1162 default value. "/tmp/*" is only used for Unix. |
| 1152 | 1163 |
| 3513 | 1164 WARNING: Not having a backup file means that when Vim fails to write |
| 1165 your buffer correctly and then, for whatever reason, Vim exits, you | |
| 1166 lose both the original file and what you were writing. Only disable | |
| 1167 backups if you don't care about losing the file. | |
| 1168 | |
| 1152 | 1169 Note that environment variables are not expanded. If you want to use |
| 1170 $HOME you must expand it explicitly, e.g.: > | |
| 27903 | 1171 :let &backupskip = escape(expand('$HOME'), '\') .. '/tmp/*' |
| 1152 | 1172 |
| 1173 < Note that the default also makes sure that "crontab -e" works (when a | |
| 557 | 1174 backup would be made by renaming the original file crontab won't see |
| 1175 the newly created file). Also see 'backupcopy' and |crontab|. | |
| 7 | 1176 |
| 1177 *'balloondelay'* *'bdlay'* | |
| 1178 'balloondelay' 'bdlay' number (default: 600) | |
| 1179 global | |
| 1180 {only available when compiled with the |+balloon_eval| | |
| 1181 feature} | |
| 1182 Delay in milliseconds before a balloon may pop up. See |balloon-eval|. | |
| 1183 | |
| 1184 *'ballooneval'* *'beval'* *'noballooneval'* *'nobeval'* | |
| 1185 'ballooneval' 'beval' boolean (default off) | |
| 1186 global | |
| 1187 {only available when compiled with the |+balloon_eval| | |
| 189 | 1188 feature} |
|
12865
ebb4f6c93598
patch 8.0.1309: cannot use 'balloonexpr' in a terminal
Christian Brabandt <cb@256bit.org>
parents:
12826
diff
changeset
|
1189 Switch on the |balloon-eval| functionality for the GUI. |
|
ebb4f6c93598
patch 8.0.1309: cannot use 'balloonexpr' in a terminal
Christian Brabandt <cb@256bit.org>
parents:
12826
diff
changeset
|
1190 |
|
ebb4f6c93598
patch 8.0.1309: cannot use 'balloonexpr' in a terminal
Christian Brabandt <cb@256bit.org>
parents:
12826
diff
changeset
|
1191 *'balloonevalterm'* *'bevalterm'* *'noballoonevalterm'* |
|
ebb4f6c93598
patch 8.0.1309: cannot use 'balloonexpr' in a terminal
Christian Brabandt <cb@256bit.org>
parents:
12826
diff
changeset
|
1192 *'nobevalterm'* |
|
ebb4f6c93598
patch 8.0.1309: cannot use 'balloonexpr' in a terminal
Christian Brabandt <cb@256bit.org>
parents:
12826
diff
changeset
|
1193 'balloonevalterm' 'bevalterm' boolean (default off) |
|
ebb4f6c93598
patch 8.0.1309: cannot use 'balloonexpr' in a terminal
Christian Brabandt <cb@256bit.org>
parents:
12826
diff
changeset
|
1194 global |
|
ebb4f6c93598
patch 8.0.1309: cannot use 'balloonexpr' in a terminal
Christian Brabandt <cb@256bit.org>
parents:
12826
diff
changeset
|
1195 {only available when compiled with the |
|
ebb4f6c93598
patch 8.0.1309: cannot use 'balloonexpr' in a terminal
Christian Brabandt <cb@256bit.org>
parents:
12826
diff
changeset
|
1196 |+balloon_eval_term| feature} |
|
ebb4f6c93598
patch 8.0.1309: cannot use 'balloonexpr' in a terminal
Christian Brabandt <cb@256bit.org>
parents:
12826
diff
changeset
|
1197 Switch on the |balloon-eval| functionality for the terminal. |
| 7 | 1198 |
| 189 | 1199 *'balloonexpr'* *'bexpr'* |
| 1200 'balloonexpr' 'bexpr' string (default "") | |
| 790 | 1201 global or local to buffer |global-local| |
| 189 | 1202 {only available when compiled with the |+balloon_eval| |
| 1203 feature} | |
| 782 | 1204 Expression for text to show in evaluation balloon. It is only used |
| 16610 | 1205 when 'ballooneval' or 'balloonevalterm' is on. These variables can be |
| 1206 used: | |
| 189 | 1207 |
| 1208 v:beval_bufnr number of the buffer in which balloon is going to show | |
| 1209 v:beval_winnr number of the window | |
|
9227
ecb621205ed1
commit https://github.com/vim/vim/commit/82af8710bf8d1caeeceafb1370a052cb7d92f076
Christian Brabandt <cb@256bit.org>
parents:
9116
diff
changeset
|
1210 v:beval_winid ID of the window |
| 189 | 1211 v:beval_lnum line number |
| 1212 v:beval_col column number (byte index) | |
| 1213 v:beval_text word under or after the mouse pointer | |
| 1214 | |
| 17571 | 1215 Instead of showing a balloon, which is limited to plain text, consider |
| 1216 using a popup window, see |popup_beval_example|. A popup window can | |
| 1217 use highlighting and show a border. | |
| 1218 | |
| 189 | 1219 The evaluation of the expression must not have side effects! |
| 1220 Example: > | |
| 16610 | 1221 function MyBalloonExpr() |
| 27903 | 1222 return 'Cursor is at line ' .. v:beval_lnum .. |
| 1223 \ ', column ' .. v:beval_col .. | |
| 1224 \ ' of file ' .. bufname(v:beval_bufnr) .. | |
| 1225 \ ' on word "' .. v:beval_text .. '"' | |
| 189 | 1226 endfunction |
| 1227 set bexpr=MyBalloonExpr() | |
| 1228 set ballooneval | |
| 1229 < | |
| 17372 | 1230 Also see |balloon_show()|, it can be used if the content of the balloon |
| 1231 is to be fetched asynchronously. In that case evaluating | |
| 1232 'balloonexpr' should result in an empty string. If you get a balloon | |
| 1233 with only "0" you probably didn't return anything from your function. | |
| 11062 | 1234 |
| 189 | 1235 NOTE: The balloon is displayed only if the cursor is on a text |
| 1236 character. If the result of evaluating 'balloonexpr' is not empty, | |
| 1237 Vim does not try to send a message to an external debugger (Netbeans | |
| 1238 or Sun Workshop). | |
| 1239 | |
|
26743
c2c40cefc17b
patch 8.2.3900: it is not easy to use a script-local function for an option
Bram Moolenaar <Bram@vim.org>
parents:
26708
diff
changeset
|
1240 If the expression starts with s: or |<SID>|, then it is replaced with |
|
c2c40cefc17b
patch 8.2.3900: it is not easy to use a script-local function for an option
Bram Moolenaar <Bram@vim.org>
parents:
26708
diff
changeset
|
1241 the script ID (|local-function|). Example: > |
|
c2c40cefc17b
patch 8.2.3900: it is not easy to use a script-local function for an option
Bram Moolenaar <Bram@vim.org>
parents:
26708
diff
changeset
|
1242 set bexpr=s:MyBalloonExpr() |
|
c2c40cefc17b
patch 8.2.3900: it is not easy to use a script-local function for an option
Bram Moolenaar <Bram@vim.org>
parents:
26708
diff
changeset
|
1243 set bexpr=<SID>SomeBalloonExpr() |
| 27321 | 1244 < Otherwise, the expression is evaluated in the context of the script |
| 1245 where the option was set, thus script-local items are available. | |
| 1246 | |
| 3682 | 1247 The expression will be evaluated in the |sandbox| when set from a |
| 1248 modeline, see |sandbox-option|. | |
|
16728
e55c26aaf484
patch 8.1.1366: using expressions in a modeline is unsafe
Bram Moolenaar <Bram@vim.org>
parents:
16610
diff
changeset
|
1249 This option cannot be set in a modeline when 'modelineexpr' is off. |
| 634 | 1250 |
| 1251 It is not allowed to change text or jump to another window while | |
| 17372 | 1252 evaluating 'balloonexpr', see |textlock|. |
| 634 | 1253 |
| 446 | 1254 To check whether line breaks in the balloon text work use this check: > |
| 435 | 1255 if has("balloon_multiline") |
| 714 | 1256 < When they are supported "\n" characters will start a new line. If the |
| 1257 expression evaluates to a |List| this is equal to using each List item | |
| 1258 as a string and putting "\n" in between them. | |
| 11160 | 1259 NOTE: This option is set to "" when 'compatible' is set. |
| 714 | 1260 |
| 6949 | 1261 *'belloff'* *'bo'* |
| 1262 'belloff' 'bo' string (default "") | |
| 1263 global | |
| 1264 Specifies for which events the bell will not be rung. It is a comma | |
| 1265 separated list of items. For each item that is present, the bell | |
| 1266 will be silenced. This is most useful to specify specific events in | |
| 1267 insert mode to be silenced. | |
|
28439
16bd027b039e
patch 8.2.4744: a terminal window can't use the bell
Bram Moolenaar <Bram@vim.org>
parents:
28399
diff
changeset
|
1268 You can also make it flash by using 'visualbell'. |
| 6949 | 1269 |
| 1270 item meaning when present ~ | |
| 1271 all All events. | |
| 1272 backspace When hitting <BS> or <Del> and deleting results in an | |
| 1273 error. | |
| 1274 cursor Fail to move around using the cursor keys or | |
| 1275 <PageUp>/<PageDown> in |Insert-mode|. | |
| 1276 complete Error occurred when using |i_CTRL-X_CTRL-K| or | |
| 1277 |i_CTRL-X_CTRL-T|. | |
| 1278 copy Cannot copy char from insert mode using |i_CTRL-Y| or | |
| 1279 |i_CTRL-E|. | |
| 1280 ctrlg Unknown Char after <C-G> in Insert mode. | |
| 1281 error Other Error occurred (e.g. try to join last line) | |
| 1282 (mostly used in |Normal-mode| or |Cmdline-mode|). | |
| 1283 esc hitting <Esc> in |Normal-mode|. | |
| 1284 ex In |Visual-mode|, hitting |Q| results in an error. | |
| 18719 | 1285 hangul Ignored. |
| 6949 | 1286 insertmode Pressing <Esc> in 'insertmode'. |
| 1287 lang Calling the beep module for Lua/Mzscheme/TCL. | |
| 1288 mess No output available for |g<|. | |
| 1289 showmatch Error occurred for 'showmatch' function. | |
| 1290 operator Empty region error |cpo-E|. | |
| 1291 register Unknown register after <C-R> in |Insert-mode|. | |
| 1292 shell Bell from shell output |:!|. | |
| 1293 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
|
1294 term Bell from |:terminal| output. |
| 6949 | 1295 wildmode More matches in |cmdline-completion| available |
| 1296 (depends on the 'wildmode' setting). | |
| 1297 | |
| 11160 | 1298 This is most useful to fine tune when in Insert mode the bell should |
| 1299 be rung. For Normal mode and Ex commands, the bell is often rung to | |
| 6949 | 1300 indicate that an error occurred. It can be silenced by adding the |
| 1301 "error" keyword. | |
| 1302 | |
| 7 | 1303 *'binary'* *'bin'* *'nobinary'* *'nobin'* |
| 1304 'binary' 'bin' boolean (default off) | |
| 1305 local to buffer | |
| 1306 This option should be set before editing a binary file. You can also | |
| 1307 use the |-b| Vim argument. When this option is switched on a few | |
| 1308 options will be changed (also when it already was on): | |
| 1309 'textwidth' will be set to 0 | |
| 1310 'wrapmargin' will be set to 0 | |
| 1311 'modeline' will be off | |
| 1312 'expandtab' will be off | |
| 1313 Also, 'fileformat' and 'fileformats' options will not be used, the | |
| 1314 file is read and written like 'fileformat' was "unix" (a single <NL> | |
| 1315 separates lines). | |
| 1316 The 'fileencoding' and 'fileencodings' options will not be used, the | |
| 1317 file is read without conversion. | |
| 1318 NOTE: When you start editing a(nother) file while the 'bin' option is | |
| 1319 on, settings from autocommands may change the settings again (e.g., | |
| 1320 'textwidth'), causing trouble when editing. You might want to set | |
| 1321 'bin' again when the file has been loaded. | |
| 1322 The previous values of these options are remembered and restored when | |
| 1323 'bin' is switched from on to off. Each buffer has its own set of | |
| 1324 saved option values. | |
| 1325 To edit a file with 'binary' set you can use the |++bin| argument. | |
| 1326 This avoids you have to do ":set bin", which would have effect for all | |
| 1327 files you edit. | |
| 1328 When writing a file the <EOL> for the last line is only written if | |
| 1329 there was one in the original file (normally Vim appends an <EOL> to | |
| 1330 the last line if there is none; this would make the file longer). See | |
| 1331 the 'endofline' option. | |
| 1332 | |
| 1333 *'bioskey'* *'biosk'* *'nobioskey'* *'nobiosk'* | |
| 1334 'bioskey' 'biosk' boolean (default on) | |
| 1335 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
|
1336 {only for MS-DOS} |
|
8246
f16bfe02cef1
commit https://github.com/vim/vim/commit/f391327adbbffb11180cf6038a92af1ed144e907
Christian Brabandt <cb@256bit.org>
parents:
8182
diff
changeset
|
1337 This was for MS-DOS and is no longer supported. |
| 7 | 1338 |
| 1339 *'bomb'* *'nobomb'* | |
| 1340 'bomb' boolean (default off) | |
| 1341 local to buffer | |
| 1342 When writing a file and the following conditions are met, a BOM (Byte | |
| 1343 Order Mark) is prepended to the file: | |
| 1344 - this option is on | |
| 1345 - the 'binary' option is off | |
| 1346 - 'fileencoding' is "utf-8", "ucs-2", "ucs-4" or one of the little/big | |
| 1347 endian variants. | |
| 1348 Some applications use the BOM to recognize the encoding of the file. | |
| 1349 Often used for UCS-2 files on MS-Windows. For other applications it | |
| 1350 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
|
1351 appear halfway the resulting file. Gcc doesn't accept a BOM. |
| 7 | 1352 When Vim reads a file and 'fileencodings' starts with "ucs-bom", a |
| 1353 check for the presence of the BOM is done and 'bomb' set accordingly. | |
| 1354 Unless 'binary' is set, it is removed from the first line, so that you | |
| 1355 don't see it when editing. When you don't change the options, the BOM | |
| 1356 will be restored when writing the file. | |
| 1357 | |
| 1358 *'breakat'* *'brk'* | |
| 1359 'breakat' 'brk' string (default " ^I!@*-+;:,./?") | |
| 1360 global | |
|
2570
71b56b4e7785
Make the references to features in the help more consistent. (Sylvain Hitier)
Bram Moolenaar <bram@vim.org>
parents:
2561
diff
changeset
|
1361 {not available when compiled without the |+linebreak| |
| 7 | 1362 feature} |
| 1363 This option lets you choose which characters might cause a line | |
| 500 | 1364 break if 'linebreak' is on. Only works for ASCII and also for 8-bit |
| 1365 characters when 'encoding' is an 8-bit encoding. | |
| 7 | 1366 |
|
8835
c1a5623cfc86
commit https://github.com/vim/vim/commit/7c1c6dbb6817640fd3956a0d5417da23fde336d8
Christian Brabandt <cb@256bit.org>
parents:
8748
diff
changeset
|
1367 *'breakindent'* *'bri'* *'nobreakindent'* *'nobri'* |
| 6009 | 1368 'breakindent' 'bri' boolean (default off) |
| 1369 local to window | |
| 1370 {not available when compiled without the |+linebreak| | |
| 1371 feature} | |
| 1372 Every wrapped line will continue visually indented (same amount of | |
| 1373 space as the beginning of that line), thus preserving horizontal blocks | |
| 1374 of text. | |
| 11160 | 1375 NOTE: This option is reset when 'compatible' is set. |
| 6009 | 1376 |
| 1377 *'breakindentopt'* *'briopt'* | |
| 1378 'breakindentopt' 'briopt' string (default empty) | |
| 1379 local to window | |
| 1380 {not available when compiled without the |+linebreak| | |
| 1381 feature} | |
| 1382 Settings for 'breakindent'. It can consist of the following optional | |
| 6026 | 1383 items and must be separated by a comma: |
| 6009 | 1384 min:{n} Minimum text width that will be kept after |
| 1385 applying 'breakindent', even if the resulting | |
| 1386 text should normally be narrower. This prevents | |
| 1387 text indented almost to the right window border | |
| 1388 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
|
1389 (default: 20) |
| 6026 | 1390 shift:{n} After applying 'breakindent', the wrapped line's |
| 1391 beginning will be shifted by the given number of | |
| 1392 characters. It permits dynamic French paragraph | |
| 6009 | 1393 indentation (negative) or emphasizing the line |
| 1394 continuation (positive). | |
|
28716
2bd5cb054180
patch 8.2.4882: cannot make 'breakindent' use a specific column
Bram Moolenaar <Bram@vim.org>
parents:
28517
diff
changeset
|
1395 (default: 0) |
|
13341
acd7eaa13d2b
Updated runtime files.
Christian Brabandt <cb@256bit.org>
parents:
13314
diff
changeset
|
1396 sbr Display the 'showbreak' value before applying the |
| 6009 | 1397 additional indent. |
|
28716
2bd5cb054180
patch 8.2.4882: cannot make 'breakindent' use a specific column
Bram Moolenaar <Bram@vim.org>
parents:
28517
diff
changeset
|
1398 (default: off) |
|
25322
b3d7becabe99
patch 8.2.3198: cannot use 'formatlistpat' for breakindent
Bram Moolenaar <Bram@vim.org>
parents:
25248
diff
changeset
|
1399 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
|
1400 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
|
1401 'formatlistpat' setting). |
|
25322
b3d7becabe99
patch 8.2.3198: cannot use 'formatlistpat' for breakindent
Bram Moolenaar <Bram@vim.org>
parents:
25248
diff
changeset
|
1402 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
|
1403 for indentation. |
|
28716
2bd5cb054180
patch 8.2.4882: cannot make 'breakindent' use a specific column
Bram Moolenaar <Bram@vim.org>
parents:
28517
diff
changeset
|
1404 (default: 0) |
|
2bd5cb054180
patch 8.2.4882: cannot make 'breakindent' use a specific column
Bram Moolenaar <Bram@vim.org>
parents:
28517
diff
changeset
|
1405 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
|
1406 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
|
1407 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
|
1408 (default: off) |
| 6009 | 1409 |
| 7 | 1410 *'browsedir'* *'bsdir'* |
| 29 | 1411 'browsedir' 'bsdir' string (default: "last") |
| 7 | 1412 global |
| 28379 | 1413 {only for Motif, GTK, Mac and Win32 GUI} |
| 7 | 1414 Which directory to use for the file browser: |
| 1621 | 1415 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
|
1416 file was opened or saved. |
| 7 | 1417 buffer Use the directory of the related buffer. |
| 1418 current Use the current directory. | |
| 1419 {path} Use the specified directory | |
| 1420 | |
| 1421 *'bufhidden'* *'bh'* | |
| 1422 'bufhidden' 'bh' string (default: "") | |
| 1423 local to buffer | |
| 1424 This option specifies what happens when a buffer is no longer | |
| 1425 displayed in a window: | |
| 1426 <empty> follow the global 'hidden' option | |
| 28379 | 1427 hide hide the buffer (don't unload it), even if 'hidden' is |
| 1428 not set | |
| 1429 unload unload the buffer, even if 'hidden' is set; the | |
| 1430 |:hide| command will also unlod the buffer | |
| 1431 delete delete the buffer from the buffer list, even if | |
| 1432 'hidden' is set; the |:hide| command will also delete | |
| 1433 the buffer, making it behave like |:bdelete| | |
| 1434 wipe wipe the buffer from the buffer list, even if | |
| 1435 'hidden' is set; the |:hide| command will also wipe | |
| 1436 out the buffer, making it behave like |:bwipeout| | |
| 7 | 1437 |
| 82 | 1438 CAREFUL: when "unload", "delete" or "wipe" is used changes in a buffer |
| 3224 | 1439 are lost without a warning. Also, these values may break autocommands |
| 1440 that switch between buffers temporarily. | |
| 7 | 1441 This option is used together with 'buftype' and 'swapfile' to specify |
| 1442 special kinds of buffers. See |special-buffers|. | |
| 1443 | |
| 1444 *'buflisted'* *'bl'* *'nobuflisted'* *'nobl'* *E85* | |
| 1445 'buflisted' 'bl' boolean (default: on) | |
| 1446 local to buffer | |
| 1447 When this option is set, the buffer shows up in the buffer list. If | |
| 1448 it is reset it is not used for ":bnext", "ls", the Buffers menu, etc. | |
| 1449 This option is reset by Vim for buffers that are only used to remember | |
| 1450 a file name or marks. Vim sets it when starting to edit a buffer. | |
| 1451 But not when moving to a buffer with ":buffer". | |
| 1452 | |
| 1453 *'buftype'* *'bt'* *E382* | |
| 1454 'buftype' 'bt' string (default: "") | |
| 1455 local to buffer | |
| 1456 The value of this option specifies the type of a buffer: | |
| 1457 <empty> normal buffer | |
| 1458 nofile buffer which is not related to a file and will not be | |
| 1459 written | |
| 1460 nowrite buffer which will not be written | |
| 17 | 1461 acwrite buffer which will always be written with BufWriteCmd |
| 13437 | 1462 autocommands. |
| 7 | 1463 quickfix quickfix buffer, contains list of errors |:cwindow| |
| 648 | 1464 or list of locations |:lwindow| |
| 7 | 1465 help help buffer (you are not supposed to set this |
| 1466 manually) | |
|
11757
74abb6c84984
patch 8.0.0761: options not set properly for a terminal buffer
Christian Brabandt <cb@256bit.org>
parents:
11666
diff
changeset
|
1467 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
|
1468 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
|
1469 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
|
1470 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
|
1471 {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
|
1472 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
|
1473 {only when compiled with the |+textprop| feature} |
| 7 | 1474 |
| 1475 This option is used together with 'bufhidden' and 'swapfile' to | |
| 1476 specify special kinds of buffers. See |special-buffers|. | |
| 19404 | 1477 Also see |win_gettype()|, which returns the type of the window. |
| 7 | 1478 |
| 1479 Be careful with changing this option, it can have many side effects! | |
| 26100 | 1480 One such effect is that Vim will not check the timestamp of the file, |
| 1481 if the file is changed by another program this will not be noticed. | |
| 7 | 1482 |
| 648 | 1483 A "quickfix" buffer is only used for the error list and the location |
| 1484 list. This value is set by the |:cwindow| and |:lwindow| commands and | |
| 1485 you are not supposed to change it. | |
| 7 | 1486 |
| 1487 "nofile" and "nowrite" buffers are similar: | |
| 1488 both: The buffer is not to be written to disk, ":w" doesn't | |
| 1489 work (":w filename" does work though). | |
| 1490 both: The buffer is never considered to be |'modified'|. | |
| 1491 There is no warning when the changes will be lost, for | |
| 1492 example when you quit Vim. | |
| 1493 both: A swap file is only created when using too much memory | |
| 1494 (when 'swapfile' has been reset there is never a swap | |
| 1495 file). | |
| 1496 nofile only: The buffer name is fixed, it is not handled like a | |
| 1497 file name. It is not modified in response to a |:cd| | |
| 1498 command. | |
| 6647 | 1499 both: When using ":e bufname" and already editing "bufname" |
| 1500 the buffer is made empty and autocommands are | |
| 1501 triggered as usual for |:edit|. | |
| 17 | 1502 *E676* |
| 1503 "acwrite" implies that the buffer name is not related to a file, like | |
| 1504 "nofile", but it will be written. Thus, in contrast to "nofile" and | |
| 1505 "nowrite", ":w" does work and a modified buffer can't be abandoned | |
| 1506 without saving. For writing there must be matching |BufWriteCmd|, | |
| 1507 |FileWriteCmd| or |FileAppendCmd| autocommands. | |
| 7 | 1508 |
| 1509 *'casemap'* *'cmp'* | |
| 1510 'casemap' 'cmp' string (default: "internal,keepascii") | |
| 1511 global | |
| 1512 Specifies details about changing the case of letters. It may contain | |
| 1513 these words, separated by a comma: | |
| 1514 internal Use internal case mapping functions, the current | |
| 1515 locale does not change the case mapping. This only | |
| 493 | 1516 matters when 'encoding' is a Unicode encoding, |
| 1517 "latin1" or "iso-8859-15". When "internal" is | |
| 1518 omitted, the towupper() and towlower() system library | |
| 1519 functions are used when available. | |
| 7 | 1520 keepascii For the ASCII characters (0x00 to 0x7f) use the US |
| 1521 case mapping, the current locale is not effective. | |
| 1522 This probably only matters for Turkish. | |
| 1523 | |
|
26508
a0bc10e83cf8
patch 8.2.3784: the help for options is outdated
Bram Moolenaar <Bram@vim.org>
parents:
26441
diff
changeset
|
1524 *'cdhome'* *'cdh'* |
|
a0bc10e83cf8
patch 8.2.3784: the help for options is outdated
Bram Moolenaar <Bram@vim.org>
parents:
26441
diff
changeset
|
1525 '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
|
1526 global |
|
a0bc10e83cf8
patch 8.2.3784: the help for options is outdated
Bram Moolenaar <Bram@vim.org>
parents:
26441
diff
changeset
|
1527 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
|
1528 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
|
1529 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
|
1530 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
|
1531 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
|
1532 |
| 7 | 1533 *'cdpath'* *'cd'* *E344* *E346* |
| 1534 'cdpath' 'cd' string (default: equivalent to $CDPATH or ",,") | |
| 1535 global | |
| 1536 {not available when compiled without the | |
| 1537 |+file_in_path| feature} | |
| 1538 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
|
1539 |: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
|
1540 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
|
1541 "/", "./" or "../", the 'cdpath' option is not used then. |
| 7 | 1542 The 'cdpath' option's value has the same form and semantics as |
| 1543 |'path'|. Also see |file-searching|. | |
| 1544 The default value is taken from $CDPATH, with a "," prepended to look | |
| 1545 in the current directory first. | |
| 1546 If the default value taken from $CDPATH is not what you want, include | |
| 1547 a modified version of the following command in your vimrc file to | |
| 1548 override it: > | |
| 27903 | 1549 :let &cdpath = ',' .. substitute(substitute($CDPATH, '[, ]', '\\\0', 'g'), ':', ',', 'g') |
| 7 | 1550 < This option cannot be set from a |modeline| or in the |sandbox|, for |
| 1551 security reasons. | |
| 1552 (parts of 'cdpath' can be passed to the shell to expand file names). | |
| 1553 | |
| 1554 *'cedit'* | |
| 1555 'cedit' string (Vi default: "", Vim default: CTRL-F) | |
| 1556 global | |
| 1557 The key used in Command-line Mode to open the command-line window. | |
| 1558 The default is CTRL-F when 'compatible' is off. | |
| 1559 Only non-printable keys are allowed. | |
| 1560 The key can be specified as a single character, but it is difficult to | |
| 1561 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
|
1562 :exe "set cedit=\<C-Y>" |
|
619a98a67f67
commit https://github.com/vim/vim/commit/e18dbe865d190e74fb5d43ac8bc6ac22507d0223
Christian Brabandt <cb@256bit.org>
parents:
9344
diff
changeset
|
1563 :exe "set cedit=\<Esc>" |
| 7 | 1564 < |Nvi| also has this option, but it only uses the first character. |
| 1565 See |cmdwin|. | |
| 11160 | 1566 NOTE: This option is set to the Vim default value when 'compatible' |
| 1567 is reset. | |
| 7 | 1568 |
| 1569 *'charconvert'* *'ccv'* *E202* *E214* *E513* | |
| 1570 'charconvert' 'ccv' string (default "") | |
| 1571 global | |
| 15878 | 1572 {only available when compiled with the |+eval| feature} |
| 7 | 1573 An expression that is used for character encoding conversion. It is |
| 1574 evaluated when a file that is to be read or has been written has a | |
| 1575 different encoding from what is desired. | |
| 1576 'charconvert' is not used when the internal iconv() function is | |
| 1577 supported and is able to do the conversion. Using iconv() is | |
| 1578 preferred, because it is much faster. | |
| 1579 'charconvert' is not used when reading stdin |--|, because there is no | |
| 1580 file to convert from. You will have to save the text in a file first. | |
| 27459 | 1581 The expression must return zero, false or an empty string for success, |
| 1582 non-zero or true for failure. | |
| 7 | 1583 The possible encoding names encountered are in 'encoding'. |
| 1584 Additionally, names given in 'fileencodings' and 'fileencoding' are | |
| 1585 used. | |
| 1586 Conversion between "latin1", "unicode", "ucs-2", "ucs-4" and "utf-8" | |
| 1587 is done internally by Vim, 'charconvert' is not used for this. | |
| 1588 'charconvert' is also used to convert the viminfo file, if the 'c' | |
| 1589 flag is present in 'viminfo'. Also used for Unicode conversion. | |
| 1590 Example: > | |
| 1591 set charconvert=CharConvert() | |
| 1592 fun CharConvert() | |
| 1593 system("recode " | |
| 27903 | 1594 \ .. v:charconvert_from .. ".." .. v:charconvert_to |
| 1595 \ .. " <" .. v:fname_in .. " >" .. v:fname_out) | |
| 7 | 1596 return v:shell_error |
| 1597 endfun | |
| 1598 < The related Vim variables are: | |
| 1599 v:charconvert_from name of the current encoding | |
| 1600 v:charconvert_to name of the desired encoding | |
| 1601 v:fname_in name of the input file | |
| 1602 v:fname_out name of the output file | |
| 1603 Note that v:fname_in and v:fname_out will never be the same. | |
| 1604 Note that v:charconvert_from and v:charconvert_to may be different | |
| 1605 from 'encoding'. Vim internally uses UTF-8 instead of UCS-2 or UCS-4. | |
| 27459 | 1606 |
| 7 | 1607 Encryption is not done by Vim when using 'charconvert'. If you want |
| 1608 to encrypt the file after conversion, 'charconvert' should take care | |
| 1609 of this. | |
| 27459 | 1610 |
| 1611 If the 'charconvert' expression starts with s: or |<SID>|, then it is | |
| 1612 replaced with the script ID (|local-function|). Example: > | |
| 1613 set charconvert=s:MyConvert() | |
| 1614 set charconvert=<SID>SomeConvert() | |
| 1615 < Otherwise the expression is evaluated in the context of the script | |
| 1616 where the option was set, thus script-local items are available. | |
| 1617 | |
| 7 | 1618 This option cannot be set from a |modeline| or in the |sandbox|, for |
| 1619 security reasons. | |
| 1620 | |
| 1621 *'cindent'* *'cin'* *'nocindent'* *'nocin'* | |
| 1622 'cindent' 'cin' boolean (default off) | |
| 1623 local to buffer | |
| 1624 {not available when compiled without the |+cindent| | |
| 1625 feature} | |
| 1621 | 1626 Enables automatic C program indenting. See 'cinkeys' to set the keys |
| 7 | 1627 that trigger reindenting in insert mode and 'cinoptions' to set your |
| 1628 preferred indent style. | |
| 1629 If 'indentexpr' is not empty, it overrules 'cindent'. | |
| 1630 If 'lisp' is not on and both 'indentexpr' and 'equalprg' are empty, | |
| 1631 the "=" operator indents using this algorithm rather than calling an | |
| 1632 external program. | |
| 1633 See |C-indenting|. | |
| 1634 When you don't like the way 'cindent' works, try the 'smartindent' | |
| 1635 option or 'indentexpr'. | |
| 1636 This option is not used when 'paste' is set. | |
| 1637 NOTE: This option is reset when 'compatible' is set. | |
| 1638 | |
| 1639 *'cinkeys'* *'cink'* | |
|
15701
9cd11f6beb70
patch 8.1.0858: 'indentkeys' and 'cinkeys' defaults are different
Bram Moolenaar <Bram@vim.org>
parents:
15512
diff
changeset
|
1640 'cinkeys' 'cink' string (default "0{,0},0),0],:,0#,!^F,o,O,e") |
| 7 | 1641 local to buffer |
| 1642 {not available when compiled without the |+cindent| | |
| 1643 feature} | |
| 1644 A list of keys that, when typed in Insert mode, cause reindenting of | |
| 1645 the current line. Only used if 'cindent' is on and 'indentexpr' is | |
| 1646 empty. | |
| 1647 For the format of this option see |cinkeys-format|. | |
| 1648 See |C-indenting|. | |
| 1649 | |
| 1650 *'cinoptions'* *'cino'* | |
| 1651 'cinoptions' 'cino' string (default "") | |
| 1652 local to buffer | |
| 1653 {not available when compiled without the |+cindent| | |
| 1654 feature} | |
| 1655 The 'cinoptions' affect the way 'cindent' reindents lines in a C | |
| 1656 program. See |cinoptions-values| for the values of this option, and | |
| 1657 |C-indenting| for info on C indenting in general. | |
| 1658 | |
| 1659 | |
| 1660 *'cinwords'* *'cinw'* | |
| 1661 'cinwords' 'cinw' string (default "if,else,while,do,for,switch") | |
| 1662 local to buffer | |
| 1663 {not available when compiled without both the | |
| 1664 |+cindent| and the |+smartindent| features} | |
| 1665 These keywords start an extra indent in the next line when | |
| 1666 'smartindent' or 'cindent' is set. For 'cindent' this is only done at | |
| 1667 an appropriate place (inside {}). | |
| 1668 Note that 'ignorecase' isn't used for 'cinwords'. If case doesn't | |
| 1669 matter, include the keyword both the uppercase and lowercase: | |
| 1670 "if,If,IF". | |
| 1671 | |
|
28353
8bc8071928ed
patch 8.2.4702: C++ scope labels are hard-coded
Bram Moolenaar <Bram@vim.org>
parents:
28297
diff
changeset
|
1672 *'cinscopedecls'* *'cinsd'* |
|
8bc8071928ed
patch 8.2.4702: C++ scope labels are hard-coded
Bram Moolenaar <Bram@vim.org>
parents:
28297
diff
changeset
|
1673 '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
|
1674 local to buffer |
|
8bc8071928ed
patch 8.2.4702: C++ scope labels are hard-coded
Bram Moolenaar <Bram@vim.org>
parents:
28297
diff
changeset
|
1675 {not available when compiled without the |+cindent| |
|
8bc8071928ed
patch 8.2.4702: C++ scope labels are hard-coded
Bram Moolenaar <Bram@vim.org>
parents:
28297
diff
changeset
|
1676 feature} |
|
8bc8071928ed
patch 8.2.4702: C++ scope labels are hard-coded
Bram Moolenaar <Bram@vim.org>
parents:
28297
diff
changeset
|
1677 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
|
1678 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
|
1679 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
|
1680 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
|
1681 |
|
8bc8071928ed
patch 8.2.4702: C++ scope labels are hard-coded
Bram Moolenaar <Bram@vim.org>
parents:
28297
diff
changeset
|
1682 < *'clipboard'* *'cb'* |
| 7 | 1683 'clipboard' 'cb' string (default "autoselect,exclude:cons\|linux" |
| 1684 for X-windows, "" otherwise) | |
| 1685 global | |
| 1686 {only in GUI versions or when the |+xterm_clipboard| | |
| 1687 feature is included} | |
|
28353
8bc8071928ed
patch 8.2.4702: C++ scope labels are hard-coded
Bram Moolenaar <Bram@vim.org>
parents:
28297
diff
changeset
|
1688 This option is a list of comma-separated names. |
| 23931 | 1689 Note: if one of the items is "exclude:", then you can't add an item |
| 1690 after that. Therefore do append an item with += but use ^= to | |
| 1691 prepend, e.g.: > | |
| 1692 set clipboard^=unnamed | |
| 1693 < These names are recognized: | |
| 7 | 1694 |
| 3674 | 1695 *clipboard-unnamed* |
| 7 | 1696 unnamed When included, Vim will use the clipboard register '*' |
| 1697 for all yank, delete, change and put operations which | |
| 1698 would normally go to the unnamed register. When a | |
| 1699 register is explicitly specified, it will always be | |
| 1700 used regardless of whether "unnamed" is in 'clipboard' | |
| 1701 or not. The clipboard register can always be | |
| 1702 explicitly accessed using the "* notation. Also see | |
| 1703 |gui-clipboard|. | |
| 1704 | |
| 3682 | 1705 *clipboard-unnamedplus* |
| 4119 | 1706 unnamedplus A variant of the "unnamed" flag which uses the |
| 1707 clipboard register '+' (|quoteplus|) instead of | |
| 1708 register '*' for all yank, delete, change and put | |
| 1709 operations which would normally go to the unnamed | |
| 1710 register. When "unnamed" is also included to the | |
| 1711 option, yank operations (but not delete, change or | |
| 1712 put) will additionally copy the text into register | |
| 1713 '*'. | |
| 2662 | 1714 Only available with the |+X11| feature. |
| 2654 | 1715 Availability can be checked with: > |
| 1716 if has('unnamedplus') | |
| 1717 < | |
| 3682 | 1718 *clipboard-autoselect* |
| 7 | 1719 autoselect Works like the 'a' flag in 'guioptions': If present, |
| 1720 then whenever Visual mode is started, or the Visual | |
| 1721 area extended, Vim tries to become the owner of the | |
| 1722 windowing system's global selection or put the | |
| 1723 selected text on the clipboard used by the selection | |
| 14999 | 1724 register "*. See |'go-a'| and |quotestar| for details. |
| 1725 When the GUI is active, the 'a' flag in 'guioptions' | |
| 1726 is used, when the GUI is not active, this "autoselect" | |
| 1727 flag is used. | |
| 7 | 1728 Also applies to the modeless selection. |
| 1729 | |
| 3674 | 1730 *clipboard-autoselectplus* |
| 1731 autoselectplus Like "autoselect" but using the + register instead of | |
| 1732 the * register. Compare to the 'P' flag in | |
| 1733 'guioptions'. | |
| 1734 | |
| 1735 *clipboard-autoselectml* | |
| 7 | 1736 autoselectml Like "autoselect", but for the modeless selection |
| 1737 only. Compare to the 'A' flag in 'guioptions'. | |
| 1738 | |
| 3674 | 1739 *clipboard-html* |
| 1904 | 1740 html When the clipboard contains HTML, use this when |
| 1741 pasting. When putting text on the clipboard, mark it | |
| 1742 as HTML. This works to copy rendered HTML from | |
| 1743 Firefox, paste it as raw HTML in Vim, select the HTML | |
| 1744 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
|
1745 You probably want to add this only temporarily, |
|
6b4879aea261
Add test for gettabvar() and settabvar().
Bram Moolenaar <bram@vim.org>
parents:
2220
diff
changeset
|
1746 possibly use BufEnter autocommands. |
| 1904 | 1747 Only supported for GTK version 2 and later. |
| 1748 | |
| 3674 | 1749 *clipboard-exclude* |
| 7 | 1750 exclude:{pattern} |
| 1751 Defines a pattern that is matched against the name of | |
| 1752 the terminal 'term'. If there is a match, no | |
| 1753 connection will be made to the X server. This is | |
| 1754 useful in this situation: | |
| 1755 - Running Vim in a console. | |
| 1756 - $DISPLAY is set to start applications on another | |
| 1757 display. | |
| 1758 - You do not want to connect to the X server in the | |
| 1759 console, but do want this in a terminal emulator. | |
| 1760 To never connect to the X server use: > | |
| 1761 exclude:.* | |
| 1762 < This has the same effect as using the |-X| argument. | |
| 1763 Note that when there is no connection to the X server | |
| 1764 the window title won't be restored and the clipboard | |
| 1765 cannot be accessed. | |
| 1766 The value of 'magic' is ignored, {pattern} is | |
| 1767 interpreted as if 'magic' was on. | |
| 1768 The rest of the option value will be used for | |
| 1769 {pattern}, this must be the last entry. | |
| 1770 | |
| 1771 *'cmdheight'* *'ch'* | |
| 1772 'cmdheight' 'ch' number (default 1) | |
| 1773 global | |
| 1774 Number of screen lines to use for the command-line. Helps avoiding | |
| 1775 |hit-enter| prompts. | |
| 824 | 1776 The value of this option is stored with the tab page, so that each tab |
| 1777 page can have a different value. | |
| 7 | 1778 |
| 1779 *'cmdwinheight'* *'cwh'* | |
| 1780 'cmdwinheight' 'cwh' number (default 7) | |
| 1781 global | |
| 1782 Number of screen lines to use for the command-line window. |cmdwin| | |
| 1783 | |
|
2608
7d8af31066c8
Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents:
2607
diff
changeset
|
1784 *'colorcolumn'* *'cc'* |
|
7d8af31066c8
Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents:
2607
diff
changeset
|
1785 'colorcolumn' 'cc' string (default "") |
|
7d8af31066c8
Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents:
2607
diff
changeset
|
1786 local to window |
|
7d8af31066c8
Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents:
2607
diff
changeset
|
1787 {not available when compiled without the |+syntax| |
|
7d8af31066c8
Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents:
2607
diff
changeset
|
1788 feature} |
| 28379 | 1789 '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
|
1790 highlighted with ColorColumn |hl-ColorColumn|. Useful to align |
|
7d8af31066c8
Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents:
2607
diff
changeset
|
1791 text. Will make screen redrawing slower. |
|
7d8af31066c8
Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents:
2607
diff
changeset
|
1792 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
|
1793 '+' or '-', which is added to or subtracted from 'textwidth'. > |
|
7d8af31066c8
Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents:
2607
diff
changeset
|
1794 |
|
7d8af31066c8
Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents:
2607
diff
changeset
|
1795 :set cc=+1 " highlight column after 'textwidth' |
|
7d8af31066c8
Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents:
2607
diff
changeset
|
1796 :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
|
1797 :hi ColorColumn ctermbg=lightgrey guibg=lightgrey |
|
7d8af31066c8
Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents:
2607
diff
changeset
|
1798 < |
|
7d8af31066c8
Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents:
2607
diff
changeset
|
1799 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
|
1800 A maximum of 256 columns are highlighted. |
|
7d8af31066c8
Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents:
2607
diff
changeset
|
1801 |
| 7 | 1802 *'columns'* *'co'* *E594* |
| 1803 'columns' 'co' number (default 80 or terminal width) | |
| 1804 global | |
| 1805 Number of columns of the screen. Normally this is set by the terminal | |
| 161 | 1806 initialization and does not have to be set by hand. Also see |
| 1807 |posix-screen-size|. | |
| 7 | 1808 When Vim is running in the GUI or in a resizable window, setting this |
| 1809 option will cause the window size to be changed. When you only want | |
| 1810 to use the size for the GUI, put the command in your |gvimrc| file. | |
| 1811 When you set this option and Vim is unable to change the physical | |
| 1152 | 1812 number of columns of the display, the display may be messed up. For |
| 1813 the GUI it is always possible and Vim limits the number of columns to | |
| 1814 what fits on the screen. You can use this command to get the widest | |
| 1815 window possible: > | |
| 1816 :set columns=9999 | |
| 1817 < Minimum value is 12, maximum value is 10000. | |
| 7 | 1818 |
| 1819 *'comments'* *'com'* *E524* *E525* | |
| 1820 'comments' 'com' string (default | |
| 1821 "s1:/*,mb:*,ex:*/,://,b:#,:%,:XCOMM,n:>,fb:-") | |
| 1822 local to buffer | |
| 28379 | 1823 A comma-separated list of strings that can start a comment line. See |
| 7 | 1824 |format-comments|. See |option-backslash| about using backslashes to |
| 1825 insert a space. | |
| 1826 | |
| 1827 *'commentstring'* *'cms'* *E537* | |
| 1828 'commentstring' 'cms' string (default "/*%s*/") | |
| 1829 local to buffer | |
| 1830 {not available when compiled without the |+folding| | |
| 1831 feature} | |
| 1832 A template for a comment. The "%s" in the value is replaced with the | |
| 1833 comment text. Currently only used to add markers for folding, see | |
| 1834 |fold-marker|. | |
| 1835 | |
| 1836 *'compatible'* *'cp'* *'nocompatible'* *'nocp'* | |
| 819 | 1837 '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
|
1838 file is found, reset in |defaults.vim|) |
| 7 | 1839 global |
| 1840 This option has the effect of making Vim either more Vi-compatible, or | |
| 1841 make Vim behave in a more useful way. | |
| 11062 | 1842 |
| 7 | 1843 This is a special kind of option, because when it's set or reset, |
| 11062 | 1844 other options are also changed as a side effect. |
| 1845 NOTE: Setting or resetting this option can have a lot of unexpected | |
| 1846 effects: Mappings are interpreted in another way, undo behaves | |
| 1847 differently, etc. If you set this option in your vimrc file, you | |
| 1848 should probably put it at the very start. | |
| 1849 | |
| 7 | 1850 By default this option is on and the Vi defaults are used for the |
| 1851 options. This default was chosen for those people who want to use Vim | |
| 1852 just like Vi, and don't even (want to) know about the 'compatible' | |
| 1853 option. | |
| 819 | 1854 When a |vimrc| or |gvimrc| file is found while Vim is starting up, |
| 378 | 1855 this option is switched off, and all options that have not been |
| 1856 modified will be set to the Vim defaults. Effectively, this means | |
| 819 | 1857 that when a |vimrc| or |gvimrc| file exists, Vim will use the Vim |
| 378 | 1858 defaults, otherwise it will use the Vi defaults. (Note: This doesn't |
| 1152 | 1859 happen for the system-wide vimrc or gvimrc file, nor for a file given |
| 1860 with the |-u| argument). Also see |compatible-default| and | |
| 1861 |posix-compliance|. | |
| 7 | 1862 You can also set this option with the "-C" argument, and reset it with |
| 1863 "-N". See |-C| and |-N|. | |
| 11062 | 1864 See 'cpoptions' for more fine tuning of Vi compatibility. |
| 1865 | |
| 1866 When this option is set, numerous other options are set to make Vim as | |
| 1867 Vi-compatible as possible. When this option is unset, various options | |
| 1868 are set to make Vim more useful. The table below lists all the | |
| 1869 options affected. | |
| 1870 The {?} column indicates when the options are affected: | |
| 1871 + Means that the option is set to the value given in {set value} when | |
| 1872 'compatible' is set. | |
| 1873 & Means that the option is set to the value given in {set value} when | |
| 1874 'compatible' is set AND is set to its Vim default value when | |
| 1875 'compatible' is unset. | |
| 1876 - Means the option is NOT changed when setting 'compatible' but IS | |
| 1877 set to its Vim default when 'compatible' is unset. | |
| 1878 The {effect} column summarises the change when 'compatible' is set. | |
| 1879 | |
| 11160 | 1880 option ? set value effect ~ |
| 11062 | 1881 |
| 1882 'allowrevins' + off no CTRL-_ command | |
| 1883 'antialias' + off don't use antialiased fonts | |
| 1884 'arabic' + off reset arabic-related options | |
| 1885 'arabicshape' + on correct character shapes | |
| 1886 'backspace' + "" normal backspace | |
| 1887 'backup' + off no backup file | |
| 1888 'backupcopy' & Unix: "yes" backup file is a copy | |
| 1889 else: "auto" copy or rename backup file | |
| 1890 'balloonexpr' + "" text to show in evaluation balloon | |
| 1891 'breakindent' + off don't indent when wrapping lines | |
| 1892 '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
|
1893 'cdhome' + off ":cd" don't chdir to home on non-Unix |
| 11062 | 1894 'cindent' + off no C code indentation |
| 1895 'compatible' - {unchanged} {set vim default only on resetting 'cp'} | |
| 1896 'copyindent' + off don't copy indent structure | |
| 1897 'cpoptions' & (all flags) Vi-compatible flags | |
| 1898 'cscopepathcomp'+ 0 don't show directories in tags list | |
|
13341
acd7eaa13d2b
Updated runtime files.
Christian Brabandt <cb@256bit.org>
parents:
13314
diff
changeset
|
1899 'cscoperelative'+ off don't use basename of path as prefix |
| 11062 | 1900 'cscopetag' + off don't use cscope for ":tag" |
| 11160 | 1901 'cscopetagorder'+ 0 see |cscopetagorder| |
| 11062 | 1902 'cscopeverbose' + off see |cscopeverbose| |
| 1903 'delcombine' + off unicode: delete whole char combination | |
| 1904 'digraph' + off no digraphs | |
| 1905 'esckeys' & off no <Esc>-keys in Insert mode | |
| 1906 'expandtab' + off tabs not expanded to spaces | |
| 1907 '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
|
1908 "dos,unix" except for MS-Windows |
| 11062 | 1909 'formatexpr' + "" use 'formatprg' for auto-formatting |
| 1910 'formatoptions' & "vt" Vi compatible formatting | |
| 1911 'gdefault' + off no default 'g' flag for ":s" | |
| 1912 'history' & 0 no commandline history | |
| 1913 'hkmap' + off no Hebrew keyboard mapping | |
| 1914 'hkmapp' + off no phonetic Hebrew keyboard mapping | |
| 1915 'hlsearch' + off no highlighting of search matches | |
| 1916 'incsearch' + off no incremental searching | |
| 1917 'indentexpr' + "" no indenting by expression | |
| 1918 'insertmode' + off do not start in Insert mode | |
| 1919 'iskeyword' & "@,48-57,_" keywords contain alphanumeric | |
| 7 | 1920 characters and '_' |
| 11062 | 1921 'joinspaces' + on insert 2 spaces after period |
| 1922 'modeline' & off no modelines | |
| 1923 'more' & off no pauses in listings | |
| 1924 'mzquantum' - {unchanged} {set vim default only on resetting 'cp'} | |
| 1925 'numberwidth' & 8 min number of columns for line number | |
| 1926 'preserveindent'+ off don't preserve current indent structure | |
| 1927 when changing it | |
| 1928 'revins' + off no reverse insert | |
| 1929 'ruler' + off no ruler | |
| 1930 'scrolljump' + 1 no jump scroll | |
| 1931 'scrolloff' + 0 no scroll offset | |
| 1932 'shelltemp' - {unchanged} {set vim default only on resetting 'cp'} | |
| 1933 '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
|
1934 'shortmess' & "S" no shortening of messages |
| 11062 | 1935 'showcmd' & off command characters not shown |
| 1936 'showmode' & off current mode not shown | |
| 1937 'sidescrolloff' + 0 cursor moves to edge of screen in scroll | |
| 1938 'smartcase' + off no automatic ignore case switch | |
| 1939 'smartindent' + off no smart indentation | |
| 1940 'smarttab' + off no smart tab size | |
| 1941 'softtabstop' + 0 tabs are always 'tabstop' positions | |
| 1942 'startofline' + on goto startofline with some commands | |
| 1943 'tagcase' & "followic" 'ignorecase' when searching tags file | |
| 1944 'tagrelative' & off tag file names are not relative | |
| 1945 'termguicolors' + off don't use highlight-(guifg|guibg) | |
| 1946 'textauto' & off no automatic textmode detection | |
| 1947 'textwidth' + 0 no automatic line wrap | |
| 1948 'tildeop' + off tilde is not an operator | |
| 1949 'ttimeout' + off no terminal timeout | |
| 1950 'undofile' + off don't use an undo file | |
| 11160 | 1951 'viminfo' - {unchanged} {set Vim default only on resetting 'cp'} |
| 11062 | 1952 'virtualedit' + "" cursor can only be placed on characters |
| 1953 'whichwrap' & "" left-right movements don't wrap | |
| 1954 'wildchar' & CTRL-E only when the current value is <Tab> | |
| 7 | 1955 use CTRL-E for cmdline completion |
| 11062 | 1956 'writebackup' + on or off depends on the |+writebackup| feature |
| 7 | 1957 |
| 1958 *'complete'* *'cpt'* *E535* | |
| 1959 'complete' 'cpt' string (default: ".,w,b,u,t,i") | |
| 1960 local to buffer | |
| 1961 This option specifies how keyword completion |ins-completion| works | |
| 1962 when CTRL-P or CTRL-N are used. It is also used for whole-line | |
| 1963 completion |i_CTRL-X_CTRL-L|. It indicates the type of completion | |
| 28379 | 1964 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
|
1965 . scan the current buffer ('wrapscan' is ignored) |
| 7 | 1966 w scan buffers from other windows |
| 1967 b scan other loaded buffers that are in the buffer list | |
| 1968 u scan the unloaded buffers that are in the buffer list | |
| 1969 U scan the buffers that are not in the buffer list | |
| 1970 k scan the files given with the 'dictionary' option | |
| 703 | 1971 kspell use the currently active spell checking |spell| |
| 7 | 1972 k{dict} scan the file {dict}. Several "k" flags can be given, |
| 1973 patterns are valid too. For example: > | |
| 1974 :set cpt=k/usr/dict/*,k~/spanish | |
| 1975 < s scan the files given with the 'thesaurus' option | |
| 1976 s{tsr} scan the file {tsr}. Several "s" flags can be given, patterns | |
| 1977 are valid too. | |
| 1978 i scan current and included files | |
| 1979 d scan current and included files for defined name or macro | |
| 1980 |i_CTRL-X_CTRL-D| | |
| 1981 ] tag completion | |
| 1982 t same as "]" | |
| 1983 | |
| 1984 Unloaded buffers are not loaded, thus their autocmds |:autocmd| are | |
| 1985 not executed, this may lead to unexpected completions from some files | |
| 1986 (gzipped files for example). Unloaded buffers are not scanned for | |
| 1987 whole-line completion. | |
| 1988 | |
| 1989 The default is ".,w,b,u,t,i", which means to scan: | |
| 1990 1. the current buffer | |
| 1991 2. buffers in other windows | |
| 1992 3. other loaded buffers | |
| 1993 4. unloaded buffers | |
| 1994 5. tags | |
| 1995 6. included files | |
| 1996 | |
| 1997 As you can see, CTRL-N and CTRL-P can be used to do any 'iskeyword'- | |
| 233 | 1998 based expansion (e.g., dictionary |i_CTRL-X_CTRL-K|, included patterns |
| 1999 |i_CTRL-X_CTRL-I|, tags |i_CTRL-X_CTRL-]| and normal expansions). | |
| 7 | 2000 |
| 12 | 2001 *'completefunc'* *'cfu'* |
| 2002 'completefunc' 'cfu' string (default: empty) | |
| 2003 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
|
2004 {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
|
2005 feature} |
| 623 | 2006 This option specifies a function to be used for Insert mode completion |
| 2007 with CTRL-X CTRL-U. |i_CTRL-X_CTRL-U| | |
| 648 | 2008 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
|
2009 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
|
2010 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
|
2011 more information. |
| 2642 | 2012 This option cannot be set from a |modeline| or in the |sandbox|, for |
| 2013 security reasons. | |
| 14 | 2014 |
|
17543
77c3f6428b6c
patch 8.1.1769: 'shellslash' is also used for completion
Bram Moolenaar <Bram@vim.org>
parents:
17433
diff
changeset
|
2015 *'completeslash'* *'csl'* |
|
77c3f6428b6c
patch 8.1.1769: 'shellslash' is also used for completion
Bram Moolenaar <Bram@vim.org>
parents:
17433
diff
changeset
|
2016 'completeslash' 'csl' string (default: "") |
|
77c3f6428b6c
patch 8.1.1769: 'shellslash' is also used for completion
Bram Moolenaar <Bram@vim.org>
parents:
17433
diff
changeset
|
2017 local to buffer |
| 18343 | 2018 {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
|
2019 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
|
2020 - 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
|
2021 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
|
2022 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
|
2023 - 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
|
2024 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
|
2025 - 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
|
2026 'shellslash'. |
|
77c3f6428b6c
patch 8.1.1769: 'shellslash' is also used for completion
Bram Moolenaar <Bram@vim.org>
parents:
17433
diff
changeset
|
2027 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
|
2028 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
|
2029 |
| 540 | 2030 *'completeopt'* *'cot'* |
| 730 | 2031 'completeopt' 'cot' string (default: "menu,preview") |
| 540 | 2032 global |
| 28379 | 2033 A comma-separated list of options for Insert mode completion |
| 665 | 2034 |ins-completion|. The supported values are: |
| 540 | 2035 |
| 2036 menu Use a popup menu to show the possible completions. The | |
| 2037 menu is only shown when there is more than one match and | |
| 2038 sufficient colors are available. |ins-completion-menu| | |
| 2039 | |
| 707 | 2040 menuone Use the popup menu also when there is only one match. |
| 856 | 2041 Useful when there is additional information about the |
| 707 | 2042 match, e.g., what file it comes from. |
| 2043 | |
| 836 | 2044 longest Only insert the longest common text of the matches. If |
| 2045 the menu is displayed you can use CTRL-L to add more | |
| 2046 characters. Whether case is ignored depends on the kind | |
| 2047 of completion. For buffer text the 'ignorecase' option is | |
| 2048 used. | |
| 665 | 2049 |
| 730 | 2050 preview Show extra information about the currently selected |
| 1152 | 2051 completion in the preview window. Only works in |
| 2052 combination with "menu" or "menuone". | |
| 2053 | |
|
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
|
2054 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
|
2055 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
|
2056 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
|
2057 See |'completepopup'| for specifying properties. |
| 18343 | 2058 {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
|
2059 |
|
18396
ba5d8c5d77d7
patch 8.1.2192: cannot easily fill the info popup asynchronously
Bram Moolenaar <Bram@vim.org>
parents:
18372
diff
changeset
|
2060 popuphidden |
| 18719 | 2061 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
|
2062 |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
|
2063 |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
|
2064 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
|
2065 {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
|
2066 |
| 6911 | 2067 noinsert Do not insert any text for a match until the user selects |
| 2068 a match from the menu. Only works in combination with | |
| 2069 "menu" or "menuone". No effect if "longest" is present. | |
| 2070 | |
| 2071 noselect Do not select a match in the menu, force the user to | |
| 2072 select one from the menu. Only works in combination with | |
| 2073 "menu" or "menuone". | |
| 2074 | |
| 730 | 2075 |
|
17771
4bd21046902b
patch 8.1.1882: cannot specify properties of the info popup window
Bram Moolenaar <Bram@vim.org>
parents:
17767
diff
changeset
|
2076 *'completepopup'* *'cpp'* |
|
4bd21046902b
patch 8.1.1882: cannot specify properties of the info popup window
Bram Moolenaar <Bram@vim.org>
parents:
17767
diff
changeset
|
2077 '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
|
2078 global |
|
4bd21046902b
patch 8.1.1882: cannot specify properties of the info popup window
Bram Moolenaar <Bram@vim.org>
parents:
17767
diff
changeset
|
2079 {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
|
2080 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
|
2081 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
|
2082 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
|
2083 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
|
2084 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
|
2085 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
|
2086 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
|
2087 |
|
4bd21046902b
patch 8.1.1882: cannot specify properties of the info popup window
Bram Moolenaar <Bram@vim.org>
parents:
17767
diff
changeset
|
2088 |
|
2378
85b7dc8da5eb
Add the 'concealcursor' option to decide when the cursor line is to be
Bram Moolenaar <bram@vim.org>
parents:
2365
diff
changeset
|
2089 *'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
|
2090 '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
|
2091 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
|
2092 {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
|
2093 feature} |
|
85b7dc8da5eb
Add the 'concealcursor' option to decide when the cursor line is to be
Bram Moolenaar <bram@vim.org>
parents:
2365
diff
changeset
|
2094 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
|
2095 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
|
2096 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
|
2097 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
|
2098 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
|
2099 i Insert mode |
|
2382
3a5ededa240a
Add the 'c' flag to 'concealcursor'.
Bram Moolenaar <bram@vim.org>
parents:
2380
diff
changeset
|
2100 c Command line editing, for 'incsearch' |
|
3a5ededa240a
Add the 'c' flag to 'concealcursor'.
Bram Moolenaar <bram@vim.org>
parents:
2380
diff
changeset
|
2101 |
|
2400
e6f1424dd66a
Let 'v' flag in 'concealcursor' apply to all lines in the Visual area.
Bram Moolenaar <bram@vim.org>
parents:
2394
diff
changeset
|
2102 '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
|
2103 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
|
2104 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
|
2105 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
|
2106 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
|
2107 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
|
2108 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
|
2109 |
|
85b7dc8da5eb
Add the 'concealcursor' option to decide when the cursor line is to be
Bram Moolenaar <bram@vim.org>
parents:
2365
diff
changeset
|
2110 |
| 14864 | 2111 *'conceallevel'* *'cole'* |
| 2112 'conceallevel' 'cole' number (default 0) | |
|
2250
1bac28a53fae
Add the conceal patch from Vince Negri.
Bram Moolenaar <bram@vim.org>
parents:
2249
diff
changeset
|
2113 local to window |
|
1bac28a53fae
Add the conceal patch from Vince Negri.
Bram Moolenaar <bram@vim.org>
parents:
2249
diff
changeset
|
2114 {not available when compiled without the |+conceal| |
|
1bac28a53fae
Add the conceal patch from Vince Negri.
Bram Moolenaar <bram@vim.org>
parents:
2249
diff
changeset
|
2115 feature} |
|
2340
99c1eba60b2d
Make automatic prototype generation work with more interfaces.
Bram Moolenaar <bram@vim.org>
parents:
2337
diff
changeset
|
2116 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
|
2117 is shown: |
|
99c1eba60b2d
Make automatic prototype generation work with more interfaces.
Bram Moolenaar <bram@vim.org>
parents:
2337
diff
changeset
|
2118 |
|
99c1eba60b2d
Make automatic prototype generation work with more interfaces.
Bram Moolenaar <bram@vim.org>
parents:
2337
diff
changeset
|
2119 Value Effect ~ |
|
2250
1bac28a53fae
Add the conceal patch from Vince Negri.
Bram Moolenaar <bram@vim.org>
parents:
2249
diff
changeset
|
2120 0 Text is shown normally |
| 2426 | 2121 1 Each block of concealed text is replaced with one |
| 2122 character. If the syntax item does not have a custom | |
| 2123 replacement character defined (see |:syn-cchar|) the | |
| 2124 character defined in 'listchars' is used (default is a | |
| 2125 space). | |
| 2126 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
|
2127 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
|
2128 custom replacement character defined (see |
| 2426 | 2129 |: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
|
2130 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
|
2131 |
|
586a459f3980
Never hide text for conceal in cursor line. Do hide when there is
Bram Moolenaar <bram@vim.org>
parents:
2348
diff
changeset
|
2132 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
|
2133 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
|
2134 option. |
|
2250
1bac28a53fae
Add the conceal patch from Vince Negri.
Bram Moolenaar <bram@vim.org>
parents:
2249
diff
changeset
|
2135 |
| 7 | 2136 *'confirm'* *'cf'* *'noconfirm'* *'nocf'* |
| 2137 'confirm' 'cf' boolean (default off) | |
| 2138 global | |
| 2139 When 'confirm' is on, certain operations that would normally | |
| 2140 fail because of unsaved changes to a buffer, e.g. ":q" and ":e", | |
| 2141 instead raise a |dialog| asking if you wish to save the current | |
| 2142 file(s). You can still use a ! to unconditionally |abandon| a buffer. | |
| 2143 If 'confirm' is off you can still activate confirmation for one | |
| 2144 command only (this is most useful in mappings) with the |:confirm| | |
| 2145 command. | |
| 2146 Also see the |confirm()| function and the 'v' flag in 'guioptions'. | |
| 2147 | |
| 2148 *'conskey'* *'consk'* *'noconskey'* *'noconsk'* | |
| 2149 'conskey' 'consk' boolean (default off) | |
| 2150 global | |
|
8246
f16bfe02cef1
commit https://github.com/vim/vim/commit/f391327adbbffb11180cf6038a92af1ed144e907
Christian Brabandt <cb@256bit.org>
parents:
8182
diff
changeset
|
2151 This was for MS-DOS and is no longer supported. |
| 7 | 2152 |
| 2153 *'copyindent'* *'ci'* *'nocopyindent'* *'noci'* | |
| 2154 'copyindent' 'ci' boolean (default off) | |
| 2155 local to buffer | |
| 2156 Copy the structure of the existing lines indent when autoindenting a | |
| 2157 new line. Normally the new indent is reconstructed by a series of | |
| 2158 tabs followed by spaces as required (unless |'expandtab'| is enabled, | |
| 2159 in which case only spaces are used). Enabling this option makes the | |
| 2160 new line copy whatever characters were used for indenting on the | |
| 1621 | 2161 existing line. 'expandtab' has no effect on these characters, a Tab |
| 2162 remains a Tab. If the new indent is greater than on the existing | |
| 7 | 2163 line, the remaining space is filled in the normal manner. |
| 11160 | 2164 NOTE: This option is reset when 'compatible' is set. |
| 7 | 2165 Also see 'preserveindent'. |
| 2166 | |
|
8148
f5da459c5698
commit https://github.com/vim/vim/commit/e0fa3742ead676a3074a10edadbc955e1a89153d
Christian Brabandt <cb@256bit.org>
parents:
8061
diff
changeset
|
2167 *'cpoptions'* *'cpo'* *cpo* |
| 7 | 2168 'cpoptions' 'cpo' string (Vim default: "aABceFs", |
| 2169 Vi default: all flags) | |
| 2170 global | |
| 2171 A sequence of single character flags. When a character is present | |
| 5340 | 2172 this indicates Vi-compatible behavior. This is used for things where |
| 2173 not being Vi-compatible is mostly or sometimes preferred. | |
| 7 | 2174 'cpoptions' stands for "compatible-options". |
| 2175 Commas can be added for readability. | |
| 2176 To avoid problems with flags that are added in the future, use the | |
| 2177 "+=" 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
|
2178 |
| 7 | 2179 NOTE: This option is set to the Vi default value when 'compatible' is |
| 2180 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
|
2181 |
|
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
|
2182 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
|
2183 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
|
2184 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
|
2185 '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
|
2186 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
|
2187 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
|
2188 `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
|
2189 |
| 164 | 2190 NOTE: This option is set to the POSIX default value at startup when |
| 2191 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
|
2192 variable exists |posix|. This means Vim tries to behave like the |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
2193 POSIX specification. |
| 7 | 2194 |
| 2195 contains behavior ~ | |
| 2196 *cpo-a* | |
| 2197 a When included, a ":read" command with a file name | |
| 2198 argument will set the alternate file name for the | |
| 2199 current window. | |
| 2200 *cpo-A* | |
| 2201 A When included, a ":write" command with a file name | |
| 2202 argument will set the alternate file name for the | |
| 2203 current window. | |
| 2204 *cpo-b* | |
| 2205 b "\|" in a ":map" command is recognized as the end of | |
| 2206 the map command. The '\' is included in the mapping, | |
| 2207 the text after the '|' is interpreted as the next | |
| 2208 command. Use a CTRL-V instead of a backslash to | |
| 2209 include the '|' in the mapping. Applies to all | |
| 2210 mapping, abbreviation, menu and autocmd commands. | |
| 2211 See also |map_bar|. | |
| 2212 *cpo-B* | |
| 2213 B A backslash has no special meaning in mappings, | |
| 14372 | 2214 abbreviations, user commands and the "to" part of the |
| 2215 menu commands. Remove this flag to be able to use a | |
| 2216 backslash like a CTRL-V. For example, the command | |
| 2217 ":map X \<Esc>" results in X being mapped to: | |
| 7 | 2218 'B' included: "\^[" (^[ is a real <Esc>) |
| 2219 'B' excluded: "<Esc>" (5 characters) | |
| 2220 ('<' excluded in both cases) | |
| 2221 *cpo-c* | |
| 2222 c Searching continues at the end of any match at the | |
| 2223 cursor position, but not further than the start of the | |
| 2224 next line. When not present searching continues | |
| 2225 one character from the cursor position. With 'c' | |
| 2226 "abababababab" only gets three matches when repeating | |
| 2227 "/abab", without 'c' there are five matches. | |
| 2228 *cpo-C* | |
| 2229 C Do not concatenate sourced lines that start with a | |
| 2230 backslash. See |line-continuation|. | |
| 2231 *cpo-d* | |
| 2232 d Using "./" in the 'tags' option doesn't mean to use | |
| 2233 the tags file relative to the current file, but the | |
| 2234 tags file in the current directory. | |
| 2235 *cpo-D* | |
| 2236 D Can't use CTRL-K to enter a digraph after Normal mode | |
| 2237 commands with a character argument, like |r|, |f| and | |
| 2238 |t|. | |
| 2239 *cpo-e* | |
| 2240 e When executing a register with ":@r", always add a | |
| 2241 <CR> to the last line, also when the register is not | |
| 2242 linewise. If this flag is not present, the register | |
| 2243 is not linewise and the last line does not end in a | |
| 2244 <CR>, then the last line is put on the command-line | |
| 2245 and can be edited before hitting <CR>. | |
| 2246 *cpo-E* | |
| 2247 E It is an error when using "y", "d", "c", "g~", "gu" or | |
| 2248 "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
|
2249 at least one character is to be operated on. Example: |
| 7 | 2250 This makes "y0" fail in the first column. |
| 2251 *cpo-f* | |
| 2252 f When included, a ":read" command with a file name | |
| 2253 argument will set the file name for the current buffer, | |
| 2254 if the current buffer doesn't have a file name yet. | |
| 2255 *cpo-F* | |
| 2256 F When included, a ":write" command with a file name | |
| 2257 argument will set the file name for the current | |
| 2258 buffer, if the current buffer doesn't have a file name | |
| 590 | 2259 yet. Also see |cpo-P|. |
| 7 | 2260 *cpo-g* |
| 2261 g Goto line 1 when using ":edit" without argument. | |
| 164 | 2262 *cpo-H* |
| 2263 H When using "I" on a line with only blanks, insert | |
| 2264 before the last blank. Without this flag insert after | |
| 2265 the last blank. | |
| 7 | 2266 *cpo-i* |
| 2267 i When included, interrupting the reading of a file will | |
| 2268 leave it modified. | |
| 10 | 2269 *cpo-I* |
| 2270 I When moving the cursor up or down just after inserting | |
| 2271 indent for 'autoindent', do not delete the indent. | |
| 7 | 2272 *cpo-j* |
| 2273 j When joining lines, only add two spaces after a '.', | |
| 2274 not after '!' or '?'. Also see 'joinspaces'. | |
| 2275 *cpo-J* | |
| 2276 J A |sentence| has to be followed by two spaces after | |
| 233 | 2277 the '.', '!' or '?'. A <Tab> is not recognized as |
| 7 | 2278 white space. |
| 2279 *cpo-k* | |
| 2280 k Disable the recognition of raw key codes in | |
| 2281 mappings, abbreviations, and the "to" part of menu | |
| 2282 commands. For example, if <Key> sends ^[OA (where ^[ | |
| 2283 is <Esc>), the command ":map X ^[OA" results in X | |
| 2284 being mapped to: | |
| 2285 'k' included: "^[OA" (3 characters) | |
| 2286 'k' excluded: "<Key>" (one key code) | |
| 2287 Also see the '<' flag below. | |
| 2288 *cpo-K* | |
| 2289 K Don't wait for a key code to complete when it is | |
| 2290 halfway a mapping. This breaks mapping <F1><F1> when | |
| 2291 only part of the second <F1> has been read. It | |
| 2292 enables cancelling the mapping by typing <F1><Esc>. | |
| 2293 *cpo-l* | |
| 2294 l Backslash in a [] range in a search pattern is taken | |
| 168 | 2295 literally, only "\]", "\^", "\-" and "\\" are special. |
| 2296 See |/[]| | |
| 7 | 2297 'l' included: "/[ \t]" finds <Space>, '\' and 't' |
| 2298 'l' excluded: "/[ \t]" finds <Space> and <Tab> | |
| 168 | 2299 Also see |cpo-\|. |
| 7 | 2300 *cpo-L* |
| 2301 L When the 'list' option is set, 'wrapmargin', | |
| 2302 'textwidth', 'softtabstop' and Virtual Replace mode | |
| 2303 (see |gR|) count a <Tab> as two characters, instead of | |
| 2304 the normal behavior of a <Tab>. | |
| 2305 *cpo-m* | |
| 2306 m When included, a showmatch will always wait half a | |
| 2307 second. When not included, a showmatch will wait half | |
| 2308 a second or until a character is typed. |'showmatch'| | |
| 2309 *cpo-M* | |
| 2310 M When excluded, "%" matching will take backslashes into | |
| 2311 account. Thus in "( \( )" and "\( ( \)" the outer | |
| 2312 parenthesis match. When included "%" ignores | |
| 2313 backslashes, which is Vi compatible. | |
| 2314 *cpo-n* | |
|
2178
c6f1aa1e9f32
Add 'relativenumber' patch from Markus Heidelberg.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2315 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
|
2316 '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
|
2317 lines. |
| 7 | 2318 *cpo-o* |
| 2319 o Line offset to search command is not remembered for | |
| 2320 next search. | |
| 2321 *cpo-O* | |
| 2322 O Don't complain if a file is being overwritten, even | |
| 2323 when it didn't exist when editing it. This is a | |
| 2324 protection against a file unexpectedly created by | |
| 2325 someone else. Vi didn't complain about this. | |
| 2326 *cpo-p* | |
| 2327 p Vi compatible Lisp indenting. When not present, a | |
| 2328 slightly better algorithm is used. | |
| 590 | 2329 *cpo-P* |
| 2330 P When included, a ":write" command that appends to a | |
| 2331 file will set the file name for the current buffer, if | |
| 2332 the current buffer doesn't have a file name yet and | |
| 2333 the 'F' flag is also included |cpo-F|. | |
| 164 | 2334 *cpo-q* |
| 2335 q When joining multiple lines leave the cursor at the | |
| 2336 position where it would be when joining two lines. | |
| 7 | 2337 *cpo-r* |
| 2338 r Redo ("." command) uses "/" to repeat a search | |
| 2339 command, instead of the actually used search string. | |
| 2340 *cpo-R* | |
| 2341 R Remove marks from filtered lines. Without this flag | |
| 2342 marks are kept like |:keepmarks| was used. | |
| 2343 *cpo-s* | |
| 2344 s Set buffer options when entering the buffer for the | |
| 2345 first time. This is like it is in Vim version 3.0. | |
| 10 | 2346 And it is the default. If not present the options are |
| 7 | 2347 set when the buffer is created. |
| 2348 *cpo-S* | |
| 2349 S Set buffer options always when entering a buffer | |
| 2350 (except 'readonly', 'fileformat', 'filetype' and | |
| 2351 'syntax'). This is the (most) Vi compatible setting. | |
| 2352 The options are set to the values in the current | |
| 2353 buffer. When you change an option and go to another | |
| 2354 buffer, the value is copied. Effectively makes the | |
| 2355 buffer options global to all buffers. | |
| 2356 | |
| 2357 's' 'S' copy buffer options | |
| 2358 no no when buffer created | |
| 2359 yes no when buffer first entered (default) | |
| 2360 X yes each time when buffer entered (vi comp.) | |
| 2361 *cpo-t* | |
| 2362 t Search pattern for the tag command is remembered for | |
| 2363 "n" command. Otherwise Vim only puts the pattern in | |
| 2364 the history for search pattern, but doesn't change the | |
| 2365 last used search pattern. | |
| 2366 *cpo-u* | |
| 10 | 2367 u Undo is Vi compatible. See |undo-two-ways|. |
| 7 | 2368 *cpo-v* |
| 2369 v Backspaced characters remain visible on the screen in | |
| 2370 Insert mode. Without this flag the characters are | |
| 2371 erased from the screen right away. With this flag the | |
| 2372 screen newly typed text overwrites backspaced | |
| 2373 characters. | |
| 2374 *cpo-w* | |
| 2375 w When using "cw" on a blank character, only change one | |
| 2376 character and not all blanks until the start of the | |
| 2377 next word. | |
| 2378 *cpo-W* | |
| 2379 W Don't overwrite a readonly file. When omitted, ":w!" | |
| 2380 overwrites a readonly file, if possible. | |
| 2381 *cpo-x* | |
| 2382 x <Esc> on the command-line executes the command-line. | |
| 2383 The default in Vim is to abandon the command-line, | |
| 2384 because <Esc> normally aborts a command. |c_<Esc>| | |
| 164 | 2385 *cpo-X* |
| 2386 X When using a count with "R" the replaced text is | |
| 2387 deleted only once. Also when repeating "R" with "." | |
| 2388 and a count. | |
| 7 | 2389 *cpo-y* |
| 15512 | 2390 y A yank command can be redone with ".". Think twice if |
| 2391 you really want to use this, it may break some | |
| 2392 plugins, since most people expect "." to only repeat a | |
| 2393 change. | |
| 164 | 2394 *cpo-Z* |
| 2395 Z When using "w!" while the 'readonly' option is set, | |
| 2396 don't reset 'readonly'. | |
| 7 | 2397 *cpo-!* |
| 2398 ! When redoing a filter command, use the last used | |
| 2399 external command, whatever it was. Otherwise the last | |
| 2400 used -filter- command is used. | |
| 2401 *cpo-$* | |
| 2402 $ When making a change to one line, don't redisplay the | |
| 2403 line, but put a '$' at the end of the changed text. | |
| 2404 The changed text will be overwritten when you type the | |
| 2405 new text. The line is redisplayed if you type any | |
| 2406 command that moves the cursor from the insertion | |
| 2407 point. | |
| 2408 *cpo-%* | |
| 2409 % Vi-compatible matching is done for the "%" command. | |
| 2410 Does not recognize "#if", "#endif", etc. | |
| 2411 Does not recognize "/*" and "*/". | |
| 2412 Parens inside single and double quotes are also | |
| 2413 counted, causing a string that contains a paren to | |
| 2414 disturb the matching. For example, in a line like | |
| 2415 "if (strcmp("foo(", s))" the first paren does not | |
| 2416 match the last one. When this flag is not included, | |
| 2417 parens inside single and double quotes are treated | |
| 2418 specially. When matching a paren outside of quotes, | |
| 2419 everything inside quotes is ignored. When matching a | |
| 2420 paren inside quotes, it will find the matching one (if | |
| 10 | 2421 there is one). This works very well for C programs. |
| 36 | 2422 This flag is also used for other features, such as |
| 2423 C-indenting. | |
| 161 | 2424 *cpo--* |
| 2425 - When included, a vertical movement command fails when | |
| 632 | 2426 it would go above the first line or below the last |
| 2427 line. Without it the cursor moves to the first or | |
| 2428 last line, unless it already was in that line. | |
| 161 | 2429 Applies to the commands "-", "k", CTRL-P, "+", "j", |
| 632 | 2430 CTRL-N, CTRL-J and ":1234". |
| 39 | 2431 *cpo-+* |
| 2432 + When included, a ":write file" command will reset the | |
| 2433 'modified' flag of the buffer, even though the buffer | |
| 2434 itself may still be different from its file. | |
| 856 | 2435 *cpo-star* |
| 7 | 2436 * Use ":*" in the same way as ":@". When not included, |
| 2437 ":*" is an alias for ":'<,'>", select the Visual area. | |
| 2438 *cpo-<* | |
| 2439 < Disable the recognition of special key codes in |<>| | |
| 2440 form in mappings, abbreviations, and the "to" part of | |
| 10 | 2441 menu commands. For example, the command |
| 7 | 2442 ":map X <Tab>" results in X being mapped to: |
| 2443 '<' included: "<Tab>" (5 characters) | |
| 2444 '<' excluded: "^I" (^I is a real <Tab>) | |
| 2445 Also see the 'k' flag above. | |
| 164 | 2446 *cpo->* |
| 2447 > When appending to a register, put a line break before | |
| 2448 the appended text. | |
| 2925 | 2449 *cpo-;* |
| 2450 ; When using |,| or |;| to repeat the last |t| search | |
| 2451 and the cursor is right in front of the searched | |
| 2452 character, the cursor won't move. When not included, | |
| 2453 the cursor would skip over it and jump to the | |
| 3557 | 2454 following occurrence. |
| 164 | 2455 |
| 2456 POSIX flags. These are not included in the Vi default value, except | |
| 2457 when $VIM_POSIX was set on startup. |posix| | |
| 2458 | |
| 2459 contains behavior ~ | |
| 856 | 2460 *cpo-#* |
| 164 | 2461 # A count before "D", "o" and "O" has no effect. |
| 168 | 2462 *cpo-&* |
| 2463 & When ":preserve" was used keep the swap file when | |
| 2464 exiting normally while this buffer is still loaded. | |
| 2465 This flag is tested when exiting. | |
| 2466 *cpo-\* | |
| 2467 \ Backslash in a [] range in a search pattern is taken | |
| 2468 literally, only "\]" is special See |/[]| | |
| 488 | 2469 '\' included: "/[ \-]" finds <Space>, '\' and '-' |
| 2470 '\' excluded: "/[ \-]" finds <Space> and '-' | |
| 2471 Also see |cpo-l|. | |
| 168 | 2472 *cpo-/* |
| 2473 / When "%" is used as the replacement string in a |:s| | |
| 2474 command, use the previous replacement string. |:s%| | |
| 164 | 2475 *cpo-{* |
| 2476 { The |{| and |}| commands also stop at a "{" character | |
| 2477 at the start of a line. | |
| 168 | 2478 *cpo-.* |
| 2479 . The ":chdir" and ":cd" commands fail if the current | |
| 2480 buffer is modified, unless ! is used. Vim doesn't | |
| 2481 need this, since it remembers the full path of an | |
| 2482 opened file. | |
| 164 | 2483 *cpo-bar* |
| 2484 | The value of the $LINES and $COLUMNS environment | |
| 2485 variables overrule the terminal size values obtained | |
| 2486 with system specific functions. | |
| 2487 | |
| 7 | 2488 |
|
2180
f60a0c9cbe6c
Add the blowfish encryption patch from Mohsin Ahmed. Needs more work.
Bram Moolenaar <bram@vim.org>
parents:
2178
diff
changeset
|
2489 *'cryptmethod'* *'cm'* |
|
15192
690da0a83419
patch 8.1.0606: 'cryptmethod' defaults to a very old method
Bram Moolenaar <Bram@vim.org>
parents:
15131
diff
changeset
|
2490 '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
|
2491 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
|
2492 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
|
2493 *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
|
2494 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
|
2495 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
|
2496 *blowfish* |
| 6122 | 2497 blowfish Blowfish method. Medium strong encryption but it has |
| 2498 an implementation flaw. Requires Vim 7.3 or later, | |
| 2499 files can NOT be read by Vim 7.2 and older. This adds | |
| 2500 a "seed" to the file, every time you write the file | |
| 2501 the encrypted bytes will be different. | |
| 2502 *blowfish2* | |
| 2503 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
|
2504 Vim 7.4.401 or later, files can NOT be read by Vim 7.3 |
| 6122 | 2505 and older. This adds a "seed" to the file, every time |
| 2506 you write the file the encrypted bytes will be | |
| 2507 different. The whole undo file is encrypted, not just | |
| 2508 the pieces of text. | |
| 27537 | 2509 *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
|
2510 *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
|
2511 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
|
2512 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
|
2513 Encryption is provided by the libsodium library, it |
| 25973 | 2514 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
|
2515 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
|
2516 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
|
2517 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
|
2518 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
|
2519 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
|
2520 enabled. |
|
7e9e53a0368f
patch 8.2.3022: available encryption methods are not strong enough
Bram Moolenaar <Bram@vim.org>
parents:
24911
diff
changeset
|
2521 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
|
2522 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
|
2523 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
|
2524 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
|
2525 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
|
2526 |
|
8748
b1a19a2f73f0
commit https://github.com/vim/vim/commit/4f3f668c8486444e53163c29d2fc79bf47eb3c82
Christian Brabandt <cb@256bit.org>
parents:
8629
diff
changeset
|
2527 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
|
2528 |
|
2180
f60a0c9cbe6c
Add the blowfish encryption patch from Mohsin Ahmed. Needs more work.
Bram Moolenaar <bram@vim.org>
parents:
2178
diff
changeset
|
2529 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
|
2530 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
|
2531 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
|
2532 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
|
2533 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
|
2534 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
|
2535 |
|
d8e4b27cef80
Change 'cryptmethod' from a number to a string option. Make it global-local.
Bram Moolenaar <bram@vim.org>
parents:
2350
diff
changeset
|
2536 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
|
2537 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
|
2538 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
|
2539 |
|
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
|
2540 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
|
2541 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
|
2542 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
|
2543 |
|
f60a0c9cbe6c
Add the blowfish encryption patch from Mohsin Ahmed. Needs more work.
Bram Moolenaar <bram@vim.org>
parents:
2178
diff
changeset
|
2544 |
| 7 | 2545 *'cscopepathcomp'* *'cspc'* |
| 2546 'cscopepathcomp' 'cspc' number (default 0) | |
| 2547 global | |
| 2548 {not available when compiled without the |+cscope| | |
| 2549 feature} | |
| 2550 Determines how many components of the path to show in a list of tags. | |
| 2551 See |cscopepathcomp|. | |
| 11160 | 2552 NOTE: This option is set to 0 when 'compatible' is set. |
| 7 | 2553 |
| 2554 *'cscopeprg'* *'csprg'* | |
| 2555 'cscopeprg' 'csprg' string (default "cscope") | |
| 2556 global | |
| 2557 {not available when compiled without the |+cscope| | |
| 2558 feature} | |
| 2559 Specifies the command to execute cscope. See |cscopeprg|. | |
| 2560 This option cannot be set from a |modeline| or in the |sandbox|, for | |
| 2561 security reasons. | |
| 2562 | |
| 2563 *'cscopequickfix'* *'csqf'* | |
| 2564 'cscopequickfix' 'csqf' string (default "") | |
| 2565 global | |
| 2566 {not available when compiled without the |+cscope| | |
| 2567 or |+quickfix| features} | |
| 2568 Specifies whether to use quickfix window to show cscope results. | |
| 2569 See |cscopequickfix|. | |
| 2570 | |
| 4869 | 2571 *'cscoperelative'* *'csre'* *'nocscoperelative'* *'nocsre'* |
| 2873 | 2572 'cscoperelative' 'csre' boolean (default off) |
| 2573 global | |
| 2574 {not available when compiled without the |+cscope| | |
| 2575 feature} | |
| 2576 In the absence of a prefix (-P) for cscope. setting this option enables | |
| 2577 to use the basename of cscope.out path as the prefix. | |
| 2578 See |cscoperelative|. | |
| 11160 | 2579 NOTE: This option is reset when 'compatible' is set. |
| 2873 | 2580 |
| 7 | 2581 *'cscopetag'* *'cst'* *'nocscopetag'* *'nocst'* |
| 2582 'cscopetag' 'cst' boolean (default off) | |
| 2583 global | |
| 2584 {not available when compiled without the |+cscope| | |
| 2585 feature} | |
| 2586 Use cscope for tag commands. See |cscope-options|. | |
| 2587 NOTE: This option is reset when 'compatible' is set. | |
| 2588 | |
| 2589 *'cscopetagorder'* *'csto'* | |
| 2590 'cscopetagorder' 'csto' number (default 0) | |
| 2591 global | |
| 2592 {not available when compiled without the |+cscope| | |
| 2593 feature} | |
| 2594 Determines the order in which ":cstag" performs a search. See | |
| 2595 |cscopetagorder|. | |
| 2596 NOTE: This option is set to 0 when 'compatible' is set. | |
| 2597 | |
| 2598 *'cscopeverbose'* *'csverb'* | |
| 2599 *'nocscopeverbose'* *'nocsverb'* | |
| 2600 'cscopeverbose' 'csverb' boolean (default off) | |
| 2601 global | |
| 2602 {not available when compiled without the |+cscope| | |
| 2603 feature} | |
| 2604 Give messages when adding a cscope database. See |cscopeverbose|. | |
| 2605 NOTE: This option is reset when 'compatible' is set. | |
| 2606 | |
|
2250
1bac28a53fae
Add the conceal patch from Vince Negri.
Bram Moolenaar <bram@vim.org>
parents:
2249
diff
changeset
|
2607 *'cursorbind'* *'crb'* *'nocursorbind'* *'nocrb'* |
|
1bac28a53fae
Add the conceal patch from Vince Negri.
Bram Moolenaar <bram@vim.org>
parents:
2249
diff
changeset
|
2608 'cursorbind' 'crb' boolean (default off) |
|
1bac28a53fae
Add the conceal patch from Vince Negri.
Bram Moolenaar <bram@vim.org>
parents:
2249
diff
changeset
|
2609 local to window |
|
1bac28a53fae
Add the conceal patch from Vince Negri.
Bram Moolenaar <bram@vim.org>
parents:
2249
diff
changeset
|
2610 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
|
2611 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
|
2612 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
|
2613 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
|
2614 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
|
2615 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
|
2616 taken into account. |
|
2250
1bac28a53fae
Add the conceal patch from Vince Negri.
Bram Moolenaar <bram@vim.org>
parents:
2249
diff
changeset
|
2617 |
| 743 | 2618 |
| 2619 *'cursorcolumn'* *'cuc'* *'nocursorcolumn'* *'nocuc'* | |
| 2620 'cursorcolumn' 'cuc' boolean (default off) | |
| 2621 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
|
2622 {not available when compiled without the |+syntax| |
| 743 | 2623 feature} |
| 2624 Highlight the screen column of the cursor with CursorColumn | |
| 2625 |hl-CursorColumn|. Useful to align text. Will make screen redrawing | |
| 2626 slower. | |
| 826 | 2627 If you only want the highlighting in the current window you can use |
| 2628 these autocommands: > | |
| 2629 au WinLeave * set nocursorline nocursorcolumn | |
| 2630 au WinEnter * set cursorline cursorcolumn | |
| 2631 < | |
| 743 | 2632 |
| 2633 *'cursorline'* *'cul'* *'nocursorline'* *'nocul'* | |
| 2634 'cursorline' 'cul' boolean (default off) | |
| 2635 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
|
2636 {not available when compiled without the |+syntax| |
| 743 | 2637 feature} |
|
18047
6650e3dff8d4
patch 8.1.2019: 'cursorline' always highlights the whole line
Bram Moolenaar <Bram@vim.org>
parents:
17909
diff
changeset
|
2638 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
|
2639 Useful to easily spot the cursor. Will make screen redrawing slower. |
| 818 | 2640 When Visual mode is active the highlighting isn't used to make it |
| 825 | 2641 easier to see the selected text. |
| 743 | 2642 |
| 2643 | |
|
18047
6650e3dff8d4
patch 8.1.2019: 'cursorline' always highlights the whole line
Bram Moolenaar <Bram@vim.org>
parents:
17909
diff
changeset
|
2644 *'cursorlineopt'* *'culopt'* |
|
18068
1101eacc1444
patch 8.1.2029: cannot control 'cursorline' highlighting well
Bram Moolenaar <Bram@vim.org>
parents:
18053
diff
changeset
|
2645 '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
|
2646 local to window |
|
6650e3dff8d4
patch 8.1.2019: 'cursorline' always highlights the whole line
Bram Moolenaar <Bram@vim.org>
parents:
17909
diff
changeset
|
2647 {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
|
2648 feature} |
| 28379 | 2649 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
|
2650 Valid values: |
|
1101eacc1444
patch 8.1.2029: cannot control 'cursorline' highlighting well
Bram Moolenaar <Bram@vim.org>
parents:
18053
diff
changeset
|
2651 "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
|
2652 CursorLine |hl-CursorLine|. |
|
1101eacc1444
patch 8.1.2029: cannot control 'cursorline' highlighting well
Bram Moolenaar <Bram@vim.org>
parents:
18053
diff
changeset
|
2653 "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
|
2654 CursorLine |hl-CursorLine|. |
|
18068
1101eacc1444
patch 8.1.2029: cannot control 'cursorline' highlighting well
Bram Moolenaar <Bram@vim.org>
parents:
18053
diff
changeset
|
2655 "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
|
2656 CursorLineNr |hl-CursorLineNr|. |
|
18068
1101eacc1444
patch 8.1.2029: cannot control 'cursorline' highlighting well
Bram Moolenaar <Bram@vim.org>
parents:
18053
diff
changeset
|
2657 |
|
1101eacc1444
patch 8.1.2029: cannot control 'cursorline' highlighting well
Bram Moolenaar <Bram@vim.org>
parents:
18053
diff
changeset
|
2658 Special value: |
|
1101eacc1444
patch 8.1.2029: cannot control 'cursorline' highlighting well
Bram Moolenaar <Bram@vim.org>
parents:
18053
diff
changeset
|
2659 "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
|
2660 |
|
1101eacc1444
patch 8.1.2029: cannot control 'cursorline' highlighting well
Bram Moolenaar <Bram@vim.org>
parents:
18053
diff
changeset
|
2661 "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
|
2662 |
|
6650e3dff8d4
patch 8.1.2019: 'cursorline' always highlights the whole line
Bram Moolenaar <Bram@vim.org>
parents:
17909
diff
changeset
|
2663 |
| 7 | 2664 *'debug'* |
| 2665 'debug' string (default "") | |
| 2666 global | |
| 839 | 2667 These values can be used: |
| 2668 msg Error messages that would otherwise be omitted will be given | |
| 2669 anyway. | |
| 2670 throw Error messages that would otherwise be omitted will be given | |
| 2671 anyway and also throw an exception and set |v:errmsg|. | |
| 2672 beep A message will be given when otherwise only a beep would be | |
| 2673 produced. | |
| 168 | 2674 The values can be combined, separated by a comma. |
| 839 | 2675 "msg" and "throw" are useful for debugging 'foldexpr', 'formatexpr' or |
| 2676 'indentexpr'. | |
| 7 | 2677 |
| 2678 *'define'* *'def'* | |
| 2679 'define' 'def' string (default "^\s*#\s*define") | |
| 2680 global or local to buffer |global-local| | |
| 10 | 2681 Pattern to be used to find a macro definition. It is a search |
| 7 | 2682 pattern, just like for the "/" command. This option is used for the |
| 2683 commands like "[i" and "[d" |include-search|. The 'isident' option is | |
| 2684 used to recognize the defined name after the match: | |
| 2685 {match with 'define'}{non-ID chars}{defined name}{non-ID char} | |
| 2686 See |option-backslash| about inserting backslashes to include a space | |
| 2687 or backslash. | |
| 2688 The default value is for C programs. For C++ this value would be | |
| 2689 useful, to include const type declarations: > | |
| 2690 ^\(#\s*define\|[a-z]*\s*const\s*[a-z]*\) | |
| 16086 | 2691 < You can also use "\ze" just before the name and continue the pattern |
| 2692 to check what is following. E.g. for Javascript, if a function is | |
| 2693 defined with "func_name = function(args)": > | |
| 2694 ^\s*\ze\i\+\s*=\s*function( | |
| 2695 < If the function is defined with "func_name : function() {...": > | |
| 2696 ^\s*\ze\i\+\s*[:]\s*(*function\s*( | |
| 7 | 2697 < When using the ":set" command, you need to double the backslashes! |
| 16086 | 2698 To avoid that use `:let` with a single quote string: > |
| 2699 let &l:define = '^\s*\ze\k\+\s*=\s*function(' | |
| 16380 | 2700 < |
| 7 | 2701 |
| 2702 *'delcombine'* *'deco'* *'nodelcombine'* *'nodeco'* | |
| 2703 'delcombine' 'deco' boolean (default off) | |
| 2704 global | |
| 2705 If editing Unicode and this option is set, backspace and Normal mode | |
| 2706 "x" delete each combining character on its own. When it is off (the | |
| 2707 default) the character along with its combining characters are | |
| 2708 deleted. | |
| 22565 | 2709 Note: When 'delcombine' is set "xx" may work differently from "2x"! |
| 7 | 2710 |
| 2711 This is useful for Arabic, Hebrew and many other languages where one | |
| 2712 may have combining characters overtop of base characters, and want | |
| 2713 to remove only the combining ones. | |
| 11160 | 2714 NOTE: This option is reset when 'compatible' is set. |
| 7 | 2715 |
| 2716 *'dictionary'* *'dict'* | |
| 2717 'dictionary' 'dict' string (default "") | |
| 2718 global or local to buffer |global-local| | |
| 2719 List of file names, separated by commas, that are used to lookup words | |
| 2720 for keyword completion commands |i_CTRL-X_CTRL-K|. Each file should | |
| 2721 contain a list of words. This can be one word per line, or several | |
| 2722 words per line, separated by non-keyword characters (white space is | |
| 2723 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
|
2724 |
|
741b1feeac9f
patch 8.0.1845: various comment updates needed, missing white space
Christian Brabandt <cb@256bit.org>
parents:
13818
diff
changeset
|
2725 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
|
2726 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
|
2727 '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
|
2728 |
| 10 | 2729 To include a comma in a file name precede it with a backslash. Spaces |
| 7 | 2730 after a comma are ignored, otherwise spaces are included in the file |
| 2731 name. See |option-backslash| about using backslashes. | |
| 99 | 2732 This has nothing to do with the |Dictionary| variable type. |
| 7 | 2733 Where to find a list of words? |
| 2734 - On FreeBSD, there is the file "/usr/share/dict/words". | |
| 2735 - In the Simtel archive, look in the "msdos/linguist" directory. | |
| 2736 - In "miscfiles" of the GNU collection. | |
| 2737 The use of |:set+=| and |:set-=| is preferred when adding or removing | |
| 2738 directories from the list. This avoids problems when a future version | |
| 2739 uses another default. | |
| 2740 Backticks cannot be used in this option for security reasons. | |
| 2741 | |
| 2742 *'diff'* *'nodiff'* | |
| 2743 'diff' boolean (default off) | |
| 2744 local to window | |
| 2745 {not available when compiled without the |+diff| | |
| 2746 feature} | |
| 2747 Join the current window in the group of windows that shows differences | |
| 10 | 2748 between files. See |vimdiff|. |
| 7 | 2749 |
| 2750 *'dex'* *'diffexpr'* | |
| 2751 'diffexpr' 'dex' string (default "") | |
| 2752 global | |
| 2753 {not available when compiled without the |+diff| | |
| 2754 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
|
2755 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
|
2756 or unified-style) from two versions of a file. See |diff-diffexpr|. |
| 7 | 2757 This option cannot be set from a |modeline| or in the |sandbox|, for |
| 2758 security reasons. | |
| 2759 | |
| 2760 *'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
|
2761 'diffopt' 'dip' string (default "internal,filler,closeoff") |
| 7 | 2762 global |
| 2763 {not available when compiled without the |+diff| | |
| 2764 feature} | |
| 10 | 2765 Option settings for diff mode. It can consist of the following items. |
| 7 | 2766 All are optional. Items must be separated by a comma. |
| 2767 | |
| 2768 filler Show filler lines, to keep the text | |
| 2769 synchronized with a window that has inserted | |
| 2770 lines at the same position. Mostly useful | |
| 2771 when windows are side-by-side and 'scrollbind' | |
| 2772 is set. | |
| 2773 | |
| 2774 context:{n} Use a context of {n} lines between a change | |
| 2775 and a fold that contains unchanged lines. | |
| 2776 When omitted a context of six lines is used. | |
| 15932 | 2777 When using zero the context is actually one, |
| 2778 since folds require a line in between, also | |
| 2779 for a deleted line. | |
| 7 | 2780 See |fold-diff|. |
| 2781 | |
| 14864 | 2782 iblank Ignore changes where lines are all blank. Adds |
| 2783 the "-B" flag to the "diff" command if | |
| 2784 'diffexpr' is empty. Check the documentation | |
| 2785 of the "diff" command for what this does | |
| 2786 exactly. | |
| 2787 NOTE: the diff windows will get out of sync, | |
| 2788 because no differences between blank lines are | |
| 2789 taken into account. | |
| 2790 | |
| 7 | 2791 icase Ignore changes in case of text. "a" and "A" |
| 2792 are considered the same. Adds the "-i" flag | |
| 2793 to the "diff" command if 'diffexpr' is empty. | |
| 2794 | |
| 2795 iwhite Ignore changes in amount of white space. Adds | |
| 2796 the "-b" flag to the "diff" command if | |
| 2797 'diffexpr' is empty. Check the documentation | |
| 2798 of the "diff" command for what this does | |
| 2799 exactly. It should ignore adding trailing | |
| 2800 white space, but not leading white space. | |
| 2801 | |
| 14864 | 2802 iwhiteall Ignore all white space changes. Adds |
| 2803 the "-w" flag to the "diff" command if | |
| 2804 'diffexpr' is empty. Check the documentation | |
| 2805 of the "diff" command for what this does | |
| 2806 exactly. | |
| 2807 | |
| 2808 iwhiteeol Ignore white space changes at end of line. | |
| 2809 Adds the "-Z" flag to the "diff" command if | |
| 2810 'diffexpr' is empty. Check the documentation | |
| 2811 of the "diff" command for what this does | |
| 2812 exactly. | |
| 2813 | |
| 766 | 2814 horizontal Start diff mode with horizontal splits (unless |
| 2815 explicitly specified otherwise). | |
| 2816 | |
| 2817 vertical Start diff mode with vertical splits (unless | |
| 2818 explicitly specified otherwise). | |
| 2819 | |
|
18590
41484f342f80
patch 8.1.2289: after :diffsplit closing the window does not disable diff
Bram Moolenaar <Bram@vim.org>
parents:
18574
diff
changeset
|
2820 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
|
2821 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
|
2822 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
|
2823 `: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
|
2824 `: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
|
2825 |
|
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
|
2826 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
|
2827 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
|
2828 |
| 766 | 2829 foldcolumn:{n} Set the 'foldcolumn' option to {n} when |
| 2830 starting diff mode. Without this 2 is used. | |
| 2831 | |
|
23895
e313b6ee2d9c
patch 8.2.2490: 'wrap' option is always reset when starting diff mode
Bram Moolenaar <Bram@vim.org>
parents:
23825
diff
changeset
|
2832 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
|
2833 |
|
14696
195e8b1fcbbf
patch 8.1.0360: using an external diff program is slow and inflexible
Christian Brabandt <cb@256bit.org>
parents:
14695
diff
changeset
|
2834 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
|
2835 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
|
2836 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
|
2837 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
|
2838 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
|
2839 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
|
2840 |
|
195e8b1fcbbf
patch 8.1.0360: using an external diff program is slow and inflexible
Christian Brabandt <cb@256bit.org>
parents:
14695
diff
changeset
|
2841 indent-heuristic |
| 15033 | 2842 Use the indent heuristic for the internal |
| 2843 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
|
2844 |
|
195e8b1fcbbf
patch 8.1.0360: using an external diff program is slow and inflexible
Christian Brabandt <cb@256bit.org>
parents:
14695
diff
changeset
|
2845 algorithm:{text} Use the specified diff algorithm with the |
| 15033 | 2846 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
|
2847 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
|
2848 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
|
2849 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
|
2850 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
|
2851 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
|
2852 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
|
2853 |
| 7 | 2854 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
|
2855 :set diffopt=internal,filler,context:4 |
| 7 | 2856 :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
|
2857 :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
|
2858 :set diffopt-=internal " do NOT use the internal diff parser |
| 7 | 2859 < |
| 2860 *'digraph'* *'dg'* *'nodigraph'* *'nodg'* | |
| 2861 'digraph' 'dg' boolean (default off) | |
| 2862 global | |
| 2863 {not available when compiled without the |+digraphs| | |
| 2864 feature} | |
| 2865 Enable the entering of digraphs in Insert mode with {char1} <BS> | |
| 2866 {char2}. See |digraphs|. | |
| 2867 NOTE: This option is reset when 'compatible' is set. | |
| 2868 | |
| 2869 *'directory'* *'dir'* | |
| 2870 'directory' 'dir' string (default for Amiga: ".,t:", | |
| 18972 | 2871 for Win32: ".,$TEMP,c:\tmp,c:\temp" |
| 7 | 2872 for Unix: ".,~/tmp,/var/tmp,/tmp") |
| 2873 global | |
| 2874 List of directory names for the swap file, separated with commas. | |
| 21676 | 2875 Recommended value: ".,~/vimswap//" - this will put the swap file next |
| 2876 to the edited file if possible, and in your personal swap directory | |
| 2877 otherwise. Make sure "~/vimswap//" is only readable for you. | |
| 2878 | |
| 2879 Possible items: | |
| 7 | 2880 - The swap file will be created in the first directory where this is |
| 2881 possible. | |
| 2882 - 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
|
2883 impossible!) and no |E303| error will be given. |
| 7 | 2884 - A directory "." means to put the swap file in the same directory as |
| 2885 the edited file. On Unix, a dot is prepended to the file name, so | |
| 2886 it doesn't show in a directory listing. On MS-Windows the "hidden" | |
| 2887 attribute is set and a dot prepended if possible. | |
| 19116 | 2888 - A directory starting with "./" (or ".\" for MS-Windows) means to put |
| 2889 the swap file relative to where the edited file is. The leading "." | |
| 2890 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
|
2891 - 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
|
2892 the swap file name will be built from the complete path to the file |
| 21991 | 2893 with all path separators replaced by percent '%' signs (including |
| 2894 the colon following the drive letter on Win32). This will ensure | |
| 2895 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
|
2896 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
|
2897 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
|
2898 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
|
2899 use '//', instead of '\\'. |
| 7 | 2900 - Spaces after the comma are ignored, other spaces are considered part |
| 2901 of the directory name. To have a space at the start of a directory | |
| 2902 name, precede it with a backslash. | |
| 2903 - To include a comma in a directory name precede it with a backslash. | |
| 2904 - A directory name may end in an ':' or '/'. | |
| 2905 - Environment variables are expanded |:set_env|. | |
| 2906 - Careful with '\' characters, type one before a space, type two to | |
| 2907 get one in the option (see |option-backslash|), for example: > | |
| 2908 :set dir=c:\\tmp,\ dir\\,with\\,commas,\\\ dir\ with\ spaces | |
| 2909 < - For backwards compatibility with Vim version 3.0 a '>' at the start | |
| 2910 of the option is removed. | |
| 2911 Using "." first in the list is recommended. This means that editing | |
| 2912 the same file twice will result in a warning. Using "/tmp" on Unix is | |
| 2913 discouraged: When the system crashes you lose the swap file. | |
| 2914 "/var/tmp" is often not cleared when rebooting, thus is a better | |
| 21676 | 2915 choice than "/tmp". But others on the computer may be able to see the |
| 2916 files, and it can contain a lot of files, your swap files get lost in | |
| 2917 the crowd. That is why a "tmp" directory in your home directory is | |
| 2918 tried first. | |
| 7 | 2919 The use of |:set+=| and |:set-=| is preferred when adding or removing |
| 2920 directories from the list. This avoids problems when a future version | |
| 2921 uses another default. | |
| 2922 This option cannot be set from a |modeline| or in the |sandbox|, for | |
| 2923 security reasons. | |
| 2924 | |
| 2925 *'display'* *'dy'* | |
|
9737
35ce559b8553
commit https://github.com/vim/vim/commit/bc8801c9317eb721a2ee91322669f2dd5d136380
Christian Brabandt <cb@256bit.org>
parents:
9669
diff
changeset
|
2926 '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
|
2927 |defaults.vim|) |
| 7 | 2928 global |
| 28379 | 2929 Change the way text is displayed. This is comma-separated list of |
| 7 | 2930 flags: |
| 2931 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
|
2932 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
|
2933 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
|
2934 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
|
2935 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
|
2936 column of the last screen line. Overrules "lastline". |
| 7 | 2937 uhex Show unprintable characters hexadecimal as <xx> |
| 2938 instead of using ^C and ~C. | |
| 2939 | |
|
10211
b7da8d4c594c
commit https://github.com/vim/vim/commit/d07969093a9b3051511c478d71c36de6fc33c0d6
Christian Brabandt <cb@256bit.org>
parents:
10198
diff
changeset
|
2940 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
|
2941 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
|
2942 |
| 7 | 2943 *'eadirection'* *'ead'* |
| 2944 'eadirection' 'ead' string (default "both") | |
| 2945 global | |
| 2946 Tells when the 'equalalways' option applies: | |
| 2947 ver vertically, width of windows is not affected | |
| 2948 hor horizontally, height of windows is not affected | |
| 2949 both width and height of windows is affected | |
| 2950 | |
| 2951 *'ed'* *'edcompatible'* *'noed'* *'noedcompatible'* | |
| 2952 'edcompatible' 'ed' boolean (default off) | |
| 2953 global | |
| 2954 Makes the 'g' and 'c' flags of the ":substitute" command to be | |
| 2955 toggled each time the flag is given. See |complex-change|. See | |
| 2956 also 'gdefault' option. | |
| 11442 | 2957 Switching this option on may break plugins! |
| 23305 | 2958 This option is not used in |Vim9| script. |
| 7 | 2959 |
|
8876
47f17f66da3d
commit https://github.com/vim/vim/commit/03413f44167c4b5cd0012def9bb331e2518c83cf
Christian Brabandt <cb@256bit.org>
parents:
8835
diff
changeset
|
2960 *'emoji'* *'emo'* *'noemoji'* *'noemo'* |
|
8629
54ac275e3fc4
commit https://github.com/vim/vim/commit/3848e00e0177abdb31bc600234967863ec487233
Christian Brabandt <cb@256bit.org>
parents:
8560
diff
changeset
|
2961 'emoji' 'emo' boolean (default: on) |
|
54ac275e3fc4
commit https://github.com/vim/vim/commit/3848e00e0177abdb31bc600234967863ec487233
Christian Brabandt <cb@256bit.org>
parents:
8560
diff
changeset
|
2962 global |
|
54ac275e3fc4
commit https://github.com/vim/vim/commit/3848e00e0177abdb31bc600234967863ec487233
Christian Brabandt <cb@256bit.org>
parents:
8560
diff
changeset
|
2963 When on all Unicode emoji characters are considered to be full width. |
| 22328 | 2964 This excludes "text emoji" characters, which are normally displayed as |
| 2965 single width. Unfortunately there is no good specification for this | |
| 2966 and it has been determined on trial-and-error basis. Use the | |
| 2967 |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
|
2968 |
| 7 | 2969 *'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
|
2970 '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
|
2971 otherwise: value from $LANG or "latin1") |
| 7 | 2972 global |
| 2973 Sets the character encoding used inside Vim. It applies to text in | |
| 2974 the buffers, registers, Strings in expressions, text stored in the | |
| 2975 viminfo file, etc. It sets the kind of characters which Vim can work | |
| 2976 with. See |encoding-names| for the possible values. | |
| 2977 | |
| 2978 NOTE: Changing this option will not change the encoding of the | |
| 39 | 2979 existing text in Vim. It may cause non-ASCII text to become invalid. |
| 7 | 2980 It should normally be kept at its default value, or set when Vim |
| 1152 | 2981 starts up. See |multibyte|. To reload the menus see |:menutrans|. |
| 7 | 2982 |
|
2317
2b2cd34569eb
Disallow setting 'enc' in a modeline. (Patrick Texier)
Bram Moolenaar <bram@vim.org>
parents:
2314
diff
changeset
|
2983 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
|
2984 corrupt the text. |
|
2b2cd34569eb
Disallow setting 'enc' in a modeline. (Patrick Texier)
Bram Moolenaar <bram@vim.org>
parents:
2314
diff
changeset
|
2985 |
|
10895
c391bfbdb452
Updated runtime files.
Christian Brabandt <cb@256bit.org>
parents:
10734
diff
changeset
|
2986 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
|
2987 to "utf-8". Although care has been taken to allow different values of |
| 7 | 2988 'encoding', "utf-8" is the natural choice for the environment and |
| 2989 avoids unnecessary conversion overhead. "utf-8" has not been made | |
| 10 | 2990 the default to prevent different behavior of the GUI and terminal |
| 7 | 2991 versions, and to avoid changing the encoding of newly created files |
| 2992 without your knowledge (in case 'fileencodings' is empty). | |
| 2993 | |
| 2994 The character encoding of files can be different from 'encoding'. | |
| 10 | 2995 This is specified with 'fileencoding'. The conversion is done with |
| 7 | 2996 iconv() or as specified with 'charconvert'. |
| 2997 | |
| 21991 | 2998 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
|
2999 can use: > |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
3000 if has("multi_byte_encoding") |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
3001 < |
| 7 | 3002 Normally 'encoding' will be equal to your current locale. This will |
| 3003 be the default if Vim recognizes your environment settings. If | |
| 3004 'encoding' is not set to the current locale, 'termencoding' must be | |
| 3005 set to convert typed and displayed text. See |encoding-table|. | |
| 3006 | |
| 3007 When you set this option, it fires the |EncodingChanged| autocommand | |
| 3008 event so that you can set up fonts if necessary. | |
| 3009 | |
| 3010 When the option is set, the value is converted to lowercase. Thus | |
| 3011 you can set it with uppercase values too. Underscores are translated | |
| 3012 to '-' signs. | |
| 3013 When the encoding is recognized, it is changed to the standard name. | |
| 3014 For example "Latin-1" becomes "latin1", "ISO_88592" becomes | |
| 3015 "iso-8859-2" and "utf8" becomes "utf-8". | |
| 3016 | |
| 3017 Note: "latin1" is also used when the encoding could not be detected. | |
| 3018 This only works when editing files in the same encoding! When the | |
| 3019 actual character set is not latin1, make sure 'fileencoding' and | |
| 3020 'fileencodings' are empty. When conversion is needed, switch to using | |
| 3021 utf-8. | |
| 3022 | |
| 3023 When "unicode", "ucs-2" or "ucs-4" is used, Vim internally uses utf-8. | |
| 3024 You don't notice this while editing, but it does matter for the | |
| 3025 |viminfo-file|. And Vim expects the terminal to use utf-8 too. Thus | |
| 3026 setting 'encoding' to one of these values instead of utf-8 only has | |
| 3027 effect for encoding used for files when 'fileencoding' is empty. | |
| 448 | 3028 |
| 3029 When 'encoding' is set to a Unicode encoding, and 'fileencodings' was | |
| 3030 not set yet, the default for 'fileencodings' is changed. | |
| 7 | 3031 |
| 3032 *'endofline'* *'eol'* *'noendofline'* *'noeol'* | |
| 3033 'endofline' 'eol' boolean (default on) | |
| 3034 local to buffer | |
| 3035 When writing a file and this option is off and the 'binary' option | |
| 6933 | 3036 is on, or 'fixeol' option is off, no <EOL> will be written for the |
| 3037 last line in the file. This option is automatically set or reset when | |
| 3038 starting to edit a new file, depending on whether file has an <EOL> | |
| 3039 for the last line in the file. Normally you don't have to set or | |
| 3040 reset this option. | |
| 3041 When 'binary' is off and 'fixeol' is on the value is not used when | |
| 3042 writing the file. When 'binary' is on or 'fixeol' is off it is used | |
| 3043 to remember the presence of a <EOL> for the last line in the file, so | |
| 3044 that when you write the file the situation from the original file can | |
| 3045 be kept. But you can change it if you want to. | |
| 7 | 3046 |
| 3047 *'equalalways'* *'ea'* *'noequalalways'* *'noea'* | |
| 3048 'equalalways' 'ea' boolean (default on) | |
| 3049 global | |
| 3050 When on, all the windows are automatically made the same size after | |
| 33 | 3051 splitting or closing a window. This also happens the moment the |
| 3052 option is switched on. When off, splitting a window will reduce the | |
| 3053 size of the current window and leave the other windows the same. When | |
| 3054 closing a window the extra lines are given to the window next to it | |
| 3055 (depending on 'splitbelow' and 'splitright'). | |
| 7 | 3056 When mixing vertically and horizontally split windows, a minimal size |
| 3057 is computed and some windows may be larger if there is room. The | |
| 3058 'eadirection' option tells in which direction the size is affected. | |
| 1354 | 3059 Changing the height and width of a window can be avoided by setting |
| 3060 'winfixheight' and 'winfixwidth', respectively. | |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
3061 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
|
3062 currently not equalized (it's complicated, but may be implemented in |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
3063 the future). |
| 7 | 3064 |
| 3065 *'equalprg'* *'ep'* | |
| 3066 'equalprg' 'ep' string (default "") | |
| 3067 global or local to buffer |global-local| | |
| 3068 External program to use for "=" command. When this option is empty | |
| 1621 | 3069 the internal formatting functions are used; either 'lisp', 'cindent' |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
3070 or 'indentexpr'. When Vim was compiled without internal formatting, |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
3071 the "indent" program is used. |
| 10 | 3072 Environment variables are expanded |:set_env|. See |option-backslash| |
| 7 | 3073 about including spaces and backslashes. |
| 3074 This option cannot be set from a |modeline| or in the |sandbox|, for | |
| 3075 security reasons. | |
| 3076 | |
| 3077 *'errorbells'* *'eb'* *'noerrorbells'* *'noeb'* | |
| 3078 'errorbells' 'eb' boolean (default off) | |
| 3079 global | |
| 3080 Ring the bell (beep or screen flash) for error messages. This only | |
| 3081 makes a difference for error messages, the bell will be used always | |
| 3082 for a lot of errors without a message (e.g., hitting <Esc> in Normal | |
| 10 | 3083 mode). See 'visualbell' on how to make the bell behave like a beep, |
| 6949 | 3084 screen flash or do nothing. See 'belloff' to finetune when to ring the |
| 3085 bell. | |
| 7 | 3086 |
| 3087 *'errorfile'* *'ef'* | |
| 3088 'errorfile' 'ef' string (Amiga default: "AztecC.Err", | |
| 3089 others: "errors.err") | |
| 3090 global | |
| 3091 {not available when compiled without the |+quickfix| | |
| 3092 feature} | |
| 3093 Name of the errorfile for the QuickFix mode (see |:cf|). | |
| 3094 When the "-q" command-line argument is used, 'errorfile' is set to the | |
| 3095 following argument. See |-q|. | |
| 3096 NOT used for the ":make" command. See 'makeef' for that. | |
| 3097 Environment variables are expanded |:set_env|. | |
| 3098 See |option-backslash| about including spaces and backslashes. | |
| 3099 This option cannot be set from a |modeline| or in the |sandbox|, for | |
| 3100 security reasons. | |
| 3101 | |
| 3102 *'errorformat'* *'efm'* | |
| 3103 'errorformat' 'efm' string (default is very long) | |
| 3104 global or local to buffer |global-local| | |
| 3105 {not available when compiled without the |+quickfix| | |
| 3106 feature} | |
| 3107 Scanf-like description of the format for the lines in the error file | |
| 3108 (see |errorformat|). | |
| 3109 | |
| 3110 *'esckeys'* *'ek'* *'noesckeys'* *'noek'* | |
| 3111 'esckeys' 'ek' boolean (Vim default: on, Vi default: off) | |
| 3112 global | |
| 3113 Function keys that start with an <Esc> are recognized in Insert | |
| 3114 mode. When this option is off, the cursor and function keys cannot be | |
| 3115 used in Insert mode if they start with an <Esc>. The advantage of | |
| 3116 this is that the single <Esc> is recognized immediately, instead of | |
| 3117 after one second. Instead of resetting this option, you might want to | |
| 3118 try changing the values for 'timeoutlen' and 'ttimeoutlen'. Note that | |
| 3119 when 'esckeys' is off, you can still map anything, but the cursor keys | |
| 3120 won't work by default. | |
| 3121 NOTE: This option is set to the Vi default value when 'compatible' is | |
| 3122 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
|
3123 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
|
3124 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
|
3125 key that has a modifier. |
| 7 | 3126 |
| 3127 *'eventignore'* *'ei'* | |
| 3128 'eventignore' 'ei' string (default "") | |
| 3129 global | |
| 3130 A list of autocommand event names, which are to be ignored. | |
| 844 | 3131 When set to "all" or when "all" is one of the items, all autocommand |
| 3132 events are ignored, autocommands will not be executed. | |
| 28379 | 3133 Otherwise this is a comma-separated list of event names. Example: > |
| 7 | 3134 :set ei=WinEnter,WinLeave |
| 3135 < | |
| 3136 *'expandtab'* *'et'* *'noexpandtab'* *'noet'* | |
| 3137 'expandtab' 'et' boolean (default off) | |
| 3138 local to buffer | |
| 3139 In Insert mode: Use the appropriate number of spaces to insert a | |
| 10 | 3140 <Tab>. Spaces are used in indents with the '>' and '<' commands and |
| 7 | 3141 when 'autoindent' is on. To insert a real tab when 'expandtab' is |
| 3142 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
|
3143 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
|
3144 the 'paste' option is reset. |
| 7 | 3145 NOTE: This option is reset when 'compatible' is set. |
| 3146 | |
| 3147 *'exrc'* *'ex'* *'noexrc'* *'noex'* | |
| 3148 'exrc' 'ex' boolean (default off) | |
| 3149 global | |
| 3150 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
|
3151 directory. |
|
018fead968c1
commit https://github.com/vim/vim/commit/36f44c21da2e912c008683a0c4447fca2a071e9a
Christian Brabandt <cb@256bit.org>
parents:
9975
diff
changeset
|
3152 |
|
018fead968c1
commit https://github.com/vim/vim/commit/36f44c21da2e912c008683a0c4447fca2a071e9a
Christian Brabandt <cb@256bit.org>
parents:
9975
diff
changeset
|
3153 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
|
3154 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
|
3155 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
|
3156 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
|
3157 matching directory. |
|
018fead968c1
commit https://github.com/vim/vim/commit/36f44c21da2e912c008683a0c4447fca2a071e9a
Christian Brabandt <cb@256bit.org>
parents:
9975
diff
changeset
|
3158 |
|
018fead968c1
commit https://github.com/vim/vim/commit/36f44c21da2e912c008683a0c4447fca2a071e9a
Christian Brabandt <cb@256bit.org>
parents:
9975
diff
changeset
|
3159 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
|
3160 'secure' option (see |initialization|). |
|
018fead968c1
commit https://github.com/vim/vim/commit/36f44c21da2e912c008683a0c4447fca2a071e9a
Christian Brabandt <cb@256bit.org>
parents:
9975
diff
changeset
|
3161 Also see |.vimrc| and |gui-init|. |
| 7 | 3162 This option cannot be set from a |modeline| or in the |sandbox|, for |
| 3163 security reasons. | |
| 3164 | |
| 3165 *'fileencoding'* *'fenc'* *E213* | |
| 3166 'fileencoding' 'fenc' string (default: "") | |
| 3167 local to buffer | |
| 3168 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
|
3169 |
| 7 | 3170 When 'fileencoding' is different from 'encoding', conversion will be |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
3171 done when writing the file. For reading see below. |
| 7 | 3172 When 'fileencoding' is empty, the same value as 'encoding' will be |
| 3173 used (no conversion when reading or writing a file). | |
| 11062 | 3174 No error will be given when the value is set, only when it is used, |
| 3175 only when writing a file. | |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
3176 Conversion will also be done when 'encoding' and 'fileencoding' are |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
3177 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
|
3178 because internally Unicode is always stored as utf-8. |
| 7 | 3179 WARNING: Conversion can cause loss of information! When |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
3180 'encoding' is "utf-8" or another Unicode encoding, conversion |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
3181 is most likely done in a way that the reverse conversion |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
3182 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
|
3183 characters may be lost! |
|
2317
2b2cd34569eb
Disallow setting 'enc' in a modeline. (Patrick Texier)
Bram Moolenaar <bram@vim.org>
parents:
2314
diff
changeset
|
3184 |
| 7 | 3185 See 'encoding' for the possible values. Additionally, values may be |
| 3186 specified that can be handled by the converter, see | |
| 3187 |mbyte-conversion|. | |
|
2317
2b2cd34569eb
Disallow setting 'enc' in a modeline. (Patrick Texier)
Bram Moolenaar <bram@vim.org>
parents:
2314
diff
changeset
|
3188 |
| 7 | 3189 When reading a file 'fileencoding' will be set from 'fileencodings'. |
| 3190 To read a file in a certain encoding it won't work by setting | |
| 1152 | 3191 'fileencoding', use the |++enc| argument. One exception: when |
| 3192 'fileencodings' is empty the value of 'fileencoding' is used. | |
| 692 | 3193 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
|
3194 |
| 7 | 3195 Prepending "8bit-" and "2byte-" has no meaning here, they are ignored. |
| 3196 When the option is set, the value is converted to lowercase. Thus | |
| 3197 you can set it with uppercase values too. '_' characters are | |
| 3198 replaced with '-'. If a name is recognized from the list for | |
| 3199 'encoding', it is replaced by the standard name. For example | |
| 3200 "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
|
3201 |
| 7 | 3202 When this option is set, after starting to edit a file, the 'modified' |
| 3203 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
|
3204 |
|
2b2cd34569eb
Disallow setting 'enc' in a modeline. (Patrick Texier)
Bram Moolenaar <bram@vim.org>
parents:
2314
diff
changeset
|
3205 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
|
3206 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
|
3207 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
|
3208 '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
|
3209 |
| 7 | 3210 This option can not be changed when 'modifiable' is off. |
| 3211 | |
| 3212 *'fe'* | |
| 3213 NOTE: Before version 6.0 this option specified the encoding for the | |
| 10 | 3214 whole of Vim, this was a mistake. Now use 'encoding' instead. The |
| 7 | 3215 old short name was 'fe', which is no longer used. |
| 3216 | |
| 3217 *'fileencodings'* *'fencs'* | |
| 39 | 3218 'fileencodings' 'fencs' string (default: "ucs-bom", |
| 3219 "ucs-bom,utf-8,default,latin1" when | |
| 3220 'encoding' is set to a Unicode value) | |
| 7 | 3221 global |
| 3222 This is a list of character encodings considered when starting to edit | |
| 3223 an existing file. When a file is read, Vim tries to use the first | |
| 3224 mentioned character encoding. If an error is detected, the next one | |
| 3225 in the list is tried. When an encoding is found that works, | |
| 10 | 3226 'fileencoding' is set to it. If all fail, 'fileencoding' is set to |
| 7 | 3227 an empty string, which means the value of 'encoding' is used. |
| 3228 WARNING: Conversion can cause loss of information! When | |
| 3229 'encoding' is "utf-8" (or one of the other Unicode variants) | |
| 3230 conversion is most likely done in a way that the reverse | |
| 3231 conversion results in the same text. When 'encoding' is not | |
| 596 | 3232 "utf-8" some non-ASCII characters may be lost! You can use |
| 3233 the |++bad| argument to specify what is done with characters | |
| 3234 that can't be converted. | |
| 7 | 3235 For an empty file or a file with only ASCII characters most encodings |
| 3236 will work and the first entry of 'fileencodings' will be used (except | |
| 3237 "ucs-bom", which requires the BOM to be present). If you prefer | |
| 3238 another encoding use an BufReadPost autocommand event to test if your | |
| 3239 preferred encoding is to be used. Example: > | |
| 3240 au BufReadPost * if search('\S', 'w') == 0 | | |
| 3241 \ set fenc=iso-2022-jp | endif | |
| 3242 < This sets 'fileencoding' to "iso-2022-jp" if the file does not contain | |
| 3243 non-blank characters. | |
| 596 | 3244 When the |++enc| argument is used then the value of 'fileencodings' is |
| 3245 not used. | |
| 692 | 3246 Note that 'fileencodings' is not used for a new file, the global value |
| 3247 of 'fileencoding' is used instead. You can set it with: > | |
| 3248 :setglobal fenc=iso-8859-2 | |
| 3249 < This means that a non-existing file may get a different encoding than | |
| 3250 an empty file. | |
| 7 | 3251 The special value "ucs-bom" can be used to check for a Unicode BOM |
| 3252 (Byte Order Mark) at the start of the file. It must not be preceded | |
| 3253 by "utf-8" or another Unicode encoding for this to work properly. | |
| 3254 An entry for an 8-bit encoding (e.g., "latin1") should be the last, | |
| 3255 because Vim cannot detect an error, thus the encoding is always | |
| 3256 accepted. | |
| 39 | 3257 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
|
3258 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
|
3259 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
|
3260 '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
|
3261 encoding, such as Russian. |
| 777 | 3262 When 'encoding' is "utf-8" and a file contains an illegal byte |
| 3263 sequence it won't be recognized as UTF-8. You can use the |8g8| | |
| 3264 command to find the illegal byte sequence. | |
| 7 | 3265 WRONG VALUES: WHAT'S WRONG: |
| 3266 latin1,utf-8 "latin1" will always be used | |
| 3267 utf-8,ucs-bom,latin1 BOM won't be recognized in an utf-8 | |
| 3268 file | |
| 3269 cp1250,latin1 "cp1250" will always be used | |
| 3270 If 'fileencodings' is empty, 'fileencoding' is not modified. | |
| 3271 See 'fileencoding' for the possible values. | |
| 3272 Setting this option does not have an effect until the next time a file | |
| 3273 is read. | |
| 3274 | |
| 3275 *'fileformat'* *'ff'* | |
|
15840
734b1928a5aa
patch 8.1.0927: USE_CR is never defined
Bram Moolenaar <Bram@vim.org>
parents:
15804
diff
changeset
|
3276 '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
|
3277 Unix, macOS default: "unix") |
| 7 | 3278 local to buffer |
| 3279 This gives the <EOL> of the current buffer, which is used for | |
| 3280 reading/writing the buffer from/to a file: | |
| 23305 | 3281 dos <CR><NL> |
| 7 | 3282 unix <NL> |
| 3283 mac <CR> | |
| 3284 When "dos" is used, CTRL-Z at the end of a file is ignored. | |
| 3285 See |file-formats| and |file-read|. | |
| 3286 For the character encoding of the file see 'fileencoding'. | |
| 3287 When 'binary' is set, the value of 'fileformat' is ignored, file I/O | |
| 4264 | 3288 works like it was set to "unix". |
| 7 | 3289 This option is set automatically when starting to edit a file and |
| 3290 'fileformats' is not empty and 'binary' is off. | |
| 3291 When this option is set, after starting to edit a file, the 'modified' | |
| 3292 option is set, because the file would be different when written. | |
| 3293 This option can not be changed when 'modifiable' is off. | |
| 3294 For backwards compatibility: When this option is set to "dos", | |
| 3295 'textmode' is set, otherwise 'textmode' is reset. | |
| 3296 | |
| 3297 *'fileformats'* *'ffs'* | |
| 3298 'fileformats' 'ffs' string (default: | |
|
15840
734b1928a5aa
patch 8.1.0927: USE_CR is never defined
Bram Moolenaar <Bram@vim.org>
parents:
15804
diff
changeset
|
3299 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
|
3300 Vim Unix, macOS: "unix,dos", |
| 7 | 3301 Vi Cygwin: "unix,dos", |
| 3302 Vi others: "") | |
| 3303 global | |
| 3304 This gives the end-of-line (<EOL>) formats that will be tried when | |
| 3305 starting to edit a new buffer and when reading a file into an existing | |
| 3306 buffer: | |
| 3307 - When empty, the format defined with 'fileformat' will be used | |
| 3308 always. It is not set automatically. | |
| 3309 - When set to one name, that format will be used whenever a new buffer | |
| 10 | 3310 is opened. 'fileformat' is set accordingly for that buffer. The |
| 7 | 3311 'fileformats' name will be used when a file is read into an existing |
| 3312 buffer, no matter what 'fileformat' for that buffer is set to. | |
| 3313 - When more than one name is present, separated by commas, automatic | |
| 3314 <EOL> detection will be done when reading a file. When starting to | |
| 3315 edit a file, a check is done for the <EOL>: | |
| 3316 1. If all lines end in <CR><NL>, and 'fileformats' includes "dos", | |
| 3317 'fileformat' is set to "dos". | |
| 3318 2. If a <NL> is found and 'fileformats' includes "unix", 'fileformat' | |
| 10 | 3319 is set to "unix". Note that when a <NL> is found without a |
| 7 | 3320 preceding <CR>, "unix" is preferred over "dos". |
| 6647 | 3321 3. If 'fileformat' has not yet been set, and if a <CR> is found, and |
| 3322 if 'fileformats' includes "mac", 'fileformat' is set to "mac". | |
| 2587 | 3323 This means that "mac" is only chosen when: |
| 3324 "unix" is not present or no <NL> is found in the file, and | |
| 3325 "dos" is not present or no <CR><NL> is found in the file. | |
| 3326 Except: if "unix" was chosen, but there is a <CR> before | |
| 3327 the first <NL>, and there appear to be more <CR>s than <NL>s in | |
| 2642 | 3328 the first few lines, "mac" is used. |
| 7 | 3329 4. If 'fileformat' is still not set, the first name from |
| 3330 'fileformats' is used. | |
| 3331 When reading a file into an existing buffer, the same is done, but | |
| 3332 this happens like 'fileformat' has been set appropriately for that | |
| 3333 file only, the option is not changed. | |
| 3334 When 'binary' is set, the value of 'fileformats' is not used. | |
| 3335 | |
|
8748
b1a19a2f73f0
commit https://github.com/vim/vim/commit/4f3f668c8486444e53163c29d2fc79bf47eb3c82
Christian Brabandt <cb@256bit.org>
parents:
8629
diff
changeset
|
3336 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
|
3337 can overrule this by setting 'fileformat' in your .vimrc. |
| 2662 | 3338 |
| 7 | 3339 For systems with a Dos-like <EOL> (<CR><NL>), when reading files that |
| 3340 are ":source"ed and for vimrc files, automatic <EOL> detection may be | |
| 3341 done: | |
| 3342 - When 'fileformats' is empty, there is no automatic detection. Dos | |
| 3343 format will be used. | |
| 3344 - When 'fileformats' is set to one or more names, automatic detection | |
| 3345 is done. This is based on the first <NL> in the file: If there is a | |
| 3346 <CR> in front of it, Dos format is used, otherwise Unix format is | |
| 3347 used. | |
| 3348 Also see |file-formats|. | |
| 3349 For backwards compatibility: When this option is set to an empty | |
| 3350 string or one format (no comma is included), 'textauto' is reset, | |
| 3351 otherwise 'textauto' is set. | |
| 3352 NOTE: This option is set to the Vi default value when 'compatible' is | |
| 3353 set and to the Vim default value when 'compatible' is reset. | |
| 3354 | |
| 4264 | 3355 *'fileignorecase'* *'fic'* *'nofileignorecase'* *'nofic'* |
| 3356 'fileignorecase' 'fic' boolean (default on for systems where case in file | |
| 3357 names is normally ignored) | |
| 4242 | 3358 global |
| 3359 When set case is ignored when using file names and directories. | |
| 3360 See 'wildignorecase' for only ignoring case when doing completion. | |
| 3361 | |
| 7 | 3362 *'filetype'* *'ft'* |
| 3363 'filetype' 'ft' string (default: "") | |
| 3364 local to buffer | |
| 3365 When this option is set, the FileType autocommand event is triggered. | |
| 3366 All autocommands that match with the value of this option will be | |
| 3367 executed. Thus the value of 'filetype' is used in place of the file | |
| 3368 name. | |
| 3369 Otherwise this option does not always reflect the current file type. | |
| 3370 This option is normally set when the file type is detected. To enable | |
| 3371 this use the ":filetype on" command. |:filetype| | |
| 3372 Setting this option to a different value is most useful in a modeline, | |
| 3373 for a file for which the file type is not automatically recognized. | |
| 782 | 3374 Example, for in an IDL file: |
| 3375 /* vim: set filetype=idl : */ ~ | |
| 3376 |FileType| |filetypes| | |
| 3377 When a dot appears in the value then this separates two filetype | |
| 3378 names. Example: | |
| 3379 /* vim: set filetype=c.doxygen : */ ~ | |
| 3380 This will use the "c" filetype first, then the "doxygen" filetype. | |
| 3381 This works both for filetype plugins and for syntax files. More than | |
| 3382 one dot may appear. | |
| 7 | 3383 This option is not copied to another buffer, independent of the 's' or |
| 3384 'S' flag in 'cpoptions'. | |
| 36 | 3385 Only normal file name characters can be used, "/\*?[|<>" are illegal. |
| 7 | 3386 |
| 3387 *'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
|
3388 'fillchars' 'fcs' string (default "vert:|,fold:-,eob:~") |
| 7 | 3389 global |
|
17771
4bd21046902b
patch 8.1.1882: cannot specify properties of the info popup window
Bram Moolenaar <Bram@vim.org>
parents:
17767
diff
changeset
|
3390 {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
|
3391 feature} |
| 7 | 3392 Characters to fill the statuslines and vertical separators. |
| 28379 | 3393 It is a comma-separated list of items: |
| 7 | 3394 |
| 3395 item default Used for ~ | |
| 3396 stl:c ' ' or '^' statusline of the current window | |
|
8061
abd64cf67bcf
commit https://github.com/vim/vim/commit/38a55639d603823efcf2d2fdf542dbffdeb60b75
Christian Brabandt <cb@256bit.org>
parents:
7876
diff
changeset
|
3397 stlnc:c ' ' or '=' statusline of the non-current windows |
| 7 | 3398 vert:c '|' vertical separators |:vsplit| |
| 3399 fold:c '-' filling 'foldtext' | |
|
23964
17697c4e5d48
patch 8.2.2524: cannot change the characters displayed in the foldcolumn
Bram Moolenaar <Bram@vim.org>
parents:
23952
diff
changeset
|
3400 foldopen:c '-' mark the beginning of a fold |
|
17697c4e5d48
patch 8.2.2524: cannot change the characters displayed in the foldcolumn
Bram Moolenaar <Bram@vim.org>
parents:
23952
diff
changeset
|
3401 foldclose:c '+' show a closed fold |
|
17697c4e5d48
patch 8.2.2524: cannot change the characters displayed in the foldcolumn
Bram Moolenaar <Bram@vim.org>
parents:
23952
diff
changeset
|
3402 foldsep:c '|' open fold middle character |
| 7 | 3403 diff:c '-' deleted lines of the 'diff' option |
|
23932
4549133c1e77
patch 8.2.2508: cannot change the character displayed in non existing lines
Bram Moolenaar <Bram@vim.org>
parents:
23931
diff
changeset
|
3404 eob:c '~' empty lines below the end of a buffer |
| 7 | 3405 |
| 10 | 3406 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
|
3407 "stlnc" the space will be used when there is highlighting, '^' or '=' |
| 7 | 3408 otherwise. |
| 3409 | |
| 3410 Example: > | |
|
8061
abd64cf67bcf
commit https://github.com/vim/vim/commit/38a55639d603823efcf2d2fdf542dbffdeb60b75
Christian Brabandt <cb@256bit.org>
parents:
7876
diff
changeset
|
3411 :set fillchars=stl:^,stlnc:=,vert:\|,fold:-,diff:- |
| 7 | 3412 < This is similar to the default, except that these characters will also |
| 3413 be used when there is highlighting. | |
| 3414 | |
|
24055
90d1636a8fcb
patch 8.2.2569: 'fillchars' "stl" and "stlnc" items must be single byte
Bram Moolenaar <Bram@vim.org>
parents:
23964
diff
changeset
|
3415 For "stl" and "stlnc" single-byte and multibyte characters are |
|
90d1636a8fcb
patch 8.2.2569: 'fillchars' "stl" and "stlnc" items must be single byte
Bram Moolenaar <Bram@vim.org>
parents:
23964
diff
changeset
|
3416 supported. But double-width characters are not supported. |
| 819 | 3417 |
| 7 | 3418 The highlighting used for these items: |
| 3419 item highlight group ~ | |
| 3420 stl:c StatusLine |hl-StatusLine| | |
| 3421 stlnc:c StatusLineNC |hl-StatusLineNC| | |
| 3422 vert:c VertSplit |hl-VertSplit| | |
| 3423 fold:c Folded |hl-Folded| | |
| 3424 diff:c DiffDelete |hl-DiffDelete| | |
|
23932
4549133c1e77
patch 8.2.2508: cannot change the character displayed in non existing lines
Bram Moolenaar <Bram@vim.org>
parents:
23931
diff
changeset
|
3425 eob:c EndOfBuffer |hl-EndOfBuffer| |
| 7 | 3426 |
| 6933 | 3427 *'fixendofline'* *'fixeol'* *'nofixendofline'* *'nofixeol'* |
| 3428 'fixendofline' 'fixeol' boolean (default on) | |
| 3429 local to buffer | |
| 3430 When writing a file and this option is on, <EOL> at the end of file | |
| 3431 will be restored if missing. Turn this option off if you want to | |
| 3432 preserve the situation from the original file. | |
| 3433 When the 'binary' option is set the value of this option doesn't | |
| 3434 matter. | |
| 3435 See the 'endofline' option. | |
| 3436 | |
| 7 | 3437 *'fkmap'* *'fk'* *'nofkmap'* *'nofk'* |
| 23666 | 3438 'fkmap' 'fk' boolean (default off) |
| 7 | 3439 global |
| 3440 {only available when compiled with the |+rightleft| | |
| 3441 feature} | |
|
15850
a6ca8cf07a98
patch 8.1.0932: Farsi support is outdated and unused
Bram Moolenaar <Bram@vim.org>
parents:
15840
diff
changeset
|
3442 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
|
3443 |farsi.txt|. |
| 7 | 3444 |
| 3445 *'foldclose'* *'fcl'* | |
| 3446 'foldclose' 'fcl' string (default "") | |
| 3447 global | |
| 3448 {not available when compiled without the |+folding| | |
| 3449 feature} | |
| 3450 When set to "all", a fold is closed when the cursor isn't in it and | |
| 3451 its level is higher than 'foldlevel'. Useful if you want folds to | |
| 3452 automatically close when moving out of them. | |
| 3453 | |
| 3454 *'foldcolumn'* *'fdc'* | |
| 3455 'foldcolumn' 'fdc' number (default 0) | |
| 3456 local to window | |
| 3457 {not available when compiled without the |+folding| | |
| 3458 feature} | |
| 3459 When non-zero, a column with the specified width is shown at the side | |
| 3460 of the window which indicates open and closed folds. The maximum | |
| 3461 value is 12. | |
| 3462 See |folding|. | |
| 3463 | |
| 3464 *'foldenable'* *'fen'* *'nofoldenable'* *'nofen'* | |
| 3465 'foldenable' 'fen' boolean (default on) | |
| 3466 local to window | |
| 3467 {not available when compiled without the |+folding| | |
| 3468 feature} | |
| 3469 When off, all folds are open. This option can be used to quickly | |
| 3470 switch between showing all text unfolded and viewing the text with | |
| 3471 folds (including manually opened or closed folds). It can be toggled | |
| 10 | 3472 with the |zi| command. The 'foldcolumn' will remain blank when |
| 7 | 3473 'foldenable' is off. |
| 3474 This option is set by commands that create a new fold or close a fold. | |
| 3475 See |folding|. | |
| 3476 | |
| 3477 *'foldexpr'* *'fde'* | |
| 3478 'foldexpr' 'fde' string (default: "0") | |
| 3479 local to window | |
| 3480 {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
|
3481 or |+eval| features} |
| 7 | 3482 The expression used for when 'foldmethod' is "expr". It is evaluated |
| 27321 | 3483 for each line to obtain its fold level. The context is set to the |
| 3484 script where 'foldexpr' was set, script-local items can be accessed. | |
| 3485 See |fold-expr| for the usage. | |
| 782 | 3486 |
| 3682 | 3487 The expression will be evaluated in the |sandbox| if set from a |
| 3488 modeline, see |sandbox-option|. | |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
3489 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
|
3490 on or the 'modelineexpr' option is off. |
| 634 | 3491 |
| 3492 It is not allowed to change text or jump to another window while | |
| 3493 evaluating 'foldexpr' |textlock|. | |
| 7 | 3494 |
| 3495 *'foldignore'* *'fdi'* | |
| 3496 'foldignore' 'fdi' string (default: "#") | |
| 3497 local to window | |
| 3498 {not available when compiled without the |+folding| | |
| 3499 feature} | |
| 3500 Used only when 'foldmethod' is "indent". Lines starting with | |
| 3501 characters in 'foldignore' will get their fold level from surrounding | |
| 10 | 3502 lines. White space is skipped before checking for this character. |
| 7 | 3503 The default "#" works well for C programs. See |fold-indent|. |
| 3504 | |
| 3505 *'foldlevel'* *'fdl'* | |
| 3506 'foldlevel' 'fdl' number (default: 0) | |
| 3507 local to window | |
| 3508 {not available when compiled without the |+folding| | |
| 3509 feature} | |
| 3510 Sets the fold level: Folds with a higher level will be closed. | |
| 3511 Setting this option to zero will close all folds. Higher numbers will | |
| 3512 close fewer folds. | |
| 3513 This option is set by commands like |zm|, |zM| and |zR|. | |
| 3514 See |fold-foldlevel|. | |
| 3515 | |
| 3516 *'foldlevelstart'* *'fdls'* | |
| 3517 'foldlevelstart' 'fdls' number (default: -1) | |
| 3518 global | |
| 3519 {not available when compiled without the |+folding| | |
| 3520 feature} | |
| 3521 Sets 'foldlevel' when starting to edit another buffer in a window. | |
| 3522 Useful to always start editing with all folds closed (value zero), | |
| 3523 some folds closed (one) or no folds closed (99). | |
| 3524 This is done before reading any modeline, thus a setting in a modeline | |
| 10 | 3525 overrules this option. Starting to edit a file for |diff-mode| also |
| 7 | 3526 ignores this option and closes all folds. |
| 3527 It is also done before BufReadPre autocommands, to allow an autocmd to | |
| 3528 overrule the 'foldlevel' value for specific files. | |
| 3529 When the value is negative, it is not used. | |
| 3530 | |
| 3531 *'foldmarker'* *'fmr'* *E536* | |
| 3532 'foldmarker' 'fmr' string (default: "{{{,}}}") | |
| 3533 local to window | |
| 3534 {not available when compiled without the |+folding| | |
| 3535 feature} | |
| 3536 The start and end marker used when 'foldmethod' is "marker". There | |
| 3537 must be one comma, which separates the start and end marker. The | |
| 3538 marker is a literal string (a regular expression would be too slow). | |
| 3539 See |fold-marker|. | |
| 3540 | |
| 3541 *'foldmethod'* *'fdm'* | |
| 3542 'foldmethod' 'fdm' string (default: "manual") | |
| 3543 local to window | |
| 3544 {not available when compiled without the |+folding| | |
| 3545 feature} | |
| 3546 The kind of folding used for the current window. Possible values: | |
| 3547 |fold-manual| manual Folds are created manually. | |
| 3548 |fold-indent| indent Lines with equal indent form a fold. | |
| 3549 |fold-expr| expr 'foldexpr' gives the fold level of a line. | |
| 3550 |fold-marker| marker Markers are used to specify folds. | |
| 3551 |fold-syntax| syntax Syntax highlighting items specify folds. | |
| 3552 |fold-diff| diff Fold text that is not changed. | |
| 3553 | |
| 3554 *'foldminlines'* *'fml'* | |
| 3555 'foldminlines' 'fml' number (default: 1) | |
| 3556 local to window | |
| 3557 {not available when compiled without the |+folding| | |
| 3558 feature} | |
| 2709 | 3559 Sets the number of screen lines above which a fold can be displayed |
| 3560 closed. Also for manually closed folds. With the default value of | |
| 3561 one a fold can only be closed if it takes up two or more screen lines. | |
| 3562 Set to zero to be able to close folds of just one screen line. | |
| 2826 | 3563 Note that this only has an effect on what is displayed. After using |
| 7 | 3564 "zc" to close a fold, which is displayed open because it's smaller |
| 3565 than 'foldminlines', a following "zc" may close a containing fold. | |
| 3566 | |
| 3567 *'foldnestmax'* *'fdn'* | |
| 3568 'foldnestmax' 'fdn' number (default: 20) | |
| 3569 local to window | |
| 3570 {not available when compiled without the |+folding| | |
| 3571 feature} | |
| 3572 Sets the maximum nesting of folds for the "indent" and "syntax" | |
| 3573 methods. This avoids that too many folds will be created. Using more | |
| 3574 than 20 doesn't work, because the internal limit is 20. | |
| 3575 | |
| 3576 *'foldopen'* *'fdo'* | |
| 3577 'foldopen' 'fdo' string (default: "block,hor,mark,percent,quickfix, | |
| 3578 search,tag,undo") | |
| 3579 global | |
| 3580 {not available when compiled without the |+folding| | |
| 3581 feature} | |
| 3582 Specifies for which type of commands folds will be opened, if the | |
| 28379 | 3583 command moves the cursor into a closed fold. It is a comma-separated |
| 7 | 3584 list of items. |
| 2625 | 3585 NOTE: When the command is part of a mapping this option is not used. |
| 3586 Add the |zv| command to the mapping to get the same effect. | |
| 3587 (rationale: the mapping may want to control opening folds itself) | |
| 3588 | |
| 7 | 3589 item commands ~ |
| 3590 all any | |
| 3591 block "(", "{", "[[", "[{", etc. | |
| 3592 hor horizontal movements: "l", "w", "fx", etc. | |
| 3593 insert any command in Insert mode | |
| 3594 jump far jumps: "G", "gg", etc. | |
| 3595 mark jumping to a mark: "'m", CTRL-O, etc. | |
| 3596 percent "%" | |
| 3597 quickfix ":cn", ":crew", ":make", etc. | |
| 3598 search search for a pattern: "/", "n", "*", "gd", etc. | |
| 3599 (not for a search pattern in a ":" command) | |
| 819 | 3600 Also for |[s| and |]s|. |
| 7 | 3601 tag jumping to a tag: ":ta", CTRL-T, etc. |
| 3602 undo undo or redo: "u" and CTRL-R | |
| 3603 When a movement command is used for an operator (e.g., "dl" or "y%") | |
| 3604 this option is not used. This means the operator will include the | |
| 3605 whole closed fold. | |
| 3606 Note that vertical movements are not here, because it would make it | |
| 3607 very difficult to move onto a closed fold. | |
| 3608 In insert mode the folds containing the cursor will always be open | |
| 3609 when text is inserted. | |
| 3610 To close folds you can re-apply 'foldlevel' with the |zx| command or | |
| 3611 set the 'foldclose' option to "all". | |
| 3612 | |
| 3613 *'foldtext'* *'fdt'* | |
| 3614 'foldtext' 'fdt' string (default: "foldtext()") | |
| 3615 local to window | |
| 3616 {not available when compiled without the |+folding| | |
| 3617 feature} | |
| 3618 An expression which is used to specify the text displayed for a closed | |
| 27321 | 3619 fold. The context is set to the script where 'foldexpr' was set, |
| 3620 script-local items can be accessed. See |fold-foldtext| for the | |
| 3621 usage. | |
| 7 | 3622 |
| 3682 | 3623 The expression will be evaluated in the |sandbox| if set from a |
| 3624 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
|
3625 This option cannot be set in a modeline when 'modelineexpr' is off. |
| 634 | 3626 |
| 3627 It is not allowed to change text or jump to another window while | |
| 3628 evaluating 'foldtext' |textlock|. | |
| 3629 | |
|
9286
64035abb986b
commit https://github.com/vim/vim/commit/c95a302a4c42ec8230473cd4a5e0064d0a143aa8
Christian Brabandt <cb@256bit.org>
parents:
9227
diff
changeset
|
3630 *'formatexpr'* *'fex'* |
|
64035abb986b
commit https://github.com/vim/vim/commit/c95a302a4c42ec8230473cd4a5e0064d0a143aa8
Christian Brabandt <cb@256bit.org>
parents:
9227
diff
changeset
|
3631 'formatexpr' 'fex' string (default "") |
|
64035abb986b
commit https://github.com/vim/vim/commit/c95a302a4c42ec8230473cd4a5e0064d0a143aa8
Christian Brabandt <cb@256bit.org>
parents:
9227
diff
changeset
|
3632 local to buffer |
|
64035abb986b
commit https://github.com/vim/vim/commit/c95a302a4c42ec8230473cd4a5e0064d0a143aa8
Christian Brabandt <cb@256bit.org>
parents:
9227
diff
changeset
|
3633 {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
|
3634 feature} |
|
64035abb986b
commit https://github.com/vim/vim/commit/c95a302a4c42ec8230473cd4a5e0064d0a143aa8
Christian Brabandt <cb@256bit.org>
parents:
9227
diff
changeset
|
3635 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
|
3636 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
|
3637 option is empty 'formatprg' is used. |
|
64035abb986b
commit https://github.com/vim/vim/commit/c95a302a4c42ec8230473cd4a5e0064d0a143aa8
Christian Brabandt <cb@256bit.org>
parents:
9227
diff
changeset
|
3638 |
|
64035abb986b
commit https://github.com/vim/vim/commit/c95a302a4c42ec8230473cd4a5e0064d0a143aa8
Christian Brabandt <cb@256bit.org>
parents:
9227
diff
changeset
|
3639 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
|
3640 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
|
3641 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
|
3642 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
|
3643 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
|
3644 it yet! |
|
64035abb986b
commit https://github.com/vim/vim/commit/c95a302a4c42ec8230473cd4a5e0064d0a143aa8
Christian Brabandt <cb@256bit.org>
parents:
9227
diff
changeset
|
3645 |
|
64035abb986b
commit https://github.com/vim/vim/commit/c95a302a4c42ec8230473cd4a5e0064d0a143aa8
Christian Brabandt <cb@256bit.org>
parents:
9227
diff
changeset
|
3646 Example: > |
|
64035abb986b
commit https://github.com/vim/vim/commit/c95a302a4c42ec8230473cd4a5e0064d0a143aa8
Christian Brabandt <cb@256bit.org>
parents:
9227
diff
changeset
|
3647 :set formatexpr=mylang#Format() |
|
64035abb986b
commit https://github.com/vim/vim/commit/c95a302a4c42ec8230473cd4a5e0064d0a143aa8
Christian Brabandt <cb@256bit.org>
parents:
9227
diff
changeset
|
3648 < 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
|
3649 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
|
3650 |
|
64035abb986b
commit https://github.com/vim/vim/commit/c95a302a4c42ec8230473cd4a5e0064d0a143aa8
Christian Brabandt <cb@256bit.org>
parents:
9227
diff
changeset
|
3651 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
|
3652 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
|
3653 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
|
3654 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
|
3655 return "i" or "R" in this situation. |
|
13341
acd7eaa13d2b
Updated runtime files.
Christian Brabandt <cb@256bit.org>
parents:
13314
diff
changeset
|
3656 |
|
9286
64035abb986b
commit https://github.com/vim/vim/commit/c95a302a4c42ec8230473cd4a5e0064d0a143aa8
Christian Brabandt <cb@256bit.org>
parents:
9227
diff
changeset
|
3657 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
|
3658 the internal format mechanism. |
|
64035abb986b
commit https://github.com/vim/vim/commit/c95a302a4c42ec8230473cd4a5e0064d0a143aa8
Christian Brabandt <cb@256bit.org>
parents:
9227
diff
changeset
|
3659 |
|
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
|
3660 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
|
3661 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
|
3662 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
|
3663 set formatexpr=<SID>SomeFormatExpr() |
| 27321 | 3664 < Otherwise, the expression is evaluated in the context of the script |
| 3665 where the option was set, thus script-local items are available. | |
| 3666 | |
|
9286
64035abb986b
commit https://github.com/vim/vim/commit/c95a302a4c42ec8230473cd4a5e0064d0a143aa8
Christian Brabandt <cb@256bit.org>
parents:
9227
diff
changeset
|
3667 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
|
3668 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
|
3669 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
|
3670 This option cannot be set in a modeline when 'modelineexpr' is off. |
| 11160 | 3671 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
|
3672 |
| 41 | 3673 *'formatlistpat'* *'flp'* |
| 3674 'formatlistpat' 'flp' string (default: "^\s*\d\+[\]:.)}\t ]\s*") | |
| 3675 local to buffer | |
| 3676 A pattern that is used to recognize a list header. This is used for | |
| 3677 the "n" flag in 'formatoptions'. | |
| 3678 The pattern must match exactly the text that will be the indent for | |
| 140 | 3679 the line below it. You can use |/\ze| to mark the end of the match |
| 41 | 3680 while still checking more characters. There must be a character |
| 3681 following the pattern, when it matches the whole line it is handled | |
| 3682 like there is no match. | |
| 3683 The default recognizes a number, followed by an optional punctuation | |
| 3684 character and white space. | |
| 3685 | |
|
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
|
3686 *'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
|
3687 '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
|
3688 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
|
3689 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
|
3690 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
|
3691 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
|
3692 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
|
3693 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
|
3694 "+=" 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
|
3695 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
|
3696 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
|
3697 |
| 7 | 3698 *'formatprg'* *'fp'* |
| 3699 '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
|
3700 global or local to buffer |global-local| |
| 7 | 3701 The name of an external program that will be used to format the lines |
| 667 | 3702 selected with the |gq| operator. The program must take the input on |
| 7 | 3703 stdin and produce the output on stdout. The Unix program "fmt" is |
| 557 | 3704 such a program. |
| 667 | 3705 If the 'formatexpr' option is not empty it will be used instead. |
| 3706 Otherwise, if 'formatprg' option is an empty string, the internal | |
| 3707 format function will be used |C-indenting|. | |
| 557 | 3708 Environment variables are expanded |:set_env|. See |option-backslash| |
| 3709 about including spaces and backslashes. | |
| 3682 | 3710 This option cannot be set from a |modeline| or in the |sandbox|, for |
| 3711 security reasons. | |
| 667 | 3712 |
|
7196
42717d048817
commit https://github.com/vim/vim/commit/d94464ee294a351ce7b6ba18e8bd3f24f1bef920
Christian Brabandt <cb@256bit.org>
parents:
7147
diff
changeset
|
3713 *'fsync'* *'fs'* *'nofsync'* *'nofs'* |
| 36 | 3714 'fsync' 'fs' boolean (default on) |
| 3715 global | |
| 3716 When on, the library function fsync() will be called after writing a | |
| 3717 file. This will flush a file to disk, ensuring that it is safely | |
| 3718 written even on filesystems which do metadata-only journaling. This | |
| 3719 will force the harddrive to spin up on Linux systems running in laptop | |
| 3720 mode, so it may be undesirable in some situations. Be warned that | |
| 3721 turning this off increases the chances of data loss after a crash. On | |
| 3722 systems without an fsync() implementation, this variable is always | |
| 3723 off. | |
| 3724 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
|
3725 '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
|
3726 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
|
3727 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
|
3728 security reasons. |
| 36 | 3729 |
| 7 | 3730 *'gdefault'* *'gd'* *'nogdefault'* *'nogd'* |
| 3731 'gdefault' 'gd' boolean (default off) | |
| 3732 global | |
| 3733 When on, the ":substitute" flag 'g' is default on. This means that | |
| 3734 all matches in a line are substituted instead of one. When a 'g' flag | |
| 3735 is given to a ":substitute" command, this will toggle the substitution | |
| 3736 of all or one match. See |complex-change|. | |
| 3737 | |
| 3738 command 'gdefault' on 'gdefault' off ~ | |
| 3739 :s/// subst. all subst. one | |
| 3740 :s///g subst. one subst. all | |
| 3741 :s///gg subst. all subst. one | |
| 3742 | |
| 3743 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
|
3744 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
|
3745 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
|
3746 has the opposite effect of that it normally does. |
| 23305 | 3747 This option is not used in |Vim9| script. |
| 7 | 3748 |
| 3749 *'grepformat'* *'gfm'* | |
| 6213 | 3750 'grepformat' 'gfm' string (default "%f:%l:%m,%f:%l%m,%f %l%m") |
| 7 | 3751 global |
| 3752 Format to recognize for the ":grep" command output. | |
| 3753 This is a scanf-like string that uses the same format as the | |
| 3754 'errorformat' option: see |errorformat|. | |
| 3755 | |
| 3756 *'grepprg'* *'gp'* | |
| 3757 'grepprg' 'gp' string (default "grep -n ", | |
| 3758 Unix: "grep -n $* /dev/null", | |
| 3759 Win32: "findstr /n" or "grep -n", | |
| 3760 VMS: "SEARCH/NUMBERS ") | |
| 3761 global or local to buffer |global-local| | |
| 233 | 3762 Program to use for the |:grep| command. This option may contain '%' |
| 7 | 3763 and '#' characters, which are expanded like when used in a command- |
| 3764 line. The placeholder "$*" is allowed to specify where the arguments | |
| 3765 will be included. Environment variables are expanded |:set_env|. See | |
| 3766 |option-backslash| about including spaces and backslashes. | |
| 3767 When your "grep" accepts the "-H" argument, use this to make ":grep" | |
| 3768 also work well with a single file: > | |
| 3769 :set grepprg=grep\ -nH | |
| 161 | 3770 < Special value: When 'grepprg' is set to "internal" the |:grep| command |
| 657 | 3771 works like |:vimgrep|, |:lgrep| like |:lvimgrep|, |:grepadd| like |
| 3772 |:vimgrepadd| and |:lgrepadd| like |:lvimgrepadd|. | |
| 41 | 3773 See also the section |:make_makeprg|, since most of the comments there |
| 7 | 3774 apply equally to 'grepprg'. |
| 3775 For Win32, the default is "findstr /n" if "findstr.exe" can be found, | |
| 3776 otherwise it's "grep -n". | |
| 3777 This option cannot be set from a |modeline| or in the |sandbox|, for | |
| 3778 security reasons. | |
| 3779 | |
| 3780 *'guicursor'* *'gcr'* *E545* *E546* *E548* *E549* | |
| 3781 'guicursor' 'gcr' string (default "n-v-c:block-Cursor/lCursor, | |
| 3782 ve:ver35-Cursor, | |
| 3783 o:hor50-Cursor, | |
| 3784 i-ci:ver25-Cursor/lCursor, | |
| 3785 r-cr:hor20-Cursor/lCursor, | |
| 3786 sm:block-Cursor | |
| 3787 -blinkwait175-blinkoff150-blinkon175", | |
| 18972 | 3788 for Win32 console: |
| 7 | 3789 "n-v-c:block,o:hor50,i-ci:hor15, |
| 3790 r-cr:hor30,sm:block") | |
| 3791 global | |
| 3792 {only available when compiled with GUI enabled, and | |
| 18972 | 3793 for Win32 console} |
| 7 | 3794 This option tells Vim what the cursor should look like in different |
| 19116 | 3795 modes. It fully works in the GUI. In a Win32 console, only the |
| 18972 | 3796 height of the cursor can be changed. This can be done by specifying a |
| 3797 block cursor, or a percentage for a vertical or horizontal cursor. | |
| 6727 | 3798 For a console the 't_SI', 't_SR', and 't_EI' escape sequences are |
| 3799 used. | |
| 7 | 3800 |
| 28379 | 3801 The option is a comma-separated list of parts. Each part consist of a |
| 7 | 3802 mode-list and an argument-list: |
| 3803 mode-list:argument-list,mode-list:argument-list,.. | |
| 3804 The mode-list is a dash separated list of these modes: | |
| 3805 n Normal mode | |
| 3806 v Visual mode | |
| 3807 ve Visual mode with 'selection' "exclusive" (same as 'v', | |
| 3808 if not specified) | |
| 3809 o Operator-pending mode | |
| 3810 i Insert mode | |
| 3811 r Replace mode | |
| 3812 c Command-line Normal (append) mode | |
| 3813 ci Command-line Insert mode | |
| 3814 cr Command-line Replace mode | |
| 3815 sm showmatch in Insert mode | |
| 3816 a all modes | |
| 3817 The argument-list is a dash separated list of these arguments: | |
| 3818 hor{N} horizontal bar, {N} percent of the character height | |
| 3819 ver{N} vertical bar, {N} percent of the character width | |
| 3820 block block cursor, fills the whole character | |
| 3821 [only one of the above three should be present] | |
| 3822 blinkwait{N} *cursor-blinking* | |
| 3823 blinkon{N} | |
| 3824 blinkoff{N} | |
| 3825 blink times for cursor: blinkwait is the delay before | |
| 3826 the cursor starts blinking, blinkon is the time that | |
| 3827 the cursor is shown and blinkoff is the time that the | |
| 3828 cursor is not shown. The times are in msec. When one | |
| 3829 of the numbers is zero, there is no blinking. The | |
| 3830 default is: "blinkwait700-blinkon400-blinkoff250". | |
| 3831 These numbers are used for a missing entry. This | |
| 3832 means that blinking is enabled by default. To switch | |
| 3833 blinking off you can use "blinkon0". The cursor only | |
| 3834 blinks when Vim is waiting for input, not while | |
| 3835 executing a command. | |
| 3836 To make the cursor blink in an xterm, see | |
| 3837 |xterm-blink|. | |
| 3838 {group-name} | |
| 3839 a highlight group name, that sets the color and font | |
| 3840 for the cursor | |
| 3841 {group-name}/{group-name} | |
| 3842 Two highlight group names, the first is used when | |
| 3843 no language mappings are used, the other when they | |
| 3844 are. |language-mapping| | |
| 3845 | |
| 3846 Examples of parts: | |
| 3847 n-c-v:block-nCursor in Normal, Command-line and Visual mode, use a | |
| 3848 block cursor with colors from the "nCursor" | |
| 3849 highlight group | |
| 3850 i-ci:ver30-iCursor-blinkwait300-blinkon200-blinkoff150 | |
| 3851 In Insert and Command-line Insert mode, use a | |
| 3852 30% vertical bar cursor with colors from the | |
| 3853 "iCursor" highlight group. Blink a bit | |
| 3854 faster. | |
| 3855 | |
| 3856 The 'a' mode is different. It will set the given argument-list for | |
| 3857 all modes. It does not reset anything to defaults. This can be used | |
| 3858 to do a common setting for all modes. For example, to switch off | |
| 3859 blinking: "a:blinkon0" | |
| 3860 | |
| 3861 Examples of cursor highlighting: > | |
| 3862 :highlight Cursor gui=reverse guifg=NONE guibg=NONE | |
| 3863 :highlight Cursor gui=NONE guifg=bg guibg=fg | |
| 3864 < | |
| 3865 *'guifont'* *'gfn'* | |
| 2908 | 3866 *E235* *E596* |
| 7 | 3867 'guifont' 'gfn' string (default "") |
| 3868 global | |
| 3869 {only available when compiled with GUI enabled} | |
| 3870 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
|
3871 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
|
3872 See |gui-font| for the details. |
| 7 | 3873 |
| 3874 *'guifontset'* *'gfs'* | |
| 3875 *E250* *E252* *E234* *E597* *E598* | |
| 3876 'guifontset' 'gfs' string (default "") | |
| 3877 global | |
| 3878 {only available when compiled with GUI enabled and | |
| 3879 with the |+xfontset| feature} | |
|
10895
c391bfbdb452
Updated runtime files.
Christian Brabandt <cb@256bit.org>
parents:
10734
diff
changeset
|
3880 {not available in the GTK+ GUI} |
| 7 | 3881 When not empty, specifies two (or more) fonts to be used. The first |
| 3882 one for normal English, the second one for your special language. See | |
| 3883 |xfontset|. | |
|
16439
9d20e26dc13c
patch 8.1.1224: MS-Windows: cannot specify font weight
Bram Moolenaar <Bram@vim.org>
parents:
16427
diff
changeset
|
3884 |
| 7 | 3885 *'guifontwide'* *'gfw'* *E231* *E533* *E534* |
| 3886 'guifontwide' 'gfw' string (default "") | |
| 3887 global | |
| 3888 {only available when compiled with GUI enabled} | |
| 3889 When not empty, specifies a comma-separated list of fonts to be used | |
| 3890 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
|
3891 used. See |gui-fontwide|. |
| 4055 | 3892 |
| 7 | 3893 *'guiheadroom'* *'ghr'* |
| 3894 'guiheadroom' 'ghr' number (default 50) | |
| 3895 global | |
|
16728
e55c26aaf484
patch 8.1.1366: using expressions in a modeline is unsafe
Bram Moolenaar <Bram@vim.org>
parents:
16610
diff
changeset
|
3896 {only for GTK and X11 GUI} |
| 7 | 3897 The number of pixels subtracted from the screen height when fitting |
| 3898 the GUI window on the screen. Set this before the GUI is started, | |
| 3899 e.g., in your |gvimrc| file. When zero, the whole screen height will | |
| 10 | 3900 be used by the window. When positive, the specified number of pixel |
| 7 | 3901 lines will be left for window decorations and other items on the |
| 3902 screen. Set it to a negative value to allow windows taller than the | |
| 3903 screen. | |
| 3904 | |
|
25982
aade8ef975d5
patch 8.2.3524: GUI: ligatures are not used
Bram Moolenaar <Bram@vim.org>
parents:
25978
diff
changeset
|
3905 *'guiligatures'* *'gli'* *E1243* |
|
aade8ef975d5
patch 8.2.3524: GUI: ligatures are not used
Bram Moolenaar <Bram@vim.org>
parents:
25978
diff
changeset
|
3906 'guiligatures' 'gli' string (default "") |
|
aade8ef975d5
patch 8.2.3524: GUI: ligatures are not used
Bram Moolenaar <Bram@vim.org>
parents:
25978
diff
changeset
|
3907 global |
|
aade8ef975d5
patch 8.2.3524: GUI: ligatures are not used
Bram Moolenaar <Bram@vim.org>
parents:
25978
diff
changeset
|
3908 {only for GTK GUI} |
|
aade8ef975d5
patch 8.2.3524: GUI: ligatures are not used
Bram Moolenaar <Bram@vim.org>
parents:
25978
diff
changeset
|
3909 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
|
3910 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
|
3911 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
|
3912 Example: > |
|
aade8ef975d5
patch 8.2.3524: GUI: ligatures are not used
Bram Moolenaar <Bram@vim.org>
parents:
25978
diff
changeset
|
3913 :set guiligatures=!\"#$%&()*+-./:<=>?@[]^_{\|~ |
|
aade8ef975d5
patch 8.2.3524: GUI: ligatures are not used
Bram Moolenaar <Bram@vim.org>
parents:
25978
diff
changeset
|
3914 < 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
|
3915 empty string to disable ligatures. |
|
aade8ef975d5
patch 8.2.3524: GUI: ligatures are not used
Bram Moolenaar <Bram@vim.org>
parents:
25978
diff
changeset
|
3916 |
| 7 | 3917 *'guioptions'* *'go'* |
| 14945 | 3918 'guioptions' 'go' string (default "egmrLtT" (MS-Windows, |
| 3919 "t" is removed in |defaults.vim|), | |
| 28379 | 3920 "aegimrLtT" (GTK and Motif), |
|
9669
284b4eb307fc
commit https://github.com/vim/vim/commit/8c08b5b569e2a9e9f63dea514591ecfa2d3bb392
Christian Brabandt <cb@256bit.org>
parents:
9665
diff
changeset
|
3921 ) |
| 7 | 3922 global |
| 3923 {only available when compiled with GUI enabled} | |
| 8 | 3924 This option only has an effect in the GUI version of Vim. It is a |
| 7 | 3925 sequence of letters which describes what components and options of the |
| 3926 GUI should be used. | |
| 3927 To avoid problems with flags that are added in the future, use the | |
| 3928 "+=" and "-=" feature of ":set" |add-option-flags|. | |
| 3929 | |
|
13470
6faef782f50b
patch 8.0.1609: shell commands in the GUI use a dumb terminal
Christian Brabandt <cb@256bit.org>
parents:
13437
diff
changeset
|
3930 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
|
3931 *'go-!'* |
|
6faef782f50b
patch 8.0.1609: shell commands in the GUI use a dumb terminal
Christian Brabandt <cb@256bit.org>
parents:
13437
diff
changeset
|
3932 '!' 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
|
3933 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
|
3934 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
|
3935 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
|
3936 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
|
3937 upwards as needed. |
| 14999 | 3938 *'go-a'* |
| 7 | 3939 'a' Autoselect: If present, then whenever VISUAL mode is started, |
| 3940 or the Visual area extended, Vim tries to become the owner of | |
| 3941 the windowing system's global selection. This means that the | |
| 3942 Visually highlighted text is available for pasting into other | |
| 3943 applications as well as into Vim itself. When the Visual mode | |
| 3944 ends, possibly due to an operation on the text, or when an | |
| 3945 application wants to paste the selection, the highlighted text | |
| 3946 is automatically yanked into the "* selection register. | |
| 3947 Thus the selection is still available for pasting into other | |
| 3948 applications after the VISUAL mode has ended. | |
| 3949 If not present, then Vim won't become the owner of the | |
| 3950 windowing system's global selection unless explicitly told to | |
| 3951 by a yank or delete operation for the "* register. | |
| 3952 The same applies to the modeless selection. | |
| 3674 | 3953 *'go-P'* |
| 3954 '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
|
3955 register. |
| 1152 | 3956 *'go-A'* |
| 10 | 3957 'A' Autoselect for the modeless selection. Like 'a', but only |
| 7 | 3958 applies to the modeless selection. |
| 3959 | |
| 3960 'guioptions' autoselect Visual autoselect modeless ~ | |
| 3961 "" - - | |
| 3962 "a" yes yes | |
| 3963 "A" - yes | |
| 3964 "aA" yes yes | |
| 3965 | |
| 1152 | 3966 *'go-c'* |
| 7 | 3967 'c' Use console dialogs instead of popup dialogs for simple |
| 3968 choices. | |
|
18078
5ae41d0ea397
patch 8.1.2034: dark them of GTK 3 not supported
Bram Moolenaar <Bram@vim.org>
parents:
18068
diff
changeset
|
3969 *'go-d'* |
|
5ae41d0ea397
patch 8.1.2034: dark them of GTK 3 not supported
Bram Moolenaar <Bram@vim.org>
parents:
18068
diff
changeset
|
3970 '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
|
3971 GTK+ GUI. |
| 1152 | 3972 *'go-e'* |
| 697 | 3973 'e' Add tab pages when indicated with 'showtabline'. |
| 688 | 3974 'guitablabel' can be used to change the text in the labels. |
| 3975 When 'e' is missing a non-GUI tab pages line may be used. | |
| 857 | 3976 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
|
3977 GTK, Motif, Mac OS/X, Haiku, and MS-Windows. |
| 1152 | 3978 *'go-f'* |
| 7 | 3979 'f' Foreground: Don't use fork() to detach the GUI from the shell |
| 3980 where it was started. Use this for programs that wait for the | |
| 3981 editor to finish (e.g., an e-mail program). Alternatively you | |
| 3982 can use "gvim -f" or ":gui -f" to start the GUI in the | |
| 3983 foreground. |gui-fork| | |
| 3984 Note: Set this option in the vimrc file. The forking may have | |
| 819 | 3985 happened already when the |gvimrc| file is read. |
| 1152 | 3986 *'go-i'* |
| 7 | 3987 'i' Use a Vim icon. For GTK with KDE it is used in the left-upper |
| 3988 corner of the window. It's black&white on non-GTK, because of | |
| 3989 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
|
3990 *'go-m'* |
| 7 | 3991 'm' Menu bar is present. |
|
2290
22529abcd646
Fixed ":s" message. Docs updates.
Bram Moolenaar <bram@vim.org>
parents:
2283
diff
changeset
|
3992 *'go-M'* |
| 10 | 3993 'M' The system menu "$VIMRUNTIME/menu.vim" is not sourced. Note |
| 7 | 3994 that this flag must be added in the .vimrc file, before |
| 819 | 3995 switching on syntax or filetype recognition (when the |gvimrc| |
| 7 | 3996 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
|
3997 `: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
|
3998 *'go-g'* |
| 7 | 3999 'g' Grey menu items: Make menu items that are not active grey. If |
| 4000 'g' is not included inactive menu items are not shown at all. | |
| 1152 | 4001 *'go-t'* |
| 7 | 4002 't' Include tearoff menu items. Currently only works for Win32, |
| 4003 GTK+, and Motif 1.2 GUI. | |
| 1152 | 4004 *'go-T'* |
| 28379 | 4005 'T' Include Toolbar. Currently only in Win32, GTK+, Motif and |
| 4006 Photon GUIs. | |
| 1152 | 4007 *'go-r'* |
| 7 | 4008 'r' Right-hand scrollbar is always present. |
|
2290
22529abcd646
Fixed ":s" message. Docs updates.
Bram Moolenaar <bram@vim.org>
parents:
2283
diff
changeset
|
4009 *'go-R'* |
| 7 | 4010 'R' Right-hand scrollbar is present when there is a vertically |
| 4011 split window. | |
|
2290
22529abcd646
Fixed ":s" message. Docs updates.
Bram Moolenaar <bram@vim.org>
parents:
2283
diff
changeset
|
4012 *'go-l'* |
| 7 | 4013 'l' Left-hand scrollbar is always present. |
|
2290
22529abcd646
Fixed ":s" message. Docs updates.
Bram Moolenaar <bram@vim.org>
parents:
2283
diff
changeset
|
4014 *'go-L'* |
| 7 | 4015 'L' Left-hand scrollbar is present when there is a vertically |
| 4016 split window. | |
| 1152 | 4017 *'go-b'* |
| 7 | 4018 'b' Bottom (horizontal) scrollbar is present. Its size depends on |
| 4019 the longest visible line, or on the cursor line if the 'h' | |
| 4020 flag is included. |gui-horiz-scroll| | |
|
2290
22529abcd646
Fixed ":s" message. Docs updates.
Bram Moolenaar <bram@vim.org>
parents:
2283
diff
changeset
|
4021 *'go-h'* |
| 7 | 4022 'h' Limit horizontal scrollbar size to the length of the cursor |
| 4023 line. Reduces computations. |gui-horiz-scroll| | |
| 4024 | |
| 4025 And yes, you may even have scrollbars on the left AND the right if | |
| 4026 you really want to :-). See |gui-scrollbars| for more information. | |
| 4027 | |
|
2290
22529abcd646
Fixed ":s" message. Docs updates.
Bram Moolenaar <bram@vim.org>
parents:
2283
diff
changeset
|
4028 *'go-v'* |
| 7 | 4029 'v' Use a vertical button layout for dialogs. When not included, |
| 4030 a horizontal layout is preferred, but when it doesn't fit a | |
| 24278 | 4031 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
|
4032 *'go-p'* |
| 7 | 4033 'p' Use Pointer callbacks for X11 GUI. This is required for some |
| 4034 window managers. If the cursor is not blinking or hollow at | |
| 4035 the right moment, try adding this flag. This must be done | |
| 819 | 4036 before starting the GUI. Set it in your |gvimrc|. Adding or |
| 7 | 4037 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
|
4038 *'go-F'* |
| 10 | 4039 '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
|
4040 *'go-k'* |
|
29a728529f92
patch 8.0.1278: GUI window always resizes when adding scrollbar
Christian Brabandt <cb@256bit.org>
parents:
12785
diff
changeset
|
4041 '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
|
4042 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
|
4043 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
|
4044 '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
|
4045 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
|
4046 removing GUI components. |
| 1152 | 4047 |
| 7 | 4048 *'guipty'* *'noguipty'* |
| 4049 'guipty' boolean (default on) | |
| 4050 global | |
| 4051 {only available when compiled with GUI enabled} | |
| 4052 Only in the GUI: If on, an attempt is made to open a pseudo-tty for | |
| 4053 I/O to/from shell commands. See |gui-pty|. | |
| 4054 | |
| 688 | 4055 *'guitablabel'* *'gtl'* |
| 4056 'guitablabel' 'gtl' string (default empty) | |
| 4057 global | |
|
17771
4bd21046902b
patch 8.1.1882: cannot specify properties of the info popup window
Bram Moolenaar <Bram@vim.org>
parents:
17767
diff
changeset
|
4058 {only available when compiled with GUI enabled} |
| 27804 | 4059 When non-empty describes the text to use in a label of the GUI tab |
| 857 | 4060 pages line. When empty and when the result is empty Vim will use a |
| 4061 default label. See |setting-guitablabel| for more info. | |
| 688 | 4062 |
| 692 | 4063 The format of this option is like that of 'statusline'. |
| 839 | 4064 '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
|
4065 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
|
4066 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
|
4067 This option cannot be set in a modeline when 'modelineexpr' is off. |
| 692 | 4068 |
| 688 | 4069 Only used when the GUI tab pages line is displayed. 'e' must be |
| 4070 present in 'guioptions'. For the non-GUI tab pages line 'tabline' is | |
| 4071 used. | |
| 4072 | |
| 839 | 4073 *'guitabtooltip'* *'gtt'* |
| 4074 'guitabtooltip' 'gtt' string (default empty) | |
| 4075 global | |
|
17771
4bd21046902b
patch 8.1.1882: cannot specify properties of the info popup window
Bram Moolenaar <Bram@vim.org>
parents:
17767
diff
changeset
|
4076 {only available when compiled with GUI enabled} |
| 27804 | 4077 When non-empty describes the text to use in a tooltip for the GUI tab |
| 839 | 4078 pages line. When empty Vim will use a default tooltip. |
| 4079 This option is otherwise just like 'guitablabel' above. | |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
4080 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
|
4081 :let &guitabtooltip = "line one\nline two" |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
4082 < |
| 839 | 4083 |
| 7 | 4084 *'helpfile'* *'hf'* |
| 18972 | 4085 'helpfile' 'hf' string (default (MS-Windows) "$VIMRUNTIME\doc\help.txt" |
| 7 | 4086 (others) "$VIMRUNTIME/doc/help.txt") |
| 4087 global | |
| 4088 Name of the main help file. All distributed help files should be | |
| 4089 placed together in one directory. Additionally, all "doc" directories | |
| 4090 in 'runtimepath' will be used. | |
| 4091 Environment variables are expanded |:set_env|. For example: | |
| 4092 "$VIMRUNTIME/doc/help.txt". If $VIMRUNTIME is not set, $VIM is also | |
| 10 | 4093 tried. Also see |$VIMRUNTIME| and |option-backslash| about including |
| 7 | 4094 spaces and backslashes. |
| 4095 This option cannot be set from a |modeline| or in the |sandbox|, for | |
| 4096 security reasons. | |
| 4097 | |
| 4098 *'helpheight'* *'hh'* | |
| 4099 'helpheight' 'hh' number (default 20) | |
| 4100 global | |
| 4101 Minimal initial height of the help window when it is opened with the | |
| 4102 ":help" command. The initial height of the help window is half of the | |
| 4103 current window, or (when the 'ea' option is on) the same as other | |
| 4104 windows. When the height is less than 'helpheight', the height is | |
| 4105 set to 'helpheight'. Set to zero to disable. | |
| 4106 | |
| 4107 *'helplang'* *'hlg'* | |
| 4108 'helplang' 'hlg' string (default: messages language or empty) | |
| 4109 global | |
| 4110 {only available when compiled with the |+multi_lang| | |
| 4111 feature} | |
| 28379 | 4112 Comma-separated list of languages. Vim will use the first language |
| 7 | 4113 for which the desired help can be found. The English help will always |
| 4114 be used as a last resort. You can add "en" to prefer English over | |
| 4115 another language, but that will only find tags that exist in that | |
| 4116 language and not in the English help. | |
| 4117 Example: > | |
| 4118 :set helplang=de,it | |
| 4119 < This will first search German, then Italian and finally English help | |
| 4120 files. | |
| 4121 When using |CTRL-]| and ":help!" in a non-English help file Vim will | |
| 4122 try to find the tag in the current language before using this option. | |
| 4123 See |help-translated|. | |
| 4124 | |
| 4125 *'hidden'* *'hid'* *'nohidden'* *'nohid'* | |
| 4126 'hidden' 'hid' boolean (default off) | |
| 4127 global | |
| 4128 When off a buffer is unloaded when it is |abandon|ed. When on a | |
| 4129 buffer becomes hidden when it is |abandon|ed. If the buffer is still | |
| 4130 displayed in another window, it does not become hidden, of course. | |
| 28379 | 4131 |
| 7 | 4132 The commands that move through the buffer list sometimes make a buffer |
| 28379 | 4133 hidden even if the 'hidden' option is off when these three are true: |
| 4134 - the buffer is modified | |
| 4135 - 'autowrite' is off or writing is not possible | |
| 4136 - the '!' flag was used | |
| 4137 Also see |windows.txt|. | |
| 4138 | |
| 12 | 4139 To only make one buffer hidden use the 'bufhidden' option. |
| 7 | 4140 This option is set for one command with ":hide {command}" |:hide|. |
| 4141 WARNING: It's easy to forget that you have changes in hidden buffers. | |
| 4142 Think twice when using ":q!" or ":qa!". | |
| 4143 | |
| 4144 *'highlight'* *'hl'* | |
| 4145 '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
|
4146 "8:SpecialKey,~:EndOfBuffer,@:NonText, |
|
7da89d9c744b
commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents:
9860
diff
changeset
|
4147 d:Directory,e:ErrorMsg,i:IncSearch, |
|
7da89d9c744b
commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents:
9860
diff
changeset
|
4148 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
|
4149 a:LineNrAbove,b:LineNrBelow, |
|
9877
7da89d9c744b
commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents:
9860
diff
changeset
|
4150 N:CursorLineNr,r:Question,s:StatusLine, |
|
7da89d9c744b
commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents:
9860
diff
changeset
|
4151 S:StatusLineNC,c:VertSplit,t:Title, |
| 15194 | 4152 v:Visual,V:VisualNOS,w:WarningMsg, |
| 4153 W:WildMenu,f:Folded,F:FoldColumn, | |
| 4154 A:DiffAdd,C:DiffChange,D:DiffDelete, | |
| 4155 T:DiffText,>:SignColumn,-:Conceal, | |
| 15281 | 4156 B:SpellBad,P:SpellCap,R:SpellRare, |
| 15194 | 4157 L:SpellLocal,+:Pmenu,=:PmenuSel, |
|
11516
80491a71c716
patch 8.0.0641: cannot set a separate highlighting for the quickfix line
Christian Brabandt <cb@256bit.org>
parents:
11473
diff
changeset
|
4158 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
|
4159 #:TabLineSel,_:TabLineFill,!:CursorColumn, |
| 11914 | 4160 .:CursorLine,o:ColorColumn,q:QuickFixLine, |
| 12254 | 4161 z:StatusLineTerm,Z:StatusLineTermNC") |
| 7 | 4162 global |
| 4163 This option can be used to set highlighting mode for various | |
| 28379 | 4164 occasions. It is a comma-separated list of character pairs. The |
| 7 | 4165 first character in a pair gives the occasion, the second the mode to |
| 10 | 4166 use for that occasion. The occasions are: |
| 7 | 4167 |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
|
4168 |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
|
4169 |hl-NonText| @ '@' at the end of the window and |
| 7 | 4170 characters from 'showbreak' |
| 4171 |hl-Directory| d directories in CTRL-D listing and other special | |
| 4172 things in listings | |
| 4173 |hl-ErrorMsg| e error messages | |
| 4174 h (obsolete, ignored) | |
| 4175 |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
|
4176 |hl-CurSearch| y current instance of last search pattern |
| 7 | 4177 |hl-Search| l last search pattern highlighting (see 'hlsearch') |
| 4178 |hl-MoreMsg| m |more-prompt| | |
| 4179 |hl-ModeMsg| M Mode (e.g., "-- INSERT --") | |
|
2178
c6f1aa1e9f32
Add 'relativenumber' patch from Markus Heidelberg.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
4180 |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
|
4181 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
|
4182 |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
|
4183 '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
|
4184 |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
|
4185 'relativenumber' option is set. |
| 4073 | 4186 |hl-CursorLineNr| N like n for when 'cursorline' or 'relativenumber' is |
| 4187 set. | |
| 7 | 4188 |hl-Question| r |hit-enter| prompt and yes/no questions |
| 4189 |hl-StatusLine| s status line of current window |status-line| | |
| 12785 | 4190 |hl-StatusLineNC| S status lines of not-current windows |
| 7 | 4191 |hl-Title| t Titles for output from ":set all", ":autocmd" etc. |
| 4192 |hl-VertSplit| c column used to separate vertically split windows | |
| 4193 |hl-Visual| v Visual mode | |
| 4194 |hl-VisualNOS| V Visual mode when Vim does is "Not Owning the | |
| 4195 Selection" Only X11 Gui's |gui-x11| and | |
| 4196 |xterm-clipboard|. | |
| 4197 |hl-WarningMsg| w warning messages | |
| 4198 |hl-WildMenu| W wildcard matches displayed for 'wildmenu' | |
| 4199 |hl-Folded| f line used for closed folds | |
| 4200 |hl-FoldColumn| F 'foldcolumn' | |
| 386 | 4201 |hl-DiffAdd| A added line in diff mode |
| 4202 |hl-DiffChange| C changed line in diff mode | |
| 4203 |hl-DiffDelete| D deleted line in diff mode | |
| 4204 |hl-DiffText| T inserted text in diff mode | |
| 7 | 4205 |hl-SignColumn| > column used for |signs| |
| 15194 | 4206 |hl-Conceal| - the placeholders used for concealed characters |
| 4207 (see 'conceallevel') | |
| 221 | 4208 |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
|
4209 |hl-SpellCap| P word that should start with capital |spell| |
| 221 | 4210 |hl-SpellRare| R rare word |spell| |
| 4211 |hl-SpellLocal| L word from other region |spell| | |
| 15194 | 4212 |hl-Pmenu| + popup menu normal line |
| 4213 |hl-PmenuSel| = popup menu selected line | |
| 4214 |hl-PmenuSbar| x popup menu scrollbar | |
| 4215 |hl-PmenuThumb| X popup menu scrollbar thumb | |
| 7 | 4216 |
| 4217 The display modes are: | |
| 4218 r reverse (termcap entry "mr" and "me") | |
| 4219 i italic (termcap entry "ZH" and "ZR") | |
| 4220 b bold (termcap entry "md" and "me") | |
| 4221 s standout (termcap entry "so" and "se") | |
| 4222 u underline (termcap entry "us" and "ue") | |
| 205 | 4223 c undercurl (termcap entry "Cs" and "Ce") |
|
12317
2a8890b80923
patch 8.0.1038: strike-through text not supported
Christian Brabandt <cb@256bit.org>
parents:
12293
diff
changeset
|
4224 t strikethrough (termcap entry "Ts" and "Te") |
| 7 | 4225 n no highlighting |
| 4226 - no highlighting | |
| 4227 : use a highlight group | |
| 4228 The default is used for occasions that are not included. | |
| 4229 If you want to change what the display modes do, see |dos-colors| | |
| 4230 for an example. | |
| 4231 When using the ':' display mode, this must be followed by the name of | |
| 4232 a highlight group. A highlight group can be used to define any type | |
| 4233 of highlighting, including using color. See |:highlight| on how to | |
| 4234 define one. The default uses a different group for each occasion. | |
| 4235 See |highlight-default| for the default highlight groups. | |
| 4236 | |
| 4237 *'history'* *'hi'* | |
|
9669
284b4eb307fc
commit https://github.com/vim/vim/commit/8c08b5b569e2a9e9f63dea514591ecfa2d3bb392
Christian Brabandt <cb@256bit.org>
parents:
9665
diff
changeset
|
4238 '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
|
4239 set to 200 in |defaults.vim|) |
| 7 | 4240 global |
| 4241 A history of ":" commands, and a history of previous search patterns | |
| 5991 | 4242 is remembered. This option decides how many entries may be stored in |
| 7 | 4243 each of these histories (see |cmdline-editing|). |
| 5991 | 4244 The maximum value is 10000. |
| 7 | 4245 NOTE: This option is set to the Vi default value when 'compatible' is |
| 4246 set and to the Vim default value when 'compatible' is reset. | |
| 4247 | |
| 4248 *'hkmap'* *'hk'* *'nohkmap'* *'nohk'* | |
| 4249 'hkmap' 'hk' boolean (default off) | |
| 4250 global | |
| 4251 {only available when compiled with the |+rightleft| | |
| 4252 feature} | |
| 4253 When on, the keyboard is mapped for the Hebrew character set. | |
| 4254 Normally you would set 'allowrevins' and use CTRL-_ in insert mode to | |
| 4255 toggle this option. See |rileft.txt|. | |
| 4256 NOTE: This option is reset when 'compatible' is set. | |
| 4257 | |
| 4258 *'hkmapp'* *'hkp'* *'nohkmapp'* *'nohkp'* | |
| 4259 'hkmapp' 'hkp' boolean (default off) | |
| 4260 global | |
| 4261 {only available when compiled with the |+rightleft| | |
| 4262 feature} | |
| 4263 When on, phonetic keyboard mapping is used. 'hkmap' must also be on. | |
| 4264 This is useful if you have a non-Hebrew keyboard. | |
| 4265 See |rileft.txt|. | |
| 4266 NOTE: This option is reset when 'compatible' is set. | |
| 4267 | |
| 11160 | 4268 *'hlsearch'* *'hls'* *'nohlsearch'* *'nohls'* |
| 4269 'hlsearch' 'hls' boolean (default off) | |
| 4270 global | |
| 4271 {not available when compiled without the | |
| 4272 |+extra_search| feature} | |
| 4273 When there is a previous search pattern, highlight all its matches. | |
| 4274 The type of highlighting used can be set with the 'l' occasion in the | |
| 4275 'highlight' option. This uses the "Search" highlight group by | |
| 4276 default. Note that only the matching text is highlighted, any offsets | |
| 4277 are not applied. | |
| 4278 See also: 'incsearch' and |:match|. | |
| 4279 When you get bored looking at the highlighted matches, you can turn it | |
| 4280 off with |:nohlsearch|. This does not change the option value, as | |
| 4281 soon as you use a search command, the highlighting comes back. | |
| 4282 'redrawtime' specifies the maximum time spent on finding matches. | |
| 4283 When the search pattern can match an end-of-line, Vim will try to | |
| 4284 highlight all of the matched text. However, this depends on where the | |
| 4285 search starts. This will be the first line in the window or the first | |
| 4286 line below a closed fold. A match in a previous line which is not | |
| 4287 drawn may not continue in a newly drawn line. | |
| 4288 You can specify whether the highlight status is restored on startup | |
| 4289 with the 'h' flag in 'viminfo' |viminfo-h|. | |
| 4290 NOTE: This option is reset when 'compatible' is set. | |
| 4291 | |
| 7 | 4292 *'icon'* *'noicon'* |
| 4293 'icon' boolean (default off, on when title can be restored) | |
| 4294 global | |
| 4295 When on, the icon text of the window will be set to the value of | |
| 4296 'iconstring' (if it is not empty), or to the name of the file | |
| 4297 currently being edited. Only the last part of the name is used. | |
| 4298 Overridden by the 'iconstring' option. | |
| 4299 Only works if the terminal supports setting window icons (currently | |
| 4300 only X11 GUI and terminals with a non-empty 't_IS' option - these are | |
| 4301 Unix xterm and iris-ansi by default, where 't_IS' is taken from the | |
| 4302 builtin termcap). | |
| 4303 When Vim was compiled with HAVE_X11 defined, the original icon will be | |
| 233 | 4304 restored if possible |X11|. See |X11-icon| for changing the icon on |
| 7 | 4305 X11. |
| 6259 | 4306 For MS-Windows the icon can be changed, see |windows-icon|. |
| 7 | 4307 |
| 4308 *'iconstring'* | |
| 4309 'iconstring' string (default "") | |
| 4310 global | |
| 4311 When this option is not empty, it will be used for the icon text of | |
| 4312 the window. This happens only when the 'icon' option is on. | |
| 4313 Only works if the terminal supports setting window icon text | |
| 4314 (currently only X11 GUI and terminals with a non-empty 't_IS' option). | |
| 24387 | 4315 Does not work for MS-Windows. |
| 7 | 4316 When Vim was compiled with HAVE_X11 defined, the original icon will be |
| 4317 restored if possible |X11|. | |
| 4318 When this option contains printf-style '%' items, they will be | |
| 10 | 4319 expanded according to the rules used for 'statusline'. See |
| 7 | 4320 '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
|
4321 This option cannot be set in a modeline when 'modelineexpr' is off. |
| 7 | 4322 {not available when compiled without the |+statusline| feature} |
| 4323 | |
| 4324 *'ignorecase'* *'ic'* *'noignorecase'* *'noic'* | |
| 4325 'ignorecase' 'ic' boolean (default off) | |
| 4326 global | |
| 4327 Ignore case in search patterns. Also used when searching in the tags | |
| 4328 file. | |
|
7266
6ba7182fb7bd
commit https://github.com/vim/vim/commit/0f6562e9036f889185dff49a75c7fc5ffb28b307
Christian Brabandt <cb@256bit.org>
parents:
7245
diff
changeset
|
4329 Also see 'smartcase' and 'tagcase'. |
| 7 | 4330 Can be overruled by using "\c" or "\C" in the pattern, see |
| 4331 |/ignorecase|. | |
| 4332 | |
|
5008
3717d569027d
updated for version 7.3.1248
Bram Moolenaar <bram@vim.org>
parents:
4869
diff
changeset
|
4333 *'imactivatefunc'* *'imaf'* |
|
3717d569027d
updated for version 7.3.1248
Bram Moolenaar <bram@vim.org>
parents:
4869
diff
changeset
|
4334 'imactivatefunc' 'imaf' string (default "") |
|
3717d569027d
updated for version 7.3.1248
Bram Moolenaar <bram@vim.org>
parents:
4869
diff
changeset
|
4335 global |
|
3717d569027d
updated for version 7.3.1248
Bram Moolenaar <bram@vim.org>
parents:
4869
diff
changeset
|
4336 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
|
4337 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
|
4338 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
|
4339 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
|
4340 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
|
4341 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
|
4342 modeline, see |sandbox-option|. |
|
5008
3717d569027d
updated for version 7.3.1248
Bram Moolenaar <bram@vim.org>
parents:
4869
diff
changeset
|
4343 |
|
3717d569027d
updated for version 7.3.1248
Bram Moolenaar <bram@vim.org>
parents:
4869
diff
changeset
|
4344 Example: > |
|
3717d569027d
updated for version 7.3.1248
Bram Moolenaar <bram@vim.org>
parents:
4869
diff
changeset
|
4345 function ImActivateFunc(active) |
|
3717d569027d
updated for version 7.3.1248
Bram Moolenaar <bram@vim.org>
parents:
4869
diff
changeset
|
4346 if a:active |
|
3717d569027d
updated for version 7.3.1248
Bram Moolenaar <bram@vim.org>
parents:
4869
diff
changeset
|
4347 ... do something |
|
3717d569027d
updated for version 7.3.1248
Bram Moolenaar <bram@vim.org>
parents:
4869
diff
changeset
|
4348 else |
|
3717d569027d
updated for version 7.3.1248
Bram Moolenaar <bram@vim.org>
parents:
4869
diff
changeset
|
4349 ... do something |
|
3717d569027d
updated for version 7.3.1248
Bram Moolenaar <bram@vim.org>
parents:
4869
diff
changeset
|
4350 endif |
|
3717d569027d
updated for version 7.3.1248
Bram Moolenaar <bram@vim.org>
parents:
4869
diff
changeset
|
4351 " return value is not used |
|
3717d569027d
updated for version 7.3.1248
Bram Moolenaar <bram@vim.org>
parents:
4869
diff
changeset
|
4352 endfunction |
|
3717d569027d
updated for version 7.3.1248
Bram Moolenaar <bram@vim.org>
parents:
4869
diff
changeset
|
4353 set imactivatefunc=ImActivateFunc |
|
3717d569027d
updated for version 7.3.1248
Bram Moolenaar <bram@vim.org>
parents:
4869
diff
changeset
|
4354 < |
| 7 | 4355 *'imactivatekey'* *'imak'* |
| 4356 'imactivatekey' 'imak' string (default "") | |
| 4357 global | |
| 4358 {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
|
4359 |+GUI_GTK|} *E599* |
| 7 | 4360 Specifies the key that your Input Method in X-Windows uses for |
| 4361 activation. When this is specified correctly, vim can fully control | |
| 4362 IM with 'imcmdline', 'iminsert' and 'imsearch'. | |
| 4363 You can't use this option to change the activation key, the option | |
| 4364 tells Vim what the key is. | |
| 4365 Format: | |
| 4366 [MODIFIER_FLAG-]KEY_STRING | |
| 4367 | |
| 4368 These characters can be used for MODIFIER_FLAG (case is ignored): | |
| 4369 S Shift key | |
| 4370 L Lock key | |
| 4371 C Control key | |
| 4372 1 Mod1 key | |
| 4373 2 Mod2 key | |
| 4374 3 Mod3 key | |
| 4375 4 Mod4 key | |
| 4376 5 Mod5 key | |
| 4377 Combinations are allowed, for example "S-C-space" or "SC-space" are | |
| 4378 both shift+ctrl+space. | |
| 4379 See <X11/keysymdef.h> and XStringToKeysym for KEY_STRING. | |
| 4380 | |
| 4381 Example: > | |
| 4382 :set imactivatekey=S-space | |
| 4383 < "S-space" means shift+space. This is the activation key for kinput2 + | |
| 4384 canna (Japanese), and ami (Korean). | |
| 4385 | |
| 4386 *'imcmdline'* *'imc'* *'noimcmdline'* *'noimc'* | |
| 4387 'imcmdline' 'imc' boolean (default off) | |
| 4388 global | |
| 4389 When set the Input Method is always on when starting to edit a command | |
| 4390 line, unless entering a search pattern (see 'imsearch' for that). | |
| 4391 Setting this option is useful when your input method allows entering | |
| 4392 English characters directly, e.g., when it's used to type accented | |
| 4393 characters with dead keys. | |
| 4394 | |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
4395 *'imdisable'* *'imd'* *'noimdisable'* *'noimd'* |
| 7 | 4396 'imdisable' 'imd' boolean (default off, on for some systems (SGI)) |
| 4397 global | |
| 4398 When set the Input Method is never used. This is useful to disable | |
| 4399 the IM when it doesn't work properly. | |
| 4400 Currently this option is on by default for SGI/IRIX machines. This | |
| 4401 may change in later releases. | |
| 4402 | |
| 4403 *'iminsert'* *'imi'* | |
|
12469
61d910f0999d
patch 8.0.1114: default for 'iminsert' is annoying
Christian Brabandt <cb@256bit.org>
parents:
12317
diff
changeset
|
4404 'iminsert' 'imi' number (default 0) |
| 7 | 4405 local to buffer |
| 4406 Specifies whether :lmap or an Input Method (IM) is to be used in | |
| 4407 Insert mode. Valid values: | |
| 4408 0 :lmap is off and IM is off | |
| 4409 1 :lmap is ON and IM is off | |
| 4410 2 :lmap is off and IM is ON | |
| 4411 To always reset the option to zero when leaving Insert mode with <Esc> | |
| 4412 this can be used: > | |
| 4413 :inoremap <ESC> <ESC>:set iminsert=0<CR> | |
| 4414 < This makes :lmap and IM turn off automatically when leaving Insert | |
| 4415 mode. | |
| 4416 Note that this option changes when using CTRL-^ in Insert mode | |
| 4417 |i_CTRL-^|. | |
| 4418 The value is set to 1 when setting 'keymap' to a valid keymap name. | |
| 4419 It is also used for the argument of commands like "r" and "f". | |
| 28379 | 4420 The value 0 may not work correctly with Motif with some XIM |
| 7 | 4421 methods. Use 'imdisable' to disable XIM then. |
| 4422 | |
|
12920
327e1264b9bf
patch 8.0.1336: cannot use imactivatefunc() unless compiled with +xim
Christian Brabandt <cb@256bit.org>
parents:
12865
diff
changeset
|
4423 You can set 'imactivatefunc' and 'imstatusfunc' to handle IME/XIM |
| 14519 | 4424 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
|
4425 |+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
|
4426 |
| 7 | 4427 *'imsearch'* *'ims'* |
|
12469
61d910f0999d
patch 8.0.1114: default for 'iminsert' is annoying
Christian Brabandt <cb@256bit.org>
parents:
12317
diff
changeset
|
4428 'imsearch' 'ims' number (default -1) |
| 7 | 4429 local to buffer |
| 4430 Specifies whether :lmap or an Input Method (IM) is to be used when | |
| 4431 entering a search pattern. Valid values: | |
| 4432 -1 the value of 'iminsert' is used, makes it look like | |
| 4433 'iminsert' is also used when typing a search pattern | |
| 4434 0 :lmap is off and IM is off | |
| 4435 1 :lmap is ON and IM is off | |
| 4436 2 :lmap is off and IM is ON | |
| 4437 Note that this option changes when using CTRL-^ in Command-line mode | |
| 4438 |c_CTRL-^|. | |
| 4439 The value is set to 1 when it is not -1 and setting the 'keymap' | |
| 4440 option to a valid keymap name. | |
| 28379 | 4441 The value 0 may not work correctly with Motif with some XIM |
| 7 | 4442 methods. Use 'imdisable' to disable XIM then. |
| 4443 | |
|
5008
3717d569027d
updated for version 7.3.1248
Bram Moolenaar <bram@vim.org>
parents:
4869
diff
changeset
|
4444 *'imstatusfunc'* *'imsf'* |
|
3717d569027d
updated for version 7.3.1248
Bram Moolenaar <bram@vim.org>
parents:
4869
diff
changeset
|
4445 'imstatusfunc' 'imsf' string (default "") |
|
3717d569027d
updated for version 7.3.1248
Bram Moolenaar <bram@vim.org>
parents:
4869
diff
changeset
|
4446 global |
|
3717d569027d
updated for version 7.3.1248
Bram Moolenaar <bram@vim.org>
parents:
4869
diff
changeset
|
4447 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
|
4448 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
|
4449 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
|
4450 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
|
4451 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
|
4452 |
|
3717d569027d
updated for version 7.3.1248
Bram Moolenaar <bram@vim.org>
parents:
4869
diff
changeset
|
4453 Example: > |
|
3717d569027d
updated for version 7.3.1248
Bram Moolenaar <bram@vim.org>
parents:
4869
diff
changeset
|
4454 function ImStatusFunc() |
|
3717d569027d
updated for version 7.3.1248
Bram Moolenaar <bram@vim.org>
parents:
4869
diff
changeset
|
4455 let is_active = ...do something |
|
3717d569027d
updated for version 7.3.1248
Bram Moolenaar <bram@vim.org>
parents:
4869
diff
changeset
|
4456 return is_active ? 1 : 0 |
|
3717d569027d
updated for version 7.3.1248
Bram Moolenaar <bram@vim.org>
parents:
4869
diff
changeset
|
4457 endfunction |
|
3717d569027d
updated for version 7.3.1248
Bram Moolenaar <bram@vim.org>
parents:
4869
diff
changeset
|
4458 set imstatusfunc=ImStatusFunc |
|
3717d569027d
updated for version 7.3.1248
Bram Moolenaar <bram@vim.org>
parents:
4869
diff
changeset
|
4459 < |
|
3717d569027d
updated for version 7.3.1248
Bram Moolenaar <bram@vim.org>
parents:
4869
diff
changeset
|
4460 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
|
4461 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
|
4462 modeline, see |sandbox-option|. |
|
5008
3717d569027d
updated for version 7.3.1248
Bram Moolenaar <bram@vim.org>
parents:
4869
diff
changeset
|
4463 |
|
12293
1ff5e5dfa9b0
patch 8.0.1026: GTK on-the-spot input has problems
Christian Brabandt <cb@256bit.org>
parents:
12254
diff
changeset
|
4464 *'imstyle'* *'imst'* |
|
1ff5e5dfa9b0
patch 8.0.1026: GTK on-the-spot input has problems
Christian Brabandt <cb@256bit.org>
parents:
12254
diff
changeset
|
4465 '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
|
4466 global |
|
1ff5e5dfa9b0
patch 8.0.1026: GTK on-the-spot input has problems
Christian Brabandt <cb@256bit.org>
parents:
12254
diff
changeset
|
4467 {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
|
4468 |+GUI_GTK|} |
| 12499 | 4469 This option specifies the input style of Input Method: |
| 4470 0 use on-the-spot style | |
| 4471 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
|
4472 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
|
4473 |
| 12559 | 4474 For a long time on-the-spot style had been used in the GTK version of |
| 4475 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
|
4476 |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
|
4477 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
|
4478 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
|
4479 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
|
4480 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
|
4481 |
| 7 | 4482 *'include'* *'inc'* |
| 4483 'include' 'inc' string (default "^\s*#\s*include") | |
| 4484 global or local to buffer |global-local| | |
| 4485 {not available when compiled without the | |
| 4486 |+find_in_path| feature} | |
| 10 | 4487 Pattern to be used to find an include command. It is a search |
| 7 | 4488 pattern, just like for the "/" command (See |pattern|). The default |
| 4489 value is for C programs. This option is used for the commands "[i", | |
| 532 | 4490 "]I", "[d", etc. |
| 4491 Normally the 'isfname' option is used to recognize the file name that | |
| 534 | 4492 comes after the matched pattern. But if "\zs" appears in the pattern |
| 4493 then the text matched from "\zs" to the end, or until "\ze" if it | |
| 4494 appears, is used as the file name. Use this to include characters | |
| 4495 that are not in 'isfname', such as a space. You can then use | |
| 4496 'includeexpr' to process the matched text. | |
| 532 | 4497 See |option-backslash| about including spaces and backslashes. |
| 7 | 4498 |
| 4499 *'includeexpr'* *'inex'* | |
| 4500 'includeexpr' 'inex' string (default "") | |
| 4501 local to buffer | |
| 4502 {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
|
4503 |+find_in_path| or |+eval| features} |
| 7 | 4504 Expression to be used to transform the string found with the 'include' |
| 10 | 4505 option to a file name. Mostly useful to change "." to "/" for Java: > |
| 7 | 4506 :set includeexpr=substitute(v:fname,'\\.','/','g') |
| 4507 < The "v:fname" variable will be set to the file name that was detected. | |
| 634 | 4508 |
| 7 | 4509 Also used for the |gf| command if an unmodified file name can't be |
| 10 | 4510 found. Allows doing "gf" on the name after an 'include' statement. |
| 7 | 4511 Also used for |<cfile>|. |
| 4512 | |
|
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
|
4513 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
|
4514 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
|
4515 set includeexpr=s:MyIncludeExpr(v:fname) |
|
c2c40cefc17b
patch 8.2.3900: it is not easy to use a script-local function for an option
Bram Moolenaar <Bram@vim.org>
parents:
26708
diff
changeset
|
4516 set includeexpr=<SID>SomeIncludeExpr(v:fname) |
| 27321 | 4517 < Otherwise, the expression is evaluated in the context of the script |
| 4518 where the option was set, thus script-local items are available. | |
| 4519 | |
| 3682 | 4520 The expression will be evaluated in the |sandbox| when set from a |
| 4521 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
|
4522 This option cannot be set in a modeline when 'modelineexpr' is off. |
| 634 | 4523 |
| 4524 It is not allowed to change text or jump to another window while | |
| 4525 evaluating 'includeexpr' |textlock|. | |
| 4526 | |
| 7 | 4527 *'incsearch'* *'is'* *'noincsearch'* *'nois'* |
|
9669
284b4eb307fc
commit https://github.com/vim/vim/commit/8c08b5b569e2a9e9f63dea514591ecfa2d3bb392
Christian Brabandt <cb@256bit.org>
parents:
9665
diff
changeset
|
4528 'incsearch' 'is' boolean (default off, set in |defaults.vim| if the |
|
284b4eb307fc
commit https://github.com/vim/vim/commit/8c08b5b569e2a9e9f63dea514591ecfa2d3bb392
Christian Brabandt <cb@256bit.org>
parents:
9665
diff
changeset
|
4529 +reltime feature is supported) |
| 7 | 4530 global |
| 4531 {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
|
4532 |+extra_search| features} |
| 17 | 4533 While typing a search command, show where the pattern, as it was typed |
| 4534 so far, matches. The matched string is highlighted. If the pattern | |
| 4535 is invalid or not found, nothing is shown. The screen will be updated | |
| 4536 often, this is only useful on fast terminals. | |
| 14637 | 4537 Also applies to the pattern in commands: > |
| 4538 :global | |
| 4539 :lvimgrep | |
| 4540 :lvimgrepadd | |
| 4541 :smagic | |
| 4542 :snomagic | |
| 4543 :sort | |
| 4544 :substitute | |
| 4545 :vglobal | |
| 4546 :vimgrep | |
| 4547 :vimgrepadd | |
| 4548 < Note that the match will be shown, but the cursor will return to its | |
| 17 | 4549 original position when no match is found and when pressing <Esc>. You |
| 4550 still need to finish the search command with <Enter> to move the | |
| 4551 cursor to the match. | |
|
10261
bdd7fc1a38c0
commit https://github.com/vim/vim/commit/dc08328821a2c11e33dfb1980332e4923ec64fca
Christian Brabandt <cb@256bit.org>
parents:
10244
diff
changeset
|
4552 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
|
4553 previous match. |c_CTRL-G| |c_CTRL-T| |
| 1521 | 4554 When compiled with the |+reltime| feature Vim only searches for about |
| 4555 half a second. With a complicated pattern and/or a lot of text the | |
| 4556 match may not be found. This is to avoid that Vim hangs while you | |
| 4557 are typing the pattern. | |
| 17 | 4558 The highlighting can be set with the 'i' flag in 'highlight'. |
| 12968 | 4559 When 'hlsearch' is on, all matched strings are highlighted too while |
| 4560 typing a search command. See also: 'hlsearch'. | |
| 14519 | 4561 If you don't want to turn 'hlsearch' on, but want to highlight all |
| 4562 matches while searching, you can turn on and off 'hlsearch' with | |
| 4563 autocmd. Example: > | |
|
12720
37c384802df4
patch 8.0.1238: incremental search only shows one match
Christian Brabandt <cb@256bit.org>
parents:
12608
diff
changeset
|
4564 augroup vimrc-incsearch-highlight |
|
37c384802df4
patch 8.0.1238: incremental search only shows one match
Christian Brabandt <cb@256bit.org>
parents:
12608
diff
changeset
|
4565 autocmd! |
|
12744
0c704288ced4
patch 8.0.1250: 'hlsearch' highlighting not removed after incsearch
Christian Brabandt <cb@256bit.org>
parents:
12720
diff
changeset
|
4566 autocmd CmdlineEnter /,\? :set hlsearch |
|
0c704288ced4
patch 8.0.1250: 'hlsearch' highlighting not removed after incsearch
Christian Brabandt <cb@256bit.org>
parents:
12720
diff
changeset
|
4567 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
|
4568 augroup END |
|
37c384802df4
patch 8.0.1238: incremental search only shows one match
Christian Brabandt <cb@256bit.org>
parents:
12608
diff
changeset
|
4569 < |
| 772 | 4570 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
|
4571 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
|
4572 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
|
4573 converted to lowercase. |
| 772 | 4574 CTRL-R CTRL-W can be used to add the word at the end of the current |
| 4575 match, excluding the characters that were already typed. | |
| 7 | 4576 NOTE: This option is reset when 'compatible' is set. |
| 4577 | |
| 4578 *'indentexpr'* *'inde'* | |
| 4579 'indentexpr' 'inde' string (default "") | |
| 4580 local to buffer | |
| 4581 {not available when compiled without the |+cindent| | |
| 4582 or |+eval| features} | |
| 4583 Expression which is evaluated to obtain the proper indent for a line. | |
| 4584 It is used when a new line is created, for the |=| operator and | |
| 4585 in Insert mode as specified with the 'indentkeys' option. | |
| 4586 When this option is not empty, it overrules the 'cindent' and | |
| 2833 | 4587 'smartindent' indenting. When 'lisp' is set, this option is |
| 4588 overridden by the Lisp indentation algorithm. | |
| 7 | 4589 When 'paste' is set this option is not used for indenting. |
| 4590 The expression is evaluated with |v:lnum| set to the line number for | |
| 534 | 4591 which the indent is to be computed. The cursor is also in this line |
| 7 | 4592 when the expression is evaluated (but it may be moved around). |
| 27321 | 4593 |
|
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
|
4594 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
|
4595 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
|
4596 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
|
4597 set indentexpr=<SID>SomeIndentExpr() |
| 27321 | 4598 < Otherwise, the expression is evaluated in the context of the script |
| 4599 where the option was set, thus script-local items are available. | |
| 4600 | |
| 7 | 4601 The expression must return the number of spaces worth of indent. It |
| 4602 can return "-1" to keep the current indent (this means 'autoindent' is | |
| 4603 used for the indent). | |
| 4604 Functions useful for computing the indent are |indent()|, |cindent()| | |
| 4605 and |lispindent()|. | |
| 4606 The evaluation of the expression must not have side effects! It must | |
| 4607 not change the text, jump to another window, etc. Afterwards the | |
| 4608 cursor position is always restored, thus the cursor may be moved. | |
| 4609 Normally this option would be set to call a function: > | |
| 4610 :set indentexpr=GetMyIndent() | |
| 4611 < Error messages will be suppressed, unless the 'debug' option contains | |
| 4612 "msg". | |
| 634 | 4613 See |indent-expression|. |
| 11160 | 4614 NOTE: This option is set to "" when 'compatible' is set. |
| 7 | 4615 |
| 3682 | 4616 The expression will be evaluated in the |sandbox| when set from a |
| 4617 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
|
4618 This option cannot be set in a modeline when 'modelineexpr' is off. |
| 634 | 4619 |
| 4620 It is not allowed to change text or jump to another window while | |
| 4621 evaluating 'indentexpr' |textlock|. | |
| 4622 | |
| 4623 | |
| 7 | 4624 *'indentkeys'* *'indk'* |
|
15701
9cd11f6beb70
patch 8.1.0858: 'indentkeys' and 'cinkeys' defaults are different
Bram Moolenaar <Bram@vim.org>
parents:
15512
diff
changeset
|
4625 'indentkeys' 'indk' string (default "0{,0},0),0],:,0#,!^F,o,O,e") |
| 7 | 4626 local to buffer |
| 4627 {not available when compiled without the |+cindent| | |
| 4628 feature} | |
| 4629 A list of keys that, when typed in Insert mode, cause reindenting of | |
| 4630 the current line. Only happens if 'indentexpr' isn't empty. | |
| 4631 The format is identical to 'cinkeys', see |indentkeys-format|. | |
| 4632 See |C-indenting| and |indent-expression|. | |
| 4633 | |
| 4634 *'infercase'* *'inf'* *'noinfercase'* *'noinf'* | |
| 4635 'infercase' 'inf' boolean (default off) | |
| 4636 local to buffer | |
| 4637 When doing keyword completion in insert mode |ins-completion|, and | |
| 1621 | 4638 'ignorecase' is also on, the case of the match is adjusted depending |
| 4639 on the typed text. If the typed text contains a lowercase letter | |
| 4640 where the match has an upper case letter, the completed part is made | |
| 4641 lowercase. If the typed text has no lowercase letters and the match | |
| 4642 has a lowercase letter where the typed text has an uppercase letter, | |
| 4643 and there is a letter before it, the completed part is made uppercase. | |
| 4644 With 'noinfercase' the match is used as-is. | |
| 7 | 4645 |
| 4646 *'insertmode'* *'im'* *'noinsertmode'* *'noim'* | |
| 4647 'insertmode' 'im' boolean (default off) | |
| 4648 global | |
| 4649 Makes Vim work in a way that Insert mode is the default mode. Useful | |
| 4650 if you want to use Vim as a modeless editor. Used for |evim|. | |
| 4651 These Insert mode commands will be useful: | |
| 4652 - 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
|
4653 - Use CTRL-O to execute one Normal mode command |i_CTRL-O|. When |
| 7 | 4654 this is a mapping, it is executed as if 'insertmode' was off. |
| 4655 Normal mode remains active until the mapping is finished. | |
| 4656 - Use CTRL-L to execute a number of Normal mode commands, then use | |
| 477 | 4657 <Esc> to get back to Insert mode. Note that CTRL-L moves the cursor |
| 4658 left, like <Esc> does when 'insertmode' isn't set. |i_CTRL-L| | |
| 7 | 4659 |
| 4660 These items change when 'insertmode' is set: | |
| 4661 - when starting to edit of a file, Vim goes to Insert mode. | |
| 4662 - <Esc> in Insert mode is a no-op and beeps. | |
| 4663 - <Esc> in Normal mode makes Vim go to Insert mode. | |
| 4664 - CTRL-L in Insert mode is a command, it is not inserted. | |
| 4665 - CTRL-Z in Insert mode suspends Vim, see |CTRL-Z|. *i_CTRL-Z* | |
| 4666 However, when <Esc> is used inside a mapping, it behaves like | |
| 4667 'insertmode' was not set. This was done to be able to use the same | |
| 4668 mappings with 'insertmode' set or not set. | |
| 4669 When executing commands with |:normal| 'insertmode' is not used. | |
| 4670 | |
| 4671 NOTE: This option is reset when 'compatible' is set. | |
| 4672 | |
| 4673 *'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
|
4674 'isfname' 'isf' string (default for Win32: |
| 7 | 4675 "@,48-57,/,\,.,-,_,+,,,#,$,%,{,},[,],:,@-@,!,~,=" |
| 4676 for AMIGA: "@,48-57,/,.,-,_,+,,,$,:" | |
| 4677 for VMS: "@,48-57,/,.,-,_,+,,,#,$,%,<,>,[,],:,;,~" | |
| 4678 for OS/390: "@,240-249,/,.,-,_,+,,,#,$,%,~,=" | |
| 4679 otherwise: "@,48-57,/,.,-,_,+,,,#,$,%,~,=") | |
| 4680 global | |
| 4681 The characters specified by this option are included in file names and | |
| 4682 path names. Filenames are used for commands like "gf", "[i" and in | |
| 10 | 4683 the tags file. It is also used for "\f" in a |pattern|. |
| 7 | 4684 Multi-byte characters 256 and above are always included, only the |
| 4685 characters up to 255 are specified with this option. | |
| 4686 For UTF-8 the characters 0xa0 to 0xff are included as well. | |
| 1621 | 4687 Think twice before adding white space to this option. Although a |
| 4688 space may appear inside a file name, the effect will be that Vim | |
| 4689 doesn't know where a file name starts or ends when doing completion. | |
| 4690 It most likely works better without a space in 'isfname'. | |
| 7 | 4691 |
| 4692 Note that on systems using a backslash as path separator, Vim tries to | |
| 4693 do its best to make it work as you would expect. That is a bit | |
| 4694 tricky, since Vi originally used the backslash to escape special | |
| 4695 characters. Vim will not remove a backslash in front of a normal file | |
| 4696 name character on these systems, but it will on Unix and alikes. The | |
| 4697 '&' and '^' are not included by default, because these are special for | |
| 4698 cmd.exe. | |
| 4699 | |
| 4700 The format of this option is a list of parts, separated with commas. | |
| 10 | 4701 Each part can be a single character number or a range. A range is two |
| 4702 character numbers with '-' in between. A character number can be a | |
| 7 | 4703 decimal number between 0 and 255 or the ASCII character itself (does |
| 4704 not work for digits). Example: | |
| 4705 "_,-,128-140,#-43" (include '_' and '-' and the range | |
| 4706 128 to 140 and '#' to 43) | |
| 4707 If a part starts with '^', the following character number or range | |
| 4708 will be excluded from the option. The option is interpreted from left | |
| 4709 to right. Put the excluded character after the range where it is | |
| 4710 included. To include '^' itself use it as the last character of the | |
| 4711 option or the end of a range. Example: | |
| 4712 "^a-z,#,^" (exclude 'a' to 'z', include '#' and '^') | |
| 4713 If the character is '@', all characters where isalpha() returns TRUE | |
| 4714 are included. Normally these are the characters a to z and A to Z, | |
| 4715 plus accented characters. To include '@' itself use "@-@". Examples: | |
| 4716 "@,^a-z" All alphabetic characters, excluding lower | |
| 1621 | 4717 case ASCII letters. |
| 7 | 4718 "a-z,A-Z,@-@" All letters plus the '@' character. |
| 4719 A comma can be included by using it where a character number is | |
| 4720 expected. Example: | |
| 4721 "48-57,,,_" Digits, comma and underscore. | |
| 4722 A comma can be excluded by prepending a '^'. Example: | |
| 4723 " -~,^,,9" All characters from space to '~', excluding | |
| 4724 comma, plus <Tab>. | |
| 4725 See |option-backslash| about including spaces and backslashes. | |
| 4726 | |
| 4727 *'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
|
4728 'isident' 'isi' string (default for Win32: |
| 7 | 4729 "@,48-57,_,128-167,224-235" |
| 4730 otherwise: "@,48-57,_,192-255") | |
| 4731 global | |
| 4732 The characters given by this option are included in identifiers. | |
| 4733 Identifiers are used in recognizing environment variables and after a | |
| 4734 match of the 'define' option. It is also used for "\i" in a | |
| 233 | 4735 |pattern|. See 'isfname' for a description of the format of this |
| 14864 | 4736 option. For '@' only characters up to 255 are used. |
| 7 | 4737 Careful: If you change this option, it might break expanding |
| 10 | 4738 environment variables. E.g., when '/' is included and Vim tries to |
| 7 | 4739 expand "$HOME/.viminfo". Maybe you should change 'iskeyword' instead. |
| 4740 | |
| 4741 *'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
|
4742 'iskeyword' 'isk' string (Vim default for Win32: |
| 7 | 4743 "@,48-57,_,128-167,224-235" |
| 4744 otherwise: "@,48-57,_,192-255" | |
| 4745 Vi default: "@,48-57,_") | |
| 4746 local to buffer | |
| 4747 Keywords are used in searching and recognizing with many commands: | |
| 10 | 4748 "w", "*", "[i", etc. It is also used for "\k" in a |pattern|. See |
| 14864 | 4749 'isfname' for a description of the format of this option. For '@' |
| 24569 | 4750 characters above 255 check the "word" character class (any character |
| 4751 that is not white space or punctuation). | |
| 14864 | 4752 For C programs you could use "a-z,A-Z,48-57,_,.,-,>". |
| 7 | 4753 For a help file it is set to all non-blank printable characters except |
| 4754 '*', '"' and '|' (so that CTRL-] on a command finds the help for that | |
| 4755 command). | |
| 4756 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
|
4757 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
|
4758 uses |:syn-iskeyword|. |
| 7 | 4759 NOTE: This option is set to the Vi default value when 'compatible' is |
| 4760 set and to the Vim default value when 'compatible' is reset. | |
| 4761 | |
| 4762 *'isprint'* *'isp'* | |
| 21825 | 4763 'isprint' 'isp' string (default for Win32 and macOS: |
| 7 | 4764 "@,~-255"; otherwise: "@,161-255") |
| 4765 global | |
| 4766 The characters given by this option are displayed directly on the | |
| 4767 screen. It is also used for "\p" in a |pattern|. The characters from | |
| 4768 space (ASCII 32) to '~' (ASCII 126) are always displayed directly, | |
| 4769 even when they are not included in 'isprint' or excluded. See | |
| 4770 'isfname' for a description of the format of this option. | |
| 4771 | |
| 4772 Non-printable characters are displayed with two characters: | |
| 4773 0 - 31 "^@" - "^_" | |
| 4774 32 - 126 always single characters | |
| 4775 127 "^?" | |
| 4776 128 - 159 "~@" - "~_" | |
| 4777 160 - 254 "| " - "|~" | |
| 4778 255 "~?" | |
| 4779 When 'encoding' is a Unicode one, illegal bytes from 128 to 255 are | |
| 4780 displayed as <xx>, with the hexadecimal value of the byte. | |
| 4781 When 'display' contains "uhex" all unprintable characters are | |
| 4782 displayed as <xx>. | |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
4783 The SpecialKey highlighting will be used for unprintable characters. |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
4784 |hl-SpecialKey| |
| 7 | 4785 |
| 4786 Multi-byte characters 256 and above are always included, only the | |
| 4787 characters up to 255 are specified with this option. When a character | |
| 4788 is printable but it is not available in the current font, a | |
| 4789 replacement character will be shown. | |
| 4790 Unprintable and zero-width Unicode characters are displayed as <xxxx>. | |
| 4791 There is no option to specify these characters. | |
| 4792 | |
| 4793 *'joinspaces'* *'js'* *'nojoinspaces'* *'nojs'* | |
| 4794 'joinspaces' 'js' boolean (default on) | |
| 4795 global | |
| 4796 Insert two spaces after a '.', '?' and '!' with a join command. | |
| 4797 When 'cpoptions' includes the 'j' flag, only do this after a '.'. | |
| 4798 Otherwise only one space is inserted. | |
| 4799 NOTE: This option is set when 'compatible' is set. | |
| 4800 | |
| 4801 *'key'* | |
| 4802 'key' string (default "") | |
| 4803 local to buffer | |
|
2283
7e1bd501306d
Mainly documentation updates.
Bram Moolenaar <bram@vim.org>
parents:
2265
diff
changeset
|
4804 {only available when compiled with the |+cryptv| |
|
7e1bd501306d
Mainly documentation updates.
Bram Moolenaar <bram@vim.org>
parents:
2265
diff
changeset
|
4805 feature} |
| 7 | 4806 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
|
4807 See |encryption| and 'cryptmethod'. |
| 7 | 4808 Careful: Do not set the key value by hand, someone might see the typed |
| 4809 key. Use the |:X| command. But you can make 'key' empty: > | |
| 4810 :set key= | |
| 4811 < It is not possible to get the value of this option with ":set key" or | |
| 4812 "echo &key". This is to avoid showing it to someone who shouldn't | |
| 4813 know. It also means you cannot see it yourself once you have set it, | |
| 4814 be careful not to make a typing error! | |
|
2698
b6471224d2af
Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents:
2681
diff
changeset
|
4815 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
|
4816 enabled. When 'key' is set it returns "*****" (five stars). |
| 7 | 4817 |
| 4818 *'keymap'* *'kmp'* *E544* | |
| 4819 'keymap' 'kmp' string (default "") | |
| 4820 local to buffer | |
| 4821 {only available when compiled with the |+keymap| | |
| 4822 feature} | |
| 4823 Name of a keyboard mapping. See |mbyte-keymap|. | |
| 4824 Setting this option to a valid keymap name has the side effect of | |
| 4825 setting 'iminsert' to one, so that the keymap becomes effective. | |
| 4826 'imsearch' is also set to one, unless it was -1 | |
| 36 | 4827 Only normal file name characters can be used, "/\*?[|<>" are illegal. |
| 7 | 4828 |
| 4829 *'keymodel'* *'km'* | |
| 4830 'keymodel' 'km' string (default "") | |
| 4831 global | |
| 28379 | 4832 List of comma-separated words, which enable special things that keys |
| 7 | 4833 can do. These values can be used: |
| 4834 startsel Using a shifted special key starts selection (either | |
| 4835 Select mode or Visual mode, depending on "key" being | |
| 4836 present in 'selectmode'). | |
| 4837 stopsel Using a not-shifted special key stops selection. | |
| 4838 Special keys in this context are the cursor keys, <End>, <Home>, | |
| 4839 <PageUp> and <PageDown>. | |
| 4840 The 'keymodel' option is set by the |:behave| command. | |
| 4841 | |
| 4842 *'keywordprg'* *'kp'* | |
| 4843 '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
|
4844 VMS: "help") |
| 7 | 4845 global or local to buffer |global-local| |
| 4846 Program to use for the |K| command. Environment variables are | |
| 4847 expanded |:set_env|. ":help" may be used to access the Vim internal | |
| 4848 help. (Note that previously setting the global option to the empty | |
| 4849 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
|
4850 When the first character is ":", the command is invoked as a Vim |
|
0d52ddff8db4
commit https://github.com/vim/vim/commit/2ff8b64679242e73248774a388d54931c9ce49bd
Christian Brabandt <cb@256bit.org>
parents:
9097
diff
changeset
|
4851 Ex command prefixed with [count]. |
|
0d52ddff8db4
commit https://github.com/vim/vim/commit/2ff8b64679242e73248774a388d54931c9ce49bd
Christian Brabandt <cb@256bit.org>
parents:
9097
diff
changeset
|
4852 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
|
4853 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
|
4854 argument. For "man -s" the "-s" is removed when there is no count. |
| 7 | 4855 See |option-backslash| about including spaces and backslashes. |
| 4856 Example: > | |
| 4857 :set keywordprg=man\ -s | |
| 4858 < This option cannot be set from a |modeline| or in the |sandbox|, for | |
| 4859 security reasons. | |
| 4860 | |
| 4861 *'langmap'* *'lmap'* *E357* *E358* | |
| 4862 'langmap' 'lmap' string (default "") | |
| 4863 global | |
| 4864 {only available when compiled with the |+langmap| | |
| 4865 feature} | |
| 4866 This option allows switching your keyboard into a special language | |
| 10 | 4867 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
|
4868 inserted directly. When in Normal mode the 'langmap' option takes |
| 7 | 4869 care of translating these special characters to the original meaning |
| 4870 of the key. This means you don't have to change the keyboard mode to | |
| 4871 be able to execute Normal mode commands. | |
| 4872 This is the opposite of the 'keymap' option, where characters are | |
| 4873 mapped in Insert mode. | |
| 19646 | 4874 Also consider setting 'langremap' to off, to prevent 'langmap' from |
| 4875 applying to characters resulting from a mapping. | |
| 5908 | 4876 This option cannot be set from a |modeline| or in the |sandbox|, for |
| 4877 security reasons. | |
| 7 | 4878 |
| 699 | 4879 Example (for Greek, in UTF-8): *greek* > |
| 4880 :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 | 4881 < Example (exchanges meaning of z and y for commands): > |
| 4882 :set langmap=zy,yz,ZY,YZ | |
| 4883 < | |
| 4884 The 'langmap' option is a list of parts, separated with commas. Each | |
| 4885 part can be in one of two forms: | |
| 4886 1. A list of pairs. Each pair is a "from" character immediately | |
| 4887 followed by the "to" character. Examples: "aA", "aAbBcC". | |
| 4888 2. A list of "from" characters, a semi-colon and a list of "to" | |
| 4889 characters. Example: "abc;ABC" | |
| 4890 Example: "aA,fgh;FGH,cCdDeE" | |
| 4891 Special characters need to be preceded with a backslash. These are | |
| 22565 | 4892 ";", ',', '"', '|' and backslash itself. |
| 7 | 4893 |
| 4894 This will allow you to activate vim actions without having to switch | |
| 4895 back and forth between the languages. Your language characters will | |
| 4896 be understood as normal vim English characters (according to the | |
| 4897 langmap mappings) in the following cases: | |
| 4898 o Normal/Visual mode (commands, buffer/register names, user mappings) | |
| 4899 o Insert/Replace Mode: Register names after CTRL-R | |
| 4900 o Insert/Replace Mode: Mappings | |
| 4901 Characters entered in Command-line mode will NOT be affected by | |
| 4902 this option. Note that this option can be changed at any time | |
| 4903 allowing to switch between mappings for different languages/encodings. | |
| 4904 Use a mapping to avoid having to type it each time! | |
| 4905 | |
| 4906 *'langmenu'* *'lm'* | |
| 4907 'langmenu' 'lm' string (default "") | |
| 4908 global | |
| 4909 {only available when compiled with the |+menu| and | |
| 4910 |+multi_lang| features} | |
| 4911 Language to use for menu translation. Tells which file is loaded | |
| 4912 from the "lang" directory in 'runtimepath': > | |
| 27903 | 4913 "lang/menu_" .. &langmenu .. ".vim" |
| 7 | 4914 < (without the spaces). For example, to always use the Dutch menus, no |
| 4915 matter what $LANG is set to: > | |
| 4916 :set langmenu=nl_NL.ISO_8859-1 | |
| 4917 < When 'langmenu' is empty, |v:lang| is used. | |
| 36 | 4918 Only normal file name characters can be used, "/\*?[|<>" are illegal. |
| 7 | 4919 If your $LANG is set to a non-English language but you do want to use |
| 4920 the English menus: > | |
| 4921 :set langmenu=none | |
| 4922 < This option must be set before loading menus, switching on filetype | |
| 4923 detection or syntax highlighting. Once the menus are defined setting | |
| 4924 this option has no effect. But you could do this: > | |
| 4925 :source $VIMRUNTIME/delmenu.vim | |
| 4926 :set langmenu=de_DE.ISO_8859-1 | |
| 4927 :source $VIMRUNTIME/menu.vim | |
| 4928 < Warning: This deletes all menus that you defined yourself! | |
| 4929 | |
|
7196
42717d048817
commit https://github.com/vim/vim/commit/d94464ee294a351ce7b6ba18e8bd3f24f1bef920
Christian Brabandt <cb@256bit.org>
parents:
7147
diff
changeset
|
4930 *'langnoremap'* *'lnr'* *'nolangnoremap'* *'nolnr'* |
|
9669
284b4eb307fc
commit https://github.com/vim/vim/commit/8c08b5b569e2a9e9f63dea514591ecfa2d3bb392
Christian Brabandt <cb@256bit.org>
parents:
9665
diff
changeset
|
4931 'langnoremap' 'lnr' boolean (default off, set in |defaults.vim|) |
| 6339 | 4932 global |
| 4933 {only available when compiled with the |+langmap| | |
| 4934 feature} | |
|
9975
03fa8a51e9dc
commit https://github.com/vim/vim/commit/e4a3bcf28d92d0bde9ca227ccb40d401038185e5
Christian Brabandt <cb@256bit.org>
parents:
9913
diff
changeset
|
4935 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
|
4936 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
|
4937 '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
|
4938 |
|
03fa8a51e9dc
commit https://github.com/vim/vim/commit/e4a3bcf28d92d0bde9ca227ccb40d401038185e5
Christian Brabandt <cb@256bit.org>
parents:
9913
diff
changeset
|
4939 *'langremap'* *'lrm'* *'nolangremap'* *'nolrm'* |
| 19646 | 4940 '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
|
4941 global |
|
03fa8a51e9dc
commit https://github.com/vim/vim/commit/e4a3bcf28d92d0bde9ca227ccb40d401038185e5
Christian Brabandt <cb@256bit.org>
parents:
9913
diff
changeset
|
4942 {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
|
4943 feature} |
|
03fa8a51e9dc
commit https://github.com/vim/vim/commit/e4a3bcf28d92d0bde9ca227ccb40d401038185e5
Christian Brabandt <cb@256bit.org>
parents:
9913
diff
changeset
|
4944 When off, setting 'langmap' does not apply to characters resulting from |
| 6339 | 4945 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
|
4946 '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
|
4947 This option defaults to on for backwards compatibility. Set it off if |
| 6339 | 4948 that works for you to avoid mappings to break. |
| 4949 | |
| 7 | 4950 *'laststatus'* *'ls'* |
| 4951 'laststatus' 'ls' number (default 1) | |
| 4952 global | |
| 4953 The value of this option influences when the last window will have a | |
| 4954 status line: | |
| 4955 0: never | |
| 4956 1: only if there are at least two windows | |
| 4957 2: always | |
| 4958 The screen looks nicer with a status line if you have several | |
| 4959 windows, but it takes another screen line. |status-line| | |
| 4960 | |
| 4961 *'lazyredraw'* *'lz'* *'nolazyredraw'* *'nolz'* | |
| 4962 'lazyredraw' 'lz' boolean (default off) | |
| 4963 global | |
| 4964 When this option is set, the screen will not be redrawn while | |
| 4965 executing macros, registers and other commands that have not been | |
| 10 | 4966 typed. Also, updating the window title is postponed. To force an |
| 7 | 4967 update use |:redraw|. |
| 4968 | |
| 4969 *'linebreak'* *'lbr'* *'nolinebreak'* *'nolbr'* | |
| 4970 'linebreak' 'lbr' boolean (default off) | |
| 4971 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
|
4972 {not available when compiled without the |+linebreak| |
| 7 | 4973 feature} |
| 6009 | 4974 If on, Vim will wrap long lines at a character in 'breakat' rather |
| 7 | 4975 than at the last character that fits on the screen. Unlike |
| 4976 'wrapmargin' and 'textwidth', this does not insert <EOL>s in the file, | |
| 6009 | 4977 it only affects the way the file is displayed, not its contents. |
| 4978 If 'breakindent' is set, line is visually indented. Then, the value | |
| 4979 of 'showbreak' is used to put in front of wrapped lines. This option | |
| 6026 | 4980 is not used when the 'wrap' option is off. |
| 7 | 4981 Note that <Tab> characters after an <EOL> are mostly not displayed |
| 4982 with the right amount of white space. | |
| 4983 | |
| 4984 *'lines'* *E593* | |
| 4985 'lines' number (default 24 or terminal height) | |
| 4986 global | |
| 4987 Number of lines of the Vim window. | |
| 4988 Normally you don't need to set this. It is done automatically by the | |
| 161 | 4989 terminal initialization code. Also see |posix-screen-size|. |
| 7 | 4990 When Vim is running in the GUI or in a resizable window, setting this |
| 4991 option will cause the window size to be changed. When you only want | |
| 4992 to use the size for the GUI, put the command in your |gvimrc| file. | |
| 4993 Vim limits the number of lines to what fits on the screen. You can | |
| 4994 use this command to get the tallest window possible: > | |
| 4995 :set lines=999 | |
| 571 | 4996 < 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
|
4997 If you get fewer lines than expected, check the 'guiheadroom' option. |
| 7 | 4998 When you set this option and Vim is unable to change the physical |
| 4999 number of lines of the display, the display may be messed up. | |
| 5000 | |
| 5001 *'linespace'* *'lsp'* | |
| 5002 'linespace' 'lsp' number (default 0, 1 for Win32 GUI) | |
| 5003 global | |
| 5004 {only in the GUI} | |
| 5005 Number of pixel lines inserted between characters. Useful if the font | |
| 5006 uses the full character cell height, making lines touch each other. | |
| 5007 When non-zero there is room for underlining. | |
| 180 | 5008 With some fonts there can be too much room between lines (to have |
| 5009 space for ascents and descents). Then it makes sense to set | |
| 5010 'linespace' to a negative value. This may cause display problems | |
| 5011 though! | |
| 7 | 5012 |
| 5013 *'lisp'* *'nolisp'* | |
| 5014 'lisp' boolean (default off) | |
| 5015 local to buffer | |
| 5016 {not available when compiled without the |+lispindent| | |
| 5017 feature} | |
| 5018 Lisp mode: When <Enter> is typed in insert mode set the indent for | |
| 5019 the next line to Lisp standards (well, sort of). Also happens with | |
| 5020 "cc" or "S". 'autoindent' must also be on for this to work. The 'p' | |
| 5021 flag in 'cpoptions' changes the method of indenting: Vi compatible or | |
| 5022 better. Also see 'lispwords'. | |
| 5023 The '-' character is included in keyword characters. Redefines the | |
| 5024 "=" operator to use this same indentation algorithm rather than | |
| 5025 calling an external program if 'equalprg' is empty. | |
| 5026 This option is not used when 'paste' is set. | |
| 5027 | |
| 5028 *'lispwords'* *'lw'* | |
| 5029 'lispwords' 'lw' string (default is very long) | |
| 5712 | 5030 global or local to buffer |global-local| |
| 7 | 5031 {not available when compiled without the |+lispindent| |
| 5032 feature} | |
| 28379 | 5033 Comma-separated list of words that influence the Lisp indenting. |
| 7 | 5034 |'lisp'| |
| 5035 | |
| 5036 *'list'* *'nolist'* | |
| 5037 'list' boolean (default off) | |
| 5038 local to window | |
| 26100 | 5039 List mode: By default show tabs as CTRL-I is displayed, display $ |
| 5040 after end of line. Useful to see the difference between tabs and | |
| 5041 spaces and for trailing blanks. Further changed by the 'listchars' | |
| 5042 option. | |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
5043 |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
5044 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
|
5045 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
|
5046 position while displaying Tabs with spaces, use: > |
|
5161
f7add3891e95
Updated runtime files. Fix NL translations.
Bram Moolenaar <bram@vim.org>
parents:
5146
diff
changeset
|
5047 :set list lcs=tab:\ \ |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
5048 < |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
5049 Note that list mode will also affect formatting (set with 'textwidth' |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
5050 or 'wrapmargin') when 'cpoptions' includes 'L'. See 'listchars' for |
| 7 | 5051 changing the way tabs are displayed. |
| 5052 | |
| 5053 *'listchars'* *'lcs'* | |
| 5054 '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
|
5055 global or local to window |global-local| |
| 2458 | 5056 Strings to use in 'list' mode and for the |:list| command. It is a |
| 28379 | 5057 comma-separated list of string settings. |
| 6777 | 5058 *lcs-eol* |
| 7 | 5059 eol:c Character to show at the end of each line. When |
| 5060 omitted, there is no extra character at the end of the | |
| 5061 line. | |
| 6777 | 5062 *lcs-tab* |
|
15502
bc17a9d37810
patch 8.1.0759: showing two characters for tab is limited
Bram Moolenaar <Bram@vim.org>
parents:
15396
diff
changeset
|
5063 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
|
5064 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
|
5065 |
|
bc17a9d37810
patch 8.1.0759: showing two characters for tab is limited
Bram Moolenaar <Bram@vim.org>
parents:
15396
diff
changeset
|
5066 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
|
5067 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
|
5068 > |
|
bc17a9d37810
patch 8.1.0759: showing two characters for tab is limited
Bram Moolenaar <Bram@vim.org>
parents:
15396
diff
changeset
|
5069 >- |
|
bc17a9d37810
patch 8.1.0759: showing two characters for tab is limited
Bram Moolenaar <Bram@vim.org>
parents:
15396
diff
changeset
|
5070 >-- |
|
bc17a9d37810
patch 8.1.0759: showing two characters for tab is limited
Bram Moolenaar <Bram@vim.org>
parents:
15396
diff
changeset
|
5071 etc. |
|
bc17a9d37810
patch 8.1.0759: showing two characters for tab is limited
Bram Moolenaar <Bram@vim.org>
parents:
15396
diff
changeset
|
5072 |
|
bc17a9d37810
patch 8.1.0759: showing two characters for tab is limited
Bram Moolenaar <Bram@vim.org>
parents:
15396
diff
changeset
|
5073 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
|
5074 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
|
5075 "tab:<->" displays: |
|
bc17a9d37810
patch 8.1.0759: showing two characters for tab is limited
Bram Moolenaar <Bram@vim.org>
parents:
15396
diff
changeset
|
5076 > |
|
bc17a9d37810
patch 8.1.0759: showing two characters for tab is limited
Bram Moolenaar <Bram@vim.org>
parents:
15396
diff
changeset
|
5077 <> |
|
bc17a9d37810
patch 8.1.0759: showing two characters for tab is limited
Bram Moolenaar <Bram@vim.org>
parents:
15396
diff
changeset
|
5078 <-> |
|
bc17a9d37810
patch 8.1.0759: showing two characters for tab is limited
Bram Moolenaar <Bram@vim.org>
parents:
15396
diff
changeset
|
5079 <--> |
|
bc17a9d37810
patch 8.1.0759: showing two characters for tab is limited
Bram Moolenaar <Bram@vim.org>
parents:
15396
diff
changeset
|
5080 etc. |
|
bc17a9d37810
patch 8.1.0759: showing two characters for tab is limited
Bram Moolenaar <Bram@vim.org>
parents:
15396
diff
changeset
|
5081 |
|
bc17a9d37810
patch 8.1.0759: showing two characters for tab is limited
Bram Moolenaar <Bram@vim.org>
parents:
15396
diff
changeset
|
5082 When "tab:" is omitted, a tab is shown as ^I. |
| 6777 | 5083 *lcs-space* |
| 5084 space:c Character to show for a space. When omitted, spaces | |
| 5085 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
|
5086 *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
|
5087 multispace:c... |
|
373278f5bd51
patch 8.2.3424: a sequence of spaces is hard to see in list mode
Bram Moolenaar <Bram@vim.org>
parents:
25773
diff
changeset
|
5088 One or more characters to use cyclically to show for |
|
373278f5bd51
patch 8.2.3424: a sequence of spaces is hard to see in list mode
Bram Moolenaar <Bram@vim.org>
parents:
25773
diff
changeset
|
5089 multiple consecutive spaces. Overrides the "space" |
|
373278f5bd51
patch 8.2.3424: a sequence of spaces is hard to see in list mode
Bram Moolenaar <Bram@vim.org>
parents:
25773
diff
changeset
|
5090 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
|
5091 "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
|
5092 `: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
|
5093 spaces as: |
|
373278f5bd51
patch 8.2.3424: a sequence of spaces is hard to see in list mode
Bram Moolenaar <Bram@vim.org>
parents:
25773
diff
changeset
|
5094 ---+---+-- |
|
23825
0bd44e94dd14
patch 8.2.2454: leading space can not be made visible
Bram Moolenaar <Bram@vim.org>
parents:
23666
diff
changeset
|
5095 *lcs-lead* |
|
0bd44e94dd14
patch 8.2.2454: leading space can not be made visible
Bram Moolenaar <Bram@vim.org>
parents:
23666
diff
changeset
|
5096 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
|
5097 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
|
5098 "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
|
5099 combine it with "tab:", for example: > |
| 23931 | 5100 :set listchars+=tab:>-,lead:. |
| 5101 < *lcs-trail* | |
| 10 | 5102 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
|
5103 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
|
5104 "multispace" settings for trailing spaces. |
| 6777 | 5105 *lcs-extends* |
| 7 | 5106 extends:c Character to show in the last column, when 'wrap' is |
| 5107 off and the line continues beyond the right of the | |
| 5108 screen. | |
| 6777 | 5109 *lcs-precedes* |
|
18131
851a014dfd8b
patch 8.1.2060: "precedes" in 'listchars' not used properly
Bram Moolenaar <Bram@vim.org>
parents:
18130
diff
changeset
|
5110 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
|
5111 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
|
5112 character visible in the first column. |
| 6777 | 5113 *lcs-conceal* |
|
2250
1bac28a53fae
Add the conceal patch from Vince Negri.
Bram Moolenaar <bram@vim.org>
parents:
2249
diff
changeset
|
5114 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
|
5115 'conceallevel' is set to 1. |
| 6777 | 5116 *lcs-nbsp* |
| 6801 | 5117 nbsp:c Character to show for a non-breakable space character |
| 5118 (0xA0 (160 decimal) and U+202F). Left blank when | |
| 5119 omitted. | |
| 7 | 5120 |
| 10 | 5121 The characters ':' and ',' should not be used. UTF-8 characters can |
| 7 | 5122 be used when 'encoding' is "utf-8", otherwise only printable |
| 819 | 5123 characters are allowed. All characters must be single width. |
| 7 | 5124 |
|
25978
40b17deb294f
patch 8.2.3522: cannot use x and u when setting 'listchars'
Bram Moolenaar <Bram@vim.org>
parents:
25974
diff
changeset
|
5125 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
|
5126 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
|
5127 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
|
5128 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
|
5129 < 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
|
5130 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
|
5131 |
| 7 | 5132 Examples: > |
| 5133 :set lcs=tab:>-,trail:- | |
| 12 | 5134 :set lcs=tab:>-,eol:<,nbsp:% |
| 7 | 5135 :set lcs=extends:>,precedes:< |
| 5136 < The "NonText" highlighting will be used for "eol", "extends" and | |
| 25836 | 5137 "precedes". "SpecialKey" will be used for "tab", "nbsp", "space", |
| 5138 "multispace", "lead" and "trail". | |
| 1152 | 5139 |hl-NonText| |hl-SpecialKey| |
| 7 | 5140 |
| 5141 *'lpl'* *'nolpl'* *'loadplugins'* *'noloadplugins'* | |
| 5142 'loadplugins' 'lpl' boolean (default on) | |
| 5143 global | |
| 5144 When on the plugin scripts are loaded when starting up |load-plugins|. | |
| 5145 This option can be reset in your |vimrc| file to disable the loading | |
| 5146 of plugins. | |
|
11666
5cd9ba96561d
patch 8.0.0716: not easy to start Vim cleanly
Christian Brabandt <cb@256bit.org>
parents:
11659
diff
changeset
|
5147 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
|
5148 line arguments reset this option. See |-u| and |--noplugin|. |
| 7 | 5149 |
|
7196
42717d048817
commit https://github.com/vim/vim/commit/d94464ee294a351ce7b6ba18e8bd3f24f1bef920
Christian Brabandt <cb@256bit.org>
parents:
7147
diff
changeset
|
5150 *'luadll'* |
|
8629
54ac275e3fc4
commit https://github.com/vim/vim/commit/3848e00e0177abdb31bc600234967863ec487233
Christian Brabandt <cb@256bit.org>
parents:
8560
diff
changeset
|
5151 '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
|
5152 global |
|
7196
42717d048817
commit https://github.com/vim/vim/commit/d94464ee294a351ce7b6ba18e8bd3f24f1bef920
Christian Brabandt <cb@256bit.org>
parents:
7147
diff
changeset
|
5153 {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
|
5154 feature} |
|
7528
53163e4d9e4f
commit https://github.com/vim/vim/commit/25e4fcde767084d1a79e0926bc301c92987c0cce
Christian Brabandt <cb@256bit.org>
parents:
7477
diff
changeset
|
5155 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
|
5156 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
|
5157 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
|
5158 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
|
5159 security reasons. |
|
42717d048817
commit https://github.com/vim/vim/commit/d94464ee294a351ce7b6ba18e8bd3f24f1bef920
Christian Brabandt <cb@256bit.org>
parents:
7147
diff
changeset
|
5160 |
| 842 | 5161 *'macatsui'* *'nomacatsui'* |
| 5162 'macatsui' boolean (default on) | |
| 5163 global | |
| 21825 | 5164 {not supported} |
| 5165 No longer supported, as the Mac OS X GUI code was removed. | |
| 1152 | 5166 |
| 7 | 5167 *'magic'* *'nomagic'* |
| 5168 'magic' boolean (default on) | |
| 5169 global | |
| 5170 Changes the special characters that can be used in search patterns. | |
| 5171 See |pattern|. | |
|
10140
b11ceef7116e
commit https://github.com/vim/vim/commit/64d8e25bf6efe5f18b032563521c3ce278c316ab
Christian Brabandt <cb@256bit.org>
parents:
10027
diff
changeset
|
5172 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
|
5173 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
|
5174 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
|
5175 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
|
5176 when you want to |/\M|. |
| 23305 | 5177 In |Vim9| script the value of 'magic' is ignored, patterns behave like |
| 5178 it is always set. | |
| 7 | 5179 |
| 5180 *'makeef'* *'mef'* | |
| 5181 'makeef' 'mef' string (default: "") | |
| 5182 global | |
| 5183 {not available when compiled without the |+quickfix| | |
| 5184 feature} | |
| 5185 Name of the errorfile for the |:make| command (see |:make_makeprg|) | |
| 5186 and the |:grep| command. | |
| 5187 When it is empty, an internally generated temp file will be used. | |
| 5188 When "##" is included, it is replaced by a number to make the name | |
| 5189 unique. This makes sure that the ":make" command doesn't overwrite an | |
| 5190 existing file. | |
| 5191 NOT used for the ":cf" command. See 'errorfile' for that. | |
| 5192 Environment variables are expanded |:set_env|. | |
| 5193 See |option-backslash| about including spaces and backslashes. | |
| 5194 This option cannot be set from a |modeline| or in the |sandbox|, for | |
| 5195 security reasons. | |
| 5196 | |
|
11063
e71d3bdf3bc3
patch 8.0.0420: text garbled when the system encoding differs from 'encoding'
Christian Brabandt <cb@256bit.org>
parents:
11062
diff
changeset
|
5197 *'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
|
5198 '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
|
5199 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
|
5200 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
|
5201 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
|
5202 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
|
5203 `: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
|
5204 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
|
5205 |
|
e71d3bdf3bc3
patch 8.0.0420: text garbled when the system encoding differs from 'encoding'
Christian Brabandt <cb@256bit.org>
parents:
11062
diff
changeset
|
5206 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
|
5207 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
|
5208 '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
|
5209 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
|
5210 :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
|
5211 :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
|
5212 < |
| 7 | 5213 *'makeprg'* *'mp'* |
| 5214 'makeprg' 'mp' string (default "make", VMS: "MMS") | |
| 5215 global or local to buffer |global-local| | |
| 1152 | 5216 Program to use for the ":make" command. See |:make_makeprg|. |
|
13341
acd7eaa13d2b
Updated runtime files.
Christian Brabandt <cb@256bit.org>
parents:
13314
diff
changeset
|
5217 This option may contain '%' and '#' characters (see |:_%| and |:_#|), |
|
acd7eaa13d2b
Updated runtime files.
Christian Brabandt <cb@256bit.org>
parents:
13314
diff
changeset
|
5218 which are expanded to the current and alternate file name. Use |::S| |
| 5690 | 5219 to escape file names in case they contain special characters. |
| 1152 | 5220 Environment variables are expanded |:set_env|. See |option-backslash| |
| 5221 about including spaces and backslashes. | |
| 5222 Note that a '|' must be escaped twice: once for ":set" and once for | |
| 5223 the interpretation of a command. When you use a filter called | |
| 5224 "myfilter" do it like this: > | |
| 7 | 5225 :set makeprg=gmake\ \\\|\ myfilter |
| 5226 < The placeholder "$*" can be given (even multiple times) to specify | |
| 5227 where the arguments will be included, for example: > | |
| 5228 :set makeprg=latex\ \\\\nonstopmode\ \\\\input\\{$*} | |
| 5229 < This option cannot be set from a |modeline| or in the |sandbox|, for | |
| 5230 security reasons. | |
| 5231 | |
| 5232 *'matchpairs'* *'mps'* | |
| 5233 'matchpairs' 'mps' string (default "(:),{:},[:]") | |
| 5234 local to buffer | |
| 5235 Characters that form pairs. The |%| command jumps from one to the | |
| 4073 | 5236 other. |
| 5237 Only character pairs are allowed that are different, thus you cannot | |
| 5238 jump between two double quotes. | |
| 5239 The characters must be separated by a colon. | |
| 1152 | 5240 The pairs must be separated by a comma. Example for including '<' and |
| 24387 | 5241 '>' (for HTML): > |
| 7 | 5242 :set mps+=<:> |
| 5243 | |
| 5244 < A more exotic example, to jump between the '=' and ';' in an | |
| 5245 assignment, useful for languages like C and Java: > | |
| 5246 :au FileType c,cpp,java set mps+==:; | |
| 5247 | |
| 5248 < 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
|
5249 the $VIMRUNTIME/pack/dist/opt/matchit directory. |add-local-help| |
| 7 | 5250 |
| 5251 *'matchtime'* *'mat'* | |
| 5252 'matchtime' 'mat' number (default 5) | |
| 5253 global | |
| 5254 Tenths of a second to show the matching paren, when 'showmatch' is | |
| 5255 set. Note that this is not in milliseconds, like other options that | |
| 5256 set a time. This is to be compatible with Nvi. | |
| 5257 | |
| 714 | 5258 *'maxcombine'* *'mco'* |
| 5259 'maxcombine' 'mco' number (default 2) | |
| 5260 global | |
| 5261 The maximum number of combining characters supported for displaying. | |
| 5262 Only used when 'encoding' is "utf-8". | |
| 5263 The default is OK for most languages. Hebrew may require 4. | |
| 5264 Maximum value is 6. | |
| 5265 Even when this option is set to 2 you can still edit text with more | |
| 5266 combining characters, you just can't see them. Use |g8| or |ga|. | |
| 5267 See |mbyte-combining|. | |
| 5268 | |
| 7 | 5269 *'maxfuncdepth'* *'mfd'* |
| 5270 'maxfuncdepth' 'mfd' number (default 100) | |
| 5271 global | |
|
2570
71b56b4e7785
Make the references to features in the help more consistent. (Sylvain Hitier)
Bram Moolenaar <bram@vim.org>
parents:
2561
diff
changeset
|
5272 {not available when compiled without the |+eval| |
| 1152 | 5273 feature} |
| 7 | 5274 Maximum depth of function calls for user functions. This normally |
| 5275 catches endless recursion. When using a recursive function with | |
| 5276 more depth, set 'maxfuncdepth' to a bigger number. But this will use | |
| 5277 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
|
5278 Increasing this limit above 200 also changes the maximum for Ex |
| 14006 | 5279 command recursion, see |E169|. |
| 7 | 5280 See also |:function|. |
| 5281 | |
| 5282 *'maxmapdepth'* *'mmd'* *E223* | |
| 5283 'maxmapdepth' 'mmd' number (default 1000) | |
| 5284 global | |
| 5285 Maximum number of times a mapping is done without resulting in a | |
| 5286 character to be used. This normally catches endless mappings, like | |
| 5287 ":map x y" with ":map y x". It still does not catch ":map g wg", | |
| 5288 because the 'w' is used before the next mapping is done. See also | |
| 5289 |key-mapping|. | |
| 5290 | |
| 5291 *'maxmem'* *'mm'* | |
| 5292 'maxmem' 'mm' number (default between 256 to 5120 (system | |
| 5293 dependent) or half the amount of memory | |
| 5294 available) | |
| 5295 global | |
| 5296 Maximum amount of memory (in Kbyte) to use for one buffer. When this | |
| 5297 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
|
5298 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
|
5299 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
|
5300 limit. |
|
65c3e8259124
patch 8.0.1531: cannot use 24 bit colors in MS-Windows console
Christian Brabandt <cb@256bit.org>
parents:
13234
diff
changeset
|
5301 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
|
5302 Also see 'maxmemtot'. |
| 7 | 5303 |
| 189 | 5304 *'maxmempattern'* *'mmp'* |
| 5305 'maxmempattern' 'mmp' number (default 1000) | |
| 5306 global | |
| 5307 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
|
5308 The maximum value is about 2000000. Use this to work without a limit. |
| 189 | 5309 *E363* |
| 1152 | 5310 When Vim runs into the limit it gives an error message and mostly |
| 5311 behaves like CTRL-C was typed. | |
| 189 | 5312 Running into the limit often means that the pattern is very |
| 5313 inefficient or too complex. This may already happen with the pattern | |
| 5314 "\(.\)*" 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
|
5315 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
|
5316 text structure. |
|
4a588e3afd4a
Update runtime files, add Danish translations.
Christian Brabandt <cb@256bit.org>
parents:
14249
diff
changeset
|
5317 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
|
5318 which case you get an "Out of memory" error instead. |
| 189 | 5319 |
| 7 | 5320 *'maxmemtot'* *'mmt'* |
| 5321 'maxmemtot' 'mmt' number (default between 2048 and 10240 (system | |
| 5322 dependent) or half the amount of memory | |
| 5323 available) | |
| 5324 global | |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
5325 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
|
5326 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
|
5327 without a limit. |
|
05cf4cc72a9f
commit https://github.com/vim/vim/commit/fa7353428f705f7a13465a1943dddeede4083023
Christian Brabandt <cb@256bit.org>
parents:
7272
diff
changeset
|
5328 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
|
5329 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
|
5330 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
|
5331 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
|
5332 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
|
5333 used. |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
5334 Also see 'maxmem'. |
| 7 | 5335 |
| 5336 *'menuitems'* *'mis'* | |
| 5337 'menuitems' 'mis' number (default 25) | |
| 5338 global | |
| 5339 {not available when compiled without the |+menu| | |
| 5340 feature} | |
| 5341 Maximum number of items to use in a menu. Used for menus that are | |
| 5342 generated from a list of items, e.g., the Buffers menu. Changing this | |
| 5343 option has no direct effect, the menu must be refreshed first. | |
| 5344 | |
| 484 | 5345 *'mkspellmem'* *'msm'* |
| 5346 'mkspellmem' 'msm' string (default "460000,2000,500") | |
| 5347 global | |
| 5348 {not available when compiled without the |+syntax| | |
| 5349 feature} | |
| 5350 Parameters for |:mkspell|. This tunes when to start compressing the | |
| 5351 word tree. Compression can be slow when there are many words, but | |
| 5352 it's needed to avoid running out of memory. The amount of memory used | |
| 5353 per word depends very much on how similar the words are, that's why | |
| 5354 this tuning is complicated. | |
| 5355 | |
| 5356 There are three numbers, separated by commas: | |
| 5357 {start},{inc},{added} | |
| 5358 | |
| 5359 For most languages the uncompressed word tree fits in memory. {start} | |
| 5360 gives the amount of memory in Kbyte that can be used before any | |
| 5361 compression is done. It should be a bit smaller than the amount of | |
| 5362 memory that is available to Vim. | |
| 5363 | |
| 5364 When going over the {start} limit the {inc} number specifies the | |
| 5365 amount of memory in Kbyte that can be allocated before another | |
| 5366 compression is done. A low number means compression is done after | |
| 5367 less words are added, which is slow. A high number means more memory | |
| 5368 will be allocated. | |
| 5369 | |
| 5370 After doing compression, {added} times 1024 words can be added before | |
| 5371 the {inc} limit is ignored and compression is done when any extra | |
| 5372 amount of memory is needed. A low number means there is a smaller | |
| 5373 chance of hitting the {inc} limit, less memory is used but it's | |
| 5374 slower. | |
| 5375 | |
| 5376 The languages for which these numbers are important are Italian and | |
| 5377 Hungarian. The default works for when you have about 512 Mbyte. If | |
| 5378 you have 1 Gbyte you could use: > | |
| 5379 :set mkspellmem=900000,3000,800 | |
| 5380 < If you have less than 512 Mbyte |:mkspell| may fail for some | |
| 5381 languages, no matter what you set 'mkspellmem' to. | |
| 5382 | |
|
16798
63ac51f16ea1
patch 8.1.1401: misspelled mkspellmem as makespellmem
Bram Moolenaar <Bram@vim.org>
parents:
16778
diff
changeset
|
5383 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
|
5384 |
| 7 | 5385 *'modeline'* *'ml'* *'nomodeline'* *'noml'* |
| 1111 | 5386 'modeline' 'ml' boolean (Vim default: on (off for root), |
| 5387 Vi default: off) | |
| 7 | 5388 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
|
5389 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
|
5390 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
|
5391 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
|
5392 |
|
e55c26aaf484
patch 8.1.1366: using expressions in a modeline is unsafe
Bram Moolenaar <Bram@vim.org>
parents:
16610
diff
changeset
|
5393 *'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
|
5394 '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
|
5395 global |
|
e55c26aaf484
patch 8.1.1366: using expressions in a modeline is unsafe
Bram Moolenaar <Bram@vim.org>
parents:
16610
diff
changeset
|
5396 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
|
5397 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
|
5398 '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
|
5399 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
|
5400 security reasons. |
|
16728
e55c26aaf484
patch 8.1.1366: using expressions in a modeline is unsafe
Bram Moolenaar <Bram@vim.org>
parents:
16610
diff
changeset
|
5401 |
| 7 | 5402 *'modelines'* *'mls'* |
| 5403 'modelines' 'mls' number (default 5) | |
| 5404 global | |
| 5405 If 'modeline' is on 'modelines' gives the number of lines that is | |
| 5406 checked for set commands. If 'modeline' is off or 'modelines' is zero | |
| 5407 no lines are checked. See |modeline|. | |
| 5408 NOTE: 'modeline' is set to the Vi default value when 'compatible' is | |
| 5409 set and to the Vim default value when 'compatible' is reset. | |
| 5410 | |
| 5411 *'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
|
5412 *E21* |
| 7 | 5413 'modifiable' 'ma' boolean (default on) |
| 5414 local to buffer | |
| 5415 When off the buffer contents cannot be changed. The 'fileformat' and | |
| 5416 'fileencoding' options also can't be changed. | |
| 10617 | 5417 Can be reset on startup with the |-M| command line argument. |
| 7 | 5418 |
| 5419 *'modified'* *'mod'* *'nomodified'* *'nomod'* | |
| 5420 'modified' 'mod' boolean (default off) | |
| 5421 local to buffer | |
| 5422 When on, the buffer is considered to be modified. This option is set | |
| 5423 when: | |
| 5424 1. A change was made to the text since it was last written. Using the | |
| 5425 |undo| command to go back to the original text will reset the | |
| 5426 option. But undoing changes that were made before writing the | |
| 5427 buffer will set the option again, since the text is different from | |
| 5428 when it was written. | |
| 5429 2. 'fileformat' or 'fileencoding' is different from its original | |
| 5430 value. The original value is set when the buffer is read or | |
| 5431 written. A ":set nomodified" command also resets the original | |
| 5432 values to the current values and the 'modified' option will be | |
| 5433 reset. | |
|
8748
b1a19a2f73f0
commit https://github.com/vim/vim/commit/4f3f668c8486444e53163c29d2fc79bf47eb3c82
Christian Brabandt <cb@256bit.org>
parents:
8629
diff
changeset
|
5434 Similarly for 'eol' and 'bomb'. |
| 3082 | 5435 This option is not set when a change is made to the buffer as the |
| 5436 result of a BufNewFile, BufRead/BufReadPost, BufWritePost, | |
| 5437 FileAppendPost or VimLeave autocommand event. See |gzip-example| for | |
| 5438 an explanation. | |
| 7 | 5439 When 'buftype' is "nowrite" or "nofile" this option may be set, but |
| 5440 will be ignored. | |
| 13437 | 5441 Note that the text may actually be the same, e.g. 'modified' is set |
| 5442 when using "rA" on an "A". | |
| 7 | 5443 |
| 5444 *'more'* *'nomore'* | |
| 5445 'more' boolean (Vim default: on, Vi default: off) | |
| 5446 global | |
| 5447 When on, listings pause when the whole screen is filled. You will get | |
| 5448 the |more-prompt|. When this option is off there are no pauses, the | |
| 5449 listing continues until finished. | |
| 5450 NOTE: This option is set to the Vi default value when 'compatible' is | |
| 5451 set and to the Vim default value when 'compatible' is reset. | |
| 5452 | |
| 23666 | 5453 *'mouse'* |
| 18972 | 5454 '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
|
5455 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
|
5456 global |
| 18972 | 5457 Enable the use of the mouse. Works for most terminals (xterm, Win32 |
| 5458 |win32-mouse|, QNX pterm, *BSD console with sysmouse and Linux console | |
| 5459 with gpm). For using the mouse in the GUI, see |gui-mouse|. The | |
| 5460 mouse can be enabled for different modes: | |
| 12826 | 5461 n Normal mode and Terminal modes |
| 7 | 5462 v Visual mode |
| 5463 i Insert mode | |
| 5464 c Command-line mode | |
| 5465 h all previous modes when editing a help file | |
| 5466 a all previous modes | |
| 5467 r for |hit-enter| and |more-prompt| prompt | |
| 14864 | 5468 Normally you would enable the mouse in all five modes with: > |
| 7 | 5469 :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
|
5470 < 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
|
5471 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
|
5472 :set mouse=nvi |
| 20856 | 5473 < 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
|
5474 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
|
5475 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
|
5476 "xterm". |
|
d7619a9874cd
patch 8.1.2226: cannot use system copy/paste in non-xterm terminals
Bram Moolenaar <Bram@vim.org>
parents:
18463
diff
changeset
|
5477 |
|
d7619a9874cd
patch 8.1.2226: cannot use system copy/paste in non-xterm terminals
Bram Moolenaar <Bram@vim.org>
parents:
18463
diff
changeset
|
5478 When the mouse is not enabled, the GUI will still use the mouse for |
| 7 | 5479 modeless selection. This doesn't move the text cursor. |
| 5480 | |
| 5481 See |mouse-using|. Also see |'clipboard'|. | |
| 5482 | |
| 5483 Note: When enabling the mouse in a terminal, copy/paste will use the | |
| 10 | 5484 "* register if there is access to an X-server. The xterm handling of |
| 7 | 5485 the mouse buttons can still be used by keeping the shift key pressed. |
| 5486 Also see the 'clipboard' option. | |
| 5487 | |
| 5488 *'mousefocus'* *'mousef'* *'nomousefocus'* *'nomousef'* | |
| 5489 'mousefocus' 'mousef' boolean (default off) | |
| 5490 global | |
| 5491 {only works in the GUI} | |
| 5492 The window that the mouse pointer is on is automatically activated. | |
| 5493 When changing the window layout or window focus in another way, the | |
| 5494 mouse pointer is moved to the window with keyboard focus. Off is the | |
| 5495 default because it makes using the pull down menus a little goofy, as | |
| 5496 a pointer transit may activate a window unintentionally. | |
| 18594 | 5497 MS-Windows: Also see 'scrollfocus' for what window is scrolled when |
| 19180 | 5498 using the mouse scroll wheel. |
| 7 | 5499 |
| 5500 *'mousehide'* *'mh'* *'nomousehide'* *'nomh'* | |
| 5501 'mousehide' 'mh' boolean (default on) | |
| 5502 global | |
| 5503 {only works in the GUI} | |
| 5504 When on, the mouse pointer is hidden when characters are typed. | |
| 5505 The mouse pointer is restored when the mouse is moved. | |
| 5506 | |
| 5507 *'mousemodel'* *'mousem'* | |
| 18972 | 5508 'mousemodel' 'mousem' string (default "extend", "popup" for Win32) |
| 7 | 5509 global |
| 5510 Sets the model to use for the mouse. The name mostly specifies what | |
| 5511 the right mouse button is used for: | |
| 5512 extend Right mouse button extends a selection. This works | |
| 5513 like in an xterm. | |
| 5514 popup Right mouse button pops up a menu. The shifted left | |
| 5515 mouse button extends a selection. This works like | |
| 233 | 5516 with Microsoft Windows. |
| 7 | 5517 popup_setpos Like "popup", but the cursor will be moved to the |
| 5518 position where the mouse was clicked, and thus the | |
| 5519 selected operation will act upon the clicked object. | |
| 5520 If clicking inside a selection, that selection will | |
| 233 | 5521 be acted upon, i.e. no cursor move. This implies of |
| 7 | 5522 course, that right clicking outside a selection will |
| 5523 end Visual mode. | |
| 5524 Overview of what button does what for each model: | |
| 5525 mouse extend popup(_setpos) ~ | |
| 5526 left click place cursor place cursor | |
| 5527 left drag start selection start selection | |
| 5528 shift-left search word extend selection | |
| 5529 right click extend selection popup menu (place cursor) | |
| 5530 right drag extend selection - | |
| 5531 middle click paste paste | |
| 5532 | |
| 5533 In the "popup" model the right mouse button produces a pop-up menu. | |
| 5534 You need to define this first, see |popup-menu|. | |
| 5535 | |
| 5536 Note that you can further refine the meaning of buttons with mappings. | |
| 5537 See |gui-mouse-mapping|. But mappings are NOT used for modeless | |
| 5538 selection (because that's handled in the GUI code directly). | |
| 5539 | |
| 5540 The 'mousemodel' option is set by the |:behave| command. | |
| 5541 | |
|
28297
4190b932e6ca
patch 8.2.4674: cannot force getting MouseMove events
Bram Moolenaar <Bram@vim.org>
parents:
28246
diff
changeset
|
5542 *'mousemoveevent'* *'mousemev'* |
|
4190b932e6ca
patch 8.2.4674: cannot force getting MouseMove events
Bram Moolenaar <Bram@vim.org>
parents:
28246
diff
changeset
|
5543 'mousemoveevent' 'mousemev' boolean (default off) |
|
4190b932e6ca
patch 8.2.4674: cannot force getting MouseMove events
Bram Moolenaar <Bram@vim.org>
parents:
28246
diff
changeset
|
5544 global |
|
4190b932e6ca
patch 8.2.4674: cannot force getting MouseMove events
Bram Moolenaar <Bram@vim.org>
parents:
28246
diff
changeset
|
5545 {only works in the GUI} |
|
4190b932e6ca
patch 8.2.4674: cannot force getting MouseMove events
Bram Moolenaar <Bram@vim.org>
parents:
28246
diff
changeset
|
5546 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
|
5547 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
|
5548 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
|
5549 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
|
5550 when the mouse is moved. |
|
4190b932e6ca
patch 8.2.4674: cannot force getting MouseMove events
Bram Moolenaar <Bram@vim.org>
parents:
28246
diff
changeset
|
5551 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
|
5552 later. |
|
4190b932e6ca
patch 8.2.4674: cannot force getting MouseMove events
Bram Moolenaar <Bram@vim.org>
parents:
28246
diff
changeset
|
5553 |
| 7 | 5554 *'mouseshape'* *'mouses'* *E547* |
| 15932 | 5555 'mouseshape' 'mouses' string (default "i-r:beam,s:updown,sd:udsizing, |
| 5556 vs:leftright,vd:lrsizing,m:no, | |
| 5557 ml:up-arrow,v:rightup-arrow") | |
| 7 | 5558 global |
| 5559 {only available when compiled with the |+mouseshape| | |
| 5560 feature} | |
| 5561 This option tells Vim what the mouse pointer should look like in | |
| 28379 | 5562 different modes. The option is a comma-separated list of parts, much |
| 7 | 5563 like used for 'guicursor'. Each part consist of a mode/location-list |
| 5564 and an argument-list: | |
| 5565 mode-list:shape,mode-list:shape,.. | |
| 5566 The mode-list is a dash separated list of these modes/locations: | |
| 5567 In a normal window: ~ | |
| 5568 n Normal mode | |
| 5569 v Visual mode | |
| 5570 ve Visual mode with 'selection' "exclusive" (same as 'v', | |
| 5571 if not specified) | |
| 5572 o Operator-pending mode | |
| 5573 i Insert mode | |
| 5574 r Replace mode | |
| 5575 | |
| 5576 Others: ~ | |
| 5577 c appending to the command-line | |
| 5578 ci inserting in the command-line | |
| 5579 cr replacing in the command-line | |
| 5580 m at the 'Hit ENTER' or 'More' prompts | |
| 5581 ml idem, but cursor in the last line | |
| 5582 e any mode, pointer below last window | |
| 5583 s any mode, pointer on a status line | |
| 5584 sd any mode, while dragging a status line | |
| 5585 vs any mode, pointer on a vertical separator line | |
| 5586 vd any mode, while dragging a vertical separator line | |
| 5587 a everywhere | |
| 5588 | |
| 5589 The shape is one of the following: | |
| 5590 avail name looks like ~ | |
| 5591 w x arrow Normal mouse pointer | |
| 5592 w x blank no pointer at all (use with care!) | |
| 5593 w x beam I-beam | |
| 5594 w x updown up-down sizing arrows | |
| 5595 w x leftright left-right sizing arrows | |
| 5596 w x busy The system's usual busy pointer | |
| 5597 w x no The system's usual 'no input' pointer | |
| 5598 x udsizing indicates up-down resizing | |
| 5599 x lrsizing indicates left-right resizing | |
| 5600 x crosshair like a big thin + | |
| 5601 x hand1 black hand | |
| 5602 x hand2 white hand | |
| 5603 x pencil what you write with | |
| 5604 x question big ? | |
| 5605 x rightup-arrow arrow pointing right-up | |
| 5606 w x up-arrow arrow pointing up | |
| 5607 x <number> any X11 pointer number (see X11/cursorfont.h) | |
| 5608 | |
| 5609 The "avail" column contains a 'w' if the shape is available for Win32, | |
| 5610 x for X11. | |
| 5611 Any modes not specified or shapes not available use the normal mouse | |
| 5612 pointer. | |
| 5613 | |
| 5614 Example: > | |
| 5615 :set mouseshape=s:udsizing,m:no | |
| 5616 < will make the mouse turn to a sizing arrow over the status lines and | |
| 5617 indicate no input when the hit-enter prompt is displayed (since | |
| 5618 clicking the mouse has no effect in this state.) | |
| 5619 | |
| 5620 *'mousetime'* *'mouset'* | |
| 5621 'mousetime' 'mouset' number (default 500) | |
| 5622 global | |
| 18972 | 5623 Only for GUI, Win32 and Unix with xterm. Defines the maximum |
| 7 | 5624 time in msec between two mouse clicks for the second click to be |
| 5625 recognized as a multi click. | |
| 5626 | |
|
12608
b390f5003e2f
patch 8.0.1182: cannot see or change mzscheme dll name
Christian Brabandt <cb@256bit.org>
parents:
12559
diff
changeset
|
5627 *'mzschemedll'* |
|
b390f5003e2f
patch 8.0.1182: cannot see or change mzscheme dll name
Christian Brabandt <cb@256bit.org>
parents:
12559
diff
changeset
|
5628 '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
|
5629 global |
|
b390f5003e2f
patch 8.0.1182: cannot see or change mzscheme dll name
Christian Brabandt <cb@256bit.org>
parents:
12559
diff
changeset
|
5630 {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
|
5631 feature} |
|
b390f5003e2f
patch 8.0.1182: cannot see or change mzscheme dll name
Christian Brabandt <cb@256bit.org>
parents:
12559
diff
changeset
|
5632 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
|
5633 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
|
5634 Environment variables are expanded |:set_env|. |
| 12785 | 5635 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
|
5636 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
|
5637 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
|
5638 security reasons. |
|
b390f5003e2f
patch 8.0.1182: cannot see or change mzscheme dll name
Christian Brabandt <cb@256bit.org>
parents:
12559
diff
changeset
|
5639 |
|
b390f5003e2f
patch 8.0.1182: cannot see or change mzscheme dll name
Christian Brabandt <cb@256bit.org>
parents:
12559
diff
changeset
|
5640 *'mzschemegcdll'* |
|
b390f5003e2f
patch 8.0.1182: cannot see or change mzscheme dll name
Christian Brabandt <cb@256bit.org>
parents:
12559
diff
changeset
|
5641 '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
|
5642 global |
|
b390f5003e2f
patch 8.0.1182: cannot see or change mzscheme dll name
Christian Brabandt <cb@256bit.org>
parents:
12559
diff
changeset
|
5643 {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
|
5644 feature} |
|
b390f5003e2f
patch 8.0.1182: cannot see or change mzscheme dll name
Christian Brabandt <cb@256bit.org>
parents:
12559
diff
changeset
|
5645 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
|
5646 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
|
5647 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
|
5648 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
|
5649 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
|
5650 security reasons. |
|
b390f5003e2f
patch 8.0.1182: cannot see or change mzscheme dll name
Christian Brabandt <cb@256bit.org>
parents:
12559
diff
changeset
|
5651 |
| 14 | 5652 *'mzquantum'* *'mzq'* |
| 5653 'mzquantum' 'mzq' number (default 100) | |
| 5654 global | |
| 5655 {not available when compiled without the |+mzscheme| | |
| 5656 feature} | |
| 5657 The number of milliseconds between polls for MzScheme threads. | |
| 5658 Negative or zero value means no thread scheduling. | |
| 11160 | 5659 NOTE: This option is set to the Vim default value when 'compatible' |
| 5660 is reset. | |
| 14 | 5661 |
| 7 | 5662 *'nrformats'* *'nf'* |
|
9669
284b4eb307fc
commit https://github.com/vim/vim/commit/8c08b5b569e2a9e9f63dea514591ecfa2d3bb392
Christian Brabandt <cb@256bit.org>
parents:
9665
diff
changeset
|
5663 '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
|
5664 set to "bin,hex" in |defaults.vim|) |
| 7 | 5665 local to buffer |
| 5666 This defines what bases Vim will consider for numbers when using the | |
| 5667 CTRL-A and CTRL-X commands for adding to and subtracting from a number | |
| 5668 respectively; see |CTRL-A| for more info on these commands. | |
| 625 | 5669 alpha If included, single alphabetical characters will be |
| 7 | 5670 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
|
5671 letter index a), b), etc. *octal-nrformats* |
| 625 | 5672 octal If included, numbers that start with a zero will be considered |
| 7 | 5673 to be octal. Example: Using CTRL-A on "007" results in "010". |
| 625 | 5674 hex If included, numbers starting with "0x" or "0X" will be |
| 7 | 5675 considered to be hexadecimal. Example: Using CTRL-X on |
| 5676 "0x100" results in "0x0ff". | |
|
7528
53163e4d9e4f
commit https://github.com/vim/vim/commit/25e4fcde767084d1a79e0926bc301c92987c0cce
Christian Brabandt <cb@256bit.org>
parents:
7477
diff
changeset
|
5677 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
|
5678 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
|
5679 "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
|
5680 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
|
5681 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
|
5682 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
|
5683 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
|
5684 (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
|
5685 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
|
5686 (without "unsigned" it would become "9-2019"). |
| 20753 | 5687 Using CTRL-X on "0" or CTRL-A on "18446744073709551615" |
| 5688 (2^64 - 1) has no effect, overflow is prevented. | |
| 7 | 5689 Numbers which simply begin with a digit in the range 1-9 are always |
| 5690 considered decimal. This also happens for numbers that are not | |
| 5691 recognized as octal or hex. | |
| 5692 | |
| 5693 *'number'* *'nu'* *'nonumber'* *'nonu'* | |
| 5694 'number' 'nu' boolean (default off) | |
| 5695 local to window | |
| 5696 Print the line number in front of each line. When the 'n' option is | |
| 5697 excluded from 'cpoptions' a wrapped line will not use the column of | |
| 5698 line numbers (this is the default when 'compatible' isn't set). | |
| 13 | 5699 The 'numberwidth' option can be used to set the room used for the line |
| 5700 number. | |
| 7 | 5701 When a long, wrapped line doesn't start with the first character, '-' |
| 5702 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
|
5703 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
|
5704 |:sign-define| "numhl" argument. |
| 4780 | 5705 *number_relativenumber* |
| 5706 The 'relativenumber' option changes the displayed number to be | |
| 5707 relative to the cursor. Together with 'number' there are these | |
| 5708 four combinations (cursor in line 3): | |
| 5709 | |
|
8629
54ac275e3fc4
commit https://github.com/vim/vim/commit/3848e00e0177abdb31bc600234967863ec487233
Christian Brabandt <cb@256bit.org>
parents:
8560
diff
changeset
|
5710 'nonu' 'nu' 'nonu' 'nu' |
| 4780 | 5711 'nornu' 'nornu' 'rnu' 'rnu' |
| 5712 | |
| 5713 |apple | 1 apple | 2 apple | 2 apple | |
| 5714 |pear | 2 pear | 1 pear | 1 pear | |
| 5715 |nobody | 3 nobody | 0 nobody |3 nobody | |
| 5716 |there | 4 there | 1 there | 1 there | |
| 7 | 5717 |
| 13 | 5718 *'numberwidth'* *'nuw'* |
| 5719 'numberwidth' 'nuw' number (Vim default: 4 Vi default: 8) | |
| 5720 local to window | |
| 14 | 5721 {only available when compiled with the |+linebreak| |
| 5722 feature} | |
| 13 | 5723 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
|
5724 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
|
5725 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
|
5726 the text, there is one less character for the number itself. |
| 13 | 5727 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
|
5728 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
|
5729 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
|
5730 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
|
5731 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
|
5732 The minimum value is 1, the maximum value is 20. |
| 11160 | 5733 NOTE: This option is set to the Vi default value when 'compatible' is |
| 5734 set and to the Vim default value when 'compatible' is reset. | |
| 13 | 5735 |
| 523 | 5736 *'omnifunc'* *'ofu'* |
| 5737 'omnifunc' 'ofu' string (default: empty) | |
| 502 | 5738 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
|
5739 {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
|
5740 feature} |
| 623 | 5741 This option specifies a function to be used for Insert mode omni |
| 5742 completion with CTRL-X CTRL-O. |i_CTRL-X_CTRL-O| | |
| 648 | 5743 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
|
5744 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
|
5745 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
|
5746 more information. |
| 1004 | 5747 This option is usually set by a filetype plugin: |
| 859 | 5748 |:filetype-plugin-on| |
| 3682 | 5749 This option cannot be set from a |modeline| or in the |sandbox|, for |
| 5750 security reasons. | |
| 502 | 5751 |
| 5752 | |
| 1152 | 5753 *'opendevice'* *'odev'* *'noopendevice'* *'noodev'* |
| 1004 | 5754 'opendevice' 'odev' boolean (default off) |
| 5755 global | |
| 27321 | 5756 {only for MS-Windows} *E796* |
| 1004 | 5757 Enable reading and writing from devices. This may get Vim stuck on a |
| 5758 device that can be opened but doesn't actually do the I/O. Therefore | |
| 5759 it is off by default. | |
| 5760 Note that on MS-Windows editing "aux.h", "lpt1.txt" and the like also | |
| 5761 result in editing a device. | |
| 5762 | |
| 5763 | |
| 593 | 5764 *'operatorfunc'* *'opfunc'* |
| 5765 'operatorfunc' 'opfunc' string (default: empty) | |
| 5766 global | |
| 5767 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
|
5768 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
|
5769 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
|
5770 |option-value-function| for more information. |
| 593 | 5771 |
| 5772 This option cannot be set from a |modeline| or in the |sandbox|, for | |
| 5773 security reasons. | |
| 5774 | |
| 5775 | |
| 2908 | 5776 *'osfiletype'* *'oft'* |
| 5777 'osfiletype' 'oft' string (default: "") | |
| 7 | 5778 local to buffer |
| 2908 | 5779 This option was supported on RISC OS, which has been removed. |
| 5780 | |
| 7 | 5781 |
|
8182
95d59081580f
commit https://github.com/vim/vim/commit/f6fee0e2d4341c0c2f5339c1268e5877fafd07cf
Christian Brabandt <cb@256bit.org>
parents:
8148
diff
changeset
|
5782 *'packpath'* *'pp'* |
|
95d59081580f
commit https://github.com/vim/vim/commit/f6fee0e2d4341c0c2f5339c1268e5877fafd07cf
Christian Brabandt <cb@256bit.org>
parents:
8148
diff
changeset
|
5783 'packpath' 'pp' string (default: see 'runtimepath') |
|
95d59081580f
commit https://github.com/vim/vim/commit/f6fee0e2d4341c0c2f5339c1268e5877fafd07cf
Christian Brabandt <cb@256bit.org>
parents:
8148
diff
changeset
|
5784 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
|
5785 |
|
95d59081580f
commit https://github.com/vim/vim/commit/f6fee0e2d4341c0c2f5339c1268e5877fafd07cf
Christian Brabandt <cb@256bit.org>
parents:
8148
diff
changeset
|
5786 |
| 7 | 5787 *'paragraphs'* *'para'* |
| 1564 | 5788 'paragraphs' 'para' string (default "IPLPPPQPP TPHPLIPpLpItpplpipbp") |
| 7 | 5789 global |
| 5790 Specifies the nroff macros that separate paragraphs. These are pairs | |
| 5791 of two letters (see |object-motions|). | |
| 5792 | |
| 5793 *'paste'* *'nopaste'* | |
| 5794 'paste' boolean (default off) | |
| 5795 global | |
| 10 | 5796 Put Vim in Paste mode. This is useful if you want to cut or copy |
| 5797 some text from one window and paste it in Vim. This will avoid | |
| 7 | 5798 unexpected effects. |
| 5799 Setting this option is useful when using Vim in a terminal, where Vim | |
| 10 | 5800 cannot distinguish between typed text and pasted text. In the GUI, Vim |
| 7 | 5801 knows about pasting and will mostly do the right thing without 'paste' |
| 5802 being set. The same is true for a terminal where Vim handles the | |
| 5803 mouse clicks itself. | |
| 148 | 5804 This option is reset when starting the GUI. Thus if you set it in |
| 5805 your .vimrc it will work in a terminal, but not in the GUI. Setting | |
| 5806 'paste' in the GUI has side effects: e.g., the Paste toolbar button | |
| 5807 will no longer work in Insert mode, because it uses a mapping. | |
| 7 | 5808 When the 'paste' option is switched on (also when it was already on): |
| 5809 - mapping in Insert mode and Command-line mode is disabled | |
| 5810 - abbreviations are disabled | |
| 5811 - 'autoindent' is reset | |
|
7147
c590de398af9
commit https://github.com/vim/vim/commit/ca63501fbcd1cf9c8aa9ff12c093c95b62a89ed7
Christian Brabandt <cb@256bit.org>
parents:
7080
diff
changeset
|
5812 - 'expandtab' is reset |
| 25056 | 5813 - 'hkmap' is reset |
| 7 | 5814 - 'revins' is reset |
| 5815 - 'ruler' is reset | |
| 5816 - 'showmatch' is reset | |
|
7147
c590de398af9
commit https://github.com/vim/vim/commit/ca63501fbcd1cf9c8aa9ff12c093c95b62a89ed7
Christian Brabandt <cb@256bit.org>
parents:
7080
diff
changeset
|
5817 - 'smarttab' is reset |
|
c590de398af9
commit https://github.com/vim/vim/commit/ca63501fbcd1cf9c8aa9ff12c093c95b62a89ed7
Christian Brabandt <cb@256bit.org>
parents:
7080
diff
changeset
|
5818 - 'softtabstop' is set to 0 |
|
c590de398af9
commit https://github.com/vim/vim/commit/ca63501fbcd1cf9c8aa9ff12c093c95b62a89ed7
Christian Brabandt <cb@256bit.org>
parents:
7080
diff
changeset
|
5819 - 'textwidth' is set to 0 |
|
c590de398af9
commit https://github.com/vim/vim/commit/ca63501fbcd1cf9c8aa9ff12c093c95b62a89ed7
Christian Brabandt <cb@256bit.org>
parents:
7080
diff
changeset
|
5820 - 'wrapmargin' is set to 0 |
| 25056 | 5821 - 'varsofttabstop' is made empty |
| 7 | 5822 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
|
5823 - 'cindent' |
| 25056 | 5824 - '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
|
5825 - 'indentexpr' |
| 7 | 5826 - 'lisp' |
| 25056 | 5827 - 'smartindent' |
| 7 | 5828 NOTE: When you start editing another file while the 'paste' option is |
| 5829 on, settings from the modelines or autocommands may change the | |
| 5830 settings again, causing trouble when pasting text. You might want to | |
| 5831 set the 'paste' option again. | |
| 5832 When the 'paste' option is reset the mentioned options are restored to | |
| 5833 the value before the moment 'paste' was switched from off to on. | |
| 5834 Resetting 'paste' before ever setting it does not have any effect. | |
| 5835 Since mapping doesn't work while 'paste' is active, you need to use | |
| 5836 the 'pastetoggle' option to toggle the 'paste' option with some key. | |
| 5837 | |
| 5838 *'pastetoggle'* *'pt'* | |
| 5839 'pastetoggle' 'pt' string (default "") | |
| 5840 global | |
| 5841 When non-empty, specifies the key sequence that toggles the 'paste' | |
| 5842 option. This is like specifying a mapping: > | |
| 5843 :map {keys} :set invpaste<CR> | |
| 5844 < Where {keys} is the value of 'pastetoggle'. | |
| 5845 The difference is that it will work even when 'paste' is set. | |
| 5846 'pastetoggle' works in Insert mode and Normal mode, but not in | |
| 5847 Command-line mode. | |
| 5848 Mappings are checked first, thus overrule 'pastetoggle'. However, | |
| 5849 when 'paste' is on mappings are ignored in Insert mode, thus you can do | |
| 5850 this: > | |
| 5851 :map <F10> :set paste<CR> | |
| 5852 :map <F11> :set nopaste<CR> | |
| 5853 :imap <F10> <C-O>:set paste<CR> | |
| 5854 :imap <F11> <nop> | |
| 5855 :set pastetoggle=<F11> | |
| 5856 < This will make <F10> start paste mode and <F11> stop paste mode. | |
| 5857 Note that typing <F10> in paste mode inserts "<F10>", since in paste | |
| 5858 mode everything is inserted literally, except the 'pastetoggle' key | |
| 5859 sequence. | |
| 1621 | 5860 When the value has several bytes 'ttimeoutlen' applies. |
| 7 | 5861 |
| 5862 *'pex'* *'patchexpr'* | |
| 5863 'patchexpr' 'pex' string (default "") | |
| 5864 global | |
| 5865 {not available when compiled without the |+diff| | |
| 5866 feature} | |
| 5867 Expression which is evaluated to apply a patch to a file and generate | |
| 10 | 5868 the resulting new version of the file. See |diff-patchexpr|. |
| 7 | 5869 |
|
6091
7090d7f160f7
Update runtime files. Add vroom file support.
Bram Moolenaar <bram@vim.org>
parents:
6032
diff
changeset
|
5870 *'patchmode'* *'pm'* *E205* *E206* |
| 7 | 5871 'patchmode' 'pm' string (default "") |
| 5872 global | |
| 5873 When non-empty the oldest version of a file is kept. This can be used | |
| 5874 to keep the original version of a file if you are changing files in a | |
| 5875 source distribution. Only the first time that a file is written a | |
| 5876 copy of the original file will be kept. The name of the copy is the | |
| 5877 name of the original file with the string in the 'patchmode' option | |
| 5878 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
|
5879 ".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
|
5880 (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
|
5881 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
|
5882 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
|
5883 empty file is created. |
| 7 | 5884 When the 'backupskip' pattern matches, a patchmode file is not made. |
| 5885 Using 'patchmode' for compressed files appends the extension at the | |
| 5886 end (e.g., "file.gz.orig"), thus the resulting name isn't always | |
| 5887 recognized as a compressed file. | |
| 36 | 5888 Only normal file name characters can be used, "/\*?[|<>" are illegal. |
| 7 | 5889 |
| 3224 | 5890 *'path'* *'pa'* *E343* *E345* *E347* *E854* |
| 7 | 5891 'path' 'pa' string (default on Unix: ".,/usr/include,," |
| 5892 other systems: ".,,") | |
| 5893 global or local to buffer |global-local| | |
| 5894 This is a list of directories which will be searched when using the | |
| 1668 | 5895 |gf|, [f, ]f, ^Wf, |:find|, |:sfind|, |:tabfind| and other commands, |
| 5896 provided that the file being searched for has a relative path (not | |
| 5897 starting with "/", "./" or "../"). The directories in the 'path' | |
| 5898 option may be relative or absolute. | |
| 7 | 5899 - Use commas to separate directory names: > |
| 5900 :set path=.,/usr/local/include,/usr/include | |
| 5901 < - Spaces can also be used to separate directory names (for backwards | |
| 5902 compatibility with version 3.0). To have a space in a directory | |
| 5903 name, precede it with an extra backslash, and escape the space: > | |
| 5904 :set path=.,/dir/with\\\ space | |
| 5905 < - To include a comma in a directory name precede it with an extra | |
| 5906 backslash: > | |
| 5907 :set path=.,/dir/with\\,comma | |
| 5908 < - To search relative to the directory of the current file, use: > | |
| 5909 :set path=. | |
| 5910 < - To search in the current directory use an empty string between two | |
| 5911 commas: > | |
| 5912 :set path=,, | |
| 5913 < - A directory name may end in a ':' or '/'. | |
| 5914 - Environment variables are expanded |:set_env|. | |
| 5915 - When using |netrw.vim| URLs can be used. For example, adding | |
| 5916 "http://www.vim.org" will make ":find index.html" work. | |
| 1668 | 5917 - Search upwards and downwards in a directory tree using "*", "**" and |
| 5918 ";". See |file-searching| for info and syntax. | |
| 7 | 5919 {not available when compiled without the |+path_extra| feature} |
| 5920 - Careful with '\' characters, type two to get one in the option: > | |
| 5921 :set path=.,c:\\include | |
| 5922 < Or just use '/' instead: > | |
| 5923 :set path=.,c:/include | |
| 5924 < Don't forget "." or files won't even be found in the same directory as | |
| 5925 the file! | |
| 10 | 5926 The maximum length is limited. How much depends on the system, mostly |
| 7 | 5927 it is something like 256 or 1024 characters. |
| 5928 You can check if all the include files are found, using the value of | |
| 5929 'path', see |:checkpath|. | |
| 5930 The use of |:set+=| and |:set-=| is preferred when adding or removing | |
| 5931 directories from the list. This avoids problems when a future version | |
| 5932 uses another default. To remove the current directory use: > | |
| 5933 :set path-= | |
| 5934 < To add the current directory use: > | |
| 5935 :set path+= | |
| 5936 < To use an environment variable, you probably need to replace the | |
| 5937 separator. Here is an example to append $INCL, in which directory | |
| 5938 names are separated with a semi-colon: > | |
| 27903 | 5939 :let &path = &path .. "," .. substitute($INCL, ';', ',', 'g') |
| 7 | 5940 < Replace the ';' with a ':' or whatever separator is used. Note that |
| 5941 this doesn't work when $INCL contains a comma or white space. | |
| 5942 | |
| 12499 | 5943 *'perldll'* |
| 5944 'perldll' string (default depends on the build) | |
| 5945 global | |
| 5946 {only available when compiled with the |+perl/dyn| | |
| 5947 feature} | |
| 5948 Specifies the name of the Perl shared library. The default is | |
| 5949 DYNAMIC_PERL_DLL, which was specified at compile time. | |
| 5950 Environment variables are expanded |:set_env|. | |
| 5951 This option cannot be set from a |modeline| or in the |sandbox|, for | |
| 5952 security reasons. | |
| 5953 | |
| 7 | 5954 *'preserveindent'* *'pi'* *'nopreserveindent'* *'nopi'* |
| 5955 'preserveindent' 'pi' boolean (default off) | |
| 5956 local to buffer | |
| 5957 When changing the indent of the current line, preserve as much of the | |
| 5958 indent structure as possible. Normally the indent is replaced by a | |
| 5959 series of tabs followed by spaces as required (unless |'expandtab'| is | |
| 5960 enabled, in which case only spaces are used). Enabling this option | |
| 5961 means the indent will preserve as many existing characters as possible | |
| 5962 for indenting, and only add additional tabs or spaces as required. | |
| 1621 | 5963 'expandtab' does not apply to the preserved white space, a Tab remains |
| 5964 a Tab. | |
| 7 | 5965 NOTE: When using ">>" multiple times the resulting indent is a mix of |
| 5966 tabs and spaces. You might not like this. | |
| 11160 | 5967 NOTE: This option is reset when 'compatible' is set. |
| 7 | 5968 Also see 'copyindent'. |
| 5969 Use |:retab| to clean up white space. | |
| 5970 | |
| 5971 *'previewheight'* *'pvh'* | |
| 5972 'previewheight' 'pvh' number (default 12) | |
| 5973 global | |
|
17771
4bd21046902b
patch 8.1.1882: cannot specify properties of the info popup window
Bram Moolenaar <Bram@vim.org>
parents:
17767
diff
changeset
|
5974 {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
|
5975 feature} |
| 7 | 5976 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
|
5977 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
|
5978 '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
|
5979 |
|
ce35cdbe9f74
patch 8.1.1714: cannot preview a file in a popup window
Bram Moolenaar <Bram@vim.org>
parents:
17372
diff
changeset
|
5980 *'previewpopup'* *'pvp'* |
|
ce35cdbe9f74
patch 8.1.1714: cannot preview a file in a popup window
Bram Moolenaar <Bram@vim.org>
parents:
17372
diff
changeset
|
5981 '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
|
5982 global |
|
17771
4bd21046902b
patch 8.1.1882: cannot specify properties of the info popup window
Bram Moolenaar <Bram@vim.org>
parents:
17767
diff
changeset
|
5983 {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
|
5984 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
|
5985 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
|
5986 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
|
5987 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
|
5988 'completeopt' for that. |
| 7 | 5989 |
| 5990 *'previewwindow'* *'nopreviewwindow'* | |
| 5991 *'pvw'* *'nopvw'* *E590* | |
| 5992 'previewwindow' 'pvw' boolean (default off) | |
| 5993 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
|
5994 {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
|
5995 feature} |
| 10 | 5996 Identifies the preview window. Only one window can have this option |
| 7 | 5997 set. It's normally not set directly, but by using one of the commands |
| 5998 |:ptag|, |:pedit|, etc. | |
| 5999 | |
| 6000 *'printdevice'* *'pdev'* | |
| 6001 'printdevice' 'pdev' string (default empty) | |
| 6002 global | |
| 6003 {only available when compiled with the |+printer| | |
| 6004 feature} | |
| 15 | 6005 The name of the printer to be used for |:hardcopy|. |
| 6006 See |pdev-option|. | |
| 36 | 6007 This option cannot be set from a |modeline| or in the |sandbox|, for |
| 6008 security reasons. | |
| 15 | 6009 |
| 6010 *'printencoding'* *'penc'* | |
| 14864 | 6011 'printencoding' 'penc' string (default empty, except for some systems) |
| 7 | 6012 global |
| 6013 {only available when compiled with the |+printer| | |
| 6014 and |+postscript| features} | |
| 15 | 6015 Sets the character encoding used when printing. |
| 6016 See |penc-option|. | |
| 7 | 6017 |
| 6018 *'printexpr'* *'pexpr'* | |
| 14864 | 6019 'printexpr' 'pexpr' string (default: see below) |
| 7 | 6020 global |
| 6021 {only available when compiled with the |+printer| | |
| 6022 and |+postscript| features} | |
| 15 | 6023 Expression used to print the PostScript produced with |:hardcopy|. |
| 6024 See |pexpr-option|. | |
|
10449
222b1432814e
commit https://github.com/vim/vim/commit/5162822914372fc916a93f85848c0c82209e7cec
Christian Brabandt <cb@256bit.org>
parents:
10272
diff
changeset
|
6025 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
|
6026 security reasons. |
| 15 | 6027 |
| 6028 *'printfont'* *'pfn'* | |
| 7 | 6029 'printfont' 'pfn' string (default "courier") |
| 6030 global | |
| 6031 {only available when compiled with the |+printer| | |
| 6032 feature} | |
| 15 | 6033 The name of the font that will be used for |:hardcopy|. |
| 6034 See |pfn-option|. | |
| 7 | 6035 |
| 6036 *'printheader'* *'pheader'* | |
| 6037 'printheader' 'pheader' string (default "%<%f%h%m%=Page %N") | |
| 6038 global | |
| 6039 {only available when compiled with the |+printer| | |
| 6040 feature} | |
| 15 | 6041 The format of the header produced in |:hardcopy| output. |
| 6042 See |pheader-option|. | |
| 6043 | |
| 6044 *'printmbcharset'* *'pmbcs'* | |
| 6045 'printmbcharset' 'pmbcs' string (default "") | |
| 6046 global | |
| 15878 | 6047 {only available when compiled with the |+printer| |
| 6048 and |+postscript| features} | |
| 15 | 6049 The CJK character set to be used for CJK output from |:hardcopy|. |
| 6050 See |pmbcs-option|. | |
| 6051 | |
| 6052 *'printmbfont'* *'pmbfn'* | |
| 6053 'printmbfont' 'pmbfn' string (default "") | |
| 6054 global | |
| 15878 | 6055 {only available when compiled with the |+printer| |
| 6056 and |+postscript| features} | |
| 15 | 6057 List of font names to be used for CJK output from |:hardcopy|. |
| 6058 See |pmbfn-option|. | |
| 7 | 6059 |
| 6060 *'printoptions'* *'popt'* | |
| 6061 'printoptions' 'popt' string (default "") | |
| 6062 global | |
| 6063 {only available when compiled with |+printer| feature} | |
| 15 | 6064 List of items that control the format of the output of |:hardcopy|. |
| 6065 See |popt-option|. | |
| 6066 | |
| 168 | 6067 *'prompt'* *'noprompt'* |
| 6068 'prompt' boolean (default on) | |
| 6069 global | |
| 6070 When on a ":" prompt is used in Ex mode. | |
| 6071 | |
| 766 | 6072 *'pumheight'* *'ph'* |
| 6073 'pumheight' 'ph' number (default 0) | |
| 6074 global | |
| 853 | 6075 Determines the maximum number of items to show in the popup menu for |
| 6076 Insert mode completion. When zero as much space as available is used. | |
| 766 | 6077 |ins-completion-menu|. |
| 6078 | |
|
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
|
6079 *'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
|
6080 '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
|
6081 global |
|
13341
acd7eaa13d2b
Updated runtime files.
Christian Brabandt <cb@256bit.org>
parents:
13314
diff
changeset
|
6082 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
|
6083 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
|
6084 |
|
7228
873eae260c97
commit https://github.com/vim/vim/commit/b4ff518d95aa57c2f8c0568c915035bef849581b
Christian Brabandt <cb@256bit.org>
parents:
7218
diff
changeset
|
6085 *'pythondll'* |
|
8629
54ac275e3fc4
commit https://github.com/vim/vim/commit/3848e00e0177abdb31bc600234967863ec487233
Christian Brabandt <cb@256bit.org>
parents:
8560
diff
changeset
|
6086 '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
|
6087 global |
|
7228
873eae260c97
commit https://github.com/vim/vim/commit/b4ff518d95aa57c2f8c0568c915035bef849581b
Christian Brabandt <cb@256bit.org>
parents:
7218
diff
changeset
|
6088 {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
|
6089 feature} |
|
7528
53163e4d9e4f
commit https://github.com/vim/vim/commit/25e4fcde767084d1a79e0926bc301c92987c0cce
Christian Brabandt <cb@256bit.org>
parents:
7477
diff
changeset
|
6090 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
|
6091 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
|
6092 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
|
6093 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
|
6094 security reasons. |
|
873eae260c97
commit https://github.com/vim/vim/commit/b4ff518d95aa57c2f8c0568c915035bef849581b
Christian Brabandt <cb@256bit.org>
parents:
7218
diff
changeset
|
6095 |
|
13154
53cc7ea77c54
patch 8.0.1451: difficult to set the python home directories properly
Christian Brabandt <cb@256bit.org>
parents:
13150
diff
changeset
|
6096 *'pythonhome'* |
|
53cc7ea77c54
patch 8.0.1451: difficult to set the python home directories properly
Christian Brabandt <cb@256bit.org>
parents:
13150
diff
changeset
|
6097 '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
|
6098 global |
|
53cc7ea77c54
patch 8.0.1451: difficult to set the python home directories properly
Christian Brabandt <cb@256bit.org>
parents:
13150
diff
changeset
|
6099 {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
|
6100 feature} |
|
53cc7ea77c54
patch 8.0.1451: difficult to set the python home directories properly
Christian Brabandt <cb@256bit.org>
parents:
13150
diff
changeset
|
6101 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
|
6102 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
|
6103 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
|
6104 home directory. |
|
53cc7ea77c54
patch 8.0.1451: difficult to set the python home directories properly
Christian Brabandt <cb@256bit.org>
parents:
13150
diff
changeset
|
6105 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
|
6106 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
|
6107 security reasons. |
|
53cc7ea77c54
patch 8.0.1451: difficult to set the python home directories properly
Christian Brabandt <cb@256bit.org>
parents:
13150
diff
changeset
|
6108 |
|
7218
36dc8df8560f
commit https://github.com/vim/vim/commit/0796c0625fa4b9eb2f47fe8c976b78523924e1fb
Christian Brabandt <cb@256bit.org>
parents:
7196
diff
changeset
|
6109 *'pythonthreedll'* |
|
7528
53163e4d9e4f
commit https://github.com/vim/vim/commit/25e4fcde767084d1a79e0926bc301c92987c0cce
Christian Brabandt <cb@256bit.org>
parents:
7477
diff
changeset
|
6110 '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
|
6111 global |
|
7196
42717d048817
commit https://github.com/vim/vim/commit/d94464ee294a351ce7b6ba18e8bd3f24f1bef920
Christian Brabandt <cb@256bit.org>
parents:
7147
diff
changeset
|
6112 {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
|
6113 feature} |
|
7528
53163e4d9e4f
commit https://github.com/vim/vim/commit/25e4fcde767084d1a79e0926bc301c92987c0cce
Christian Brabandt <cb@256bit.org>
parents:
7477
diff
changeset
|
6114 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
|
6115 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
|
6116 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
|
6117 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
|
6118 security reasons. |
|
42717d048817
commit https://github.com/vim/vim/commit/d94464ee294a351ce7b6ba18e8bd3f24f1bef920
Christian Brabandt <cb@256bit.org>
parents:
7147
diff
changeset
|
6119 |
|
13154
53cc7ea77c54
patch 8.0.1451: difficult to set the python home directories properly
Christian Brabandt <cb@256bit.org>
parents:
13150
diff
changeset
|
6120 *'pythonthreehome'* |
|
53cc7ea77c54
patch 8.0.1451: difficult to set the python home directories properly
Christian Brabandt <cb@256bit.org>
parents:
13150
diff
changeset
|
6121 '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
|
6122 global |
|
53cc7ea77c54
patch 8.0.1451: difficult to set the python home directories properly
Christian Brabandt <cb@256bit.org>
parents:
13150
diff
changeset
|
6123 {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
|
6124 feature} |
|
53cc7ea77c54
patch 8.0.1451: difficult to set the python home directories properly
Christian Brabandt <cb@256bit.org>
parents:
13150
diff
changeset
|
6125 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
|
6126 '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
|
6127 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
|
6128 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
|
6129 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
|
6130 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
|
6131 security reasons. |
|
53cc7ea77c54
patch 8.0.1451: difficult to set the python home directories properly
Christian Brabandt <cb@256bit.org>
parents:
13150
diff
changeset
|
6132 |
|
10722
7598ce51bf2a
patch 8.0.0251: not easy to select Python 2 or 3
Christian Brabandt <cb@256bit.org>
parents:
10617
diff
changeset
|
6133 *'pyxversion'* *'pyx'* |
|
7598ce51bf2a
patch 8.0.0251: not easy to select Python 2 or 3
Christian Brabandt <cb@256bit.org>
parents:
10617
diff
changeset
|
6134 '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
|
6135 global |
|
7598ce51bf2a
patch 8.0.0251: not easy to select Python 2 or 3
Christian Brabandt <cb@256bit.org>
parents:
10617
diff
changeset
|
6136 {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
|
6137 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
|
6138 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
|
6139 |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
|
6140 |
|
7598ce51bf2a
patch 8.0.0251: not easy to select Python 2 or 3
Christian Brabandt <cb@256bit.org>
parents:
10617
diff
changeset
|
6141 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
|
6142 |+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
|
6143 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
|
6144 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
|
6145 |
|
7598ce51bf2a
patch 8.0.0251: not easy to select Python 2 or 3
Christian Brabandt <cb@256bit.org>
parents:
10617
diff
changeset
|
6146 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
|
6147 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
|
6148 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
|
6149 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
|
6150 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
|
6151 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
|
6152 |
|
7598ce51bf2a
patch 8.0.0251: not easy to select Python 2 or 3
Christian Brabandt <cb@256bit.org>
parents:
10617
diff
changeset
|
6153 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
|
6154 '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
|
6155 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
|
6156 |
|
7598ce51bf2a
patch 8.0.0251: not easy to select Python 2 or 3
Christian Brabandt <cb@256bit.org>
parents:
10617
diff
changeset
|
6157 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
|
6158 security reasons. |
|
7598ce51bf2a
patch 8.0.0251: not easy to select Python 2 or 3
Christian Brabandt <cb@256bit.org>
parents:
10617
diff
changeset
|
6159 |
|
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
|
6160 *'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
|
6161 '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
|
6162 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
|
6163 {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
|
6164 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
|
6165 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
|
6166 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
|
6167 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
|
6168 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
|
6169 |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
|
6170 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
|
6171 |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
|
6172 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
|
6173 |
|
d6827bd31d1d
patch 8.2.0869: it is not possible to customize the quickfix window contents
Bram Moolenaar <Bram@vim.org>
parents:
20613
diff
changeset
|
6174 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
|
6175 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
|
6176 |
| 140 | 6177 *'quoteescape'* *'qe'* |
| 12 | 6178 'quoteescape' 'qe' string (default "\") |
| 6179 local to buffer | |
| 6180 The characters that are used to escape quotes in a string. Used for | |
| 6181 objects like a', a" and a` |a'|. | |
| 6182 When one of the characters in this option is found inside a string, | |
| 6183 the following character will be skipped. The default value makes the | |
| 6184 text "foo\"bar\\" considered to be one string. | |
| 6185 | |
| 7 | 6186 *'readonly'* *'ro'* *'noreadonly'* *'noro'* |
| 6187 'readonly' 'ro' boolean (default off) | |
| 6188 local to buffer | |
| 6189 If on, writes fail unless you use a '!'. Protects you from | |
| 6190 accidentally overwriting a file. Default on when Vim is started | |
| 6191 in read-only mode ("vim -R") or when the executable is called "view". | |
| 164 | 6192 When using ":w!" the 'readonly' option is reset for the current |
| 6193 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
|
6194 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
|
6195 newly edited buffer. |
| 10617 | 6196 See 'modifiable' for disallowing changes to the buffer. |
| 7 | 6197 |
| 1521 | 6198 *'redrawtime'* *'rdt'* |
| 6199 'redrawtime' 'rdt' number (default 2000) | |
| 6200 global | |
| 6201 {only available when compiled with the |+reltime| | |
| 6202 feature} | |
| 6203 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
|
6204 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
|
6205 highlighting. |
| 1521 | 6206 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
|
6207 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
|
6208 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
|
6209 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
|
6210 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
|
6211 pattern. |
| 1521 | 6212 |
|
4681
2eb30f341e8d
Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents:
4502
diff
changeset
|
6213 *'regexpengine'* *'re'* |
|
4502
605c9ce57ec3
Updated runtime files, language files and translations.
Bram Moolenaar <bram@vim.org>
parents:
4358
diff
changeset
|
6214 'regexpengine' 're' number (default 0) |
|
605c9ce57ec3
Updated runtime files, language files and translations.
Bram Moolenaar <bram@vim.org>
parents:
4358
diff
changeset
|
6215 global |
|
605c9ce57ec3
Updated runtime files, language files and translations.
Bram Moolenaar <bram@vim.org>
parents:
4358
diff
changeset
|
6216 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
|
6217 The possible values are: |
|
605c9ce57ec3
Updated runtime files, language files and translations.
Bram Moolenaar <bram@vim.org>
parents:
4358
diff
changeset
|
6218 0 automatic selection |
|
605c9ce57ec3
Updated runtime files, language files and translations.
Bram Moolenaar <bram@vim.org>
parents:
4358
diff
changeset
|
6219 1 old engine |
|
605c9ce57ec3
Updated runtime files, language files and translations.
Bram Moolenaar <bram@vim.org>
parents:
4358
diff
changeset
|
6220 2 NFA engine |
|
605c9ce57ec3
Updated runtime files, language files and translations.
Bram Moolenaar <bram@vim.org>
parents:
4358
diff
changeset
|
6221 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
|
6222 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
|
6223 for debugging the regexp engine. |
| 6328 | 6224 Using automatic selection enables Vim to switch the engine, if the |
| 6225 default engine becomes too costly. E.g., when the NFA engine uses too | |
| 6226 many states. This should prevent Vim from hanging on a combination of | |
| 6227 a complex pattern with long text. | |
|
4502
605c9ce57ec3
Updated runtime files, language files and translations.
Bram Moolenaar <bram@vim.org>
parents:
4358
diff
changeset
|
6228 |
|
2178
c6f1aa1e9f32
Add 'relativenumber' patch from Markus Heidelberg.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
6229 *'relativenumber'* *'rnu'* *'norelativenumber'* *'nornu'* |
|
c6f1aa1e9f32
Add 'relativenumber' patch from Markus Heidelberg.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
6230 'relativenumber' 'rnu' boolean (default off) |
|
c6f1aa1e9f32
Add 'relativenumber' patch from Markus Heidelberg.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
6231 local to window |
|
c6f1aa1e9f32
Add 'relativenumber' patch from Markus Heidelberg.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
6232 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
|
6233 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
|
6234 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
|
6235 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
|
6236 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
|
6237 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
|
6238 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
|
6239 'compatible' isn't set). |
|
c6f1aa1e9f32
Add 'relativenumber' patch from Markus Heidelberg.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
6240 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
|
6241 number. |
|
c6f1aa1e9f32
Add 'relativenumber' patch from Markus Heidelberg.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
6242 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
|
6243 characters are put before the number. |
| 3445 | 6244 See |hl-LineNr| and |hl-CursorLineNr| for the highlighting used for |
| 6245 the number. | |
|
13341
acd7eaa13d2b
Updated runtime files.
Christian Brabandt <cb@256bit.org>
parents:
13314
diff
changeset
|
6246 |
| 4780 | 6247 The number in front of the cursor line also depends on the value of |
| 6248 'number', see |number_relativenumber| for all combinations of the two | |
| 6249 options. | |
|
2178
c6f1aa1e9f32
Add 'relativenumber' patch from Markus Heidelberg.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
6250 |
| 7 | 6251 *'remap'* *'noremap'* |
| 6252 'remap' boolean (default on) | |
| 6253 global | |
| 6254 Allows for mappings to work recursively. If you do not want this for | |
| 6255 a single entry, use the :noremap[!] command. | |
| 717 | 6256 NOTE: To avoid portability problems with Vim scripts, always keep |
| 6257 this option at the default "on". Only switch it off when working with | |
| 6258 old Vi scripts. | |
| 7 | 6259 |
| 6110 | 6260 *'renderoptions'* *'rop'* |
| 6261 'renderoptions' 'rop' string (default: empty) | |
| 6262 global | |
| 6263 {only available when compiled with GUI and DIRECTX on | |
| 6264 MS-Windows} | |
| 6265 Select a text renderer and set its options. The options depend on the | |
| 6266 renderer. | |
| 6267 | |
| 6268 Syntax: > | |
| 6269 set rop=type:{renderer}(,{name}:{value})* | |
| 6270 < | |
| 6271 Currently, only one optional renderer is available. | |
| 6272 | |
| 6273 render behavior ~ | |
| 6274 directx Vim will draw text using DirectX (DirectWrite). It makes | |
| 6275 drawn glyphs more beautiful than default GDI. | |
| 6276 It requires 'encoding' is "utf-8", and only works on | |
| 6277 MS-Windows Vista or newer version. | |
| 6278 | |
| 6279 Options: | |
| 6280 name meaning type value ~ | |
| 6281 gamma gamma float 1.0 - 2.2 (maybe) | |
| 6282 contrast enhancedContrast float (unknown) | |
| 6283 level clearTypeLevel float (unknown) | |
| 6284 geom pixelGeometry int 0 - 2 (see below) | |
| 6285 renmode renderingMode int 0 - 6 (see below) | |
| 6286 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
|
6287 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
|
6288 |
|
18e6f4addce9
patch 8.0.1369: MS-Windows: drawing underline slow, mFallbackDC not updated
Christian Brabandt <cb@256bit.org>
parents:
12971
diff
changeset
|
6289 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
|
6290 https://msdn.microsoft.com/en-us/library/dd368190.aspx |
| 6110 | 6291 |
| 6292 For geom: structure of a device pixel. | |
| 6293 0 - DWRITE_PIXEL_GEOMETRY_FLAT | |
| 6294 1 - DWRITE_PIXEL_GEOMETRY_RGB | |
| 6295 2 - DWRITE_PIXEL_GEOMETRY_BGR | |
| 6296 | |
| 6297 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
|
6298 https://msdn.microsoft.com/en-us/library/dd368114.aspx |
| 6110 | 6299 |
| 6300 For renmode: method of rendering glyphs. | |
| 6301 0 - DWRITE_RENDERING_MODE_DEFAULT | |
| 6302 1 - DWRITE_RENDERING_MODE_ALIASED | |
| 6303 2 - DWRITE_RENDERING_MODE_GDI_CLASSIC | |
| 6304 3 - DWRITE_RENDERING_MODE_GDI_NATURAL | |
| 6305 4 - DWRITE_RENDERING_MODE_NATURAL | |
| 6306 5 - DWRITE_RENDERING_MODE_NATURAL_SYMMETRIC | |
| 6307 6 - DWRITE_RENDERING_MODE_OUTLINE | |
| 6308 | |
| 6309 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
|
6310 https://msdn.microsoft.com/en-us/library/dd368118.aspx |
| 6110 | 6311 |
| 6312 For taamode: antialiasing mode used for drawing text. | |
| 6313 0 - D2D1_TEXT_ANTIALIAS_MODE_DEFAULT | |
| 6314 1 - D2D1_TEXT_ANTIALIAS_MODE_CLEARTYPE | |
| 6315 2 - D2D1_TEXT_ANTIALIAS_MODE_GRAYSCALE | |
| 6316 3 - D2D1_TEXT_ANTIALIAS_MODE_ALIASED | |
| 6317 | |
| 6318 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
|
6319 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
|
6320 |
|
13150
808625d4b71b
patch 8.0.1449: slow redrawing with DirectX
Christian Brabandt <cb@256bit.org>
parents:
13100
diff
changeset
|
6321 For scrlines: |
|
808625d4b71b
patch 8.0.1449: slow redrawing with DirectX
Christian Brabandt <cb@256bit.org>
parents:
13100
diff
changeset
|
6322 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
|
6323 is now deprecated. If specified, it is simply ignored. |
| 6110 | 6324 |
| 6325 Example: > | |
| 6326 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
|
6327 set gfn=Ricty_Diminished:h12 |
| 6110 | 6328 set rop=type:directx |
| 6329 < | |
|
12934
2ebc3df65ca2
patch 8.0.1343: MS-Windows: does not show colored emojis
Christian Brabandt <cb@256bit.org>
parents:
12930
diff
changeset
|
6330 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
|
6331 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
|
6332 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
|
6333 |
|
2ebc3df65ca2
patch 8.0.1343: MS-Windows: does not show colored emojis
Christian Brabandt <cb@256bit.org>
parents:
12930
diff
changeset
|
6334 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
|
6335 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
|
6336 |
|
12986
18e6f4addce9
patch 8.0.1369: MS-Windows: drawing underline slow, mFallbackDC not updated
Christian Brabandt <cb@256bit.org>
parents:
12971
diff
changeset
|
6337 - '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
|
6338 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
|
6339 bitmap glyphs). |
|
2ebc3df65ca2
patch 8.0.1343: MS-Windows: does not show colored emojis
Christian Brabandt <cb@256bit.org>
parents:
12930
diff
changeset
|
6340 - '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
|
6341 |
|
2ebc3df65ca2
patch 8.0.1343: MS-Windows: does not show colored emojis
Christian Brabandt <cb@256bit.org>
parents:
12930
diff
changeset
|
6342 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
|
6343 (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
|
6344 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
|
6345 |
|
2ebc3df65ca2
patch 8.0.1343: MS-Windows: does not show colored emojis
Christian Brabandt <cb@256bit.org>
parents:
12930
diff
changeset
|
6346 - 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
|
6347 be used. |
|
2ebc3df65ca2
patch 8.0.1343: MS-Windows: does not show colored emojis
Christian Brabandt <cb@256bit.org>
parents:
12930
diff
changeset
|
6348 - 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
|
6349 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
|
6350 will be used. |
|
2ebc3df65ca2
patch 8.0.1343: MS-Windows: does not show colored emojis
Christian Brabandt <cb@256bit.org>
parents:
12930
diff
changeset
|
6351 - 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
|
6352 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
|
6353 cell. |
| 6110 | 6354 |
| 6355 Other render types are currently not supported. | |
| 6356 | |
| 7 | 6357 *'report'* |
| 6358 'report' number (default 2) | |
| 6359 global | |
| 6360 Threshold for reporting number of lines changed. When the number of | |
| 6361 changed lines is more than 'report' a message will be given for most | |
| 6362 ":" commands. If you want it always, set 'report' to 0. | |
| 6363 For the ":substitute" command the number of substitutions is used | |
| 6364 instead of the number of lines. | |
| 6365 | |
| 6366 *'restorescreen'* *'rs'* *'norestorescreen'* *'nors'* | |
| 6367 'restorescreen' 'rs' boolean (default on) | |
| 6368 global | |
| 19116 | 6369 {only in MS-Windows console version} |
| 7 | 6370 When set, the screen contents is restored when exiting Vim. This also |
| 6371 happens when executing external commands. | |
| 6372 | |
| 6373 For non-Windows Vim: You can set or reset the 't_ti' and 't_te' | |
| 6374 options in your .vimrc. To disable restoring: | |
| 6375 set t_ti= t_te= | |
| 6376 To enable restoring (for an xterm): | |
| 6377 set t_ti=^[7^[[r^[[?47h t_te=^[[?47l^[8 | |
| 6378 (Where ^[ is an <Esc>, type CTRL-V <Esc> to insert it) | |
| 6379 | |
| 6380 *'revins'* *'ri'* *'norevins'* *'nori'* | |
| 6381 'revins' 'ri' boolean (default off) | |
| 6382 global | |
| 6383 {only available when compiled with the |+rightleft| | |
| 6384 feature} | |
| 6385 Inserting characters in Insert mode will work backwards. See "typing | |
| 6386 backwards" |ins-reverse|. This option can be toggled with the CTRL-_ | |
| 6387 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
|
6388 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
|
6389 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
|
6390 reset. |
| 7 | 6391 |
| 6392 *'rightleft'* *'rl'* *'norightleft'* *'norl'* | |
| 6393 'rightleft' 'rl' boolean (default off) | |
| 6394 local to window | |
| 6395 {only available when compiled with the |+rightleft| | |
| 6396 feature} | |
| 6397 When on, display orientation becomes right-to-left, i.e., characters | |
| 6398 that are stored in the file appear from the right to the left. | |
| 6399 Using this option, it is possible to edit files for languages that | |
| 6400 are written from the right to the left such as Hebrew and Arabic. | |
| 6401 This option is per window, so it is possible to edit mixed files | |
| 6402 simultaneously, or to view the same file in both ways (this is | |
| 6403 useful whenever you have a mixed text file with both right-to-left | |
| 6404 and left-to-right strings so that both sets are displayed properly | |
| 6405 in different windows). Also see |rileft.txt|. | |
| 6406 | |
| 2341 | 6407 *'rightleftcmd'* *'rlc'* |
| 7 | 6408 'rightleftcmd' 'rlc' string (default "search") |
| 6409 local to window | |
| 6410 {only available when compiled with the |+rightleft| | |
| 6411 feature} | |
| 6412 Each word in this option enables the command line editing to work in | |
| 6413 right-to-left mode for a group of commands: | |
| 6414 | |
| 6415 search "/" and "?" commands | |
| 6416 | |
| 6417 This is useful for languages such as Hebrew, Arabic and Farsi. | |
| 6418 The 'rightleft' option must be set for 'rightleftcmd' to take effect. | |
| 6419 | |
|
7196
42717d048817
commit https://github.com/vim/vim/commit/d94464ee294a351ce7b6ba18e8bd3f24f1bef920
Christian Brabandt <cb@256bit.org>
parents:
7147
diff
changeset
|
6420 *'rubydll'* |
|
8629
54ac275e3fc4
commit https://github.com/vim/vim/commit/3848e00e0177abdb31bc600234967863ec487233
Christian Brabandt <cb@256bit.org>
parents:
8560
diff
changeset
|
6421 '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
|
6422 global |
|
7196
42717d048817
commit https://github.com/vim/vim/commit/d94464ee294a351ce7b6ba18e8bd3f24f1bef920
Christian Brabandt <cb@256bit.org>
parents:
7147
diff
changeset
|
6423 {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
|
6424 feature} |
|
7528
53163e4d9e4f
commit https://github.com/vim/vim/commit/25e4fcde767084d1a79e0926bc301c92987c0cce
Christian Brabandt <cb@256bit.org>
parents:
7477
diff
changeset
|
6425 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
|
6426 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
|
6427 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
|
6428 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
|
6429 security reasons. |
|
42717d048817
commit https://github.com/vim/vim/commit/d94464ee294a351ce7b6ba18e8bd3f24f1bef920
Christian Brabandt <cb@256bit.org>
parents:
7147
diff
changeset
|
6430 |
| 7 | 6431 *'ruler'* *'ru'* *'noruler'* *'noru'* |
|
9669
284b4eb307fc
commit https://github.com/vim/vim/commit/8c08b5b569e2a9e9f63dea514591ecfa2d3bb392
Christian Brabandt <cb@256bit.org>
parents:
9665
diff
changeset
|
6432 'ruler' 'ru' boolean (default off, set in |defaults.vim|) |
| 7 | 6433 global |
| 6434 {not available when compiled without the | |
| 6435 |+cmdline_info| feature} | |
| 6436 Show the line and column number of the cursor position, separated by a | |
| 10 | 6437 comma. When there is room, the relative position of the displayed |
| 7 | 6438 text in the file is shown on the far right: |
| 6439 Top first line is visible | |
| 6440 Bot last line is visible | |
| 6441 All first and last line are visible | |
| 6442 45% relative position in the file | |
| 6443 If 'rulerformat' is set, it will determine the contents of the ruler. | |
| 10 | 6444 Each window has its own ruler. If a window has a status line, the |
| 7 | 6445 ruler is shown there. Otherwise it is shown in the last line of the |
| 233 | 6446 screen. If the statusline is given by 'statusline' (i.e. not empty), |
| 7 | 6447 this option takes precedence over 'ruler' and 'rulerformat' |
| 6448 If the number of characters displayed is different from the number of | |
| 21991 | 6449 bytes in the text (e.g., for a TAB or a multibyte character), both |
| 7 | 6450 the text column (byte number) and the screen column are shown, |
| 6451 separated with a dash. | |
| 6452 For an empty line "0-1" is shown. | |
| 6453 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
|
6454 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
|
6455 reset. |
| 7 | 6456 If you don't want to see the ruler all the time but want to know where |
| 6457 you are, use "g CTRL-G" |g_CTRL-G|. | |
| 6458 NOTE: This option is reset when 'compatible' is set. | |
| 6459 | |
| 6460 *'rulerformat'* *'ruf'* | |
| 6461 'rulerformat' 'ruf' string (default empty) | |
| 6462 global | |
| 6463 {not available when compiled without the |+statusline| | |
| 6464 feature} | |
| 6465 When this option is not empty, it determines the content of the ruler | |
| 6466 string, as displayed for the 'ruler' option. | |
| 692 | 6467 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
|
6468 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
|
6469 |
| 7 | 6470 The default ruler width is 17 characters. To make the ruler 15 |
| 6471 characters wide, put "%15(" at the start and "%)" at the end. | |
| 6472 Example: > | |
| 6473 :set rulerformat=%15(%c%V\ %p%%%) | |
| 6474 < | |
| 6475 *'runtimepath'* *'rtp'* *vimfiles* | |
| 6476 'runtimepath' 'rtp' string (default: | |
| 23931 | 6477 Unix: "$HOME/.vim, |
| 7 | 6478 $VIM/vimfiles, |
| 6479 $VIMRUNTIME, | |
| 6480 $VIM/vimfiles/after, | |
| 6481 $HOME/.vim/after" | |
| 6482 Amiga: "home:vimfiles, | |
| 6483 $VIM/vimfiles, | |
| 6484 $VIMRUNTIME, | |
| 6485 $VIM/vimfiles/after, | |
| 6486 home:vimfiles/after" | |
| 23931 | 6487 MS-Windows: "$HOME/vimfiles, |
| 7 | 6488 $VIM/vimfiles, |
| 6489 $VIMRUNTIME, | |
| 6490 $VIM/vimfiles/after, | |
| 6491 $HOME/vimfiles/after" | |
| 21825 | 6492 macOS: "$VIM:vimfiles, |
| 7 | 6493 $VIMRUNTIME, |
| 6494 $VIM:vimfiles:after" | |
|
19526
22f0dda71638
patch 8.2.0320: no Haiku support
Bram Moolenaar <Bram@vim.org>
parents:
19404
diff
changeset
|
6495 Haiku: "$BE_USER_SETTINGS/vim, |
|
22f0dda71638
patch 8.2.0320: no Haiku support
Bram Moolenaar <Bram@vim.org>
parents:
19404
diff
changeset
|
6496 $VIM/vimfiles, |
|
22f0dda71638
patch 8.2.0320: no Haiku support
Bram Moolenaar <Bram@vim.org>
parents:
19404
diff
changeset
|
6497 $VIMRUNTIME, |
|
22f0dda71638
patch 8.2.0320: no Haiku support
Bram Moolenaar <Bram@vim.org>
parents:
19404
diff
changeset
|
6498 $VIM/vimfiles/after, |
| 23931 | 6499 $BE_USER_SETTINGS/vim/after" |
| 6500 VMS: "sys$login:vimfiles, | |
| 7 | 6501 $VIM/vimfiles, |
| 6502 $VIMRUNTIME, | |
| 6503 $VIM/vimfiles/after, | |
| 233 | 6504 sys$login:vimfiles/after") |
| 7 | 6505 global |
| 6506 This is a list of directories which will be searched for runtime | |
| 6507 files: | |
| 6508 filetype.vim filetypes by file name |new-filetype| | |
| 6509 scripts.vim filetypes by file contents |new-filetype-scripts| | |
| 164 | 6510 autoload/ automatically loaded scripts |autoload-functions| |
| 7 | 6511 colors/ color scheme files |:colorscheme| |
| 6512 compiler/ compiler files |:compiler| | |
| 6513 doc/ documentation |write-local-help| | |
| 6514 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
|
6515 import/ files that are found by `:import` |
| 7 | 6516 indent/ indent scripts |indent-expression| |
| 6517 keymap/ key mapping files |mbyte-keymap| | |
| 6518 lang/ menu translations |:menutrans| | |
| 6519 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
|
6520 pack/ packages |:packadd| |
| 7 | 6521 plugin/ plugin scripts |write-plugin| |
| 6522 print/ files for printing |postscript-print-encoding| | |
| 650 | 6523 spell/ spell checking files |spell| |
| 7 | 6524 syntax/ syntax files |mysyntaxfile| |
| 6525 tutor/ files for vimtutor |tutor| | |
| 6526 | |
| 6527 And any other file searched for with the |:runtime| command. | |
| 6528 | |
| 6529 The defaults for most systems are setup to search five locations: | |
| 6530 1. In your home directory, for your personal preferences. | |
| 6531 2. In a system-wide Vim directory, for preferences from the system | |
| 6532 administrator. | |
| 6533 3. In $VIMRUNTIME, for files distributed with Vim. | |
| 6534 *after-directory* | |
| 6535 4. In the "after" directory in the system-wide Vim directory. This is | |
| 6536 for the system administrator to overrule or add to the distributed | |
| 6537 defaults (rarely needed) | |
| 6538 5. In the "after" directory in your home directory. This is for | |
| 6539 personal preferences to overrule or add to the distributed defaults | |
| 6540 or system-wide settings (rarely needed). | |
| 6541 | |
|
10211
b7da8d4c594c
commit https://github.com/vim/vim/commit/d07969093a9b3051511c478d71c36de6fc33c0d6
Christian Brabandt <cb@256bit.org>
parents:
10198
diff
changeset
|
6542 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
|
6543 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
|
6544 string. |
|
9116
bc38030aec7d
commit https://github.com/vim/vim/commit/26852128a2b713ef49341a0c18daba928444e7eb
Christian Brabandt <cb@256bit.org>
parents:
9098
diff
changeset
|
6545 |
| 7 | 6546 Note that, unlike 'path', no wildcards like "**" are allowed. Normal |
| 6547 wildcards are allowed, but can significantly slow down searching for | |
| 10 | 6548 runtime files. For speed, use as few items as possible and avoid |
| 7 | 6549 wildcards. |
| 6550 See |:runtime|. | |
| 6551 Example: > | |
| 6552 :set runtimepath=~/vimruntime,/mygroup/vim,$VIMRUNTIME | |
| 6553 < This will use the directory "~/vimruntime" first (containing your | |
| 6554 personal Vim runtime files), then "/mygroup/vim" (shared between a | |
| 6555 group of people) and finally "$VIMRUNTIME" (the distributed runtime | |
| 6556 files). | |
| 6557 You probably should always include $VIMRUNTIME somewhere, to use the | |
| 6558 distributed runtime files. You can put a directory before $VIMRUNTIME | |
| 6559 to find files which replace a distributed runtime files. You can put | |
| 6560 a directory after $VIMRUNTIME to find files which add to distributed | |
| 6561 runtime files. | |
| 13437 | 6562 When Vim is started with |--clean| the home directory entries are not |
| 6563 included. | |
| 7 | 6564 This option cannot be set from a |modeline| or in the |sandbox|, for |
| 6565 security reasons. | |
| 6566 | |
| 6567 *'scroll'* *'scr'* | |
| 6568 'scroll' 'scr' number (default: half the window height) | |
| 6569 local to window | |
| 6570 Number of lines to scroll with CTRL-U and CTRL-D commands. Will be | |
| 6571 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
|
6572 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
|
6573 '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
|
6574 If you give a count to the CTRL-U or CTRL-D command it will |
| 10 | 6575 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
|
6576 height with ":set scroll=0". |
| 7 | 6577 |
| 6578 *'scrollbind'* *'scb'* *'noscrollbind'* *'noscb'* | |
| 6579 'scrollbind' 'scb' boolean (default off) | |
| 6580 local to window | |
| 6581 See also |scroll-binding|. When this option is set, the current | |
| 6582 window scrolls as other scrollbind windows (windows that also have | |
| 6583 this option set) scroll. This option is useful for viewing the | |
| 6584 differences between two versions of a file, see 'diff'. | |
| 6585 See |'scrollopt'| for options that determine how this option should be | |
| 6586 interpreted. | |
| 6587 This option is mostly reset when splitting a window to edit another | |
| 6588 file. This means that ":split | edit file" results in two windows | |
| 6589 with scroll-binding, but ":split file" does not. | |
| 6590 | |
|
18526
334b1f897f3a
patch 8.1.2257: MS-Windows GUI: scroll wheel always uses current window
Bram Moolenaar <Bram@vim.org>
parents:
18489
diff
changeset
|
6591 *'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
|
6592 '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
|
6593 global |
|
334b1f897f3a
patch 8.1.2257: MS-Windows GUI: scroll wheel always uses current window
Bram Moolenaar <Bram@vim.org>
parents:
18489
diff
changeset
|
6594 {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
|
6595 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
|
6596 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
|
6597 window is scrolled. |
| 18594 | 6598 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
|
6599 |
| 7 | 6600 *'scrolljump'* *'sj'* |
| 6601 'scrolljump' 'sj' number (default 1) | |
| 6602 global | |
| 6603 Minimal number of lines to scroll when the cursor gets off the | |
| 6604 screen (e.g., with "j"). Not used for scroll commands (e.g., CTRL-E, | |
| 6605 CTRL-D). Useful if your terminal scrolls very slowly. | |
| 532 | 6606 When set to a negative number from -1 to -100 this is used as the |
| 6607 percentage of the window height. Thus -50 scrolls half the window | |
| 6608 height. | |
| 7 | 6609 NOTE: This option is set to 1 when 'compatible' is set. |
| 6610 | |
| 6611 *'scrolloff'* *'so'* | |
|
10218
584c835a2de1
commit https://github.com/vim/vim/commit/50ba526fbf3e9e5e0e6b0b3086a4d5df581ebc7e
Christian Brabandt <cb@256bit.org>
parents:
10211
diff
changeset
|
6612 '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
|
6613 global or local to window |global-local| |
| 7 | 6614 Minimal number of screen lines to keep above and below the cursor. |
| 6615 This will make some context visible around where you are working. If | |
| 6616 you set it to a very large value (999) the cursor line will always be | |
| 6617 in the middle of the window (except at the start or end of the file or | |
| 6618 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
|
6619 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
|
6620 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
|
6621 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
|
6622 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
|
6623 < For scrolling horizontally see 'sidescrolloff'. |
| 7 | 6624 NOTE: This option is set to 0 when 'compatible' is set. |
| 6625 | |
| 6626 *'scrollopt'* *'sbo'* | |
| 6627 'scrollopt' 'sbo' string (default "ver,jump") | |
| 6628 global | |
| 6629 This is a comma-separated list of words that specifies how | |
| 236 | 6630 'scrollbind' windows should behave. 'sbo' stands for ScrollBind |
| 6631 Options. | |
| 7 | 6632 The following words are available: |
| 6633 ver Bind vertical scrolling for 'scrollbind' windows | |
| 6634 hor Bind horizontal scrolling for 'scrollbind' windows | |
| 6635 jump Applies to the offset between two windows for vertical | |
| 6636 scrolling. This offset is the difference in the first | |
| 6637 displayed line of the bound windows. When moving | |
| 6638 around in a window, another 'scrollbind' window may | |
| 6639 reach a position before the start or after the end of | |
| 6640 the buffer. The offset is not changed though, when | |
| 6641 moving back the 'scrollbind' window will try to scroll | |
| 6642 to the desired position when possible. | |
| 6643 When now making that window the current one, two | |
| 6644 things can be done with the relative offset: | |
| 6645 1. When "jump" is not included, the relative offset is | |
| 6646 adjusted for the scroll position in the new current | |
| 6647 window. When going back to the other window, the | |
| 1152 | 6648 new relative offset will be used. |
| 7 | 6649 2. When "jump" is included, the other windows are |
| 6650 scrolled to keep the same relative offset. When | |
| 6651 going back to the other window, it still uses the | |
| 6652 same relative offset. | |
| 6653 Also see |scroll-binding|. | |
| 819 | 6654 When 'diff' mode is active there always is vertical scroll binding, |
| 6655 even when "ver" isn't there. | |
| 7 | 6656 |
| 6657 *'sections'* *'sect'* | |
| 6658 'sections' 'sect' string (default "SHNHH HUnhsh") | |
| 6659 global | |
| 6660 Specifies the nroff macros that separate sections. These are pairs of | |
| 6661 two letters (See |object-motions|). The default makes a section start | |
| 6662 at the nroff macros ".SH", ".NH", ".H", ".HU", ".nh" and ".sh". | |
| 6663 | |
| 6664 *'secure'* *'nosecure'* *E523* | |
| 6665 'secure' boolean (default off) | |
| 6666 global | |
| 6667 When on, ":autocmd", shell and write commands are not allowed in | |
| 6668 ".vimrc" and ".exrc" in the current directory and map commands are | |
| 6669 displayed. Switch it off only if you know that you will not run into | |
| 6670 problems, or when the 'exrc' option is off. On Unix this option is | |
| 6671 only used if the ".vimrc" or ".exrc" is not owned by you. This can be | |
| 10 | 6672 dangerous if the systems allows users to do a "chown". You better set |
| 7 | 6673 'secure' at the end of your ~/.vimrc then. |
| 6674 This option cannot be set from a |modeline| or in the |sandbox|, for | |
| 6675 security reasons. | |
| 6676 | |
| 6677 *'selection'* *'sel'* | |
| 6678 'selection' 'sel' string (default "inclusive") | |
| 6679 global | |
| 6680 This option defines the behavior of the selection. It is only used | |
| 6681 in Visual and Select mode. | |
| 6682 Possible values: | |
| 6683 value past line inclusive ~ | |
| 6684 old no yes | |
| 6685 inclusive yes yes | |
| 6686 exclusive yes no | |
| 6687 "past line" means that the cursor is allowed to be positioned one | |
| 6688 character past the line. | |
| 6689 "inclusive" means that the last character of the selection is included | |
| 6690 in an operation. For example, when "x" is used to delete the | |
| 6691 selection. | |
|
9975
03fa8a51e9dc
commit https://github.com/vim/vim/commit/e4a3bcf28d92d0bde9ca227ccb40d401038185e5
Christian Brabandt <cb@256bit.org>
parents:
9913
diff
changeset
|
6692 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
|
6693 the end of line the line break still isn't included. |
| 7 | 6694 Note that when "exclusive" is used and selecting from the end |
| 6695 backwards, you cannot include the last character of a line, when | |
| 6696 starting in Normal mode and 'virtualedit' empty. | |
| 6697 | |
| 6698 The 'selection' option is set by the |:behave| command. | |
| 6699 | |
| 6700 *'selectmode'* *'slm'* | |
| 6701 'selectmode' 'slm' string (default "") | |
| 6702 global | |
| 28379 | 6703 This is a comma-separated list of words, which specifies when to start |
| 7 | 6704 Select mode instead of Visual mode, when a selection is started. |
| 6705 Possible values: | |
| 6706 mouse when using the mouse | |
| 6707 key when using shifted special keys | |
| 6708 cmd when using "v", "V" or CTRL-V | |
| 6709 See |Select-mode|. | |
| 6710 The 'selectmode' option is set by the |:behave| command. | |
| 6711 | |
| 6712 *'sessionoptions'* *'ssop'* | |
| 6713 'sessionoptions' 'ssop' string (default: "blank,buffers,curdir,folds, | |
| 13437 | 6714 help,options,tabpages,winsize,terminal") |
| 7 | 6715 global |
|
2570
71b56b4e7785
Make the references to features in the help more consistent. (Sylvain Hitier)
Bram Moolenaar <bram@vim.org>
parents:
2561
diff
changeset
|
6716 {not available when compiled without the |+mksession| |
| 7 | 6717 feature} |
| 6718 Changes the effect of the |:mksession| command. It is a comma | |
| 6719 separated list of words. Each word enables saving and restoring | |
| 6720 something: | |
| 6721 word save and restore ~ | |
| 6722 blank empty windows | |
| 6723 buffers hidden and unloaded buffers, not just those in windows | |
| 6724 curdir the current directory | |
| 6725 folds manually created folds, opened/closed folds and local | |
| 6726 fold options | |
| 6727 globals global variables that start with an uppercase letter | |
| 75 | 6728 and contain at least one lowercase letter. Only |
| 6729 String and Number types are stored. | |
| 7 | 6730 help the help window |
| 6731 localoptions options and mappings local to a window or buffer (not | |
| 6732 global values for local options) | |
| 6733 options all options and mappings (also global values for local | |
| 6734 options) | |
|
24476
e79d1475fc89
patch 8.2.2778: problem restoring 'packpath' in session
Bram Moolenaar <Bram@vim.org>
parents:
24468
diff
changeset
|
6735 skiprtp exclude 'runtimepath' and 'packpath' from the options |
| 7 | 6736 resize size of the Vim window: 'lines' and 'columns' |
| 6737 sesdir the directory in which the session file is located | |
| 6738 will become the current directory (useful with | |
| 6739 projects accessed over a network from different | |
| 6740 systems) | |
| 6741 slash backslashes in file names replaced with forward | |
| 6742 slashes | |
| 827 | 6743 tabpages all tab pages; without this only the current tab page |
| 6744 is restored, so that you can make a session for each | |
| 6745 tab page separately | |
| 14519 | 6746 terminal include terminal windows where the command can be |
| 6747 restored | |
| 7 | 6748 unix with Unix end-of-line format (single <NL>), even when |
| 6749 on Windows or DOS | |
| 6750 winpos position of the whole Vim window | |
| 6751 winsize window sizes | |
| 6752 | |
| 6753 Don't include both "curdir" and "sesdir". | |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
6754 When neither "curdir" nor "sesdir" is included, file names are stored |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
6755 with absolute paths. |
| 27036 | 6756 If you leave out "options" many things won't work well after restoring |
| 6757 the session. | |
| 7 | 6758 "slash" and "unix" are useful on Windows when sharing session files |
| 6759 with Unix. The Unix version of Vim cannot source dos format scripts, | |
| 6760 but the Windows version of Vim can source unix format scripts. | |
| 6761 | |
| 6762 *'shell'* *'sh'* *E91* | |
| 18928 | 6763 'shell' 'sh' string (default $SHELL or "sh", Win32: "cmd.exe") |
| 7 | 6764 global |
| 6765 Name of the shell to use for ! and :! commands. When changing the | |
| 6766 value also check these options: 'shelltype', 'shellpipe', 'shellslash' | |
| 6767 'shellredir', 'shellquote', 'shellxquote' and 'shellcmdflag'. | |
| 10 | 6768 It is allowed to give an argument to the command, e.g. "csh -f". |
| 7 | 6769 See |option-backslash| about including spaces and backslashes. |
| 6770 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
|
6771 |
| 27537 | 6772 In |restricted-mode| shell commands will not be possible. This mode |
| 6773 is used if the value of $SHELL ends in "false" or "nologin". | |
| 6774 | |
| 18489 | 6775 If the name of the shell contains a space, you need to enclose it in |
| 18594 | 6776 quotes and escape the space. Example with quotes: > |
| 7 | 6777 :set shell=\"c:\program\ files\unix\sh.exe\"\ -f |
| 6778 < Note the backslash before each quote (to avoid starting a comment) and | |
| 10 | 6779 each space (to avoid ending the option value). Also note that the |
| 7 | 6780 "-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
|
6781 name. Vim automagically recognizes the backslashes that are path |
| 7 | 6782 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
|
6783 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
|
6784 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
|
6785 :set shell=/bin/with\\\ space/sh |
| 14519 | 6786 < 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
|
6787 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
|
6788 |
| 7 | 6789 Under MS-Windows, when the executable ends in ".com" it must be |
| 6790 included. Thus setting the shell to "command.com" or "4dos.com" | |
| 6791 works, but "command" and "4dos" do not work for all commands (e.g., | |
| 6792 filtering). | |
| 6793 For unknown reasons, when using "4dos.com" the current directory is | |
| 6794 changed to "C:\". To avoid this set 'shell' like this: > | |
| 6795 :set shell=command.com\ /c\ 4dos | |
| 6796 < This option cannot be set from a |modeline| or in the |sandbox|, for | |
| 6797 security reasons. | |
| 6798 | |
| 6799 *'shellcmdflag'* *'shcf'* | |
| 3356 | 6800 '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
|
6801 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
|
6802 "-Command", or when it does not contain "sh" |
| 18972 | 6803 somewhere: "/c") |
| 7 | 6804 global |
| 6805 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
|
6806 "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
|
6807 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
|
6808 to reduce the need to set this option by the user. |
| 3082 | 6809 On Unix it can have more than one flag. Each white space separated |
| 6810 part is passed as an argument to the shell command. | |
| 6811 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
|
6812 Also see |dos-shell| and |dos-powershell| for MS-Windows. |
| 7 | 6813 This option cannot be set from a |modeline| or in the |sandbox|, for |
| 6814 security reasons. | |
| 6815 | |
| 6816 *'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
|
6817 '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
|
6818 "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
|
6819 "2>&1 | Out-File -Encoding default") |
| 7 | 6820 global |
| 6821 {not available when compiled without the |+quickfix| | |
| 6822 feature} | |
| 6823 String to be used to put the output of the ":make" command in the | |
| 10 | 6824 error file. See also |:make_makeprg|. See |option-backslash| about |
| 7 | 6825 including spaces and backslashes. |
| 6826 The name of the temporary file can be represented by "%s" if necessary | |
| 6827 (the file name is appended automatically if no %s appears in the value | |
| 6828 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
|
6829 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
|
6830 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
|
6831 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
|
6832 to the screen. |
| 22171 | 6833 For Unix the default is "| tee". The stdout of the compiler is saved |
| 7 | 6834 in a file and echoed to the screen. If the 'shell' option is "csh" or |
| 6835 "tcsh" after initializations, the default becomes "|& tee". If the | |
| 18456 | 6836 '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
|
6837 "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
|
6838 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
|
6839 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
|
6840 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
|
6841 becomes ">%s 2>&1" and the output is not echoed to the screen. |
| 7 | 6842 The initialization of this option is done after reading the ".vimrc" |
| 6843 and the other initializations, so that when the 'shell' option is set | |
| 6844 there, the 'shellpipe' option changes automatically, unless it was | |
| 6845 explicitly set before. | |
| 6846 When 'shellpipe' is set to an empty string, no redirection of the | |
| 6847 ":make" output will be done. This is useful if you use a 'makeprg' | |
| 6848 that writes to 'makeef' by itself. If you want no piping, but do | |
| 6849 want to include the 'makeef', set 'shellpipe' to a single space. | |
| 6850 Don't forget to precede the space with a backslash: ":set sp=\ ". | |
| 6851 In the future pipes may be used for filtering and this option will | |
| 6852 become obsolete (at least for Unix). | |
| 6853 This option cannot be set from a |modeline| or in the |sandbox|, for | |
| 6854 security reasons. | |
| 6855 | |
| 6856 *'shellquote'* *'shq'* | |
|
25084
beff72446e2e
patch 8.2.3079: Powershell core not supported by default
Bram Moolenaar <Bram@vim.org>
parents:
25068
diff
changeset
|
6857 'shellquote' 'shq' string (default: "") |
| 7 | 6858 global |
| 6859 Quoting character(s), put around the command passed to the shell, for | |
| 6860 the "!" and ":!" commands. The redirection is kept outside of the | |
| 6861 quoting. See 'shellxquote' to include the redirection. It's | |
| 6862 probably not useful to set both options. | |
| 6863 This is an empty string by default. Only known to be useful for | |
| 18972 | 6864 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
|
6865 Shell or bash, where it should be "\"". See |dos-shell|. |
| 7 | 6866 This option cannot be set from a |modeline| or in the |sandbox|, for |
| 6867 security reasons. | |
| 6868 | |
| 6869 *'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
|
6870 '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
|
6871 "2>&1 | Out-File -Encoding default") |
| 7 | 6872 global |
| 6873 String to be used to put the output of a filter command in a temporary | |
| 6874 file. See also |:!|. See |option-backslash| about including spaces | |
| 6875 and backslashes. | |
| 6876 The name of the temporary file can be represented by "%s" if necessary | |
| 6877 (the file name is appended automatically if no %s appears in the value | |
| 6878 of this option). | |
| 18456 | 6879 The default is ">". For Unix, if the 'shell' option is "csh" or |
| 6880 "tcsh" during initializations, the default becomes ">&". If the | |
| 18719 | 6881 '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
|
6882 "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
|
6883 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
|
6884 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
|
6885 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
|
6886 "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
|
6887 same names with ".exe" appended are checked for. |
| 7 | 6888 The initialization of this option is done after reading the ".vimrc" |
| 6889 and the other initializations, so that when the 'shell' option is set | |
| 6890 there, the 'shellredir' option changes automatically unless it was | |
| 6891 explicitly set before. | |
| 6892 In the future pipes may be used for filtering and this option will | |
| 6893 become obsolete (at least for Unix). | |
| 6894 This option cannot be set from a |modeline| or in the |sandbox|, for | |
| 6895 security reasons. | |
| 6896 | |
| 6897 *'shellslash'* *'ssl'* *'noshellslash'* *'nossl'* | |
| 6898 'shellslash' 'ssl' boolean (default off) | |
| 6899 global | |
|
18912
ccd16426a1f9
patch 8.2.0017: OS/2 and MS-DOS are still mentioned
Bram Moolenaar <Bram@vim.org>
parents:
18879
diff
changeset
|
6900 {only for MS-Windows} |
| 7 | 6901 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
|
6902 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
|
6903 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
|
6904 changed to forward slashes by Vim. |
| 7 | 6905 Note that setting or resetting this option has no effect for some |
| 6906 existing file names, thus this option needs to be set before opening | |
| 6907 any file for best results. This might change in the future. | |
| 6908 'shellslash' only works when a backslash can be used as a path | |
| 6909 separator. To test if this is so use: > | |
| 6910 if exists('+shellslash') | |
|
17543
77c3f6428b6c
patch 8.1.1769: 'shellslash' is also used for completion
Bram Moolenaar <Bram@vim.org>
parents:
17433
diff
changeset
|
6911 < Also see 'completeslash'. |
|
77c3f6428b6c
patch 8.1.1769: 'shellslash' is also used for completion
Bram Moolenaar <Bram@vim.org>
parents:
17433
diff
changeset
|
6912 |
| 168 | 6913 *'shelltemp'* *'stmp'* *'noshelltemp'* *'nostmp'* |
| 6914 'shelltemp' 'stmp' boolean (Vi default off, Vim default on) | |
| 6915 global | |
| 6916 When on, use temp files for shell commands. When off use a pipe. | |
| 6917 When using a pipe is not possible temp files are used anyway. | |
| 2965 | 6918 Currently a pipe is only supported on Unix and MS-Windows 2K and |
| 6919 later. You can check it with: > | |
| 168 | 6920 :if has("filterpipe") |
| 6921 < The advantage of using a pipe is that nobody can read the temp file | |
| 6922 and the 'shell' command does not need to support redirection. | |
| 6923 The advantage of using a temp file is that the file type and encoding | |
| 6924 can be detected. | |
| 6925 The |FilterReadPre|, |FilterReadPost| and |FilterWritePre|, | |
| 6926 |FilterWritePost| autocommands event are not triggered when | |
| 6927 'shelltemp' is off. | |
|
9533
9f921133ee90
commit https://github.com/vim/vim/commit/269f595f9eef584937e7eae70fde68cdd7da5bcf
Christian Brabandt <cb@256bit.org>
parents:
9464
diff
changeset
|
6928 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
|
6929 temp files. |
| 11160 | 6930 NOTE: This option is set to the Vim default value when 'compatible' |
| 6931 is reset. | |
| 168 | 6932 |
| 7 | 6933 *'shelltype'* *'st'* |
| 6934 'shelltype' 'st' number (default 0) | |
| 6935 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
|
6936 {only for the Amiga} |
| 7 | 6937 On the Amiga this option influences the way how the commands work |
| 6938 which use a shell. | |
| 6939 0 and 1: always use the shell | |
| 6940 2 and 3: use the shell only to filter lines | |
| 6941 4 and 5: use shell only for ':sh' command | |
| 6942 When not using the shell, the command is executed directly. | |
| 6943 | |
| 6944 0 and 2: use "shell 'shellcmdflag' cmd" to start external commands | |
| 6945 1 and 3: use "shell cmd" to start external commands | |
| 6946 | |
| 3371 | 6947 *'shellxescape'* *'sxe'* |
| 6948 'shellxescape' 'sxe' string (default: ""; | |
| 18972 | 6949 for MS-Windows: "\"&|<>()@^") |
| 3371 | 6950 global |
| 6951 When 'shellxquote' is set to "(" then the characters listed in this | |
| 6952 option will be escaped with a '^' character. This makes it possible | |
| 6953 to execute most external commands with cmd.exe. | |
| 6954 | |
| 7 | 6955 *'shellxquote'* *'sxq'* |
| 6956 'shellxquote' 'sxq' string (default: ""; | |
| 3359 | 6957 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
|
6958 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
|
6959 powershell.exe: "\"" |
| 3359 | 6960 for Win32, when 'shell' contains "sh" |
| 6961 somewhere: "\"" | |
| 7 | 6962 for Unix, when using system(): "\"") |
| 6963 global | |
| 6964 Quoting character(s), put around the command passed to the shell, for | |
| 6965 the "!" and ":!" commands. Includes the redirection. See | |
| 6966 'shellquote' to exclude the redirection. It's probably not useful | |
| 6967 to set both options. | |
| 3359 | 6968 When the value is '(' then ')' is appended. When the value is '"(' |
| 6969 then ')"' is appended. | |
| 6970 When the value is '(' then also see 'shellxescape'. | |
| 3352 | 6971 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
|
6972 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
|
6973 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
|
6974 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
|
6975 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
|
6976 '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
|
6977 |dos-shell|. |
| 7 | 6978 This option cannot be set from a |modeline| or in the |sandbox|, for |
| 6979 security reasons. | |
| 6980 | |
| 6981 *'shiftround'* *'sr'* *'noshiftround'* *'nosr'* | |
| 6982 'shiftround' 'sr' boolean (default off) | |
| 6983 global | |
| 6984 Round indent to multiple of 'shiftwidth'. Applies to > and < | |
| 6985 commands. CTRL-T and CTRL-D in Insert mode always round the indent to | |
| 6986 a multiple of 'shiftwidth' (this is Vi compatible). | |
| 6987 NOTE: This option is reset when 'compatible' is set. | |
| 6988 | |
| 6989 *'shiftwidth'* *'sw'* | |
| 6990 'shiftwidth' 'sw' number (default 8) | |
| 6991 local to buffer | |
| 10 | 6992 Number of spaces to use for each step of (auto)indent. Used for |
| 7 | 6993 |'cindent'|, |>>|, |<<|, etc. |
| 3893 | 6994 When zero the 'ts' value will be used. Use the |shiftwidth()| |
| 6995 function to get the effective shiftwidth value. | |
| 7 | 6996 |
| 6997 *'shortmess'* *'shm'* | |
|
16533
5e25171e0e75
patch 8.1.1270: cannot see current match position
Bram Moolenaar <Bram@vim.org>
parents:
16447
diff
changeset
|
6998 '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
|
6999 POSIX default: "AS") |
| 7 | 7000 global |
| 7001 This option helps to avoid all the |hit-enter| prompts caused by file | |
| 7002 messages, for example with CTRL-G, and to avoid some other messages. | |
| 7003 It is a list of flags: | |
| 7004 flag meaning when present ~ | |
| 7005 f use "(3 of 5)" instead of "(file 3 of 5)" | |
| 7006 i use "[noeol]" instead of "[Incomplete last line]" | |
|
21154
9f9c26b3ddc5
patch 8.2.1128: the write message mentions characters, but it's bytes
Bram Moolenaar <Bram@vim.org>
parents:
21112
diff
changeset
|
7007 l use "999L, 888B" instead of "999 lines, 888 bytes" |
| 7 | 7008 m use "[+]" instead of "[Modified]" |
| 7009 n use "[New]" instead of "[New File]" | |
| 7010 r use "[RO]" instead of "[readonly]" | |
| 7011 w use "[w]" instead of "written" for file write message | |
| 7012 and "[a]" instead of "appended" for ':w >> file' command | |
| 7013 x use "[dos]" instead of "[dos format]", "[unix]" instead of | |
| 7014 "[unix format]" and "[mac]" instead of "[mac format]". | |
| 7015 a all of the above abbreviations | |
| 7016 | |
| 7017 o overwrite message for writing a file with subsequent message | |
| 7018 for reading a file (useful for ":wn" or when 'autowrite' on) | |
| 7019 O message for reading a file overwrites any previous message. | |
| 7020 Also for quickfix message (e.g., ":cn"). | |
| 7021 s don't give "search hit BOTTOM, continuing at TOP" or "search | |
| 16610 | 7022 hit TOP, continuing at BOTTOM" messages; when using the search |
| 7023 count do not show "W" after the count message (see S below) | |
| 7 | 7024 t truncate file message at the start if it is too long to fit |
| 7025 on the command-line, "<" will appear in the left most column. | |
| 7026 Ignored in Ex mode. | |
| 7027 T truncate other messages in the middle if they are too long to | |
| 233 | 7028 fit on the command line. "..." will appear in the middle. |
| 7 | 7029 Ignored in Ex mode. |
| 7030 W don't give "written" or "[w]" when writing a file | |
| 7031 A don't give the "ATTENTION" message when an existing swap file | |
| 7032 is found. | |
| 7033 I don't give the intro message when starting Vim |:intro|. | |
| 5946 | 7034 c don't give |ins-completion-menu| messages. For example, |
| 7035 "-- XXX completion (YYY)", "match 1 of 2", "The only match", | |
| 7036 "Pattern not found", "Back at original", etc. | |
|
8560
f3c636c673f7
commit https://github.com/vim/vim/commit/426dd0219512af5f4abeb0901b533159253ffba3
Christian Brabandt <cb@256bit.org>
parents:
8497
diff
changeset
|
7037 q use "recording" instead of "recording @a" |
|
f3c636c673f7
commit https://github.com/vim/vim/commit/426dd0219512af5f4abeb0901b533159253ffba3
Christian Brabandt <cb@256bit.org>
parents:
8497
diff
changeset
|
7038 F don't give the file info when editing a file, like `:silent` |
|
16728
e55c26aaf484
patch 8.1.1366: using expressions in a modeline is unsafe
Bram Moolenaar <Bram@vim.org>
parents:
16610
diff
changeset
|
7039 was used for the command; note that this also affects messages |
|
e55c26aaf484
patch 8.1.1366: using expressions in a modeline is unsafe
Bram Moolenaar <Bram@vim.org>
parents:
16610
diff
changeset
|
7040 from autocommands |
|
16533
5e25171e0e75
patch 8.1.1270: cannot see current match position
Bram Moolenaar <Bram@vim.org>
parents:
16447
diff
changeset
|
7041 S do not show search count message when searching, e.g. |
|
5e25171e0e75
patch 8.1.1270: cannot see current match position
Bram Moolenaar <Bram@vim.org>
parents:
16447
diff
changeset
|
7042 "[1/5]" |
| 7 | 7043 |
| 7044 This gives you the opportunity to avoid that a change between buffers | |
| 7045 requires you to hit <Enter>, but still gives as useful a message as | |
| 7046 possible for the space available. To get the whole message that you | |
| 7047 would have got with 'shm' empty, use ":file!" | |
| 7048 Useful values: | |
| 7049 shm= No abbreviation of message. | |
| 7050 shm=a Abbreviation, but no loss of information. | |
| 7051 shm=at Abbreviation, and truncate message when necessary. | |
| 7052 | |
| 7053 NOTE: This option is set to the Vi default value when 'compatible' is | |
| 7054 set and to the Vim default value when 'compatible' is reset. | |
| 7055 | |
| 7056 *'shortname'* *'sn'* *'noshortname'* *'nosn'* | |
| 7057 'shortname' 'sn' boolean (default off) | |
| 7058 local to buffer | |
| 7059 Filenames are assumed to be 8 characters plus one extension of 3 | |
| 7060 characters. Multiple dots in file names are not allowed. When this | |
| 7061 option is on, dots in file names are replaced with underscores when | |
| 18972 | 7062 adding an extension (".~" or ".swp"). This option is useful |
| 7 | 7063 when editing files on an MS-DOS compatible filesystem, e.g., messydos |
| 19163 | 7064 or crossdos. |
| 7 | 7065 |
| 7066 *'showbreak'* *'sbr'* *E595* | |
| 7067 '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
|
7068 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
|
7069 {not available when compiled without the |+linebreak| |
| 7 | 7070 feature} |
| 7071 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
|
7072 values are "> " or "+++ ": > |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
7073 :set showbreak=>\ |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
7074 < 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
|
7075 this: > |
|
2314
233eb4412f5d
Added 'colorcolumn' option. Partly by Gregor Uhlenheuer.
Bram Moolenaar <bram@vim.org>
parents:
2302
diff
changeset
|
7076 :let &showbreak = '+++ ' |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
7077 < Only printable single-cell characters are allowed, excluding <Tab> and |
| 7 | 7078 comma (in a future version the comma might be used to separate the |
| 7079 part that is shown at the end and at the start of a line). | |
| 7080 The characters are highlighted according to the '@' flag in | |
| 7081 'highlight'. | |
| 7082 Note that tabs after the showbreak will be displayed differently. | |
| 7083 If you want the 'showbreak' to appear in between line numbers, add the | |
| 7084 "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
|
7085 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
|
7086 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
|
7087 :setlocal showbreak=NONE |
|
8b0114ffde2b
patch 8.1.2281: 'showbreak' cannot be set for one window
Bram Moolenaar <Bram@vim.org>
parents:
18526
diff
changeset
|
7088 < |
| 7 | 7089 *'showcmd'* *'sc'* *'noshowcmd'* *'nosc'* |
|
9669
284b4eb307fc
commit https://github.com/vim/vim/commit/8c08b5b569e2a9e9f63dea514591ecfa2d3bb392
Christian Brabandt <cb@256bit.org>
parents:
9665
diff
changeset
|
7090 '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
|
7091 Vi default: off, set in |defaults.vim|) |
| 7 | 7092 global |
| 7093 {not available when compiled without the | |
| 7094 |+cmdline_info| feature} | |
| 1152 | 7095 Show (partial) command in the last line of the screen. Set this |
| 7096 option off if your terminal is slow. | |
| 7 | 7097 In Visual mode the size of the selected area is shown: |
| 7098 - 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
|
7099 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
|
7100 means two characters and six bytes. |
| 7 | 7101 - When selecting more than one line, the number of lines. |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
7102 - When selecting a block, the size in screen characters: |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
7103 {lines}x{columns}. |
| 7 | 7104 NOTE: This option is set to the Vi default value when 'compatible' is |
| 7105 set and to the Vim default value when 'compatible' is reset. | |
| 7106 | |
| 7107 *'showfulltag'* *'sft'* *'noshowfulltag'* *'nosft'* | |
| 7108 'showfulltag' 'sft' boolean (default off) | |
| 7109 global | |
| 7110 When completing a word in insert mode (see |ins-completion|) from the | |
| 7111 tags file, show both the tag name and a tidied-up form of the search | |
| 10 | 7112 pattern (if there is one) as possible matches. Thus, if you have |
| 7 | 7113 matched a C function, you can see a template for what arguments are |
| 7114 required (coding style permitting). | |
| 1621 | 7115 Note that this doesn't work well together with having "longest" in |
| 7116 'completeopt', because the completion from the search pattern may not | |
| 7117 match the typed text. | |
| 7 | 7118 |
| 7119 *'showmatch'* *'sm'* *'noshowmatch'* *'nosm'* | |
| 7120 'showmatch' 'sm' boolean (default off) | |
| 7121 global | |
| 7122 When a bracket is inserted, briefly jump to the matching one. The | |
| 7123 jump is only done if the match can be seen on the screen. The time to | |
| 7124 show the match can be set with 'matchtime'. | |
| 7125 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
|
7126 seen or not). |
|
c590de398af9
commit https://github.com/vim/vim/commit/ca63501fbcd1cf9c8aa9ff12c093c95b62a89ed7
Christian Brabandt <cb@256bit.org>
parents:
7080
diff
changeset
|
7127 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
|
7128 reset. |
| 7 | 7129 When the 'm' flag is not included in 'cpoptions', typing a character |
| 7130 will immediately move the cursor back to where it belongs. | |
| 7131 See the "sm" field in 'guicursor' for setting the cursor shape and | |
| 7132 blinking when showing the match. | |
| 7133 The 'matchpairs' option can be used to specify the characters to show | |
| 7134 matches for. 'rightleft' and 'revins' are used to look for opposite | |
| 7135 matches. | |
| 699 | 7136 Also see the matchparen plugin for highlighting the match when moving |
| 7137 around |pi_paren.txt|. | |
| 7138 Note: Use of the short form is rated PG. | |
| 7 | 7139 |
| 7140 *'showmode'* *'smd'* *'noshowmode'* *'nosmd'* | |
| 7141 'showmode' 'smd' boolean (Vim default: on, Vi default: off) | |
| 7142 global | |
| 7143 If in Insert, Replace or Visual mode put a message on the last line. | |
| 7144 Use the 'M' flag in 'highlight' to set the type of highlighting for | |
| 7145 this message. | |
| 10 | 7146 When |XIM| may be used the message will include "XIM". But this |
| 7 | 7147 doesn't mean XIM is really active, especially when 'imactivatekey' is |
| 7148 not set. | |
| 7149 NOTE: This option is set to the Vi default value when 'compatible' is | |
| 7150 set and to the Vim default value when 'compatible' is reset. | |
| 7151 | |
| 677 | 7152 *'showtabline'* *'stal'* |
| 7153 'showtabline' 'stal' number (default 1) | |
| 7154 global | |
| 7155 The value of this option specifies when the line with tab page labels | |
| 7156 will be displayed: | |
| 7157 0: never | |
| 7158 1: only if there are at least two tab pages | |
| 7159 2: always | |
| 7160 This is both for the GUI and non-GUI implementation of the tab pages | |
| 7161 line. | |
| 7162 See |tab-page| for more information about tab pages. | |
| 7163 | |
| 7 | 7164 *'sidescroll'* *'ss'* |
| 7165 'sidescroll' 'ss' number (default 0) | |
| 7166 global | |
| 7167 The minimal number of columns to scroll horizontally. Used only when | |
| 7168 the 'wrap' option is off and the cursor is moved off of the screen. | |
| 7169 When it is zero the cursor will be put in the middle of the screen. | |
| 7170 When using a slow terminal set it to a large number or 0. When using | |
| 7171 a fast terminal use a small number or 1. Not used for "zh" and "zl" | |
| 7172 commands. | |
| 7173 | |
| 7174 *'sidescrolloff'* *'siso'* | |
| 7175 '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
|
7176 global or local to window |global-local| |
| 7 | 7177 The minimal number of screen columns to keep to the left and to the |
| 534 | 7178 right of the cursor if 'nowrap' is set. Setting this option to a |
| 7179 value greater than 0 while having |'sidescroll'| also at a non-zero | |
| 7180 value makes some context visible in the line you are scrolling in | |
| 7181 horizontally (except at beginning of the line). Setting this option | |
| 7182 to a large value (like 999) has the effect of keeping the cursor | |
| 7183 horizontally centered in the window, as long as one does not come too | |
| 7184 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
|
7185 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
|
7186 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
|
7187 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
|
7188 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
|
7189 < NOTE: This option is set to 0 when 'compatible' is set. |
| 7 | 7190 |
| 7191 Example: Try this together with 'sidescroll' and 'listchars' as | |
| 7192 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
|
7193 onto the "extends" character: > |
| 7 | 7194 |
| 7195 :set nowrap sidescroll=1 listchars=extends:>,precedes:< | |
| 7196 :set sidescrolloff=1 | |
|
9852
4eea48b76d03
commit https://github.com/vim/vim/commit/95ec9d6a6ab3117d60ff638670a803d43974ba51
Christian Brabandt <cb@256bit.org>
parents:
9737
diff
changeset
|
7197 < |
|
4eea48b76d03
commit https://github.com/vim/vim/commit/95ec9d6a6ab3117d60ff638670a803d43974ba51
Christian Brabandt <cb@256bit.org>
parents:
9737
diff
changeset
|
7198 *'signcolumn'* *'scl'* |
|
4eea48b76d03
commit https://github.com/vim/vim/commit/95ec9d6a6ab3117d60ff638670a803d43974ba51
Christian Brabandt <cb@256bit.org>
parents:
9737
diff
changeset
|
7199 'signcolumn' 'scl' string (default "auto") |
|
4eea48b76d03
commit https://github.com/vim/vim/commit/95ec9d6a6ab3117d60ff638670a803d43974ba51
Christian Brabandt <cb@256bit.org>
parents:
9737
diff
changeset
|
7200 local to window |
|
4eea48b76d03
commit https://github.com/vim/vim/commit/95ec9d6a6ab3117d60ff638670a803d43974ba51
Christian Brabandt <cb@256bit.org>
parents:
9737
diff
changeset
|
7201 {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
|
7202 feature} |
|
9860
9eaf8ef656e9
commit https://github.com/vim/vim/commit/0952131376a517fc12dc5ae908a97018b4ee23f0
Christian Brabandt <cb@256bit.org>
parents:
9852
diff
changeset
|
7203 Whether or not to draw the signcolumn. Valid values are: |
|
9eaf8ef656e9
commit https://github.com/vim/vim/commit/0952131376a517fc12dc5ae908a97018b4ee23f0
Christian Brabandt <cb@256bit.org>
parents:
9852
diff
changeset
|
7204 "auto" only when there is a sign to display |
|
9eaf8ef656e9
commit https://github.com/vim/vim/commit/0952131376a517fc12dc5ae908a97018b4ee23f0
Christian Brabandt <cb@256bit.org>
parents:
9852
diff
changeset
|
7205 "no" never |
|
9eaf8ef656e9
commit https://github.com/vim/vim/commit/0952131376a517fc12dc5ae908a97018b4ee23f0
Christian Brabandt <cb@256bit.org>
parents:
9852
diff
changeset
|
7206 "yes" always |
|
17129
4fb68abc770f
patch 8.1.1564: sign column takes up space
Bram Moolenaar <Bram@vim.org>
parents:
16808
diff
changeset
|
7207 "number" display signs in the 'number' column. If the number |
| 17161 | 7208 column is not present, then behaves like "auto". |
| 7 | 7209 |
| 7210 | |
| 7211 *'smartcase'* *'scs'* *'nosmartcase'* *'noscs'* | |
| 7212 'smartcase' 'scs' boolean (default off) | |
| 7213 global | |
| 7214 Override the 'ignorecase' option if the search pattern contains upper | |
| 7215 case characters. Only used when the search pattern is typed and | |
| 7216 'ignorecase' option is on. Used for the commands "/", "?", "n", "N", | |
| 3557 | 7217 ":g" and ":s". Not used for "*", "#", "gd", tag search, etc. After |
| 7 | 7218 "*" and "#" you can make 'smartcase' used by doing a "/" command, |
| 7219 recalling the search pattern from history and hitting <Enter>. | |
| 7220 NOTE: This option is reset when 'compatible' is set. | |
| 7221 | |
| 7222 *'smartindent'* *'si'* *'nosmartindent'* *'nosi'* | |
| 7223 'smartindent' 'si' boolean (default off) | |
| 7224 local to buffer | |
| 7225 {not available when compiled without the | |
| 7226 |+smartindent| feature} | |
| 7227 Do smart autoindenting when starting a new line. Works for C-like | |
| 7228 programs, but can also be used for other languages. 'cindent' does | |
| 7229 something like this, works better in most cases, but is more strict, | |
| 2662 | 7230 see |C-indenting|. When 'cindent' is on or 'indentexpr' is set, |
| 2642 | 7231 setting 'si' has no effect. 'indentexpr' is a more advanced |
| 7232 alternative. | |
| 7 | 7233 Normally 'autoindent' should also be on when using 'smartindent'. |
| 7234 An indent is automatically inserted: | |
| 7235 - After a line ending in '{'. | |
| 7236 - After a line starting with a keyword from 'cinwords'. | |
| 7237 - Before a line starting with '}' (only with the "O" command). | |
| 7238 When typing '}' as the first character in a new line, that line is | |
| 7239 given the same indent as the matching '{'. | |
| 7240 When typing '#' as the first character in a new line, the indent for | |
| 7241 that line is removed, the '#' is put in the first column. The indent | |
| 10 | 7242 is restored for the next line. If you don't want this, use this |
| 7 | 7243 mapping: ":inoremap # X^H#", where ^H is entered with CTRL-V CTRL-H. |
| 7244 When using the ">>" command, lines starting with '#' are not shifted | |
| 7245 right. | |
| 11160 | 7246 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
|
7247 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
|
7248 reset. |
| 7 | 7249 |
| 7250 *'smarttab'* *'sta'* *'nosmarttab'* *'nosta'* | |
| 7251 'smarttab' 'sta' boolean (default off) | |
| 7252 global | |
| 7253 When on, a <Tab> in front of a line inserts blanks according to | |
| 648 | 7254 'shiftwidth'. 'tabstop' or 'softtabstop' is used in other places. A |
| 7255 <BS> will delete a 'shiftwidth' worth of space at the start of the | |
| 7256 line. | |
| 650 | 7257 When off, a <Tab> always inserts blanks according to 'tabstop' or |
| 648 | 7258 'softtabstop'. 'shiftwidth' is only used for shifting text left or |
| 7259 right |shift-left-right|. | |
| 1263 | 7260 What gets inserted (a <Tab> or spaces) depends on the 'expandtab' |
| 7 | 7261 option. Also see |ins-expandtab|. When 'expandtab' is not set, the |
| 11 | 7262 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
|
7263 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
|
7264 reset. |
| 7 | 7265 NOTE: This option is reset when 'compatible' is set. |
| 7266 | |
| 7267 *'softtabstop'* *'sts'* | |
| 7268 'softtabstop' 'sts' number (default 0) | |
| 7269 local to buffer | |
| 7270 Number of spaces that a <Tab> counts for while performing editing | |
| 7271 operations, like inserting a <Tab> or using <BS>. It "feels" like | |
| 7272 <Tab>s are being inserted, while in fact a mix of spaces and <Tab>s is | |
| 7273 used. This is useful to keep the 'ts' setting at its standard value | |
| 7274 of 8, while being able to edit like it is set to 'sts'. However, | |
| 7275 commands like "x" still work on the actual characters. | |
| 7276 When 'sts' is zero, this feature is off. | |
| 3893 | 7277 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
|
7278 '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
|
7279 when 'paste' is reset. |
| 7 | 7280 See also |ins-expandtab|. When 'expandtab' is not set, the number of |
| 7281 spaces is minimized by using <Tab>s. | |
| 7282 The 'L' flag in 'cpoptions' changes how tabs are used when 'list' is | |
| 7283 set. | |
| 7284 NOTE: This option is set to 0 when 'compatible' is set. | |
| 7285 | |
|
14175
2ad722003b36
patch 8.1.0105: all tab stops are the same
Christian Brabandt <cb@256bit.org>
parents:
14019
diff
changeset
|
7286 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
|
7287 '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
|
7288 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
|
7289 |
| 221 | 7290 *'spell'* *'nospell'* |
| 7291 'spell' boolean (default off) | |
| 7292 local to window | |
| 7293 {not available when compiled without the |+syntax| | |
| 7294 feature} | |
| 7295 When on spell checking will be done. See |spell|. | |
| 236 | 7296 The languages are specified with 'spelllang'. |
| 221 | 7297 |
| 386 | 7298 *'spellcapcheck'* *'spc'* |
| 389 | 7299 'spellcapcheck' 'spc' string (default "[.?!]\_[\])'" \t]\+") |
| 386 | 7300 local to buffer |
| 7301 {not available when compiled without the |+syntax| | |
| 7302 feature} | |
| 7303 Pattern to locate the end of a sentence. The following word will be | |
| 7304 checked to start with a capital letter. If not then it is highlighted | |
| 484 | 7305 with SpellCap |hl-SpellCap| (unless the word is also badly spelled). |
| 386 | 7306 When this check is not wanted make this option empty. |
| 7307 Only used when 'spell' is set. | |
| 389 | 7308 Be careful with special characters, see |option-backslash| about |
| 7309 including spaces and backslashes. | |
| 480 | 7310 To set this option automatically depending on the language, see |
| 7311 |set-spc-auto|. | |
| 386 | 7312 |
| 314 | 7313 *'spellfile'* *'spf'* |
| 7314 'spellfile' 'spf' string (default empty) | |
| 7315 local to buffer | |
| 7316 {not available when compiled without the |+syntax| | |
| 7317 feature} | |
| 7318 Name of the word list file where words are added for the |zg| and |zw| | |
| 401 | 7319 commands. It must end in ".{encoding}.add". You need to include the |
| 7320 path, otherwise the file is placed in the current directory. | |
| 386 | 7321 *E765* |
| 28379 | 7322 It may also be a comma-separated list of names. A count before the |
| 386 | 7323 |zg| and |zw| commands can be used to access each. This allows using |
| 7324 a personal word list file and a project word list file. | |
| 314 | 7325 When a word is added while this option is empty Vim will set it for |
| 819 | 7326 you: Using the first directory in 'runtimepath' that is writable. If |
| 7327 there is no "spell" directory yet it will be created. For the file | |
| 7328 name the first language name that appears in 'spelllang' is used, | |
| 353 | 7329 ignoring the region. |
| 7330 The resulting ".spl" file will be used for spell checking, it does not | |
| 7331 have to appear in 'spelllang'. | |
| 7332 Normally one file is used for all regions, but you can add the region | |
| 7333 name if you want to. However, it will then only be used when | |
| 7334 'spellfile' is set to it, for entries in 'spelllang' only files | |
| 7335 without region name will be found. | |
| 336 | 7336 This option cannot be set from a |modeline| or in the |sandbox|, for |
| 7337 security reasons. | |
| 314 | 7338 |
| 221 | 7339 *'spelllang'* *'spl'* |
| 314 | 7340 'spelllang' 'spl' string (default "en") |
| 221 | 7341 local to buffer |
| 7342 {not available when compiled without the |+syntax| | |
| 7343 feature} | |
| 28379 | 7344 A comma-separated list of word list names. When the 'spell' option is |
| 353 | 7345 on spellchecking will be done for these languages. Example: > |
| 7346 set spelllang=en_us,nl,medical | |
| 7347 < This means US English, Dutch and medical words are recognized. Words | |
| 7348 that are not recognized will be highlighted. | |
| 16380 | 7349 The word list name must consist of alphanumeric characters, a dash or |
| 7350 an underscore. It should not include a comma or dot. Using a dash is | |
| 353 | 7351 recommended to separate the two letter language name from a |
| 7352 specification. Thus "en-rare" is used for rare English words. | |
| 7353 A region name must come last and have the form "_xx", where "xx" is | |
| 7354 the two-letter, lower case region name. You can use more than one | |
| 7355 region by listing them: "en_us,en_ca" supports both US and Canadian | |
| 7356 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
|
7357 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
|
7358 en_ca, en_gb and en_us). |
| 5477 | 7359 If the name "cjk" is included East Asian characters are excluded from |
| 7360 spell checking. This is useful when editing text that also has Asian | |
| 7361 words. | |
| 25773 | 7362 Note that the "medical" dictionary does not exist, it is just an |
| 7363 example of a longer name. | |
| 484 | 7364 *E757* |
| 419 | 7365 As a special case the name of a .spl file can be given as-is. The |
| 7366 first "_xx" in the name is removed and used as the region name | |
| 7367 (_xx is an underscore, two letters and followed by a non-letter). | |
| 7368 This is mainly for testing purposes. You must make sure the correct | |
| 7369 encoding is used, Vim doesn't check it. | |
| 236 | 7370 When 'encoding' is set the word lists are reloaded. Thus it's a good |
| 419 | 7371 idea to set 'spelllang' after setting 'encoding' to avoid loading the |
| 7372 files twice. | |
| 353 | 7373 How the related spell files are found is explained here: |spell-load|. |
| 221 | 7374 |
| 653 | 7375 If the |spellfile.vim| plugin is active and you use a language name |
| 7376 for which Vim cannot find the .spl file in 'runtimepath' the plugin | |
| 7377 will ask you if you want to download the file. | |
| 7378 | |
| 480 | 7379 After this option has been set successfully, Vim will source the files |
| 7380 "spell/LANG.vim" in 'runtimepath'. "LANG" is the value of 'spelllang' | |
| 15068 | 7381 up to the first character that is not an ASCII letter or number and |
| 7382 not a dash. Also see |set-spc-auto|. | |
| 480 | 7383 |
|
20802
ed00f0fbdaef
patch 8.2.0953: spell checking doesn't work for CamelCased words
Bram Moolenaar <Bram@vim.org>
parents:
20758
diff
changeset
|
7384 *'spelloptions'* *'spo'* |
|
ed00f0fbdaef
patch 8.2.0953: spell checking doesn't work for CamelCased words
Bram Moolenaar <Bram@vim.org>
parents:
20758
diff
changeset
|
7385 '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
|
7386 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
|
7387 {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
|
7388 feature} |
| 28379 | 7389 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
|
7390 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
|
7391 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
|
7392 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
|
7393 start of a new word. |
| 480 | 7394 |
| 344 | 7395 *'spellsuggest'* *'sps'* |
| 7396 'spellsuggest' 'sps' string (default "best") | |
| 7397 global | |
| 7398 {not available when compiled without the |+syntax| | |
| 7399 feature} | |
| 593 | 7400 Methods used for spelling suggestions. Both for the |z=| command and |
| 374 | 7401 the |spellsuggest()| function. This is a comma-separated list of |
| 7402 items: | |
| 7403 | |
| 7404 best Internal method that works best for English. Finds | |
| 7405 changes like "fast" and uses a bit of sound-a-like | |
| 7406 scoring to improve the ordering. | |
| 7407 | |
| 7408 double Internal method that uses two methods and mixes the | |
| 7409 results. The first method is "fast", the other method | |
| 344 | 7410 computes how much the suggestion sounds like the bad |
| 374 | 7411 word. That only works when the language specifies |
| 7412 sound folding. Can be slow and doesn't always give | |
| 7413 better results. | |
| 7414 | |
| 7415 fast Internal method that only checks for simple changes: | |
| 7416 character inserts/deletes/swaps. Works well for | |
| 7417 simple typing mistakes. | |
| 7418 | |
| 593 | 7419 {number} The maximum number of suggestions listed for |z=|. |
| 484 | 7420 Not used for |spellsuggest()|. The number of |
| 7421 suggestions is never more than the value of 'lines' | |
| 7422 minus two. | |
| 7423 | |
|
27441
674240fcf6de
patch 8.2.4249: the timeout limit for spell suggestions is always 5000
Bram Moolenaar <Bram@vim.org>
parents:
27321
diff
changeset
|
7424 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
|
7425 {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
|
7426 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
|
7427 negative there is no limit. {only works when built |
|
674240fcf6de
patch 8.2.4249: the timeout limit for spell suggestions is always 5000
Bram Moolenaar <Bram@vim.org>
parents:
27321
diff
changeset
|
7428 with the +reltime feature} |
|
674240fcf6de
patch 8.2.4249: the timeout limit for spell suggestions is always 5000
Bram Moolenaar <Bram@vim.org>
parents:
27321
diff
changeset
|
7429 |
| 374 | 7430 file:{filename} Read file {filename}, which must have two columns, |
| 7431 separated by a slash. The first column contains the | |
| 7432 bad word, the second column the suggested good word. | |
| 7433 Example: | |
| 7434 theribal/terrible ~ | |
| 7435 Use this for common mistakes that do not appear at the | |
| 7436 top of the suggestion list with the internal methods. | |
| 7437 Lines without a slash are ignored, use this for | |
| 7438 comments. | |
| 5862 | 7439 The word in the second column must be correct, |
| 7440 otherwise it will not be used. Add the word to an | |
| 7441 ".add" file if it is currently flagged as a spelling | |
| 7442 mistake. | |
| 374 | 7443 The file is used for all languages. |
| 7444 | |
| 7445 expr:{expr} Evaluate expression {expr}. Use a function to avoid | |
| 7446 trouble with spaces. |v:val| holds the badly spelled | |
| 7447 word. The expression must evaluate to a List of | |
| 7448 Lists, each with a suggestion and a score. | |
| 7449 Example: | |
| 11062 | 7450 [['the', 33], ['that', 44]] ~ |
| 593 | 7451 Set 'verbose' and use |z=| to see the scores that the |
| 374 | 7452 internal methods use. A lower score is better. |
| 7453 This may invoke |spellsuggest()| if you temporarily | |
| 7454 set 'spellsuggest' to exclude the "expr:" part. | |
| 7455 Errors are silently ignored, unless you set the | |
| 7456 'verbose' option to a non-zero value. | |
| 7457 | |
| 7458 Only one of "best", "double" or "fast" may be used. The others may | |
| 7459 appear several times in any order. Example: > | |
| 7460 :set sps=file:~/.vim/sugg,best,expr:MySuggest() | |
| 7461 < | |
| 7462 This option cannot be set from a |modeline| or in the |sandbox|, for | |
| 7463 security reasons. | |
| 344 | 7464 |
| 7465 | |
| 7 | 7466 *'splitbelow'* *'sb'* *'nosplitbelow'* *'nosb'* |
| 7467 'splitbelow' 'sb' boolean (default off) | |
| 7468 global | |
| 7469 When on, splitting a window will put the new window below the current | |
| 7470 one. |:split| | |
| 7471 | |
| 7472 *'splitright'* *'spr'* *'nosplitright'* *'nospr'* | |
| 7473 'splitright' 'spr' boolean (default off) | |
| 7474 global | |
| 7475 When on, splitting a window will put the new window right of the | |
| 7476 current one. |:vsplit| | |
| 7477 | |
| 7478 *'startofline'* *'sol'* *'nostartofline'* *'nosol'* | |
| 7479 'startofline' 'sol' boolean (default on) | |
| 7480 global | |
| 7481 When "on" the commands listed below move the cursor to the first | |
| 11 | 7482 non-blank of the line. When off the cursor is kept in the same column |
| 10 | 7483 (if possible). This applies to the commands: CTRL-D, CTRL-U, CTRL-B, |
| 11 | 7484 CTRL-F, "G", "H", "M", "L", gg, and to the commands "d", "<<" and ">>" |
| 7 | 7485 with a linewise operator, with "%" with a count and to buffer changing |
| 7486 commands (CTRL-^, :bnext, :bNext, etc.). Also for an Ex command that | |
| 7487 only has a line number, e.g., ":25" or ":+". | |
| 7488 In case of buffer changing commands the cursor is placed at the column | |
| 7489 where it was the last time the buffer was edited. | |
| 7490 NOTE: This option is set when 'compatible' is set. | |
| 7491 | |
| 2709 | 7492 *'statusline'* *'stl'* *E540* *E542* |
| 7 | 7493 'statusline' 'stl' string (default empty) |
| 40 | 7494 global or local to window |global-local| |
| 7 | 7495 {not available when compiled without the |+statusline| |
| 7496 feature} | |
| 27804 | 7497 When non-empty, this option determines the content of the status line. |
| 7 | 7498 Also see |status-line|. |
| 7499 | |
| 7500 The option consists of printf style '%' items interspersed with | |
| 7501 normal text. Each status line item is of the form: | |
| 7502 %-0{minwid}.{maxwid}{item} | |
|
7876
93f747af7b58
commit https://github.com/vim/vim/commit/5e9b2fa9bb0e6061cf18457c173cd141a5dc9c92
Christian Brabandt <cb@256bit.org>
parents:
7687
diff
changeset
|
7503 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
|
7504 be given as "%%". |
| 7 | 7505 |
| 680 | 7506 When the option starts with "%!" then it is used as an expression, |
| 7507 evaluated and the result is used as the option value. Example: > | |
| 7508 :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
|
7509 < 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
|
7510 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
|
7511 The result can contain %{} items that will be evaluated too. |
| 3445 | 7512 Note that the "%!" expression is evaluated in the context of the |
| 7513 current window and buffer, while %{} items are evaluated in the | |
| 7514 context of the window that the statusline belongs to. | |
| 680 | 7515 |
| 7516 When there is error while evaluating the option then it will be made | |
| 7517 empty to avoid further errors. Otherwise screen updating would loop. | |
| 7518 | |
| 7 | 7519 Note that the only effect of 'ruler' when this option is set (and |
| 7520 'laststatus' is 2) is controlling the output of |CTRL-G|. | |
| 7521 | |
| 7522 field meaning ~ | |
| 233 | 7523 - Left justify the item. The default is right justified |
| 7 | 7524 when minwid is larger than the length of the item. |
| 233 | 7525 0 Leading zeroes in numeric items. Overridden by '-'. |
| 7 | 7526 minwid Minimum width of the item, padding as set by '-' & '0'. |
| 7527 Value must be 50 or less. | |
| 10 | 7528 maxwid Maximum width of the item. Truncation occurs with a '<' |
| 7 | 7529 on the left for text items. Numeric items will be |
| 7530 shifted down to maxwid-2 digits followed by '>'number | |
| 7531 where number is the amount of missing digits, much like | |
| 7532 an exponential notation. | |
| 7533 item A one letter code as described below. | |
| 7534 | |
| 7535 Following is a description of the possible statusline items. The | |
| 7536 second character in "item" is the type: | |
| 7537 N for number | |
| 7538 S for string | |
| 7539 F for flags as described below | |
| 7540 - not applicable | |
| 7541 | |
| 7542 item meaning ~ | |
| 1152 | 7543 f S Path to the file in the buffer, as typed or relative to current |
| 7544 directory. | |
| 7 | 7545 F S Full path to the file in the buffer. |
| 7546 t S File name (tail) of file in the buffer. | |
| 1698 | 7547 m F Modified flag, text is "[+]"; "[-]" if 'modifiable' is off. |
| 7 | 7548 M F Modified flag, text is ",+" or ",-". |
| 1698 | 7549 r F Readonly flag, text is "[RO]". |
| 7 | 7550 R F Readonly flag, text is ",RO". |
| 1698 | 7551 h F Help buffer flag, text is "[help]". |
| 7 | 7552 H F Help buffer flag, text is ",HLP". |
| 1698 | 7553 w F Preview window flag, text is "[Preview]". |
| 7 | 7554 W F Preview window flag, text is ",PRV". |
| 1698 | 7555 y F Type of file in the buffer, e.g., "[vim]". See 'filetype'. |
| 7 | 7556 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
|
7557 q S "[Quickfix List]", "[Location List]" or empty. |
| 7 | 7558 k S Value of "b:keymap_name" or 'keymap' when |:lmap| mappings are |
| 7559 being used: "<keymap>" | |
| 7560 n N Buffer number. | |
| 2709 | 7561 b N Value of character under cursor. |
| 7 | 7562 B N As above, in hexadecimal. |
| 7563 o N Byte number in file of byte under cursor, first byte is 1. | |
| 7564 Mnemonic: Offset from start of file (with one added) | |
| 7565 {not available when compiled without |+byte_offset| feature} | |
| 7566 O N As above, in hexadecimal. | |
| 233 | 7567 N N Printer page number. (Only works in the 'printheader' option.) |
| 7 | 7568 l N Line number. |
| 7569 L N Number of lines in buffer. | |
| 22328 | 7570 c N Column number (byte index). |
| 7571 v N Virtual column number (screen column). | |
| 10 | 7572 V N Virtual column number as -{num}. Not displayed if equal to 'c'. |
| 7 | 7573 p N Percentage through file in lines as in |CTRL-G|. |
| 7574 P S Percentage through file of displayed window. This is like the | |
| 5055 | 7575 percentage described for 'ruler'. Always 3 in length, unless |
| 7576 translated. | |
| 233 | 7577 a S Argument list status as in default title. ({current} of {max}) |
| 7 | 7578 Empty if the argument file count is zero or one. |
| 680 | 7579 { 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
|
7580 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
|
7581 expression cannot contain a '}' character, call a function to |
| 18719 | 7582 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
|
7583 {% - 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
|
7584 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
|
7585 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
|
7586 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
|
7587 expression is denoted by %}. |
| 25973 | 7588 For example: > |
|
24630
4cf4d7a71fac
patch 8.2.2854: custom statusline cannot contain % items
Bram Moolenaar <Bram@vim.org>
parents:
24600
diff
changeset
|
7589 func! Stl_filename() abort |
|
4cf4d7a71fac
patch 8.2.2854: custom statusline cannot contain % items
Bram Moolenaar <Bram@vim.org>
parents:
24600
diff
changeset
|
7590 return "%t" |
|
4cf4d7a71fac
patch 8.2.2854: custom statusline cannot contain % items
Bram Moolenaar <Bram@vim.org>
parents:
24600
diff
changeset
|
7591 endfunc |
|
4cf4d7a71fac
patch 8.2.2854: custom statusline cannot contain % items
Bram Moolenaar <Bram@vim.org>
parents:
24600
diff
changeset
|
7592 < `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
|
7593 `stl=%{%Stl_filename()%}` results in `"Name of current file"` |
| 25973 | 7594 %} - End of `{%` expression |
| 7 | 7595 ( - Start of item group. Can be used for setting the width and |
| 7596 alignment of a section. Must be followed by %) somewhere. | |
| 7597 ) - End of item group. No width fields allowed. | |
| 681 | 7598 T N For 'tabline': start of tab page N label. Use %T after the last |
| 7599 label. This information is used for mouse clicks. | |
| 7600 X N For 'tabline': start of close tab N label. Use %X after the | |
| 7601 label, e.g.: %3Xclose%X. Use %999X for a "close current tab" | |
| 7602 mark. This information is used for mouse clicks. | |
| 7 | 7603 < - Where to truncate line if too long. Default is at the start. |
| 7604 No width fields allowed. | |
| 7605 = - Separation point between left and right aligned items. | |
| 7606 No width fields allowed. | |
| 680 | 7607 # - Set highlight group. The name must follow and then a # again. |
| 7608 Thus use %#HLname# for highlight group HLname. The same | |
| 7609 highlighting is used, also for the statusline of non-current | |
| 7610 windows. | |
| 7 | 7611 * - Set highlight group to User{N}, where {N} is taken from the |
| 233 | 7612 minwid field, e.g. %1*. Restore normal highlight with %* or %0*. |
| 7 | 7613 The difference between User{N} and StatusLine will be applied |
| 7614 to StatusLineNC for the statusline of non-current windows. | |
| 7615 The number N must be between 1 and 9. See |hl-User1..9| | |
| 7616 | |
| 1698 | 7617 When displaying a flag, Vim removes the leading comma, if any, when |
| 7618 that flag comes right after plaintext. This will make a nice display | |
| 7619 when flags are used like in the examples below. | |
| 7 | 7620 |
| 233 | 7621 When all items in a group becomes an empty string (i.e. flags that are |
| 7 | 7622 not set) and a minwid is not set for the group, the whole group will |
| 7623 become empty. This will make a group like the following disappear | |
| 7624 completely from the statusline when none of the flags are set. > | |
| 7625 :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
|
7626 < 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
|
7627 line is displayed. |
| 18719 | 7628 *stl-%{* *g:actual_curbuf* *g:actual_curwin* |
| 19163 | 7629 While evaluating %{} the current buffer and current window will be set |
| 7630 temporarily to that of the window (and buffer) whose statusline is | |
| 18719 | 7631 currently being drawn. The expression will evaluate in this context. |
| 7632 The variable "g:actual_curbuf" is set to the `bufnr()` number of the | |
| 7633 real current buffer and "g:actual_curwin" to the |window-ID| of the | |
| 7634 real current window. These values are strings. | |
| 634 | 7635 |
| 3682 | 7636 The 'statusline' option will be evaluated in the |sandbox| if set from |
| 7637 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
|
7638 This option cannot be set in a modeline when 'modelineexpr' is off. |
| 634 | 7639 |
| 7640 It is not allowed to change text or jump to another window while | |
| 7641 evaluating 'statusline' |textlock|. | |
| 7 | 7642 |
| 7643 If the statusline is not updated when you want it (e.g., after setting | |
| 7644 a variable that's used in an expression), you can force an update by | |
| 7645 setting an option without changing its value. Example: > | |
| 7646 :let &ro = &ro | |
| 7647 | |
| 7648 < A result of all digits is regarded a number for display purposes. | |
| 7649 Otherwise the result is taken as flag text and applied to the rules | |
| 7650 described above. | |
| 7651 | |
| 199 | 7652 Watch out for errors in expressions. They may render Vim unusable! |
| 7 | 7653 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
|
7654 edit your .vimrc or whatever with "vim --clean" to get it right. |
| 7 | 7655 |
| 7656 Examples: | |
| 7657 Emulate standard status line with 'ruler' set > | |
| 7658 :set statusline=%<%f\ %h%m%r%=%-14.(%l,%c%V%)\ %P | |
| 7659 < Similar, but add ASCII value of char under the cursor (like "ga") > | |
| 7660 :set statusline=%<%f%h%m%r%=%b\ 0x%B\ \ %l,%c%V\ %P | |
| 7661 < Display byte count and byte value, modified flag in red. > | |
| 7662 :set statusline=%<%f%=\ [%1*%M%*%n%R%H]\ %-19(%3l,%02c%03V%)%O'%02b' | |
| 7663 :hi User1 term=inverse,bold cterm=inverse,bold ctermfg=red | |
| 7664 < Display a ,GZ flag if a compressed file is loaded > | |
| 7665 :set statusline=...%r%{VarExists('b:gzflag','\ [GZ]')}%h... | |
| 7666 < In the |:autocmd|'s: > | |
| 7667 :let b:gzflag = 1 | |
| 7668 < And: > | |
| 7669 :unlet b:gzflag | |
| 7670 < And define this function: > | |
| 7671 :function VarExists(var, val) | |
| 7672 : if exists(a:var) | return a:val | else | return '' | endif | |
| 7673 :endfunction | |
| 7674 < | |
| 7675 *'suffixes'* *'su'* | |
| 7676 'suffixes' 'su' string (default ".bak,~,.o,.h,.info,.swp,.obj") | |
| 7677 global | |
| 7678 Files with these suffixes get a lower priority when multiple files | |
| 7679 match a wildcard. See |suffixes|. Commas can be used to separate the | |
| 10 | 7680 suffixes. Spaces after the comma are ignored. A dot is also seen as |
| 7681 the start of a suffix. To avoid a dot or comma being recognized as a | |
| 7 | 7682 separator, precede it with a backslash (see |option-backslash| about |
| 7683 including spaces and backslashes). | |
| 7684 See 'wildignore' for completely ignoring files. | |
| 7685 The use of |:set+=| and |:set-=| is preferred when adding or removing | |
| 7686 suffixes from the list. This avoids problems when a future version | |
| 7687 uses another default. | |
| 7688 | |
| 7689 *'suffixesadd'* *'sua'* | |
| 7690 'suffixesadd' 'sua' string (default "") | |
| 7691 local to buffer | |
| 7692 {not available when compiled without the | |
| 7693 |+file_in_path| feature} | |
| 28379 | 7694 Comma-separated list of suffixes, which are used when searching for a |
| 7 | 7695 file for the "gf", "[I", etc. commands. Example: > |
| 7696 :set suffixesadd=.java | |
| 7697 < | |
| 7698 *'swapfile'* *'swf'* *'noswapfile'* *'noswf'* | |
| 7699 'swapfile' 'swf' boolean (default on) | |
| 7700 local to buffer | |
| 10 | 7701 Use a swapfile for the buffer. This option can be reset when a |
| 7 | 7702 swapfile is not wanted for a specific buffer. For example, with |
| 7703 confidential information that even root must not be able to access. | |
| 7704 Careful: All text will be in memory: | |
| 7705 - Don't use this for big files. | |
| 7706 - Recovery will be impossible! | |
| 7707 A swapfile will only be present when |'updatecount'| is non-zero and | |
| 7708 'swapfile' is set. | |
| 7709 When 'swapfile' is reset, the swap file for the current buffer is | |
| 7710 immediately deleted. When 'swapfile' is set, and 'updatecount' is | |
| 7711 non-zero, a swap file is immediately created. | |
| 7712 Also see |swap-file| and |'swapsync'|. | |
| 5763 | 7713 If you want to open a new buffer without creating a swap file for it, |
| 7714 use the |:noswapfile| modifier. | |
|
13341
acd7eaa13d2b
Updated runtime files.
Christian Brabandt <cb@256bit.org>
parents:
13314
diff
changeset
|
7715 See 'directory' for where the swap file is created. |
| 7 | 7716 |
| 7717 This option is used together with 'bufhidden' and 'buftype' to | |
| 7718 specify special kinds of buffers. See |special-buffers|. | |
| 7719 | |
| 7720 *'swapsync'* *'sws'* | |
| 7721 'swapsync' 'sws' string (default "fsync") | |
| 7722 global | |
| 7723 When this option is not empty a swap file is synced to disk after | |
| 10 | 7724 writing to it. This takes some time, especially on busy unix systems. |
| 7 | 7725 When this option is empty parts of the swap file may be in memory and |
| 7726 not written to disk. When the system crashes you may lose more work. | |
| 7727 On Unix the system does a sync now and then without Vim asking for it, | |
| 7728 so the disadvantage of setting this option off is small. On some | |
| 7729 systems the swap file will not be written at all. For a unix system | |
| 7730 setting it to "sync" will use the sync() call instead of the default | |
| 7731 fsync(), which may work better on some systems. | |
| 36 | 7732 The 'fsync' option is used for the actual file. |
| 7 | 7733 |
| 7734 *'switchbuf'* *'swb'* | |
| 7735 'switchbuf' 'swb' string (default "") | |
| 7736 global | |
| 7737 This option controls the behavior when switching between buffers. | |
| 24751 | 7738 Mostly for |quickfix| commands some values are also used for other |
| 7739 commands, as mentioned below. | |
| 28379 | 7740 Possible values (comma-separated list): |
| 7 | 7741 useopen If included, jump to the first open window that |
| 7742 contains the specified buffer (if there is one). | |
| 7743 Otherwise: Do not examine other windows. | |
| 7744 This setting is checked with |quickfix| commands, when | |
| 7745 jumping to errors (":cc", ":cn", "cp", etc.). It is | |
| 7746 also used in all buffer related split commands, for | |
| 7747 example ":sbuffer", ":sbnext", or ":sbrewind". | |
| 825 | 7748 usetab Like "useopen", but also consider windows in other tab |
| 856 | 7749 pages. |
| 7 | 7750 split If included, split the current window before loading |
| 3153 | 7751 a buffer for a |quickfix| command that display errors. |
| 16086 | 7752 Otherwise: do not split, use current window (when used |
| 7753 in the quickfix window: the previously used window or | |
| 7754 split if there is no other window). | |
| 6843 | 7755 vsplit Just like "split" but split vertically. |
| 1621 | 7756 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
|
7757 "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
|
7758 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
|
7759 jumping to errors with |quickfix| commands. |
| 7 | 7760 |
| 410 | 7761 *'synmaxcol'* *'smc'* |
| 7762 'synmaxcol' 'smc' number (default 3000) | |
| 7763 local to buffer | |
| 7764 {not available when compiled without the |+syntax| | |
| 7765 feature} | |
| 419 | 7766 Maximum column in which to search for syntax items. In long lines the |
| 7767 text after this column is not highlighted and following lines may not | |
| 7768 be highlighted correctly, because the syntax state is cleared. | |
| 410 | 7769 This helps to avoid very slow redrawing for an XML file that is one |
| 7770 long line. | |
| 7771 Set to zero to remove the limit. | |
| 7772 | |
| 7 | 7773 *'syntax'* *'syn'* |
| 7774 'syntax' 'syn' string (default empty) | |
| 7775 local to buffer | |
| 7776 {not available when compiled without the |+syntax| | |
| 7777 feature} | |
| 7778 When this option is set, the syntax with this name is loaded, unless | |
| 7779 syntax highlighting has been switched off with ":syntax off". | |
| 7780 Otherwise this option does not always reflect the current syntax (the | |
| 7781 b:current_syntax variable does). | |
| 7782 This option is most useful in a modeline, for a file which syntax is | |
| 782 | 7783 not automatically recognized. Example, in an IDL file: |
| 7784 /* vim: set syntax=idl : */ ~ | |
| 7785 When a dot appears in the value then this separates two filetype | |
| 7786 names. Example: | |
| 7787 /* vim: set syntax=c.doxygen : */ ~ | |
| 7788 This will use the "c" syntax first, then the "doxygen" syntax. | |
| 7789 Note that the second one must be prepared to be loaded as an addition, | |
| 7790 otherwise it will be skipped. More than one dot may appear. | |
| 7791 To switch off syntax highlighting for the current file, use: > | |
| 7 | 7792 :set syntax=OFF |
| 7793 < To switch syntax highlighting on according to the current value of the | |
| 7794 'filetype' option: > | |
| 7795 :set syntax=ON | |
| 7796 < What actually happens when setting the 'syntax' option is that the | |
| 7797 Syntax autocommand event is triggered with the value as argument. | |
| 7798 This option is not copied to another buffer, independent of the 's' or | |
| 7799 'S' flag in 'cpoptions'. | |
| 36 | 7800 Only normal file name characters can be used, "/\*?[|<>" are illegal. |
| 7 | 7801 |
| 699 | 7802 *'tabline'* *'tal'* |
| 677 | 7803 'tabline' 'tal' string (default empty) |
| 674 | 7804 global |
| 27804 | 7805 When non-empty, this option determines the content of the tab pages |
| 677 | 7806 line at the top of the Vim window. When empty Vim will use a default |
| 681 | 7807 tab pages line. See |setting-tabline| for more info. |
| 677 | 7808 |
| 7809 The tab pages line only appears as specified with the 'showtabline' | |
| 688 | 7810 option and only when there is no GUI tab line. When 'e' is in |
| 7811 '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
|
7812 instead. Note that the two tab pages lines are very different. |
| 677 | 7813 |
| 7814 The value is evaluated like with 'statusline'. You can use | |
| 7815 |tabpagenr()|, |tabpagewinnr()| and |tabpagebuflist()| to figure out | |
| 681 | 7816 the text to be displayed. Use "%1T" for the first label, "%2T" for |
| 7817 the second one, etc. Use "%X" items for closing labels. | |
| 677 | 7818 |
|
15396
325e4a8ba1b6
patch 8.1.0706: tabline is not always redrawn
Bram Moolenaar <Bram@vim.org>
parents:
15281
diff
changeset
|
7819 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
|
7820 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
|
7821 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
|
7822 |
| 677 | 7823 Keep in mind that only one of the tab pages is the current one, others |
| 7824 are invisible and you can't jump to their windows. | |
| 7825 | |
| 674 | 7826 |
| 699 | 7827 *'tabpagemax'* *'tpm'* |
| 7828 'tabpagemax' 'tpm' number (default 10) | |
| 7829 global | |
| 7830 Maximum number of tab pages to be opened by the |-p| command line | |
| 7831 argument or the ":tab all" command. |tabpage| | |
| 7832 | |
| 7833 | |
| 7834 *'tabstop'* *'ts'* | |
| 7 | 7835 'tabstop' 'ts' number (default 8) |
| 7836 local to buffer | |
| 7837 Number of spaces that a <Tab> in the file counts for. Also see | |
| 27459 | 7838 the |:retab| command, and the 'softtabstop' option. |
| 7 | 7839 |
| 7840 Note: Setting 'tabstop' to any other value than 8 can make your file | |
| 27459 | 7841 appear wrong in many places, e.g., when printing it. |
| 7842 The value must be more than 0 and less than 10000. | |
| 7 | 7843 |
| 7844 There are four main ways to use tabs in Vim: | |
| 7845 1. Always keep 'tabstop' at 8, set 'softtabstop' and 'shiftwidth' to 4 | |
| 7846 (or 3 or whatever you prefer) and use 'noexpandtab'. Then Vim | |
| 1263 | 7847 will use a mix of tabs and spaces, but typing <Tab> and <BS> will |
| 7 | 7848 behave like a tab appears every 4 (or 3) characters. |
| 7849 2. Set 'tabstop' and 'shiftwidth' to whatever you prefer and use | |
| 7850 'expandtab'. This way you will always insert spaces. The | |
| 7851 formatting will never be messed up when 'tabstop' is changed. | |
| 7852 3. Set 'tabstop' and 'shiftwidth' to whatever you prefer and use a | |
| 10 | 7853 |modeline| to set these values when editing the file again. Only |
| 7 | 7854 works when using Vim to edit the file. |
| 7855 4. Always set 'tabstop' and 'shiftwidth' to the same value, and | |
| 7856 'noexpandtab'. This should then work (for initial indents only) | |
| 7857 for any tabstop setting that people use. It might be nice to have | |
| 7858 tabs after the first non-blank inserted as spaces if you do this | |
| 7859 though. Otherwise aligned comments will be wrong when 'tabstop' is | |
| 7860 changed. | |
| 7861 | |
|
14175
2ad722003b36
patch 8.1.0105: all tab stops are the same
Christian Brabandt <cb@256bit.org>
parents:
14019
diff
changeset
|
7862 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
|
7863 '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
|
7864 than an empty string. |
|
2ad722003b36
patch 8.1.0105: all tab stops are the same
Christian Brabandt <cb@256bit.org>
parents:
14019
diff
changeset
|
7865 |
| 7 | 7866 *'tagbsearch'* *'tbs'* *'notagbsearch'* *'notbs'* |
| 7867 'tagbsearch' 'tbs' boolean (default on) | |
| 7868 global | |
| 7869 When searching for a tag (e.g., for the |:ta| command), Vim can either | |
| 10 | 7870 use a binary search or a linear search in a tags file. Binary |
| 7 | 7871 searching makes searching for a tag a LOT faster, but a linear search |
| 7872 will find more tags if the tags file wasn't properly sorted. | |
| 7873 Vim normally assumes that your tags files are sorted, or indicate that | |
| 7874 they are not sorted. Only when this is not the case does the | |
| 7875 'tagbsearch' option need to be switched off. | |
| 7876 | |
| 7877 When 'tagbsearch' is on, binary searching is first used in the tags | |
| 10 | 7878 files. In certain situations, Vim will do a linear search instead for |
| 7 | 7879 certain files, or retry all files with a linear search. When |
| 7880 'tagbsearch' is off, only a linear search is done. | |
| 7881 | |
| 7882 Linear searching is done anyway, for one file, when Vim finds a line | |
| 7883 at the start of the file indicating that it's not sorted: > | |
| 1621 | 7884 !_TAG_FILE_SORTED 0 /some comment/ |
| 7 | 7885 < [The whitespace before and after the '0' must be a single <Tab>] |
| 7886 | |
| 7887 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
|
7888 files listed in 'tags', and case is ignored or a pattern is used |
| 7 | 7889 instead of a normal tag name, a retry is done with a linear search. |
| 7890 Tags in unsorted tags files, and matches with different case will only | |
| 7891 be found in the retry. | |
| 7892 | |
| 22 | 7893 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
|
7894 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
|
7895 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
|
7896 sorted with the -f switch to "sort" in most unices, as in the command: |
| 28141 | 7897 "sort -f -o tags tags". For Universal ctags and Exuberant ctags |
| 7898 version 5.x or higher (at least 5.5) the --sort=foldcase switch can be | |
| 7899 used for this as well. Note that case must be folded to uppercase for | |
| 7900 this to work. | |
|
7266
6ba7182fb7bd
commit https://github.com/vim/vim/commit/0f6562e9036f889185dff49a75c7fc5ffb28b307
Christian Brabandt <cb@256bit.org>
parents:
7245
diff
changeset
|
7901 |
|
6ba7182fb7bd
commit https://github.com/vim/vim/commit/0f6562e9036f889185dff49a75c7fc5ffb28b307
Christian Brabandt <cb@256bit.org>
parents:
7245
diff
changeset
|
7902 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
|
7903 '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
|
7904 "ignore". |
|
9913
bb00c661b3a4
commit https://github.com/vim/vim/commit/66e29d7112e437b2b50efe1f82c7e892736d23e4
Christian Brabandt <cb@256bit.org>
parents:
9887
diff
changeset
|
7905 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
|
7906 '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
|
7907 characters. |
| 7 | 7908 |
| 7909 When 'tagbsearch' is off, tags searching is slower when a full match | |
| 7910 exists, but faster when no full match exists. Tags in unsorted tags | |
| 7911 files may only be found with 'tagbsearch' off. | |
| 7912 When the tags file is not sorted, or sorted in a wrong way (not on | |
| 7913 ASCII byte value), 'tagbsearch' should be off, or the line given above | |
| 7914 must be included in the tags file. | |
| 7915 This option doesn't affect commands that find all matching tags (e.g., | |
| 7916 command-line completion and ":help"). | |
| 7917 | |
|
7266
6ba7182fb7bd
commit https://github.com/vim/vim/commit/0f6562e9036f889185dff49a75c7fc5ffb28b307
Christian Brabandt <cb@256bit.org>
parents:
7245
diff
changeset
|
7918 *'tagcase'* *'tc'* |
|
6ba7182fb7bd
commit https://github.com/vim/vim/commit/0f6562e9036f889185dff49a75c7fc5ffb28b307
Christian Brabandt <cb@256bit.org>
parents:
7245
diff
changeset
|
7919 'tagcase' 'tc' string (default "followic") |
|
6ba7182fb7bd
commit https://github.com/vim/vim/commit/0f6562e9036f889185dff49a75c7fc5ffb28b307
Christian Brabandt <cb@256bit.org>
parents:
7245
diff
changeset
|
7920 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
|
7921 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
|
7922 file: |
|
6ba7182fb7bd
commit https://github.com/vim/vim/commit/0f6562e9036f889185dff49a75c7fc5ffb28b307
Christian Brabandt <cb@256bit.org>
parents:
7245
diff
changeset
|
7923 followic Follow the 'ignorecase' option |
|
9913
bb00c661b3a4
commit https://github.com/vim/vim/commit/66e29d7112e437b2b50efe1f82c7e892736d23e4
Christian Brabandt <cb@256bit.org>
parents:
9887
diff
changeset
|
7924 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
|
7925 ignore Ignore case |
|
6ba7182fb7bd
commit https://github.com/vim/vim/commit/0f6562e9036f889185dff49a75c7fc5ffb28b307
Christian Brabandt <cb@256bit.org>
parents:
7245
diff
changeset
|
7926 match Match case |
|
9913
bb00c661b3a4
commit https://github.com/vim/vim/commit/66e29d7112e437b2b50efe1f82c7e892736d23e4
Christian Brabandt <cb@256bit.org>
parents:
9887
diff
changeset
|
7927 smart Ignore case unless an upper case letter is used |
| 11160 | 7928 NOTE: This option is set to the Vi default value when 'compatible' is |
| 7929 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
|
7930 |
|
16447
54ffc82f38a8
patch 8.1.1228: not possible to process tags with a function
Bram Moolenaar <Bram@vim.org>
parents:
16443
diff
changeset
|
7931 *'tagfunc'* *'tfu'* |
|
54ffc82f38a8
patch 8.1.1228: not possible to process tags with a function
Bram Moolenaar <Bram@vim.org>
parents:
16443
diff
changeset
|
7932 '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
|
7933 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
|
7934 {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
|
7935 feature} |
|
54ffc82f38a8
patch 8.1.1228: not possible to process tags with a function
Bram Moolenaar <Bram@vim.org>
parents:
16443
diff
changeset
|
7936 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
|
7937 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
|
7938 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
|
7939 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
|
7940 |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
|
7941 information. |
|
16447
54ffc82f38a8
patch 8.1.1228: not possible to process tags with a function
Bram Moolenaar <Bram@vim.org>
parents:
16443
diff
changeset
|
7942 |
| 7 | 7943 *'taglength'* *'tl'* |
| 7944 'taglength' 'tl' number (default 0) | |
| 7945 global | |
| 7946 If non-zero, tags are significant up to this number of characters. | |
| 7947 | |
| 7948 *'tagrelative'* *'tr'* *'notagrelative'* *'notr'* | |
| 7949 'tagrelative' 'tr' boolean (Vim default: on, Vi default: off) | |
| 7950 global | |
| 824 | 7951 If on and using a tags file in another directory, file names in that |
| 7952 tags file are relative to the directory where the tags file is. | |
| 7 | 7953 NOTE: This option is set to the Vi default value when 'compatible' is |
| 7954 set and to the Vim default value when 'compatible' is reset. | |
| 7955 | |
| 7956 *'tags'* *'tag'* *E433* | |
| 7957 'tags' 'tag' string (default "./tags,tags", when compiled with | |
| 7958 |+emacs_tags|: "./tags,./TAGS,tags,TAGS") | |
| 7959 global or local to buffer |global-local| | |
| 7960 Filenames for the tag command, separated by spaces or commas. To | |
| 7961 include a space or comma in a file name, precede it with a backslash | |
| 7962 (see |option-backslash| about including spaces and backslashes). | |
| 7963 When a file name starts with "./", the '.' is replaced with the path | |
| 7964 of the current file. But only when the 'd' flag is not included in | |
| 7965 'cpoptions'. Environment variables are expanded |:set_env|. Also see | |
| 7966 |tags-option|. | |
| 7967 "*", "**" 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
|
7968 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
|
7969 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
|
7970 contain wildcards, it is used as-is. E.g., "/lib/**/tags?" will find |
|
d7ecfc8b784c
Update help about wildcards in 'tags' option.
Bram Moolenaar <bram@vim.org>
parents:
2492
diff
changeset
|
7971 files called "tags?". {not available when compiled without the |
|
d7ecfc8b784c
Update help about wildcards in 'tags' option.
Bram Moolenaar <bram@vim.org>
parents:
2492
diff
changeset
|
7972 |+path_extra| feature} |
| 515 | 7973 The |tagfiles()| function can be used to get a list of the file names |
| 7974 actually used. | |
| 7 | 7975 If Vim was compiled with the |+emacs_tags| feature, Emacs-style tag |
| 7976 files are also supported. They are automatically recognized. The | |
| 7977 default value becomes "./tags,./TAGS,tags,TAGS", unless case | |
| 7978 differences are ignored (MS-Windows). |emacs-tags| | |
| 7979 The use of |:set+=| and |:set-=| is preferred when adding or removing | |
| 7980 file names from the list. This avoids problems when a future version | |
| 7981 uses another default. | |
| 7982 | |
| 7983 *'tagstack'* *'tgst'* *'notagstack'* *'notgst'* | |
| 7984 'tagstack' 'tgst' boolean (default on) | |
| 7985 global | |
| 7986 When on, the |tagstack| is used normally. When off, a ":tag" or | |
| 7987 ":tselect" command with an argument will not push the tag onto the | |
| 7988 tagstack. A following ":tag" without an argument, a ":pop" command or | |
| 7989 any other command that uses the tagstack will use the unmodified | |
| 7990 tagstack, but does change the pointer to the active entry. | |
| 7991 Resetting this option is useful when using a ":tag" command in a | |
| 7992 mapping which should not change the tagstack. | |
| 7993 | |
|
7538
c9fc24b76293
commit https://github.com/vim/vim/commit/8a5115cf18751022387af2085f374d38c60dde83
Christian Brabandt <cb@256bit.org>
parents:
7528
diff
changeset
|
7994 *'tcldll'* |
|
8629
54ac275e3fc4
commit https://github.com/vim/vim/commit/3848e00e0177abdb31bc600234967863ec487233
Christian Brabandt <cb@256bit.org>
parents:
8560
diff
changeset
|
7995 '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
|
7996 global |
|
c9fc24b76293
commit https://github.com/vim/vim/commit/8a5115cf18751022387af2085f374d38c60dde83
Christian Brabandt <cb@256bit.org>
parents:
7528
diff
changeset
|
7997 {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
|
7998 feature} |
|
c9fc24b76293
commit https://github.com/vim/vim/commit/8a5115cf18751022387af2085f374d38c60dde83
Christian Brabandt <cb@256bit.org>
parents:
7528
diff
changeset
|
7999 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
|
8000 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
|
8001 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
|
8002 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
|
8003 security reasons. |
|
c9fc24b76293
commit https://github.com/vim/vim/commit/8a5115cf18751022387af2085f374d38c60dde83
Christian Brabandt <cb@256bit.org>
parents:
7528
diff
changeset
|
8004 |
| 7 | 8005 *'term'* *E529* *E530* *E531* |
| 8006 'term' string (default is $TERM, if that fails: | |
| 8007 in the GUI: "builtin_gui" | |
| 8008 on Amiga: "amiga" | |
|
19526
22f0dda71638
patch 8.2.0320: no Haiku support
Bram Moolenaar <Bram@vim.org>
parents:
19404
diff
changeset
|
8009 on Haiku: "xterm" |
| 7 | 8010 on Mac: "mac-ansi" |
| 8011 on Unix: "ansi" | |
| 8012 on VMS: "ansi" | |
| 8013 on Win 32: "win32") | |
| 8014 global | |
| 8015 Name of the terminal. Used for choosing the terminal control | |
| 8016 characters. Environment variables are expanded |:set_env|. | |
| 8017 For example: > | |
| 8018 :set term=$TERM | |
| 8019 < See |termcap|. | |
| 8020 | |
| 8021 *'termbidi'* *'tbidi'* | |
| 8022 *'notermbidi'* *'notbidi'* | |
| 8023 'termbidi' 'tbidi' boolean (default off, on for "mlterm") | |
| 8024 global | |
| 8025 {only available when compiled with the |+arabic| | |
| 8026 feature} | |
| 8027 The terminal is in charge of Bi-directionality of text (as specified | |
| 8028 by Unicode). The terminal is also expected to do the required shaping | |
| 8029 that some languages (such as Arabic) require. | |
| 8030 Setting this option implies that 'rightleft' will not be set when | |
| 8031 'arabic' is set and the value of 'arabicshape' will be ignored. | |
| 8032 Note that setting 'termbidi' has the immediate effect that | |
| 8033 'arabicshape' is ignored, but 'rightleft' isn't changed automatically. | |
| 8034 This option is reset when the GUI is started. | |
| 8035 For further details see |arabic.txt|. | |
| 8036 | |
| 8037 *'termencoding'* *'tenc'* | |
| 21825 | 8038 'termencoding' 'tenc' string (default ""; with GTK+ GUI: "utf-8") |
| 7 | 8039 global |
| 8040 Encoding used for the terminal. This specifies what character | |
| 8041 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
|
8042 the GUI it only applies to the keyboard ('encoding' is used for the |
| 21825 | 8043 display). |
|
19027
d72b30bf3a80
patch 8.2.0074: Python 3 unicode test someitmes fails
Bram Moolenaar <Bram@vim.org>
parents:
18972
diff
changeset
|
8044 *E617* *E950* |
|
10895
c391bfbdb452
Updated runtime files.
Christian Brabandt <cb@256bit.org>
parents:
10734
diff
changeset
|
8045 Note: This does not apply to the GTK+ GUI. After the GUI has been |
| 7 | 8046 successfully initialized, 'termencoding' is forcibly set to "utf-8". |
| 8047 Any attempts to set a different value will be rejected, and an error | |
| 8048 message is shown. | |
|
7080
1a34f5272977
commit https://github.com/vim/vim/commit/ac360bf2ca293735fc7c6654dc2b3066f4c62488
Christian Brabandt <cb@256bit.org>
parents:
7051
diff
changeset
|
8049 For the Win32 GUI and console versions 'termencoding' is not used, |
| 7 | 8050 because the Win32 system always passes Unicode characters. |
| 8051 When empty, the same encoding is used as for the 'encoding' option. | |
| 8052 This is the normal value. | |
| 8053 Not all combinations for 'termencoding' and 'encoding' are valid. See | |
| 8054 |encoding-table|. | |
| 8055 The value for this option must be supported by internal conversions or | |
| 8056 iconv(). When this is not possible no conversion will be done and you | |
| 8057 will probably experience problems with non-ASCII characters. | |
| 8058 Example: You are working with the locale set to euc-jp (Japanese) and | |
| 8059 want to edit a UTF-8 file: > | |
| 8060 :let &termencoding = &encoding | |
| 8061 :set encoding=utf-8 | |
| 8062 < You need to do this when your system has no locale support for UTF-8. | |
| 8063 | |
|
13314
65c3e8259124
patch 8.0.1531: cannot use 24 bit colors in MS-Windows console
Christian Brabandt <cb@256bit.org>
parents:
13234
diff
changeset
|
8064 *'termguicolors'* *'tgc'* *E954* |
|
9027
773d627cac0b
commit https://github.com/vim/vim/commit/61be73bb0f965a895bfb064ea3e55476ac175162
Christian Brabandt <cb@256bit.org>
parents:
8969
diff
changeset
|
8065 'termguicolors' 'tgc' boolean (default off) |
|
773d627cac0b
commit https://github.com/vim/vim/commit/61be73bb0f965a895bfb064ea3e55476ac175162
Christian Brabandt <cb@256bit.org>
parents:
8969
diff
changeset
|
8066 global |
|
773d627cac0b
commit https://github.com/vim/vim/commit/61be73bb0f965a895bfb064ea3e55476ac175162
Christian Brabandt <cb@256bit.org>
parents:
8969
diff
changeset
|
8067 {not available when compiled without the |
|
773d627cac0b
commit https://github.com/vim/vim/commit/61be73bb0f965a895bfb064ea3e55476ac175162
Christian Brabandt <cb@256bit.org>
parents:
8969
diff
changeset
|
8068 |+termguicolors| feature} |
|
773d627cac0b
commit https://github.com/vim/vim/commit/61be73bb0f965a895bfb064ea3e55476ac175162
Christian Brabandt <cb@256bit.org>
parents:
8969
diff
changeset
|
8069 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
|
8070 the terminal (thus using 24-bit color). |
|
13341
acd7eaa13d2b
Updated runtime files.
Christian Brabandt <cb@256bit.org>
parents:
13314
diff
changeset
|
8071 |
|
13314
65c3e8259124
patch 8.0.1531: cannot use 24 bit colors in MS-Windows console
Christian Brabandt <cb@256bit.org>
parents:
13234
diff
changeset
|
8072 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
|
8073 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
|
8074 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
|
8075 |
|
65c3e8259124
patch 8.0.1531: cannot use 24 bit colors in MS-Windows console
Christian Brabandt <cb@256bit.org>
parents:
13234
diff
changeset
|
8076 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
|
8077 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
|
8078 if has('vcon') |
|
13341
acd7eaa13d2b
Updated runtime files.
Christian Brabandt <cb@256bit.org>
parents:
13314
diff
changeset
|
8079 < This requires Vim to be built with the |+vtp| feature. |
|
acd7eaa13d2b
Updated runtime files.
Christian Brabandt <cb@256bit.org>
parents:
13314
diff
changeset
|
8080 |
| 11473 | 8081 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
|
8082 |
|
b01bca69b1d5
patch 8.2.4906: MS-Windows: cannot use transparent background
Bram Moolenaar <Bram@vim.org>
parents:
28716
diff
changeset
|
8083 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
|
8084 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
|
8085 '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
|
8086 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
|
8087 :hi Normal guibg=NONE |
|
b01bca69b1d5
patch 8.2.4906: MS-Windows: cannot use transparent background
Bram Moolenaar <Bram@vim.org>
parents:
28716
diff
changeset
|
8088 < |
| 11160 | 8089 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
|
8090 |
| 13735 | 8091 *'termwinkey'* *'twk'* |
| 8092 'termwinkey' 'twk' string (default "") | |
|
11659
49c12c93abf3
Updated runtime files and translations.
Christian Brabandt <cb@256bit.org>
parents:
11529
diff
changeset
|
8093 local to window |
| 11914 | 8094 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
|
8095 are sent to the job running in the window. |
| 11914 | 8096 The <> notation can be used, e.g.: > |
| 13735 | 8097 :set termwinkey=<C-L> |
| 11914 | 8098 < The string must be one key stroke but can be multiple bytes. |
| 8099 When not set CTRL-W is used, so that CTRL-W : gets you to the command | |
| 13735 | 8100 line. If 'termwinkey' is set to CTRL-L then CTRL-L : gets you to the |
| 11914 | 8101 command line. |
|
11659
49c12c93abf3
Updated runtime files and translations.
Christian Brabandt <cb@256bit.org>
parents:
11529
diff
changeset
|
8102 |
|
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
|
8103 *'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
|
8104 '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
|
8105 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
|
8106 {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
|
8107 |+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
|
8108 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
|
8109 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
|
8110 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
|
8111 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
|
8112 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
|
8113 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
|
8114 |
| 13735 | 8115 *'termwinsize'* *'tws'* |
| 8116 'termwinsize' 'tws' string (default "") | |
|
11659
49c12c93abf3
Updated runtime files and translations.
Christian Brabandt <cb@256bit.org>
parents:
11529
diff
changeset
|
8117 local to window |
| 22171 | 8118 Size used when opening the |terminal| window. Format: |
| 8119 {rows}x{columns} or {rows}*{columns}. | |
|
11659
49c12c93abf3
Updated runtime files and translations.
Christian Brabandt <cb@256bit.org>
parents:
11529
diff
changeset
|
8120 - 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
|
8121 - 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
|
8122 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
|
8123 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
|
8124 - 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
|
8125 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
|
8126 columns. |
|
b28d679b1843
patch 8.0.1722: cannot specify a minimal size for a terminal window
Christian Brabandt <cb@256bit.org>
parents:
13680
diff
changeset
|
8127 - 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
|
8128 - 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
|
8129 - Using "0x0" or "0*0" is the same as empty. |
| 22171 | 8130 - Can be overruled in the |term_start()| options with "term_rows" and |
| 8131 "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
|
8132 |
|
b28d679b1843
patch 8.0.1722: cannot specify a minimal size for a terminal window
Christian Brabandt <cb@256bit.org>
parents:
13680
diff
changeset
|
8133 Examples: |
|
b28d679b1843
patch 8.0.1722: cannot specify a minimal size for a terminal window
Christian Brabandt <cb@256bit.org>
parents:
13680
diff
changeset
|
8134 "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
|
8135 "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
|
8136 "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
|
8137 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
|
8138 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
|
8139 adjusted to that size, if possible. |
|
11659
49c12c93abf3
Updated runtime files and translations.
Christian Brabandt <cb@256bit.org>
parents:
11529
diff
changeset
|
8140 |
|
15746
c017195b121b
patch 8.1.0880: MS-Windows: inconsistent selection of winpty/conpty
Bram Moolenaar <Bram@vim.org>
parents:
15729
diff
changeset
|
8141 *'termwintype'* *'twt'* |
|
c017195b121b
patch 8.1.0880: MS-Windows: inconsistent selection of winpty/conpty
Bram Moolenaar <Bram@vim.org>
parents:
15729
diff
changeset
|
8142 '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
|
8143 global |
|
c017195b121b
patch 8.1.0880: MS-Windows: inconsistent selection of winpty/conpty
Bram Moolenaar <Bram@vim.org>
parents:
15729
diff
changeset
|
8144 {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
|
8145 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
|
8146 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
|
8147 window. |
|
c017195b121b
patch 8.1.0880: MS-Windows: inconsistent selection of winpty/conpty
Bram Moolenaar <Bram@vim.org>
parents:
15729
diff
changeset
|
8148 |
|
c017195b121b
patch 8.1.0880: MS-Windows: inconsistent selection of winpty/conpty
Bram Moolenaar <Bram@vim.org>
parents:
15729
diff
changeset
|
8149 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
|
8150 "" 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
|
8151 "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
|
8152 "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
|
8153 |
|
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
|
8154 |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
|
8155 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
|
8156 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
|
8157 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
|
8158 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
|
8159 |
| 7 | 8160 *'terse'* *'noterse'* |
| 8161 'terse' boolean (default off) | |
| 8162 global | |
| 8163 When set: Add 's' flag to 'shortmess' option (this makes the message | |
| 8164 for a search that hits the start or end of the file not being | |
| 8165 displayed). When reset: Remove 's' flag from 'shortmess' option. {Vi | |
| 8166 shortens a lot of messages} | |
| 8167 | |
| 8168 *'textauto'* *'ta'* *'notextauto'* *'nota'* | |
| 8169 'textauto' 'ta' boolean (Vim default: on, Vi default: off) | |
| 8170 global | |
| 8171 This option is obsolete. Use 'fileformats'. | |
| 8172 For backwards compatibility, when 'textauto' is set, 'fileformats' is | |
| 8173 set to the default value for the current system. When 'textauto' is | |
| 8174 reset, 'fileformats' is made empty. | |
| 8175 NOTE: This option is set to the Vi default value when 'compatible' is | |
| 8176 set and to the Vim default value when 'compatible' is reset. | |
| 8177 | |
| 8178 *'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
|
8179 'textmode' 'tx' boolean (Win32: default on, |
| 7 | 8180 others: default off) |
| 8181 local to buffer | |
| 8182 This option is obsolete. Use 'fileformat'. | |
| 8183 For backwards compatibility, when 'textmode' is set, 'fileformat' is | |
| 8184 set to "dos". When 'textmode' is reset, 'fileformat' is set to | |
| 8185 "unix". | |
| 8186 | |
| 8187 *'textwidth'* *'tw'* | |
| 8188 'textwidth' 'tw' number (default 0) | |
| 8189 local to buffer | |
| 8190 Maximum width of text that is being inserted. A longer line will be | |
| 8191 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
|
8192 this. |
|
c590de398af9
commit https://github.com/vim/vim/commit/ca63501fbcd1cf9c8aa9ff12c093c95b62a89ed7
Christian Brabandt <cb@256bit.org>
parents:
7080
diff
changeset
|
8193 '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
|
8194 when 'paste' is reset. |
|
c590de398af9
commit https://github.com/vim/vim/commit/ca63501fbcd1cf9c8aa9ff12c093c95b62a89ed7
Christian Brabandt <cb@256bit.org>
parents:
7080
diff
changeset
|
8195 When 'textwidth' is zero, 'wrapmargin' may be used. See also |
| 7 | 8196 'formatoptions' and |ins-textwidth|. |
| 838 | 8197 When 'formatexpr' is set it will be used to break the line. |
| 7 | 8198 NOTE: This option is set to 0 when 'compatible' is set. |
| 8199 | |
| 8200 *'thesaurus'* *'tsr'* | |
| 8201 'thesaurus' 'tsr' string (default "") | |
| 8202 global or local to buffer |global-local| | |
| 8203 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
|
8204 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
|
8205 |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
|
8206 |
|
ac330e2fecc4
patch 8.2.3528: 'thesaurus' and 'thesaurusfunc' do not have the same scope
Bram Moolenaar <Bram@vim.org>
parents:
25982
diff
changeset
|
8207 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
|
8208 buffer or globally. |
| 15033 | 8209 |
| 10 | 8210 To include a comma in a file name precede it with a backslash. Spaces |
| 7 | 8211 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
|
8212 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
|
8213 |: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
|
8214 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
|
8215 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
|
8216 reasons. |
| 7 | 8217 |
| 27036 | 8218 *'thesaurusfunc'* *'tsrfu'* |
|
25974
416237f1de22
patch 8.2.3520: cannot define a function for thesaurus completion
Bram Moolenaar <Bram@vim.org>
parents:
25973
diff
changeset
|
8219 '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
|
8220 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
|
8221 {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
|
8222 feature} |
|
416237f1de22
patch 8.2.3520: cannot define a function for thesaurus completion
Bram Moolenaar <Bram@vim.org>
parents:
25973
diff
changeset
|
8223 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
|
8224 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
|
8225 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
|
8226 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
|
8227 |
|
25974
416237f1de22
patch 8.2.3520: cannot define a function for thesaurus completion
Bram Moolenaar <Bram@vim.org>
parents:
25973
diff
changeset
|
8228 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
|
8229 security reasons. |
|
416237f1de22
patch 8.2.3520: cannot define a function for thesaurus completion
Bram Moolenaar <Bram@vim.org>
parents:
25973
diff
changeset
|
8230 |
| 7 | 8231 *'tildeop'* *'top'* *'notildeop'* *'notop'* |
| 8232 'tildeop' 'top' boolean (default off) | |
| 8233 global | |
| 8234 When on: The tilde command "~" behaves like an operator. | |
| 8235 NOTE: This option is reset when 'compatible' is set. | |
| 8236 | |
| 8237 *'timeout'* *'to'* *'notimeout'* *'noto'* | |
| 8238 'timeout' 'to' boolean (default on) | |
| 8239 global | |
| 8240 *'ttimeout'* *'nottimeout'* | |
|
11400
0f8713fe20dc
Updated runtime files.
Christian Brabandt <cb@256bit.org>
parents:
11262
diff
changeset
|
8241 'ttimeout' boolean (default off, set in |defaults.vim|) |
| 7 | 8242 global |
| 8243 These two options together determine the behavior when part of a | |
| 8244 mapped key sequence or keyboard code has been received: | |
| 8245 | |
| 8246 'timeout' 'ttimeout' action ~ | |
| 8247 off off do not time out | |
| 8248 on on or off time out on :mappings and key codes | |
| 8249 off on time out on key codes | |
| 8250 | |
| 8251 If both options are off, Vim will wait until either the complete | |
| 8252 mapping or key sequence has been received, or it is clear that there | |
| 8253 is no mapping or key sequence for the received characters. For | |
| 8254 example: if you have mapped "vl" and Vim has received 'v', the next | |
| 8255 character is needed to see if the 'v' is followed by an 'l'. | |
| 8256 When one of the options is on, Vim will wait for about 1 second for | |
| 8257 the next character to arrive. After that the already received | |
| 8258 characters are interpreted as single characters. The waiting time can | |
| 8259 be changed with the 'timeoutlen' option. | |
| 8260 On slow terminals or very busy systems timing out may cause | |
| 8261 malfunctioning cursor keys. If both options are off, Vim waits | |
| 8262 forever after an entered <Esc> if there are key codes that start | |
| 8263 with <Esc>. You will have to type <Esc> twice. If you do not have | |
| 8264 problems with key codes, but would like to have :mapped key | |
| 8265 sequences not timing out in 1 second, set the 'ttimeout' option and | |
| 8266 reset the 'timeout' option. | |
| 8267 | |
| 8268 NOTE: 'ttimeout' is reset when 'compatible' is set. | |
| 8269 | |
| 8270 *'timeoutlen'* *'tm'* | |
| 8271 'timeoutlen' 'tm' number (default 1000) | |
| 8272 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
|
8273 |
| 7 | 8274 *'ttimeoutlen'* *'ttm'* |
|
11400
0f8713fe20dc
Updated runtime files.
Christian Brabandt <cb@256bit.org>
parents:
11262
diff
changeset
|
8275 'ttimeoutlen' 'ttm' number (default -1, set to 100 in |defaults.vim|) |
| 7 | 8276 global |
| 8277 The time in milliseconds that is waited for a key code or mapped key | |
| 8278 sequence to complete. Also used for CTRL-\ CTRL-N and CTRL-\ CTRL-G | |
| 8279 when part of a command has been typed. | |
| 8280 Normally only 'timeoutlen' is used and 'ttimeoutlen' is -1. When a | |
| 8281 different timeout value for key codes is desired set 'ttimeoutlen' to | |
| 8282 a non-negative number. | |
| 8283 | |
| 8284 ttimeoutlen mapping delay key code delay ~ | |
| 8285 < 0 'timeoutlen' 'timeoutlen' | |
| 8286 >= 0 'timeoutlen' 'ttimeoutlen' | |
| 8287 | |
| 8288 The timeout only happens when the 'timeout' and 'ttimeout' options | |
| 8289 tell so. A useful setting would be > | |
| 8290 :set timeout timeoutlen=3000 ttimeoutlen=100 | |
| 8291 < (time out on mapping after three seconds, time out on key codes after | |
| 8292 a tenth of a second). | |
| 8293 | |
| 8294 *'title'* *'notitle'* | |
| 8295 'title' boolean (default off, on when title can be restored) | |
| 8296 global | |
| 8297 When on, the title of the window will be set to the value of | |
| 8298 'titlestring' (if it is not empty), or to: | |
| 8299 filename [+=-] (path) - VIM | |
| 8300 Where: | |
| 8301 filename the name of the file being edited | |
| 8302 - indicates the file cannot be modified, 'ma' off | |
| 8303 + indicates the file was modified | |
| 8304 = indicates the file is read-only | |
| 8305 =+ indicates the file is read-only and modified | |
| 8306 (path) is the path of the file being edited | |
| 8307 - VIM the server name |v:servername| or "VIM" | |
| 8308 Only works if the terminal supports setting window titles | |
| 8309 (currently Amiga console, Win32 console, all GUI versions and | |
| 19968 | 8310 terminals with a non-empty 't_ts' option - these are Unix xterm and |
| 7 | 8311 iris-ansi by default, where 't_ts' is taken from the builtin termcap). |
| 8312 *X11* | |
| 8313 When Vim was compiled with HAVE_X11 defined, the original title will | |
| 8314 be restored if possible. The output of ":version" will include "+X11" | |
| 8315 when HAVE_X11 was defined, otherwise it will be "-X11". This also | |
| 8316 works for the icon name |'icon'|. | |
| 8317 But: When Vim was started with the |-X| argument, restoring the title | |
| 8318 will not work (except in the GUI). | |
| 8319 If the title cannot be restored, it is set to the value of 'titleold'. | |
| 8320 You might want to restore the title outside of Vim then. | |
| 8321 When using an xterm from a remote machine you can use this command: | |
| 8322 rsh machine_name xterm -display $DISPLAY & | |
| 8323 then the WINDOWID environment variable should be inherited and the | |
| 8324 title of the window should change back to what it should be after | |
| 8325 exiting Vim. | |
| 8326 | |
| 8327 *'titlelen'* | |
| 8328 'titlelen' number (default 85) | |
| 8329 global | |
| 8330 Gives the percentage of 'columns' to use for the length of the window | |
| 10 | 8331 title. When the title is longer, only the end of the path name is |
| 8332 shown. A '<' character before the path name is used to indicate this. | |
| 7 | 8333 Using a percentage makes this adapt to the width of the window. But |
| 8334 it won't work perfectly, because the actual number of characters | |
| 8335 available also depends on the font used and other things in the title | |
| 8336 bar. When 'titlelen' is zero the full path is used. Otherwise, | |
| 8337 values from 1 to 30000 percent can be used. | |
| 8338 'titlelen' is also used for the 'titlestring' option. | |
| 8339 | |
| 8340 *'titleold'* | |
| 8341 'titleold' string (default "Thanks for flying Vim") | |
| 8342 global | |
| 8343 This option will be used for the window title when exiting Vim if the | |
| 8344 original title cannot be restored. Only happens if 'title' is on or | |
| 8345 'titlestring' is not empty. | |
| 36 | 8346 This option cannot be set from a |modeline| or in the |sandbox|, for |
| 8347 security reasons. | |
| 7 | 8348 *'titlestring'* |
| 8349 'titlestring' string (default "") | |
| 8350 global | |
| 8351 When this option is not empty, it will be used for the title of the | |
| 8352 window. This happens only when the 'title' option is on. | |
| 8353 Only works if the terminal supports setting window titles (currently | |
| 8354 Amiga console, Win32 console, all GUI versions and terminals with a | |
| 8355 non-empty 't_ts' option). | |
| 8356 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
|
8357 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
|
8358 |
| 7 | 8359 When this option contains printf-style '%' items, they will be |
| 8360 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
|
8361 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
|
8362 |
| 7 | 8363 Example: > |
| 27903 | 8364 :auto BufEnter * let &titlestring = hostname() .. "/" .. expand("%:p") |
| 7 | 8365 :set title titlestring=%<%F%=%l/%L-%P titlelen=70 |
| 8366 < The value of 'titlelen' is used to align items in the middle or right | |
| 8367 of the available space. | |
| 8368 Some people prefer to have the file name first: > | |
| 8369 :set titlestring=%t%(\ %M%)%(\ (%{expand(\"%:~:.:h\")})%)%(\ %a%) | |
| 8370 < Note the use of "%{ }" and an expression to get the path of the file, | |
| 10 | 8371 without the file name. The "%( %)" constructs are used to add a |
| 7 | 8372 separating space only when needed. |
| 8373 NOTE: Use of special characters in 'titlestring' may cause the display | |
| 8374 to be garbled (e.g., when it contains a CR or NL character). | |
| 8375 {not available when compiled without the |+statusline| feature} | |
| 8376 | |
| 8377 *'toolbar'* *'tb'* | |
| 8378 'toolbar' 'tb' string (default "icons,tooltips") | |
| 8379 global | |
| 28379 | 8380 {only for |+GUI_GTK|, |+GUI_Motif| and |+GUI_Photon|} |
| 10 | 8381 The contents of this option controls various toolbar settings. The |
| 7 | 8382 possible values are: |
| 8383 icons Toolbar buttons are shown with icons. | |
| 8384 text Toolbar buttons shown with text. | |
| 8385 horiz Icon and text of a toolbar button are | |
| 10 | 8386 horizontally arranged. {only in GTK+ 2 GUI} |
| 7 | 8387 tooltips Tooltips are active for toolbar buttons. |
| 8388 Tooltips refer to the popup help text which appears after the mouse | |
| 8389 cursor is placed over a toolbar button for a brief moment. | |
| 8390 | |
| 8391 If you want the toolbar to be shown with icons as well as text, do the | |
| 8392 following: > | |
| 8393 :set tb=icons,text | |
| 28379 | 8394 < Motif cannot display icons and text at the same time. They |
| 7 | 8395 will show icons if both are requested. |
| 8396 | |
| 8397 If none of the strings specified in 'toolbar' are valid or if | |
| 8398 'toolbar' is empty, this option is ignored. If you want to disable | |
| 8399 the toolbar, you need to set the 'guioptions' option. For example: > | |
| 8400 :set guioptions-=T | |
| 8401 < Also see |gui-toolbar|. | |
| 8402 | |
| 8403 *'toolbariconsize'* *'tbis'* | |
| 8404 'toolbariconsize' 'tbis' string (default "small") | |
| 8405 global | |
|
10895
c391bfbdb452
Updated runtime files.
Christian Brabandt <cb@256bit.org>
parents:
10734
diff
changeset
|
8406 {only in the GTK+ GUI} |
| 7 | 8407 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
|
8408 tiny Use tiny icons. |
|
da01d5da2cfa
commit https://github.com/vim/vim/commit/77cdfd10382e01cc51f4ba1a9177032351843151
Christian Brabandt <cb@256bit.org>
parents:
8246
diff
changeset
|
8409 small Use small icons (default). |
|
da01d5da2cfa
commit https://github.com/vim/vim/commit/77cdfd10382e01cc51f4ba1a9177032351843151
Christian Brabandt <cb@256bit.org>
parents:
8246
diff
changeset
|
8410 medium Use medium-sized icons. |
|
da01d5da2cfa
commit https://github.com/vim/vim/commit/77cdfd10382e01cc51f4ba1a9177032351843151
Christian Brabandt <cb@256bit.org>
parents:
8246
diff
changeset
|
8411 large Use large icons. |
|
da01d5da2cfa
commit https://github.com/vim/vim/commit/77cdfd10382e01cc51f4ba1a9177032351843151
Christian Brabandt <cb@256bit.org>
parents:
8246
diff
changeset
|
8412 huge Use even larger icons. |
|
da01d5da2cfa
commit https://github.com/vim/vim/commit/77cdfd10382e01cc51f4ba1a9177032351843151
Christian Brabandt <cb@256bit.org>
parents:
8246
diff
changeset
|
8413 giant Use very big icons. |
| 7 | 8414 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
|
8415 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
|
8416 large=24x24, medium=24x24, small=20x20 and tiny=16x16. |
| 7 | 8417 |
| 8418 If 'toolbariconsize' is empty, the global default size as determined | |
| 8419 by user preferences or the current theme is used. | |
| 8420 | |
| 8421 *'ttybuiltin'* *'tbi'* *'nottybuiltin'* *'notbi'* | |
| 8422 'ttybuiltin' 'tbi' boolean (default on) | |
| 8423 global | |
| 8424 When on, the builtin termcaps are searched before the external ones. | |
| 8425 When off the builtin termcaps are searched after the external ones. | |
| 8426 When this option is changed, you should set the 'term' option next for | |
| 8427 the change to take effect, for example: > | |
| 8428 :set notbi term=$TERM | |
| 8429 < See also |termcap|. | |
| 8430 Rationale: The default for this option is "on", because the builtin | |
| 8431 termcap entries are generally better (many systems contain faulty | |
| 8432 xterm entries...). | |
| 8433 | |
| 8434 *'ttyfast'* *'tf'* *'nottyfast'* *'notf'* | |
| 8435 'ttyfast' 'tf' boolean (default off, on when 'term' is xterm, hpterm, | |
| 8436 sun-cmd, screen, rxvt, dtterm or | |
| 8437 iris-ansi; also on when running Vim in | |
| 8438 a DOS console) | |
| 8439 global | |
| 8440 Indicates a fast terminal connection. More characters will be sent to | |
| 8441 the screen for redrawing, instead of using insert/delete line | |
| 8442 commands. Improves smoothness of redrawing when there are multiple | |
| 8443 windows and the terminal does not support a scrolling region. | |
| 8444 Also enables the extra writing of characters at the end of each screen | |
| 8445 line for lines that wrap. This helps when using copy/paste with the | |
| 8446 mouse in an xterm and other terminals. | |
| 8447 | |
| 8448 *'ttymouse'* *'ttym'* | |
| 8449 'ttymouse' 'ttym' string (default depends on 'term') | |
| 8450 global | |
| 8451 {only in Unix and VMS, doesn't work in the GUI; not | |
| 8452 available when compiled without |+mouse|} | |
| 8453 Name of the terminal type for which mouse codes are to be recognized. | |
| 1213 | 8454 Currently these strings are valid: |
| 7 | 8455 *xterm-mouse* |
| 8456 xterm xterm-like mouse handling. The mouse generates | |
| 8457 "<Esc>[Mscr", where "scr" is three bytes: | |
| 8458 "s" = button state | |
| 8459 "c" = column plus 33 | |
| 8460 "r" = row plus 33 | |
| 5908 | 8461 This only works up to 223 columns! See "dec", |
| 8462 "urxvt", and "sgr" for solutions. | |
| 7 | 8463 xterm2 Works like "xterm", but with the xterm reporting the |
| 8464 mouse position while the mouse is dragged. This works | |
| 8465 much faster and more precise. Your xterm must at | |
| 180 | 8466 least at patchlevel 88 / XFree 3.3.3 for this to |
| 7 | 8467 work. See below for how Vim detects this |
| 8468 automatically. | |
| 8469 *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
|
8470 netterm NetTerm mouse handling. A left mouse click generates |
| 7 | 8471 "<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
|
8472 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
|
8473 supported. |
| 7 | 8474 *dec-mouse* |
| 8475 dec DEC terminal mouse handling. The mouse generates a | |
| 8476 rather complex sequence, starting with "<Esc>[". | |
| 189 | 8477 This is also available for an Xterm, if it was |
| 8478 configured with "--enable-dec-locator". | |
| 7 | 8479 *jsbterm-mouse* |
| 8480 jsbterm JSB term mouse handling. | |
| 8481 *pterm-mouse* | |
| 8482 pterm QNX pterm mouse handling. | |
| 3224 | 8483 *urxvt-mouse* |
| 8484 urxvt Mouse handling for the urxvt (rxvt-unicode) terminal. | |
| 5908 | 8485 The mouse works only if the terminal supports this |
| 8486 encoding style, but it does not have 223 columns limit | |
| 8487 unlike "xterm" or "xterm2". | |
| 3750 | 8488 *sgr-mouse* |
| 8489 sgr Mouse handling for the terminal that emits SGR-styled | |
| 5908 | 8490 mouse reporting. The mouse works even in columns |
| 8491 beyond 223. This option is backward compatible with | |
| 8492 "xterm2" because it can also decode "xterm2" style | |
| 8493 mouse codes. | |
| 7 | 8494 |
| 8495 The mouse handling must be enabled at compile time |+mouse_xterm| | |
| 5908 | 8496 |+mouse_dec| |+mouse_netterm| |+mouse_jsbterm| |+mouse_urxvt| |
| 8497 |+mouse_sgr|. | |
| 7 | 8498 Only "xterm"(2) is really recognized. NetTerm mouse codes are always |
| 8499 recognized, if enabled at compile time. DEC terminal mouse codes | |
| 8500 are recognized if enabled at compile time, and 'ttymouse' is not | |
| 5908 | 8501 "xterm", "xterm2", "urxvt" or "sgr" (because dec mouse codes conflict |
| 8502 with them). | |
| 7 | 8503 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
|
8504 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
|
8505 "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
|
8506 already. |
| 5908 | 8507 Additionally, if vim is compiled with the |+termresponse| feature and |
| 8508 |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
|
8509 number, more intelligent detection is done. |
| 7 | 8510 The "xterm2" value will be set if the xterm version is reported to be |
| 15131 | 8511 from 95 to 276. The "sgr" value will be set if Vim detects Mac |
| 8512 Terminal.app, iTerm2 or mintty, and when the xterm version is 277 or | |
| 8513 higher. | |
| 5908 | 8514 If you do not want 'ttymouse' to be set to "xterm2" or "sgr" |
| 8515 automatically, set t_RV to an empty string: > | |
| 7 | 8516 :set t_RV= |
| 8517 < | |
| 8518 *'ttyscroll'* *'tsl'* | |
| 8519 'ttyscroll' 'tsl' number (default 999) | |
| 8520 global | |
| 8521 Maximum number of lines to scroll the screen. If there are more lines | |
| 8522 to scroll the window is redrawn. For terminals where scrolling is | |
| 8523 very slow and redrawing is not slow this can be set to a small number, | |
| 8524 e.g., 3, to speed up displaying. | |
| 8525 | |
| 8526 *'ttytype'* *'tty'* | |
| 8527 'ttytype' 'tty' string (default from $TERM) | |
| 8528 global | |
| 8529 Alias for 'term', see above. | |
| 8530 | |
|
2214
f8222d1f9a73
Included patch for persistent undo. Lots of changes and added test.
Bram Moolenaar <bram@vim.org>
parents:
2209
diff
changeset
|
8531 *'undodir'* *'udir'* |
|
f8222d1f9a73
Included patch for persistent undo. Lots of changes and added test.
Bram Moolenaar <bram@vim.org>
parents:
2209
diff
changeset
|
8532 '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
|
8533 global |
|
2570
71b56b4e7785
Make the references to features in the help more consistent. (Sylvain Hitier)
Bram Moolenaar <bram@vim.org>
parents:
2561
diff
changeset
|
8534 {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
|
8535 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
|
8536 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
|
8537 "." 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
|
8538 "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
|
8539 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
|
8540 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
|
8541 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
|
8542 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
|
8543 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
|
8544 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
|
8545 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
|
8546 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
|
8547 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
|
8548 security reasons. |
|
2214
f8222d1f9a73
Included patch for persistent undo. Lots of changes and added test.
Bram Moolenaar <bram@vim.org>
parents:
2209
diff
changeset
|
8549 |
|
4681
2eb30f341e8d
Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents:
4502
diff
changeset
|
8550 *'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
|
8551 '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
|
8552 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
|
8553 {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
|
8554 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
|
8555 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
|
8556 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
|
8557 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
|
8558 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
|
8559 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
|
8560 before a reload to be saved for undo. |
| 3920 | 8561 When 'undofile' is turned off the undo file is NOT deleted. |
| 11160 | 8562 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
|
8563 |
| 7 | 8564 *'undolevels'* *'ul'* |
| 19116 | 8565 'undolevels' 'ul' number (default 100, 1000 for Unix, VMS and Win32) |
| 5446 | 8566 global or local to buffer |global-local| |
| 7 | 8567 Maximum number of changes that can be undone. Since undo information |
| 18186 | 8568 is kept in memory, higher numbers will cause more memory to be used. |
| 8569 Nevertheless, a single change can already use a large amount of memory. | |
| 7 | 8570 Set to 0 for Vi compatibility: One level of undo and "u" undoes |
| 8571 itself: > | |
| 8572 set ul=0 | |
| 8573 < But you can also get Vi compatibility by including the 'u' flag in | |
| 8574 '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
|
8575 Also see |undo-two-ways|. |
| 5446 | 8576 Set to -1 for no undo at all. You might want to do this only for the |
| 8577 current buffer: > | |
| 8578 setlocal ul=-1 | |
| 7 | 8579 < This helps when you run out of memory for a single change. |
| 6336 | 8580 |
| 8581 The local value is set to -123456 when the global value is to be used. | |
| 8582 | |
|
2249
6d3d35ff2c2b
Use full path in undofile(). Updated docs.
Bram Moolenaar <bram@vim.org>
parents:
2240
diff
changeset
|
8583 Also see |clear-undo|. |
| 7 | 8584 |
|
2394
a3aca345aafa
Add the 'undoreload' option to be able to undo a file reload.
Bram Moolenaar <bram@vim.org>
parents:
2382
diff
changeset
|
8585 *'undoreload'* *'ur'* |
|
a3aca345aafa
Add the 'undoreload' option to be able to undo a file reload.
Bram Moolenaar <bram@vim.org>
parents:
2382
diff
changeset
|
8586 '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
|
8587 global |
|
a3aca345aafa
Add the 'undoreload' option to be able to undo a file reload.
Bram Moolenaar <bram@vim.org>
parents:
2382
diff
changeset
|
8588 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
|
8589 ":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
|
8590 Vim. |FileChangedShell| |
| 12559 | 8591 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
|
8592 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
|
8593 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
|
8594 |
|
a3aca345aafa
Add the 'undoreload' option to be able to undo a file reload.
Bram Moolenaar <bram@vim.org>
parents:
2382
diff
changeset
|
8595 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
|
8596 |
|
a3aca345aafa
Add the 'undoreload' option to be able to undo a file reload.
Bram Moolenaar <bram@vim.org>
parents:
2382
diff
changeset
|
8597 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
|
8598 this option to a lower value if you run out of memory. |
| 7 | 8599 |
| 8600 *'updatecount'* *'uc'* | |
| 8601 'updatecount' 'uc' number (default: 200) | |
| 8602 global | |
| 8603 After typing this many characters the swap file will be written to | |
| 8604 disk. When zero, no swap file will be created at all (see chapter on | |
| 8605 recovery |crash-recovery|). 'updatecount' is set to zero by starting | |
| 8606 Vim with the "-n" option, see |startup|. When editing in readonly | |
| 8607 mode this option will be initialized to 10000. | |
| 8608 The swapfile can be disabled per buffer with |'swapfile'|. | |
| 8609 When 'updatecount' is set from zero to non-zero, swap files are | |
| 8610 created for all buffers that have 'swapfile' set. When 'updatecount' | |
| 8611 is set to zero, existing swap files are not deleted. | |
| 8612 Also see |'swapsync'|. | |
| 8613 This option has no meaning in buffers where |'buftype'| is "nofile" | |
| 8614 or "nowrite". | |
| 8615 | |
| 8616 *'updatetime'* *'ut'* | |
| 8617 'updatetime' 'ut' number (default 4000) | |
| 8618 global | |
| 8619 If this many milliseconds nothing is typed the swap file will be | |
| 8620 written to disk (see |crash-recovery|). Also used for the | |
| 8621 |CursorHold| autocommand event. | |
| 8622 | |
|
14175
2ad722003b36
patch 8.1.0105: all tab stops are the same
Christian Brabandt <cb@256bit.org>
parents:
14019
diff
changeset
|
8623 *'varsofttabstop'* *'vsts'* |
|
2ad722003b36
patch 8.1.0105: all tab stops are the same
Christian Brabandt <cb@256bit.org>
parents:
14019
diff
changeset
|
8624 'varsofttabstop' 'vsts' string (default "") |
|
2ad722003b36
patch 8.1.0105: all tab stops are the same
Christian Brabandt <cb@256bit.org>
parents:
14019
diff
changeset
|
8625 local to buffer |
|
2ad722003b36
patch 8.1.0105: all tab stops are the same
Christian Brabandt <cb@256bit.org>
parents:
14019
diff
changeset
|
8626 {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
|
8627 feature} |
|
2ad722003b36
patch 8.1.0105: all tab stops are the same
Christian Brabandt <cb@256bit.org>
parents:
14019
diff
changeset
|
8628 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
|
8629 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
|
8630 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
|
8631 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
|
8632 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
|
8633 |
|
2ad722003b36
patch 8.1.0105: all tab stops are the same
Christian Brabandt <cb@256bit.org>
parents:
14019
diff
changeset
|
8634 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
|
8635 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
|
8636 to use the following: > |
|
2ad722003b36
patch 8.1.0105: all tab stops are the same
Christian Brabandt <cb@256bit.org>
parents:
14019
diff
changeset
|
8637 :set varsofttabstop=8,32,8 |
|
14249
4543777545a3
Updated runtime and language files.
Christian Brabandt <cb@256bit.org>
parents:
14175
diff
changeset
|
8638 < 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
|
8639 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
|
8640 |
|
2ad722003b36
patch 8.1.0105: all tab stops are the same
Christian Brabandt <cb@256bit.org>
parents:
14019
diff
changeset
|
8641 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
|
8642 'varsofttabstop' is set. |
|
2ad722003b36
patch 8.1.0105: all tab stops are the same
Christian Brabandt <cb@256bit.org>
parents:
14019
diff
changeset
|
8643 |
|
2ad722003b36
patch 8.1.0105: all tab stops are the same
Christian Brabandt <cb@256bit.org>
parents:
14019
diff
changeset
|
8644 *'vartabstop'* *'vts'* |
|
2ad722003b36
patch 8.1.0105: all tab stops are the same
Christian Brabandt <cb@256bit.org>
parents:
14019
diff
changeset
|
8645 'vartabstop' 'vts' string (default "") |
|
2ad722003b36
patch 8.1.0105: all tab stops are the same
Christian Brabandt <cb@256bit.org>
parents:
14019
diff
changeset
|
8646 local to buffer |
|
2ad722003b36
patch 8.1.0105: all tab stops are the same
Christian Brabandt <cb@256bit.org>
parents:
14019
diff
changeset
|
8647 {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
|
8648 feature} |
|
2ad722003b36
patch 8.1.0105: all tab stops are the same
Christian Brabandt <cb@256bit.org>
parents:
14019
diff
changeset
|
8649 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
|
8650 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
|
8651 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
|
8652 :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
|
8653 < 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
|
8654 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
|
8655 |
|
2ad722003b36
patch 8.1.0105: all tab stops are the same
Christian Brabandt <cb@256bit.org>
parents:
14019
diff
changeset
|
8656 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
|
8657 is set. |
|
2ad722003b36
patch 8.1.0105: all tab stops are the same
Christian Brabandt <cb@256bit.org>
parents:
14019
diff
changeset
|
8658 |
| 7 | 8659 *'verbose'* *'vbs'* |
| 8660 'verbose' 'vbs' number (default 0) | |
| 8661 global | |
| 8662 When bigger than zero, Vim will give messages about what it is doing. | |
| 8663 Currently, these messages are given: | |
| 8664 >= 1 When the viminfo file is read or written. | |
| 8665 >= 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
|
8666 >= 4 Shell commands. |
| 712 | 8667 >= 5 Every searched tags file and include file. |
| 7 | 8668 >= 8 Files for which a group of autocommands is executed. |
| 8669 >= 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
|
8670 >= 11 Finding items in a path |
| 7 | 8671 >= 12 Every executed function. |
| 8672 >= 13 When an exception is thrown, caught, finished, or discarded. | |
| 8673 >= 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
|
8674 >= 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
|
8675 characters). |
| 21676 | 8676 >= 16 Every executed Ex command. |
| 7 | 8677 |
| 8678 This option can also be set with the "-V" argument. See |-V|. | |
| 8679 This option is also set by the |:verbose| command. | |
| 8680 | |
| 293 | 8681 When the 'verbosefile' option is set then the verbose messages are not |
| 8682 displayed. | |
| 8683 | |
| 8684 *'verbosefile'* *'vfile'* | |
| 8685 'verbosefile' 'vfile' string (default empty) | |
| 8686 global | |
| 8687 When not empty all messages are written in a file with this name. | |
| 8688 When the file exists messages are appended. | |
| 8689 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
|
8690 empty. Writes are buffered, thus may not show up for some time. |
| 293 | 8691 Setting 'verbosefile' to a new value is like making it empty first. |
| 8692 The difference with |:redir| is that verbose messages are not | |
| 8693 displayed when 'verbosefile' is set. | |
| 8694 | |
| 7 | 8695 *'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
|
8696 'viewdir' 'vdir' string (default for Amiga and Win32: |
| 7 | 8697 "$VIM/vimfiles/view", |
| 8698 for Unix: "~/.vim/view", | |
| 21825 | 8699 for macOS: "$VIM:vimfiles:view" |
| 18972 | 8700 for VMS: "sys$login:vimfiles/view") |
| 7 | 8701 global |
|
2570
71b56b4e7785
Make the references to features in the help more consistent. (Sylvain Hitier)
Bram Moolenaar <bram@vim.org>
parents:
2561
diff
changeset
|
8702 {not available when compiled without the |+mksession| |
| 7 | 8703 feature} |
| 8704 Name of the directory where to store files for |:mkview|. | |
| 8705 This option cannot be set from a |modeline| or in the |sandbox|, for | |
| 8706 security reasons. | |
| 8707 | |
| 8708 *'viewoptions'* *'vop'* | |
|
12824
79a754456110
patch 8.0.1289: mkview always includes the local directory
Christian Brabandt <cb@256bit.org>
parents:
12802
diff
changeset
|
8709 'viewoptions' 'vop' string (default: "folds,options,cursor,curdir") |
| 7 | 8710 global |
|
2570
71b56b4e7785
Make the references to features in the help more consistent. (Sylvain Hitier)
Bram Moolenaar <bram@vim.org>
parents:
2561
diff
changeset
|
8711 {not available when compiled without the |+mksession| |
| 7 | 8712 feature} |
| 28379 | 8713 Changes the effect of the |:mkview| command. It is a comma-separated |
| 10 | 8714 list of words. Each word enables saving and restoring something: |
| 7 | 8715 word save and restore ~ |
| 8716 cursor cursor position in file and in window | |
| 8717 folds manually created folds, opened/closed folds and local | |
| 8718 fold options | |
| 8719 options options and mappings local to a window or buffer (not | |
| 8720 global values for local options) | |
| 6213 | 8721 localoptions same as "options" |
| 7 | 8722 slash backslashes in file names replaced with forward |
| 8723 slashes | |
| 8724 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
|
8725 on MS-Windows |
|
12824
79a754456110
patch 8.0.1289: mkview always includes the local directory
Christian Brabandt <cb@256bit.org>
parents:
12802
diff
changeset
|
8726 curdir the window-local directory, if set with `:lcd` |
| 7 | 8727 |
|
18912
ccd16426a1f9
patch 8.2.0017: OS/2 and MS-DOS are still mentioned
Bram Moolenaar <Bram@vim.org>
parents:
18879
diff
changeset
|
8728 "slash" and "unix" are useful on MS-Windows when sharing view files |
| 7 | 8729 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
|
8730 but the MS-Windows version of Vim can source unix format scripts. |
| 7 | 8731 |
| 8732 *'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
|
8733 '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
|
8734 MS-Windows: '100,<50,s10,h,rA:,rB:, |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
8735 for Amiga: '100,<50,s10,h,rdf0:,rdf1:,rdf2: |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
8736 for others: '100,<50,s10,h) |
| 7 | 8737 global |
|
2570
71b56b4e7785
Make the references to features in the help more consistent. (Sylvain Hitier)
Bram Moolenaar <bram@vim.org>
parents:
2561
diff
changeset
|
8738 {not available when compiled without the |+viminfo| |
| 7 | 8739 feature} |
| 8740 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
|
8741 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
|
8742 "NONE". |
| 28379 | 8743 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
|
8744 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
|
8745 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
|
8746 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
|
8747 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
|
8748 identifying characters and the effect of their value. |
| 7 | 8749 CHAR VALUE ~ |
| 3224 | 8750 *viminfo-!* |
| 7 | 8751 ! When included, save and restore global variables that start |
| 8752 with an uppercase letter, and don't contain a lowercase | |
| 8753 letter. Thus "KEEPTHIS and "K_L_M" are stored, but "KeepThis" | |
| 2607 | 8754 and "_K_L_M" are not. Nested List and Dict items may not be |
| 2642 | 8755 read back correctly, you end up with an empty item. |
| 3224 | 8756 *viminfo-quote* |
| 7 | 8757 " Maximum number of lines saved for each register. Old name of |
| 8758 the '<' item, with the disadvantage that you need to put a | |
| 8759 backslash before the ", otherwise it will be recognized as the | |
| 8760 start of a comment! | |
| 3224 | 8761 *viminfo-%* |
| 7 | 8762 % When included, save and restore the buffer list. If Vim is |
| 8763 started with a file name argument, the buffer list is not | |
| 8764 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
|
8765 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
|
8766 ('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
|
8767 removable media (|viminfo-r|) are not saved. |
| 23 | 8768 When followed by a number, the number specifies the maximum |
| 8769 number of buffers that are stored. Without a number all | |
| 8770 buffers are stored. | |
| 3224 | 8771 *viminfo-'* |
| 7 | 8772 ' Maximum number of previously edited files for which the marks |
| 8773 are remembered. This parameter must always be included when | |
| 8774 'viminfo' is non-empty. | |
| 8775 Including this item also means that the |jumplist| and the | |
| 8776 |changelist| are stored in the viminfo file. | |
| 3224 | 8777 *viminfo-/* |
| 7 | 8778 / Maximum number of items in the search pattern history to be |
| 10 | 8779 saved. If non-zero, then the previous search and substitute |
| 7 | 8780 patterns are also saved. When not included, the value of |
| 8781 'history' is used. | |
| 3224 | 8782 *viminfo-:* |
| 7 | 8783 : Maximum number of items in the command-line history to be |
| 10 | 8784 saved. When not included, the value of 'history' is used. |
| 3224 | 8785 *viminfo-<* |
| 7 | 8786 < Maximum number of lines saved for each register. If zero then |
| 8787 registers are not saved. When not included, all lines are | |
| 8788 saved. '"' is the old name for this item. | |
| 8789 Also see the 's' item below: limit specified in Kbyte. | |
| 3224 | 8790 *viminfo-@* |
| 7 | 8791 @ Maximum number of items in the input-line history to be |
| 10 | 8792 saved. When not included, the value of 'history' is used. |
| 3224 | 8793 *viminfo-c* |
| 7 | 8794 c When included, convert the text in the viminfo file from the |
| 8795 'encoding' used when writing the file to the current | |
| 233 | 8796 'encoding'. See |viminfo-encoding|. |
| 3224 | 8797 *viminfo-f* |
| 7 | 8798 f Whether file marks need to be stored. If zero, file marks ('0 |
| 8799 to '9, 'A to 'Z) are not stored. When not present or when | |
| 10 | 8800 non-zero, they are all stored. '0 is used for the current |
| 7 | 8801 cursor position (when exiting or when doing ":wviminfo"). |
| 3224 | 8802 *viminfo-h* |
| 7 | 8803 h Disable the effect of 'hlsearch' when loading the viminfo |
| 8804 file. When not included, it depends on whether ":nohlsearch" | |
| 8805 has been used since the last search command. | |
| 3224 | 8806 *viminfo-n* |
| 7 | 8807 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
|
8808 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
|
8809 '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
|
8810 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
|
8811 expanded when opening the file, not when setting the option. |
| 3224 | 8812 *viminfo-r* |
| 7 | 8813 r Removable media. The argument is a string (up to the next |
| 8814 ','). This parameter can be given several times. Each | |
| 8815 specifies the start of a path for which no marks will be | |
| 18972 | 8816 stored. This is to avoid removable media. For MS-Windows you |
| 7 | 8817 could use "ra:,rb:", for Amiga "rdf0:,rdf1:,rdf2:". You can |
| 8818 also use it for temp files, e.g., for Unix: "r/tmp". Case is | |
| 8819 ignored. Maximum length of each 'r' argument is 50 | |
| 8820 characters. | |
| 3224 | 8821 *viminfo-s* |
| 7 | 8822 s Maximum size of an item in Kbyte. If zero then registers are |
| 8823 not saved. Currently only applies to registers. The default | |
| 8824 "s10" will exclude registers with more than 10 Kbyte of text. | |
| 8825 Also see the '<' item above: line count limit. | |
| 8826 | |
| 8827 Example: > | |
| 8828 :set viminfo='50,<1000,s100,:0,n~/vim/viminfo | |
| 8829 < | |
| 8830 '50 Marks will be remembered for the last 50 files you | |
| 8831 edited. | |
| 8832 <1000 Contents of registers (up to 1000 lines each) will be | |
| 8833 remembered. | |
| 8834 s100 Registers with more than 100 Kbyte text are skipped. | |
| 8835 :0 Command-line history will not be saved. | |
| 8836 n~/vim/viminfo The name of the file to use is "~/vim/viminfo". | |
| 8837 no / Since '/' is not specified, the default will be used, | |
| 8838 that is, save all of the search history, and also the | |
| 8839 previous search and substitute patterns. | |
| 8840 no % The buffer list will not be saved nor read back. | |
| 8841 no h 'hlsearch' highlighting will be restored. | |
| 8842 | |
| 8843 When setting 'viminfo' from an empty value you can use |:rviminfo| to | |
| 8844 load the contents of the file, this is not done automatically. | |
| 8845 | |
| 8846 This option cannot be set from a |modeline| or in the |sandbox|, for | |
| 8847 security reasons. | |
| 11160 | 8848 NOTE: This option is set to the Vim default value when 'compatible' |
| 8849 is reset. | |
| 7 | 8850 |
|
11666
5cd9ba96561d
patch 8.0.0716: not easy to start Vim cleanly
Christian Brabandt <cb@256bit.org>
parents:
11659
diff
changeset
|
8851 *'viminfofile'* *'vif'* |
|
5cd9ba96561d
patch 8.0.0716: not easy to start Vim cleanly
Christian Brabandt <cb@256bit.org>
parents:
11659
diff
changeset
|
8852 'viminfofile' 'vif' string (default: "") |
|
5cd9ba96561d
patch 8.0.0716: not easy to start Vim cleanly
Christian Brabandt <cb@256bit.org>
parents:
11659
diff
changeset
|
8853 global |
|
5cd9ba96561d
patch 8.0.0716: not easy to start Vim cleanly
Christian Brabandt <cb@256bit.org>
parents:
11659
diff
changeset
|
8854 {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
|
8855 feature} |
|
5cd9ba96561d
patch 8.0.0716: not easy to start Vim cleanly
Christian Brabandt <cb@256bit.org>
parents:
11659
diff
changeset
|
8856 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
|
8857 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
|
8858 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
|
8859 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
|
8860 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
|
8861 security reasons. |
|
11666
5cd9ba96561d
patch 8.0.0716: not easy to start Vim cleanly
Christian Brabandt <cb@256bit.org>
parents:
11659
diff
changeset
|
8862 |
| 7 | 8863 *'virtualedit'* *'ve'* |
| 8864 '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
|
8865 global or local to window |global-local| |
| 28379 | 8866 A comma-separated list of these words: |
| 7 | 8867 block Allow virtual editing in Visual block mode. |
| 8868 insert Allow virtual editing in Insert mode. | |
| 8869 all Allow virtual editing in all modes. | |
| 772 | 8870 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
|
8871 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
|
8872 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
|
8873 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
|
8874 NONE Alternative spelling of "none". |
| 782 | 8875 |
| 7 | 8876 Virtual editing means that the cursor can be positioned where there is |
| 1263 | 8877 no actual character. This can be halfway into a tab or beyond the end |
| 7 | 8878 of the line. Useful for selecting a rectangle in Visual mode and |
| 8879 editing a table. | |
| 772 | 8880 "onemore" is not the same, it will only allow moving the cursor just |
| 8881 after the last character of the line. This makes some commands more | |
| 8882 consistent. Previously the cursor was always past the end of the line | |
| 8883 if the line was empty. But it is far from Vi compatible. It may also | |
| 782 | 8884 break some plugins or Vim scripts. For example because |l| can move |
| 8885 the cursor after the last character. Use with care! | |
| 5220 | 8886 Using the `$` command will move to the last character in the line, not |
| 782 | 8887 past it. This may actually move the cursor to the left! |
| 5220 | 8888 The `g$` command will move to the end of the screen line. |
| 772 | 8889 It doesn't make sense to combine "all" with "onemore", but you will |
| 8890 not get a warning for it. | |
| 25402 | 8891 When combined with other words, "none" is ignored. |
| 11160 | 8892 NOTE: This option is set to "" when 'compatible' is set. |
| 7 | 8893 |
| 8894 *'visualbell'* *'vb'* *'novisualbell'* *'novb'* *beep* | |
| 8895 'visualbell' 'vb' boolean (default off) | |
| 8896 global | |
|
11659
49c12c93abf3
Updated runtime files and translations.
Christian Brabandt <cb@256bit.org>
parents:
11529
diff
changeset
|
8897 Use a visual bell instead of beeping. The terminal code to display the |
| 7 | 8898 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
|
8899 use: > |
|
49c12c93abf3
Updated runtime files and translations.
Christian Brabandt <cb@256bit.org>
parents:
11529
diff
changeset
|
8900 :set vb t_vb= |
|
49c12c93abf3
Updated runtime files and translations.
Christian Brabandt <cb@256bit.org>
parents:
11529
diff
changeset
|
8901 < 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
|
8902 :set vb t_vb=[?5h$<100>[?5l |
|
49c12c93abf3
Updated runtime files and translations.
Christian Brabandt <cb@256bit.org>
parents:
11529
diff
changeset
|
8903 < 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
|
8904 to get a shorter or longer flash. |
|
49c12c93abf3
Updated runtime files and translations.
Christian Brabandt <cb@256bit.org>
parents:
11529
diff
changeset
|
8905 |
|
49c12c93abf3
Updated runtime files and translations.
Christian Brabandt <cb@256bit.org>
parents:
11529
diff
changeset
|
8906 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
|
8907 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
|
8908 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
|
8909 set. |
|
49c12c93abf3
Updated runtime files and translations.
Christian Brabandt <cb@256bit.org>
parents:
11529
diff
changeset
|
8910 |
| 7 | 8911 In the GUI, 't_vb' defaults to "<Esc>|f", which inverts the display |
| 8912 for 20 msec. If you want to use a different time, use "<Esc>|40f", | |
| 8913 where 40 is the time in msec. | |
|
11659
49c12c93abf3
Updated runtime files and translations.
Christian Brabandt <cb@256bit.org>
parents:
11529
diff
changeset
|
8914 |
|
49c12c93abf3
Updated runtime files and translations.
Christian Brabandt <cb@256bit.org>
parents:
11529
diff
changeset
|
8915 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
|
8916 might want to set it again in your |gvimrc|. |
|
49c12c93abf3
Updated runtime files and translations.
Christian Brabandt <cb@256bit.org>
parents:
11529
diff
changeset
|
8917 |
| 7 | 8918 Does not work on the Amiga, you always get a screen flash. |
| 8919 Also see 'errorbells'. | |
| 8920 | |
| 8921 *'warn'* *'nowarn'* | |
| 8922 'warn' boolean (default on) | |
| 8923 global | |
| 8924 Give a warning message when a shell command is used while the buffer | |
| 8925 has been changed. | |
| 8926 | |
| 8927 *'weirdinvert'* *'wiv'* *'noweirdinvert'* *'nowiv'* | |
| 8928 'weirdinvert' 'wiv' boolean (default off) | |
| 8929 global | |
| 667 | 8930 This option has the same effect as the 't_xs' terminal option. |
| 7 | 8931 It is provided for backwards compatibility with version 4.x. |
| 8932 Setting 'weirdinvert' has the effect of making 't_xs' non-empty, and | |
| 8933 vice versa. Has no effect when the GUI is running. | |
| 8934 | |
| 8935 *'whichwrap'* *'ww'* | |
| 8936 'whichwrap' 'ww' string (Vim default: "b,s", Vi default: "") | |
| 8937 global | |
| 8938 Allow specified keys that move the cursor left/right to move to the | |
| 8939 previous/next line when the cursor is on the first/last character in | |
| 8940 the line. Concatenate characters to allow this for these keys: | |
| 8941 char key mode ~ | |
| 8942 b <BS> Normal and Visual | |
| 8943 s <Space> Normal and Visual | |
| 712 | 8944 h "h" Normal and Visual (not recommended) |
| 8945 l "l" Normal and Visual (not recommended) | |
| 7 | 8946 < <Left> Normal and Visual |
| 8947 > <Right> Normal and Visual | |
| 8948 ~ "~" Normal | |
| 8949 [ <Left> Insert and Replace | |
| 8950 ] <Right> Insert and Replace | |
| 8951 For example: > | |
| 8952 :set ww=<,>,[,] | |
| 8953 < allows wrap only when cursor keys are used. | |
| 8954 When the movement keys are used in combination with a delete or change | |
| 8955 operator, the <EOL> also counts for a character. This makes "3h" | |
| 8956 different from "3dh" when the cursor crosses the end of a line. This | |
| 8957 is also true for "x" and "X", because they do the same as "dl" and | |
| 8958 "dh". If you use this, you may also want to use the mapping | |
| 8959 ":map <BS> X" to make backspace delete the character in front of the | |
| 8960 cursor. | |
| 714 | 8961 When 'l' is included and it is used after an operator at the end of a |
| 18130 | 8962 line (not an empty line) then it will not move to the next line. This |
| 8963 makes "dl", "cl", "yl" etc. work normally. | |
| 7 | 8964 NOTE: This option is set to the Vi default value when 'compatible' is |
| 8965 set and to the Vim default value when 'compatible' is reset. | |
| 8966 | |
| 8967 *'wildchar'* *'wc'* | |
| 8968 'wildchar' 'wc' number (Vim default: <Tab>, Vi default: CTRL-E) | |
| 8969 global | |
| 8970 Character you have to type to start wildcard expansion in the | |
| 8971 command-line, as specified with 'wildmode'. | |
| 1621 | 8972 More info here: |cmdline-completion|. |
| 7 | 8973 The character is not recognized when used inside a macro. See |
| 8974 'wildcharm' for that. | |
| 25836 | 8975 Some keys will not work, such as CTRL-C, <CR> and Enter. |
| 7 | 8976 Although 'wc' is a number option, you can set it to a special key: > |
| 25836 | 8977 :set wc=<Tab> |
| 7 | 8978 < NOTE: This option is set to the Vi default value when 'compatible' is |
| 8979 set and to the Vim default value when 'compatible' is reset. | |
| 8980 | |
| 8981 *'wildcharm'* *'wcm'* | |
| 8982 'wildcharm' 'wcm' number (default: none (0)) | |
| 8983 global | |
| 8984 'wildcharm' works exactly like 'wildchar', except that it is | |
| 233 | 8985 recognized when used inside a macro. You can find "spare" command-line |
| 8986 keys suitable for this option by looking at |ex-edit-index|. Normally | |
| 7 | 8987 you'll never actually type 'wildcharm', just use it in mappings that |
| 8988 automatically invoke completion mode, e.g.: > | |
| 8989 :set wcm=<C-Z> | |
| 1621 | 8990 :cnoremap ss so $vim/sessions/*.vim<C-Z> |
| 7 | 8991 < Then after typing :ss you can use CTRL-P & CTRL-N. |
| 8992 | |
| 8993 *'wildignore'* *'wig'* | |
| 8994 'wildignore' 'wig' string (default "") | |
| 8995 global | |
| 8996 {not available when compiled without the |+wildignore| | |
| 8997 feature} | |
| 8998 A list of file patterns. A file that matches with one of these | |
| 3682 | 8999 patterns is ignored when expanding |wildcards|, completing file or |
| 9000 directory names, and influences the result of |expand()|, |glob()| and | |
| 9001 |globpath()| unless a flag is passed to disable this. | |
| 7 | 9002 The pattern is used like with |:autocmd|, see |autocmd-patterns|. |
| 9003 Also see 'suffixes'. | |
| 9004 Example: > | |
| 9005 :set wildignore=*.o,*.obj | |
| 9006 < The use of |:set+=| and |:set-=| is preferred when adding or removing | |
| 9007 a pattern from the list. This avoids problems when a future version | |
| 9008 uses another default. | |
| 9009 | |
| 2652 | 9010 |
| 2662 | 9011 *'wildignorecase'* *'wic'* *'nowildignorecase'* *'nowic'* |
| 2652 | 9012 'wildignorecase' 'wic' boolean (default off) |
| 9013 global | |
| 9014 When set case is ignored when completing file names and directories. | |
| 4242 | 9015 Has no effect when 'fileignorecase' is set. |
| 2652 | 9016 Does not apply when the shell is used to expand wildcards, which |
| 9017 happens when there are special characters. | |
| 9018 | |
| 9019 | |
| 7 | 9020 *'wildmenu'* *'wmnu'* *'nowildmenu'* *'nowmnu'* |
|
9669
284b4eb307fc
commit https://github.com/vim/vim/commit/8c08b5b569e2a9e9f63dea514591ecfa2d3bb392
Christian Brabandt <cb@256bit.org>
parents:
9665
diff
changeset
|
9021 'wildmenu' 'wmnu' boolean (default off, set in |defaults.vim|) |
| 7 | 9022 global |
| 9023 {not available if compiled without the |+wildmenu| | |
| 9024 feature} | |
| 9025 When 'wildmenu' is on, command-line completion operates in an enhanced | |
| 9026 mode. On pressing 'wildchar' (usually <Tab>) to invoke completion, | |
| 9027 the possible matches are shown just above the command line, with the | |
| 9028 first match highlighted (overwriting the status line, if there is | |
|
27597
4eb2bf8b2f27
patch 8.2.4325: 'wildmenu' only shows few matches
Bram Moolenaar <Bram@vim.org>
parents:
27537
diff
changeset
|
9029 one). This is the behavior without "pum" in 'wildoptions. |
|
4eb2bf8b2f27
patch 8.2.4325: 'wildmenu' only shows few matches
Bram Moolenaar <Bram@vim.org>
parents:
27537
diff
changeset
|
9030 Keys that show the previous/next match, such as <Tab> or |
| 7 | 9031 CTRL-P/CTRL-N, cause the highlight to move to the appropriate match. |
| 9032 When 'wildmode' is used, "wildmenu" mode is used where "full" is | |
| 9033 specified. "longest" and "list" do not start "wildmenu" mode. | |
| 4159 | 9034 You can check the current mode with |wildmenumode()|. |
| 7 | 9035 If there are more matches than can fit in the line, a ">" is shown on |
| 9036 the right and/or a "<" is shown on the left. The status line scrolls | |
| 9037 as needed. | |
|
27597
4eb2bf8b2f27
patch 8.2.4325: 'wildmenu' only shows few matches
Bram Moolenaar <Bram@vim.org>
parents:
27537
diff
changeset
|
9038 When 'wildoptions' contains "pum", then the completion matches are |
|
4eb2bf8b2f27
patch 8.2.4325: 'wildmenu' only shows few matches
Bram Moolenaar <Bram@vim.org>
parents:
27537
diff
changeset
|
9039 shown in a popup menu. |
| 7 | 9040 The "wildmenu" mode is abandoned when a key is hit that is not used |
| 9041 for selecting a completion. | |
|
27597
4eb2bf8b2f27
patch 8.2.4325: 'wildmenu' only shows few matches
Bram Moolenaar <Bram@vim.org>
parents:
27537
diff
changeset
|
9042 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
|
9043 following keys have special meanings: |
| 7 | 9044 |
| 9045 <Left> <Right> - select previous/next match (like CTRL-P/CTRL-N) | |
| 9046 <Down> - in filename/menu name completion: move into a | |
| 9047 subdirectory or submenu. | |
| 9048 <CR> - in menu completion, when the cursor is just after a | |
| 9049 dot: move into a submenu. | |
| 9050 <Up> - in filename/menu name completion: move up into | |
| 9051 parent directory or parent menu. | |
| 9052 | |
|
27597
4eb2bf8b2f27
patch 8.2.4325: 'wildmenu' only shows few matches
Bram Moolenaar <Bram@vim.org>
parents:
27537
diff
changeset
|
9053 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
|
9054 keys have special meanings: |
|
4eb2bf8b2f27
patch 8.2.4325: 'wildmenu' only shows few matches
Bram Moolenaar <Bram@vim.org>
parents:
27537
diff
changeset
|
9055 <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
|
9056 <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
|
9057 parent directory or parent menu. |
|
4eb2bf8b2f27
patch 8.2.4325: 'wildmenu' only shows few matches
Bram Moolenaar <Bram@vim.org>
parents:
27537
diff
changeset
|
9058 <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
|
9059 subdirectory or submenu. |
|
4eb2bf8b2f27
patch 8.2.4325: 'wildmenu' only shows few matches
Bram Moolenaar <Bram@vim.org>
parents:
27537
diff
changeset
|
9060 <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
|
9061 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
|
9062 selecting a match. |
|
4eb2bf8b2f27
patch 8.2.4325: 'wildmenu' only shows few matches
Bram Moolenaar <Bram@vim.org>
parents:
27537
diff
changeset
|
9063 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
|
9064 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
|
9065 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
|
9066 completion. |
|
4eb2bf8b2f27
patch 8.2.4325: 'wildmenu' only shows few matches
Bram Moolenaar <Bram@vim.org>
parents:
27537
diff
changeset
|
9067 |
| 7 | 9068 This makes the menus accessible from the console |console-menus|. |
| 9069 | |
| 9070 If you prefer the <Left> and <Right> keys to move the cursor instead | |
| 9071 of selecting a different match, use this: > | |
| 9072 :cnoremap <Left> <Space><BS><Left> | |
| 9073 :cnoremap <Right> <Space><BS><Right> | |
| 9074 < | |
| 9075 The "WildMenu" highlighting is used for displaying the current match | |
| 9076 |hl-WildMenu|. | |
| 9077 | |
| 9078 *'wildmode'* *'wim'* | |
| 9079 'wildmode' 'wim' string (Vim default: "full") | |
| 9080 global | |
| 9081 Completion mode that is used for the character specified with | |
| 28379 | 9082 'wildchar'. It is a comma-separated list of up to four parts. Each |
| 1152 | 9083 part specifies what to do for each consecutive use of 'wildchar'. The |
| 7 | 9084 first part specifies the behavior for the first use of 'wildchar', |
| 9085 The second part for the second use, etc. | |
| 24387 | 9086 |
| 9087 Each part consists of a colon separated list consisting of the | |
| 9088 following possible values: | |
| 7 | 9089 "" Complete only the first match. |
| 9090 "full" Complete the next full match. After the last match, | |
| 9091 the original string is used and then the first match | |
| 24387 | 9092 again. Will also start 'wildmenu' if it is enabled. |
| 7 | 9093 "longest" Complete till longest common string. If this doesn't |
| 9094 result in a longer string, use the next part. | |
| 24387 | 9095 "list" When more than one match, list all matches. |
| 9096 "lastused" When completing buffer names and more than one buffer | |
| 9097 matches, sort buffers by time last used (other than | |
| 9098 the current buffer). | |
| 9099 When there is only a single match, it is fully completed in all cases. | |
| 9100 | |
| 9101 Examples of useful colon-separated values: | |
| 7 | 9102 "longest:full" Like "longest", but also start 'wildmenu' if it is |
| 24387 | 9103 enabled. Will not complete to the next full match. |
| 7 | 9104 "list:full" When more than one match, list all matches and |
| 9105 complete first match. | |
| 9106 "list:longest" When more than one match, list all matches and | |
| 9107 complete till longest common string. | |
| 24387 | 9108 "list:lastused" When more than one buffer matches, list all matches |
| 9109 and sort buffers by time last used (other than the | |
| 9110 current buffer). | |
| 7 | 9111 |
| 9112 Examples: > | |
| 9113 :set wildmode=full | |
| 233 | 9114 < Complete first full match, next match, etc. (the default) > |
| 7 | 9115 :set wildmode=longest,full |
| 9116 < Complete longest common string, then each full match > | |
| 9117 :set wildmode=list:full | |
| 9118 < List all matches and complete each full match > | |
| 9119 :set wildmode=list,full | |
| 9120 < List all matches without completing, then each full match > | |
| 9121 :set wildmode=longest,list | |
| 9122 < Complete longest common string, then list alternatives. | |
| 1621 | 9123 More info here: |cmdline-completion|. |
| 7 | 9124 |
| 40 | 9125 *'wildoptions'* *'wop'* |
| 9126 'wildoptions' 'wop' string (default "") | |
| 9127 global | |
| 9128 {not available when compiled without the |+wildignore| | |
| 9129 feature} | |
|
27597
4eb2bf8b2f27
patch 8.2.4325: 'wildmenu' only shows few matches
Bram Moolenaar <Bram@vim.org>
parents:
27537
diff
changeset
|
9130 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
|
9131 The following values are supported: |
| 28010 | 9132 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
|
9133 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
|
9134 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
|
9135 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
|
9136 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
|
9137 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
|
9138 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
|
9139 instead wildcard expansion is used. |
|
27597
4eb2bf8b2f27
patch 8.2.4325: 'wildmenu' only shows few matches
Bram Moolenaar <Bram@vim.org>
parents:
27537
diff
changeset
|
9140 pum Display the completion matches using the popupmenu |
|
4eb2bf8b2f27
patch 8.2.4325: 'wildmenu' only shows few matches
Bram Moolenaar <Bram@vim.org>
parents:
27537
diff
changeset
|
9141 in the same style as the |ins-completion-menu|. |
| 40 | 9142 tagfile When using CTRL-D to list matching tags, the kind of |
| 856 | 9143 tag and the file of the tag is listed. Only one match |
| 40 | 9144 is displayed per line. Often used tag kinds are: |
| 9145 d #define | |
| 9146 f function | |
| 9147 | |
| 7 | 9148 *'winaltkeys'* *'wak'* |
| 9149 'winaltkeys' 'wak' string (default "menu") | |
| 9150 global | |
| 9151 {only used in Win32, Motif, GTK and Photon GUI} | |
| 9152 Some GUI versions allow the access to menu entries by using the ALT | |
| 9153 key in combination with a character that appears underlined in the | |
| 9154 menu. This conflicts with the use of the ALT key for mappings and | |
| 9155 entering special characters. This option tells what to do: | |
| 9156 no Don't use ALT keys for menus. ALT key combinations can be | |
| 9157 mapped, but there is no automatic handling. This can then be | |
| 9158 done with the |:simalt| command. | |
| 9159 yes ALT key handling is done by the windowing system. ALT key | |
| 9160 combinations cannot be mapped. | |
| 9161 menu Using ALT in combination with a character that is a menu | |
| 10 | 9162 shortcut key, will be handled by the windowing system. Other |
| 7 | 9163 keys can be mapped. |
| 9164 If the menu is disabled by excluding 'm' from 'guioptions', the ALT | |
| 9165 key is never used for the menu. | |
| 36 | 9166 This option is not used for <F10>; on Win32 and with GTK <F10> will |
| 9167 select the menu, unless it has been mapped. | |
| 7 | 9168 |
|
16778
eda4d65f232c
patch 8.1.1391: no popup window support
Bram Moolenaar <Bram@vim.org>
parents:
16740
diff
changeset
|
9169 *'wincolor'* *'wcr'* |
|
eda4d65f232c
patch 8.1.1391: no popup window support
Bram Moolenaar <Bram@vim.org>
parents:
16740
diff
changeset
|
9170 'wincolor' 'wcr' string (default empty) |
|
eda4d65f232c
patch 8.1.1391: no popup window support
Bram Moolenaar <Bram@vim.org>
parents:
16740
diff
changeset
|
9171 local to window |
|
eda4d65f232c
patch 8.1.1391: no popup window support
Bram Moolenaar <Bram@vim.org>
parents:
16740
diff
changeset
|
9172 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
|
9173 color |hl-Normal|. |
|
eda4d65f232c
patch 8.1.1391: no popup window support
Bram Moolenaar <Bram@vim.org>
parents:
16740
diff
changeset
|
9174 |
| 164 | 9175 *'window'* *'wi'* |
| 9176 'window' 'wi' number (default screen height - 1) | |
| 9177 global | |
| 24278 | 9178 Window height used for |CTRL-F| and |CTRL-B| when there is only one |
| 9179 window and the value is smaller than 'lines' minus one. The screen | |
| 9180 will scroll 'window' minus two lines, with a minimum of one. | |
| 164 | 9181 When 'window' is equal to 'lines' minus one CTRL-F and CTRL-B scroll |
| 9182 in a much smarter way, taking care of wrapping lines. | |
| 9183 When resizing the Vim window, the value is smaller than 1 or more than | |
| 9184 or equal to 'lines' it will be set to 'lines' minus 1. | |
| 24278 | 9185 Note: Do not confuse this with the height of the Vim window, use |
| 9186 'lines' for that. | |
| 164 | 9187 |
| 7 | 9188 *'winheight'* *'wh'* *E591* |
| 9189 'winheight' 'wh' number (default 1) | |
| 9190 global | |
| 9191 Minimal number of lines for the current window. This is not a hard | |
| 10 | 9192 minimum, Vim will use fewer lines if there is not enough room. If the |
| 1621 | 9193 focus goes to a window that is smaller, its size is increased, at the |
| 9194 cost of the height of other windows. | |
| 9195 Set 'winheight' to a small number for normal editing. | |
| 9196 Set it to 999 to make the current window fill most of the screen. | |
| 9197 Other windows will be only 'winminheight' high. This has the drawback | |
| 9198 that ":all" will create only two windows. To avoid "vim -o 1 2 3 4" | |
| 9199 to create only two windows, set the option after startup is done, | |
| 9200 using the |VimEnter| event: > | |
| 9201 au VimEnter * set winheight=999 | |
| 9202 < Minimum value is 1. | |
| 9203 The height is not adjusted after one of the commands that change the | |
| 7 | 9204 height of the current window. |
| 9205 'winheight' applies to the current window. Use 'winminheight' to set | |
| 9206 the minimal height for other windows. | |
| 9207 | |
| 9208 *'winfixheight'* *'wfh'* *'nowinfixheight'* *'nowfh'* | |
| 9209 'winfixheight' 'wfh' boolean (default off) | |
| 9210 local to window | |
| 9211 Keep the window height when windows are opened or closed and | |
| 1152 | 9212 'equalalways' is set. Also for |CTRL-W_=|. Set by default for the |
| 9213 |preview-window| and |quickfix-window|. | |
| 7 | 9214 The height may be changed anyway when running out of room. |
| 9215 | |
| 782 | 9216 *'winfixwidth'* *'wfw'* *'nowinfixwidth'* *'nowfw'* |
| 9217 'winfixwidth' 'wfw' boolean (default off) | |
| 9218 local to window | |
| 9219 Keep the window width when windows are opened or closed and | |
| 1152 | 9220 'equalalways' is set. Also for |CTRL-W_=|. |
| 782 | 9221 The width may be changed anyway when running out of room. |
| 9222 | |
| 7 | 9223 *'winminheight'* *'wmh'* |
| 9224 'winminheight' 'wmh' number (default 1) | |
| 9225 global | |
| 9226 The minimal height of a window, when it's not the current window. | |
| 9227 This is a hard minimum, windows will never become smaller. | |
| 9228 When set to zero, windows may be "squashed" to zero lines (i.e. just a | |
| 9229 status bar) if necessary. They will return to at least one line when | |
| 9230 they become active (since the cursor has to have somewhere to go.) | |
| 9231 Use 'winheight' to set the minimal height of the current window. | |
| 9232 This option is only checked when making a window smaller. Don't use a | |
| 9233 large number, it will cause errors when opening more than a few | |
| 9234 windows. A value of 0 to 3 is reasonable. | |
| 9235 | |
| 9236 *'winminwidth'* *'wmw'* | |
| 9237 'winminwidth' 'wmw' number (default 1) | |
| 9238 global | |
| 9239 The minimal width of a window, when it's not the current window. | |
| 9240 This is a hard minimum, windows will never become smaller. | |
| 9241 When set to zero, windows may be "squashed" to zero columns (i.e. just | |
| 9242 a vertical separator) if necessary. They will return to at least one | |
| 9243 line when they become active (since the cursor has to have somewhere | |
| 9244 to go.) | |
| 9245 Use 'winwidth' to set the minimal width of the current window. | |
| 9246 This option is only checked when making a window smaller. Don't use a | |
| 9247 large number, it will cause errors when opening more than a few | |
| 9248 windows. A value of 0 to 12 is reasonable. | |
| 9249 | |
|
12138
bee3751f3d4e
patch 8.0.0949: winpty.dll name is fixed
Christian Brabandt <cb@256bit.org>
parents:
11914
diff
changeset
|
9250 *'winptydll'* |
|
bee3751f3d4e
patch 8.0.0949: winpty.dll name is fixed
Christian Brabandt <cb@256bit.org>
parents:
11914
diff
changeset
|
9251 '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
|
9252 global |
|
bee3751f3d4e
patch 8.0.0949: winpty.dll name is fixed
Christian Brabandt <cb@256bit.org>
parents:
11914
diff
changeset
|
9253 {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
|
9254 feature on MS-Windows} |
|
bee3751f3d4e
patch 8.0.0949: winpty.dll name is fixed
Christian Brabandt <cb@256bit.org>
parents:
11914
diff
changeset
|
9255 Specifies the name of the winpty shared library, used for the |
| 21676 | 9256 |:terminal| command. The default depends on whether Vim was built as a |
| 12254 | 9257 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
|
9258 a fallback. |
|
bee3751f3d4e
patch 8.0.0949: winpty.dll name is fixed
Christian Brabandt <cb@256bit.org>
parents:
11914
diff
changeset
|
9259 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
|
9260 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
|
9261 security reasons. |
|
bee3751f3d4e
patch 8.0.0949: winpty.dll name is fixed
Christian Brabandt <cb@256bit.org>
parents:
11914
diff
changeset
|
9262 |
| 7 | 9263 *'winwidth'* *'wiw'* *E592* |
| 9264 'winwidth' 'wiw' number (default 20) | |
| 9265 global | |
| 9266 Minimal number of columns for the current window. This is not a hard | |
| 9267 minimum, Vim will use fewer columns if there is not enough room. If | |
| 9268 the current window is smaller, its size is increased, at the cost of | |
| 9269 the width of other windows. Set it to 999 to make the current window | |
| 9270 always fill the screen. Set it to a small number for normal editing. | |
| 9271 The width is not adjusted after one of the commands to change the | |
| 9272 width of the current window. | |
| 9273 'winwidth' applies to the current window. Use 'winminwidth' to set | |
| 9274 the minimal width for other windows. | |
| 9275 | |
| 9276 *'wrap'* *'nowrap'* | |
| 9277 'wrap' boolean (default on) | |
| 9278 local to window | |
| 9279 This option changes how text is displayed. It doesn't change the text | |
| 9280 in the buffer, see 'textwidth' for that. | |
| 9281 When on, lines longer than the width of the window will wrap and | |
| 10 | 9282 displaying continues on the next line. When off lines will not wrap |
| 9283 and only part of long lines will be displayed. When the cursor is | |
| 7 | 9284 moved to a part that is not shown, the screen will scroll |
| 9285 horizontally. | |
| 9286 The line will be broken in the middle of a word if necessary. See | |
| 9287 'linebreak' to get the break at a word boundary. | |
| 9288 To make scrolling horizontally a bit more useful, try this: > | |
| 9289 :set sidescroll=5 | |
| 9290 :set listchars+=precedes:<,extends:> | |
| 9291 < See 'sidescroll', 'listchars' and |wrap-off|. | |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
9292 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
|
9293 on. |
| 7 | 9294 |
| 9295 *'wrapmargin'* *'wm'* | |
| 9296 'wrapmargin' 'wm' number (default 0) | |
| 9297 local to buffer | |
| 9298 Number of characters from the right window border where wrapping | |
| 9299 starts. When typing text beyond this limit, an <EOL> will be inserted | |
| 9300 and inserting continues on the next line. | |
| 9301 Options that add a margin, such as 'number' and 'foldcolumn', cause | |
| 9302 the text width to be further reduced. This is Vi compatible. | |
| 9303 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
|
9304 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
|
9305 is reset. |
| 16610 | 9306 See also 'formatoptions' and |ins-textwidth|. |
| 7 | 9307 |
| 9308 *'wrapscan'* *'ws'* *'nowrapscan'* *'nows'* | |
| 9309 'wrapscan' 'ws' boolean (default on) *E384* *E385* | |
| 9310 global | |
| 500 | 9311 Searches wrap around the end of the file. Also applies to |]s| and |
| 9312 |[s|, searching for spelling mistakes. | |
| 7 | 9313 |
| 9314 *'write'* *'nowrite'* | |
| 9315 'write' boolean (default on) | |
| 9316 global | |
| 9317 Allows writing files. When not set, writing a file is not allowed. | |
| 9318 Can be used for a view-only mode, where modifications to the text are | |
| 10 | 9319 still allowed. Can be reset with the |-m| or |-M| command line |
| 7 | 9320 argument. Filtering text is still possible, even though this requires |
| 9321 writing a temporary file. | |
| 9322 | |
| 9323 *'writeany'* *'wa'* *'nowriteany'* *'nowa'* | |
| 9324 'writeany' 'wa' boolean (default off) | |
| 9325 global | |
| 9326 Allows writing to any file with no need for "!" override. | |
| 9327 | |
| 9328 *'writebackup'* *'wb'* *'nowritebackup'* *'nowb'* | |
| 9329 'writebackup' 'wb' boolean (default on with |+writebackup| feature, off | |
| 9330 otherwise) | |
| 9331 global | |
| 9332 Make a backup before overwriting a file. The backup is removed after | |
| 9333 the file was successfully written, unless the 'backup' option is | |
| 3513 | 9334 also on. |
| 9335 WARNING: Switching this option off means that when Vim fails to write | |
| 9336 your buffer correctly and then, for whatever reason, Vim exits, you | |
| 9337 lose both the original file and what you were writing. Only reset | |
| 9338 this option if your file system is almost full and it makes the write | |
| 9339 fail (and make sure not to exit Vim until the write was successful). | |
| 9340 See |backup-table| for another explanation. | |
| 7 | 9341 When the 'backupskip' pattern matches, a backup is not made anyway. |
| 18719 | 9342 Depending on 'backupcopy' the backup is a new file or the original |
| 9343 file renamed (and a new file is written). | |
| 7 | 9344 NOTE: This option is set to the default value when 'compatible' is |
| 9345 set. | |
| 9346 | |
| 9347 *'writedelay'* *'wd'* | |
| 9348 'writedelay' 'wd' number (default 0) | |
| 9349 global | |
|
9344
33c1b85d408c
commit https://github.com/vim/vim/commit/802a0d902fca423acb15f835d7b09183883d79a0
Christian Brabandt <cb@256bit.org>
parents:
9286
diff
changeset
|
9350 The number of milliseconds to wait for each character sent to the |
| 7 | 9351 screen. When non-zero, characters are sent to the terminal one by |
| 18972 | 9352 one. For debugging purposes. |
| 7 | 9353 |
|
26670
a77b661439f9
patch 8.2.3864: cannot disable requesting key codes from xterm
Bram Moolenaar <Bram@vim.org>
parents:
26508
diff
changeset
|
9354 *'xtermcodes'* *'noxtermcodes'* |
|
a77b661439f9
patch 8.2.3864: cannot disable requesting key codes from xterm
Bram Moolenaar <Bram@vim.org>
parents:
26508
diff
changeset
|
9355 '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
|
9356 global |
|
a77b661439f9
patch 8.2.3864: cannot disable requesting key codes from xterm
Bram Moolenaar <Bram@vim.org>
parents:
26508
diff
changeset
|
9357 When detecting xterm patchlevel 141 or higher with the termresponse |
| 26708 | 9358 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
|
9359 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
|
9360 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
|
9361 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
|
9362 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
|
9363 display. |
|
a77b661439f9
patch 8.2.3864: cannot disable requesting key codes from xterm
Bram Moolenaar <Bram@vim.org>
parents:
26508
diff
changeset
|
9364 |
|
a77b661439f9
patch 8.2.3864: cannot disable requesting key codes from xterm
Bram Moolenaar <Bram@vim.org>
parents:
26508
diff
changeset
|
9365 |
| 14421 | 9366 vim:tw=78:ts=8:noet:ft=help:norl: |