Mercurial > vim
annotate runtime/doc/options.txt @ 31285:76acee969543 v9.0.0976
patch 9.0.0976: enabling the kitty keyboard protocol uses push/pop
Commit: https://github.com/vim/vim/commit/a87749e3eae3f918b6678f45cf975f0cf06d3e97
Author: Bram Moolenaar <Bram@vim.org>
Date: Wed Nov 30 10:23:17 2022 +0000
patch 9.0.0976: enabling the kitty keyboard protocol uses push/pop
Problem: Enabling the kitty keyboard protocol uses push/pop.
Solution: Use the start/stop codes to avoid unpredictable behavior.
author | Bram Moolenaar <Bram@vim.org> |
---|---|
date | Wed, 30 Nov 2022 11:30:05 +0100 |
parents | 5b71c3884a2a |
children | 15c80d8bc515 |
rev | line source |
---|---|
31200 | 1 *options.txt* For Vim version 9.0. Last change: 2022 Nov 23 |
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 | |
29779 | 802 or selected. When a buffer has no name it also has no directory, thus |
803 the current directory won't change when navigating to it. | |
819 | 804 Note: When this option is on some plugins may not work. |
7 | 805 |
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
|
806 *'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
|
807 '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
|
808 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
|
809 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
|
810 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
|
811 need proper setting-up, so whenever the shell's pwd changes an OSC 7 |
29659 | 812 escape sequence will be emitted. For example, on Linux, you can |
813 source /etc/profile.d/vte.sh in your shell profile if you use bash or | |
814 zsh. For bash this should work (put it in a bash init file): > | |
815 if [[ -n "$VIM_TERMINAL" ]]; then | |
816 PROMPT_COMMAND='_vim_sync_PWD' | |
817 function _vim_sync_PWD() { | |
29756 | 818 printf '\033]7;file://%s\033\\' "$PWD" |
29659 | 819 } |
820 fi | |
821 < | |
822 Or, in a zsh init file: > | |
823 if [[ -n "$VIM_TERMINAL" ]]; then | |
824 autoload -Uz add-zsh-hook | |
825 add-zsh-hook -Uz chpwd _vim_sync_PWD | |
826 function _vim_sync_PWD() { | |
29756 | 827 printf '\033]7;file://%s\033\\' "$PWD" |
29659 | 828 } |
829 fi | |
830 < | |
831 In a fish init file: > | |
832 if test -n "$VIM_TERMINAL" | |
833 function _vim_sync_PWD --on-variable=PWD | |
29756 | 834 printf '\033]7;file://%s\033\\' "$PWD" |
29659 | 835 end |
836 end | |
837 < | |
838 You can find an alternative method at |terminal-autoshelldir|. | |
27537 | 839 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
|
840 |
7 | 841 *'arabic'* *'arab'* *'noarabic'* *'noarab'* |
842 'arabic' 'arab' boolean (default off) | |
843 local to window | |
844 {only available when compiled with the |+arabic| | |
845 feature} | |
846 This option can be set to start editing Arabic text. | |
847 Setting this option will: | |
848 - Set the 'rightleft' option, unless 'termbidi' is set. | |
849 - Set the 'arabicshape' option, unless 'termbidi' is set. | |
850 - Set the 'keymap' option to "arabic"; in Insert mode CTRL-^ toggles | |
851 between typing English and Arabic key mapping. | |
852 - Set the 'delcombine' option | |
853 Note that 'encoding' must be "utf-8" for working with Arabic text. | |
854 | |
855 Resetting this option will: | |
856 - Reset the 'rightleft' option. | |
857 - Disable the use of 'keymap' (without changing its value). | |
858 Note that 'arabicshape' and 'delcombine' are not reset (it is a global | |
3557 | 859 option). |
11160 | 860 NOTE: This option is reset when 'compatible' is set. |
7 | 861 Also see |arabic.txt|. |
862 | |
863 *'arabicshape'* *'arshape'* | |
864 *'noarabicshape'* *'noarshape'* | |
865 'arabicshape' 'arshape' boolean (default on) | |
866 global | |
867 {only available when compiled with the |+arabic| | |
868 feature} | |
869 When on and 'termbidi' is off, the required visual character | |
870 corrections that need to take place for displaying the Arabic language | |
3893 | 871 take effect. Shaping, in essence, gets enabled; the term is a broad |
7 | 872 one which encompasses: |
873 a) the changing/morphing of characters based on their location | |
874 within a word (initial, medial, final and stand-alone). | |
875 b) the enabling of the ability to compose characters | |
876 c) the enabling of the required combining of some characters | |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
877 When disabled the display shows each character's true stand-alone |
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
878 form. |
7 | 879 Arabic is a complex language which requires other settings, for |
880 further details see |arabic.txt|. | |
11160 | 881 NOTE: This option is set when 'compatible' is set. |
7 | 882 |
883 *'autoindent'* *'ai'* *'noautoindent'* *'noai'* | |
884 'autoindent' 'ai' boolean (default off) | |
885 local to buffer | |
886 Copy indent from current line when starting a new line (typing <CR> | |
887 in Insert mode or when using the "o" or "O" command). If you do not | |
888 type anything on the new line except <BS> or CTRL-D and then type | |
1152 | 889 <Esc>, CTRL-O or <CR>, the indent is deleted again. Moving the cursor |
890 to another line has the same effect, unless the 'I' flag is included | |
891 in 'cpoptions'. | |
10 | 892 When autoindent is on, formatting (with the "gq" command or when you |
893 reach 'textwidth' in Insert mode) uses the indentation of the first | |
894 line. | |
7 | 895 When 'smartindent' or 'cindent' is on the indent is changed in |
896 a different way. | |
7147
c590de398af9
commit https://github.com/vim/vim/commit/ca63501fbcd1cf9c8aa9ff12c093c95b62a89ed7
Christian Brabandt <cb@256bit.org>
parents:
7080
diff
changeset
|
897 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
|
898 restored when 'paste' is reset. |
7 | 899 |
900 *'autoread'* *'ar'* *'noautoread'* *'noar'* | |
901 'autoread' 'ar' boolean (default off) | |
902 global or local to buffer |global-local| | |
903 When a file has been detected to have been changed outside of Vim and | |
904 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
|
905 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
|
906 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
|
907 |timestamp| |
7 | 908 If this option has a local value, use this command to switch back to |
909 using the global value: > | |
910 :set autoread< | |
911 < | |
912 *'autowrite'* *'aw'* *'noautowrite'* *'noaw'* | |
913 'autowrite' 'aw' boolean (default off) | |
914 global | |
915 Write the contents of the file, if it has been modified, on each | |
26438 | 916 `:next`, `:rewind`, `:last`, `:first`, `:previous`, `:stop`, |
27036 | 917 `:suspend`, `:tag`, `:!`, `:make`, CTRL-] and CTRL-^ command; and when |
918 a `:buffer`, CTRL-O, CTRL-I, '{A-Z0-9}, or `{A-Z0-9} command takes one | |
26438 | 919 to another file. |
920 A buffer is not written if it becomes hidden, e.g. when 'bufhidden' is | |
27036 | 921 set to "hide" and `:next` is used. |
7 | 922 Note that for some commands the 'autowrite' option is not used, see |
923 'autowriteall' for that. | |
14695 | 924 Some buffers will not be written, specifically when 'buftype' is |
14668 | 925 "nowrite", "nofile", "terminal" or "prompt". |
7 | 926 |
927 *'autowriteall'* *'awa'* *'noautowriteall'* *'noawa'* | |
928 'autowriteall' 'awa' boolean (default off) | |
929 global | |
930 Like 'autowrite', but also used for commands ":edit", ":enew", ":quit", | |
931 ":qall", ":exit", ":xit", ":recover" and closing the Vim window. | |
932 Setting this option also implies that Vim behaves like 'autowrite' has | |
933 been set. | |
934 | |
935 *'background'* *'bg'* | |
2826 | 936 'background' 'bg' string (default "dark" or "light", see below) |
7 | 937 global |
938 When set to "dark", Vim will try to use colors that look good on a | |
939 dark background. When set to "light", Vim will try to use colors that | |
940 look good on a light background. Any other value is illegal. | |
941 Vim tries to set the default value according to the terminal used. | |
942 This will not always be correct. | |
943 Setting this option does not change the background color, it tells Vim | |
944 what the background color looks like. For changing the background | |
945 color, see |:hi-normal|. | |
946 | |
947 When 'background' is set Vim will adjust the default color groups for | |
10 | 948 the new value. But the colors used for syntax highlighting will not |
1621 | 949 change. *g:colors_name* |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
950 When a color scheme is loaded (the "g:colors_name" variable is set) |
7 | 951 setting 'background' will cause the color scheme to be reloaded. If |
952 the color scheme adjusts to the value of 'background' this will work. | |
953 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
|
954 be undone. First delete the "g:colors_name" variable when needed. |
7 | 955 |
956 When setting 'background' to the default value with: > | |
957 :set background& | |
958 < Vim will guess the value. In the GUI this should work correctly, | |
959 in other cases Vim might not be able to guess the right value. | |
18343 | 960 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
|
961 'guioptions', see 'go-d'. |
7 | 962 |
12499 | 963 When the |t_RB| option is set, Vim will use it to request the background |
11442 | 964 color from the terminal. If the returned RGB value is dark/light and |
965 'background' is not dark/light, 'background' will be set and the | |
966 screen is redrawn. This may have side effects, make t_BG empty in | |
12499 | 967 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
|
968 be found in |v:termrbgresp|. |
11442 | 969 |
7 | 970 When starting the GUI, the default value for 'background' will be |
971 "light". When the value is not set in the .gvimrc, and Vim detects | |
972 that the background is actually quite dark, 'background' is set to | |
973 "dark". But this happens only AFTER the .gvimrc file has been read | |
974 (because the window needs to be opened to find the actual background | |
975 color). To get around this, force the GUI window to be opened by | |
976 putting a ":gui" command in the .gvimrc file, before where the value | |
977 of 'background' is used (e.g., before ":syntax on"). | |
2826 | 978 |
18912
ccd16426a1f9
patch 8.2.0017: OS/2 and MS-DOS are still mentioned
Bram Moolenaar <Bram@vim.org>
parents:
18879
diff
changeset
|
979 For MS-Windows the default is "dark". |
2826 | 980 For other systems "dark" is used when 'term' is "linux", |
981 "screen.linux", "cygwin" or "putty", or $COLORFGBG suggests a dark | |
982 background. Otherwise the default is "light". | |
983 | |
12254 | 984 The |:terminal| command and the |term_start()| function use the |
985 'background' value to decide whether the terminal window will start | |
986 with a white or black background. | |
987 | |
7 | 988 Normally this option would be set in the .vimrc file. Possibly |
989 depending on the terminal name. Example: > | |
990 :if &term == "pcterm" | |
991 : set background=dark | |
992 :endif | |
993 < When this option is set, the default settings for the highlight groups | |
994 will change. To use other settings, place ":highlight" commands AFTER | |
995 the setting of the 'background' option. | |
996 This option is also used in the "$VIMRUNTIME/syntax/syntax.vim" file | |
997 to select the colors for syntax highlighting. After changing this | |
998 option, you must load syntax.vim again to see the result. This can be | |
999 done with ":syntax on". | |
1000 | |
1001 *'backspace'* *'bs'* | |
9669
284b4eb307fc
commit https://github.com/vim/vim/commit/8c08b5b569e2a9e9f63dea514591ecfa2d3bb392
Christian Brabandt <cb@256bit.org>
parents:
9665
diff
changeset
|
1002 '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
|
1003 in |defaults.vim|) |
7 | 1004 global |
1005 Influences the working of <BS>, <Del>, CTRL-W and CTRL-U in Insert | |
1006 mode. This is a list of items, separated by commas. Each item allows | |
1007 a way to backspace over something: | |
1008 value effect ~ | |
1009 indent allow backspacing over autoindent | |
1010 eol allow backspacing over line breaks (join lines) | |
1011 start allow backspacing over the start of insert; CTRL-W and CTRL-U | |
1012 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
|
1013 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
|
1014 insert. |
7 | 1015 |
28246 | 1016 When the value is empty, Vi compatible backspacing is used, none of |
1017 the ways mentioned for the items above are possible. | |
7 | 1018 |
1019 For backwards compatibility with version 5.4 and earlier: | |
1020 value effect ~ | |
1021 0 same as ":set backspace=" (Vi compatible) | |
1022 1 same as ":set backspace=indent,eol" | |
1023 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
|
1024 3 same as ":set backspace=indent,eol,nostop" |
7 | 1025 |
1026 See |:fixdel| if your <BS> or <Del> key does not do what you want. | |
1027 NOTE: This option is set to "" when 'compatible' is set. | |
1028 | |
1029 *'backup'* *'bk'* *'nobackup'* *'nobk'* | |
1030 'backup' 'bk' boolean (default off) | |
1031 global | |
1032 Make a backup before overwriting a file. Leave it around after the | |
1033 file has been successfully written. If you do not want to keep the | |
1034 backup file, but you do want a backup while the file is being | |
1035 written, reset this option and set the 'writebackup' option (this is | |
1036 the default). If you do not want a backup file at all reset both | |
10 | 1037 options (use this if your file system is almost full). See the |
7 | 1038 |backup-table| for more explanations. |
1039 When the 'backupskip' pattern matches, a backup is not made anyway. | |
1040 When 'patchmode' is set, the backup may be renamed to become the | |
1041 oldest version of a file. | |
1042 NOTE: This option is reset when 'compatible' is set. | |
1043 | |
1044 *'backupcopy'* *'bkc'* | |
1045 'backupcopy' 'bkc' string (Vi default for Unix: "yes", otherwise: "auto") | |
6243 | 1046 global or local to buffer |global-local| |
7 | 1047 When writing a file and a backup is made, this option tells how it's |
28379 | 1048 done. This is a comma-separated list of words. |
7 | 1049 |
1050 The main values are: | |
1051 "yes" make a copy of the file and overwrite the original one | |
1052 "no" rename the file and write a new one | |
1053 "auto" one of the previous, what works best | |
1054 | |
1055 Extra values that can be combined with the ones above are: | |
1056 "breaksymlink" always break symlinks when writing | |
1057 "breakhardlink" always break hardlinks when writing | |
1058 | |
1059 Making a copy and overwriting the original file: | |
1060 - Takes extra time to copy the file. | |
1061 + When the file has special attributes, is a (hard/symbolic) link or | |
1062 has a resource fork, all this is preserved. | |
1063 - When the file is a link the backup will have the name of the link, | |
1064 not of the real file. | |
1065 | |
1066 Renaming the file and writing a new one: | |
1067 + It's fast. | |
1068 - Sometimes not all attributes of the file can be copied to the new | |
1069 file. | |
1070 - When the file is a link the new file will not be a link. | |
1071 | |
28379 | 1072 The "auto" value is the middle way: When Vim sees that renaming the |
1073 file is possible without side effects (the attributes can be passed on | |
1074 and the file is not a link) that is used. When problems are expected, | |
1075 a copy will be made. | |
7 | 1076 |
1077 The "breaksymlink" and "breakhardlink" values can be used in | |
1078 combination with any of "yes", "no" and "auto". When included, they | |
1079 force Vim to always break either symbolic or hard links by doing | |
1080 exactly what the "no" option does, renaming the original file to | |
1081 become the backup and writing a new file in its place. This can be | |
1082 useful for example in source trees where all the files are symbolic or | |
1083 hard links and any changes should stay in the local source tree, not | |
1084 be propagated back to the original source. | |
1085 *crontab* | |
1086 One situation where "no" and "auto" will cause problems: A program | |
1087 that opens a file, invokes Vim to edit that file, and then tests if | |
1088 the open file was changed (through the file descriptor) will check the | |
10 | 1089 backup file instead of the newly created file. "crontab -e" is an |
7 | 1090 example. |
1091 | |
1092 When a copy is made, the original file is truncated and then filled | |
1093 with the new text. This means that protection bits, owner and | |
28379 | 1094 symbolic links of the original file are unmodified. The backup file, |
10 | 1095 however, is a new file, owned by the user who edited the file. The |
7 | 1096 group of the backup is set to the group of the original file. If this |
1097 fails, the protection bits for the group are made the same as for | |
1098 others. | |
1099 | |
28379 | 1100 When the file is renamed, this is the other way around: The backup has |
7 | 1101 the same attributes of the original file, and the newly written file |
1102 is owned by the current user. When the file was a (hard/symbolic) | |
1103 link, the new file will not! That's why the "auto" value doesn't | |
1104 rename when the file is a link. The owner and group of the newly | |
1105 written file will be set to the same ones as the original file, but | |
1106 the system may refuse to do this. In that case the "auto" value will | |
1107 again not rename the file. | |
1108 | |
11160 | 1109 NOTE: This option is set to the Vi default value when 'compatible' is |
1110 set and to the Vim default value when 'compatible' is reset. | |
1111 | |
7 | 1112 *'backupdir'* *'bdir'* |
1113 'backupdir' 'bdir' string (default for Amiga: ".,t:", | |
18972 | 1114 for Win32: ".,$TEMP,c:/tmp,c:/temp" |
7 | 1115 for Unix: ".,~/tmp,~/") |
1116 global | |
1117 List of directories for the backup file, separated with commas. | |
1118 - 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
|
1119 where this is possible. The directory must exist, Vim will not |
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
1120 create it for you. |
8629
54ac275e3fc4
commit https://github.com/vim/vim/commit/3848e00e0177abdb31bc600234967863ec487233
Christian Brabandt <cb@256bit.org>
parents:
8560
diff
changeset
|
1121 - Empty means that no backup file will be created ('patchmode' is |
7 | 1122 impossible!). Writing may fail because of this. |
1123 - A directory "." means to put the backup file in the same directory | |
1124 as the edited file. | |
19116 | 1125 - A directory starting with "./" (or ".\" for MS-Windows) means to put |
1126 the backup file relative to where the edited file is. The leading | |
1127 "." is replaced with the path name of the edited file. | |
7 | 1128 ("." inside a directory name has no special meaning). |
1129 - Spaces after the comma are ignored, other spaces are considered part | |
1130 of the directory name. To have a space at the start of a directory | |
1131 name, precede it with a backslash. | |
1132 - To include a comma in a directory name precede it with a backslash. | |
1133 - 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
|
1134 - For Unix and Win32, if a directory ends in two path separators "//", |
15033 | 1135 the backup file name will be built from the complete path to the |
1136 file with all path separators changed to percent '%' signs. This | |
1137 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
|
1138 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
|
1139 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
|
1140 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
|
1141 use '//', instead of '\\'. |
7 | 1142 - Environment variables are expanded |:set_env|. |
1143 - Careful with '\' characters, type one before a space, type two to | |
1144 get one in the option (see |option-backslash|), for example: > | |
1145 :set bdir=c:\\tmp,\ dir\\,with\\,commas,\\\ dir\ with\ spaces | |
1146 < - For backwards compatibility with Vim version 3.0 a '>' at the start | |
1147 of the option is removed. | |
1148 See also 'backup' and 'writebackup' options. | |
1149 If you want to hide your backup files on Unix, consider this value: > | |
1150 :set backupdir=./.backup,~/.backup,.,/tmp | |
1151 < You must create a ".backup" directory in each directory and in your | |
1152 home directory for this to work properly. | |
1153 The use of |:set+=| and |:set-=| is preferred when adding or removing | |
1154 directories from the list. This avoids problems when a future version | |
1155 uses another default. | |
1156 This option cannot be set from a |modeline| or in the |sandbox|, for | |
1157 security reasons. | |
1158 | |
1159 *'backupext'* *'bex'* *E589* | |
1160 'backupext' 'bex' string (default "~", for VMS: "_") | |
1161 global | |
1162 String which is appended to a file name to make the name of the | |
1163 backup file. The default is quite unusual, because this avoids | |
1164 accidentally overwriting existing files with a backup file. You might | |
1165 prefer using ".bak", but make sure that you don't have files with | |
1166 ".bak" that you want to keep. | |
28379 | 1167 Only normal file name characters can be used; "/\*?[|<>" are illegal. |
7 | 1168 |
26 | 1169 If you like to keep a lot of backups, you could use a BufWritePre |
1170 autocommand to change 'backupext' just before writing the file to | |
1171 include a timestamp. > | |
27903 | 1172 :au BufWritePre * let &bex = '-' .. strftime("%Y%b%d%X") .. '~' |
26 | 1173 < Use 'backupdir' to put the backup in a different directory. |
1174 | |
7 | 1175 *'backupskip'* *'bsk'* |
13664
f64c5e636c9f
patch 8.0.1704: 'backupskip' default doesn't work for Mac
Christian Brabandt <cb@256bit.org>
parents:
13482
diff
changeset
|
1176 '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
|
1177 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
|
1178 Mac: "/private/tmp/*,$TMPDIR/*,$TMP/*,$TEMP/*") |
7 | 1179 global |
1180 A list of file patterns. When one of the patterns matches with the | |
1181 name of the file which is written, no backup file is created. Both | |
1182 the specified file name and the full path name of the file are used. | |
1183 The pattern is used like with |:autocmd|, see |autocmd-patterns|. | |
1184 Watch out for special characters, see |option-backslash|. | |
1185 When $TMPDIR, $TMP or $TEMP is not defined, it is not used for the | |
233 | 1186 default value. "/tmp/*" is only used for Unix. |
1152 | 1187 |
3513 | 1188 WARNING: Not having a backup file means that when Vim fails to write |
1189 your buffer correctly and then, for whatever reason, Vim exits, you | |
1190 lose both the original file and what you were writing. Only disable | |
1191 backups if you don't care about losing the file. | |
1192 | |
1152 | 1193 Note that environment variables are not expanded. If you want to use |
1194 $HOME you must expand it explicitly, e.g.: > | |
27903 | 1195 :let &backupskip = escape(expand('$HOME'), '\') .. '/tmp/*' |
1152 | 1196 |
1197 < Note that the default also makes sure that "crontab -e" works (when a | |
557 | 1198 backup would be made by renaming the original file crontab won't see |
1199 the newly created file). Also see 'backupcopy' and |crontab|. | |
7 | 1200 |
1201 *'balloondelay'* *'bdlay'* | |
1202 'balloondelay' 'bdlay' number (default: 600) | |
1203 global | |
1204 {only available when compiled with the |+balloon_eval| | |
1205 feature} | |
1206 Delay in milliseconds before a balloon may pop up. See |balloon-eval|. | |
1207 | |
1208 *'ballooneval'* *'beval'* *'noballooneval'* *'nobeval'* | |
1209 'ballooneval' 'beval' boolean (default off) | |
1210 global | |
1211 {only available when compiled with the |+balloon_eval| | |
189 | 1212 feature} |
12865
ebb4f6c93598
patch 8.0.1309: cannot use 'balloonexpr' in a terminal
Christian Brabandt <cb@256bit.org>
parents:
12826
diff
changeset
|
1213 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
|
1214 |
ebb4f6c93598
patch 8.0.1309: cannot use 'balloonexpr' in a terminal
Christian Brabandt <cb@256bit.org>
parents:
12826
diff
changeset
|
1215 *'balloonevalterm'* *'bevalterm'* *'noballoonevalterm'* |
ebb4f6c93598
patch 8.0.1309: cannot use 'balloonexpr' in a terminal
Christian Brabandt <cb@256bit.org>
parents:
12826
diff
changeset
|
1216 *'nobevalterm'* |
ebb4f6c93598
patch 8.0.1309: cannot use 'balloonexpr' in a terminal
Christian Brabandt <cb@256bit.org>
parents:
12826
diff
changeset
|
1217 '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
|
1218 global |
ebb4f6c93598
patch 8.0.1309: cannot use 'balloonexpr' in a terminal
Christian Brabandt <cb@256bit.org>
parents:
12826
diff
changeset
|
1219 {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
|
1220 |+balloon_eval_term| feature} |
ebb4f6c93598
patch 8.0.1309: cannot use 'balloonexpr' in a terminal
Christian Brabandt <cb@256bit.org>
parents:
12826
diff
changeset
|
1221 Switch on the |balloon-eval| functionality for the terminal. |
7 | 1222 |
189 | 1223 *'balloonexpr'* *'bexpr'* |
1224 'balloonexpr' 'bexpr' string (default "") | |
790 | 1225 global or local to buffer |global-local| |
189 | 1226 {only available when compiled with the |+balloon_eval| |
1227 feature} | |
782 | 1228 Expression for text to show in evaluation balloon. It is only used |
16610 | 1229 when 'ballooneval' or 'balloonevalterm' is on. These variables can be |
1230 used: | |
189 | 1231 |
1232 v:beval_bufnr number of the buffer in which balloon is going to show | |
1233 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
|
1234 v:beval_winid ID of the window |
189 | 1235 v:beval_lnum line number |
1236 v:beval_col column number (byte index) | |
1237 v:beval_text word under or after the mouse pointer | |
1238 | |
17571 | 1239 Instead of showing a balloon, which is limited to plain text, consider |
1240 using a popup window, see |popup_beval_example|. A popup window can | |
1241 use highlighting and show a border. | |
1242 | |
189 | 1243 The evaluation of the expression must not have side effects! |
1244 Example: > | |
16610 | 1245 function MyBalloonExpr() |
27903 | 1246 return 'Cursor is at line ' .. v:beval_lnum .. |
1247 \ ', column ' .. v:beval_col .. | |
1248 \ ' of file ' .. bufname(v:beval_bufnr) .. | |
1249 \ ' on word "' .. v:beval_text .. '"' | |
189 | 1250 endfunction |
1251 set bexpr=MyBalloonExpr() | |
1252 set ballooneval | |
1253 < | |
17372 | 1254 Also see |balloon_show()|, it can be used if the content of the balloon |
1255 is to be fetched asynchronously. In that case evaluating | |
1256 'balloonexpr' should result in an empty string. If you get a balloon | |
1257 with only "0" you probably didn't return anything from your function. | |
11062 | 1258 |
189 | 1259 NOTE: The balloon is displayed only if the cursor is on a text |
1260 character. If the result of evaluating 'balloonexpr' is not empty, | |
1261 Vim does not try to send a message to an external debugger (Netbeans | |
1262 or Sun Workshop). | |
1263 | |
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
|
1264 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
|
1265 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
|
1266 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
|
1267 set bexpr=<SID>SomeBalloonExpr() |
27321 | 1268 < Otherwise, the expression is evaluated in the context of the script |
1269 where the option was set, thus script-local items are available. | |
1270 | |
3682 | 1271 The expression will be evaluated in the |sandbox| when set from a |
1272 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
|
1273 This option cannot be set in a modeline when 'modelineexpr' is off. |
634 | 1274 |
1275 It is not allowed to change text or jump to another window while | |
17372 | 1276 evaluating 'balloonexpr', see |textlock|. |
634 | 1277 |
446 | 1278 To check whether line breaks in the balloon text work use this check: > |
435 | 1279 if has("balloon_multiline") |
714 | 1280 < When they are supported "\n" characters will start a new line. If the |
1281 expression evaluates to a |List| this is equal to using each List item | |
1282 as a string and putting "\n" in between them. | |
11160 | 1283 NOTE: This option is set to "" when 'compatible' is set. |
714 | 1284 |
6949 | 1285 *'belloff'* *'bo'* |
1286 'belloff' 'bo' string (default "") | |
1287 global | |
1288 Specifies for which events the bell will not be rung. It is a comma | |
1289 separated list of items. For each item that is present, the bell | |
1290 will be silenced. This is most useful to specify specific events in | |
1291 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
|
1292 You can also make it flash by using 'visualbell'. |
6949 | 1293 |
1294 item meaning when present ~ | |
1295 all All events. | |
1296 backspace When hitting <BS> or <Del> and deleting results in an | |
1297 error. | |
1298 cursor Fail to move around using the cursor keys or | |
1299 <PageUp>/<PageDown> in |Insert-mode|. | |
1300 complete Error occurred when using |i_CTRL-X_CTRL-K| or | |
1301 |i_CTRL-X_CTRL-T|. | |
1302 copy Cannot copy char from insert mode using |i_CTRL-Y| or | |
1303 |i_CTRL-E|. | |
1304 ctrlg Unknown Char after <C-G> in Insert mode. | |
1305 error Other Error occurred (e.g. try to join last line) | |
1306 (mostly used in |Normal-mode| or |Cmdline-mode|). | |
1307 esc hitting <Esc> in |Normal-mode|. | |
1308 ex In |Visual-mode|, hitting |Q| results in an error. | |
18719 | 1309 hangul Ignored. |
6949 | 1310 insertmode Pressing <Esc> in 'insertmode'. |
1311 lang Calling the beep module for Lua/Mzscheme/TCL. | |
1312 mess No output available for |g<|. | |
1313 showmatch Error occurred for 'showmatch' function. | |
1314 operator Empty region error |cpo-E|. | |
1315 register Unknown register after <C-R> in |Insert-mode|. | |
1316 shell Bell from shell output |:!|. | |
1317 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
|
1318 term Bell from |:terminal| output. |
6949 | 1319 wildmode More matches in |cmdline-completion| available |
1320 (depends on the 'wildmode' setting). | |
1321 | |
11160 | 1322 This is most useful to fine tune when in Insert mode the bell should |
1323 be rung. For Normal mode and Ex commands, the bell is often rung to | |
6949 | 1324 indicate that an error occurred. It can be silenced by adding the |
1325 "error" keyword. | |
1326 | |
7 | 1327 *'binary'* *'bin'* *'nobinary'* *'nobin'* |
1328 'binary' 'bin' boolean (default off) | |
1329 local to buffer | |
1330 This option should be set before editing a binary file. You can also | |
1331 use the |-b| Vim argument. When this option is switched on a few | |
1332 options will be changed (also when it already was on): | |
1333 'textwidth' will be set to 0 | |
1334 'wrapmargin' will be set to 0 | |
1335 'modeline' will be off | |
1336 'expandtab' will be off | |
1337 Also, 'fileformat' and 'fileformats' options will not be used, the | |
1338 file is read and written like 'fileformat' was "unix" (a single <NL> | |
1339 separates lines). | |
1340 The 'fileencoding' and 'fileencodings' options will not be used, the | |
1341 file is read without conversion. | |
1342 NOTE: When you start editing a(nother) file while the 'bin' option is | |
1343 on, settings from autocommands may change the settings again (e.g., | |
1344 'textwidth'), causing trouble when editing. You might want to set | |
1345 'bin' again when the file has been loaded. | |
1346 The previous values of these options are remembered and restored when | |
1347 'bin' is switched from on to off. Each buffer has its own set of | |
1348 saved option values. | |
1349 To edit a file with 'binary' set you can use the |++bin| argument. | |
1350 This avoids you have to do ":set bin", which would have effect for all | |
1351 files you edit. | |
1352 When writing a file the <EOL> for the last line is only written if | |
1353 there was one in the original file (normally Vim appends an <EOL> to | |
1354 the last line if there is none; this would make the file longer). See | |
1355 the 'endofline' option. | |
1356 | |
1357 *'bioskey'* *'biosk'* *'nobioskey'* *'nobiosk'* | |
1358 'bioskey' 'biosk' boolean (default on) | |
1359 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
|
1360 {only for MS-DOS} |
8246
f16bfe02cef1
commit https://github.com/vim/vim/commit/f391327adbbffb11180cf6038a92af1ed144e907
Christian Brabandt <cb@256bit.org>
parents:
8182
diff
changeset
|
1361 This was for MS-DOS and is no longer supported. |
7 | 1362 |
1363 *'bomb'* *'nobomb'* | |
1364 'bomb' boolean (default off) | |
1365 local to buffer | |
1366 When writing a file and the following conditions are met, a BOM (Byte | |
1367 Order Mark) is prepended to the file: | |
1368 - this option is on | |
1369 - the 'binary' option is off | |
1370 - 'fileencoding' is "utf-8", "ucs-2", "ucs-4" or one of the little/big | |
1371 endian variants. | |
1372 Some applications use the BOM to recognize the encoding of the file. | |
1373 Often used for UCS-2 files on MS-Windows. For other applications it | |
1374 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
|
1375 appear halfway the resulting file. Gcc doesn't accept a BOM. |
7 | 1376 When Vim reads a file and 'fileencodings' starts with "ucs-bom", a |
1377 check for the presence of the BOM is done and 'bomb' set accordingly. | |
1378 Unless 'binary' is set, it is removed from the first line, so that you | |
1379 don't see it when editing. When you don't change the options, the BOM | |
1380 will be restored when writing the file. | |
1381 | |
1382 *'breakat'* *'brk'* | |
1383 'breakat' 'brk' string (default " ^I!@*-+;:,./?") | |
1384 global | |
2570
71b56b4e7785
Make the references to features in the help more consistent. (Sylvain Hitier)
Bram Moolenaar <bram@vim.org>
parents:
2561
diff
changeset
|
1385 {not available when compiled without the |+linebreak| |
7 | 1386 feature} |
1387 This option lets you choose which characters might cause a line | |
500 | 1388 break if 'linebreak' is on. Only works for ASCII and also for 8-bit |
1389 characters when 'encoding' is an 8-bit encoding. | |
7 | 1390 |
8835
c1a5623cfc86
commit https://github.com/vim/vim/commit/7c1c6dbb6817640fd3956a0d5417da23fde336d8
Christian Brabandt <cb@256bit.org>
parents:
8748
diff
changeset
|
1391 *'breakindent'* *'bri'* *'nobreakindent'* *'nobri'* |
6009 | 1392 'breakindent' 'bri' boolean (default off) |
1393 local to window | |
1394 {not available when compiled without the |+linebreak| | |
1395 feature} | |
1396 Every wrapped line will continue visually indented (same amount of | |
1397 space as the beginning of that line), thus preserving horizontal blocks | |
1398 of text. | |
11160 | 1399 NOTE: This option is reset when 'compatible' is set. |
6009 | 1400 |
1401 *'breakindentopt'* *'briopt'* | |
1402 'breakindentopt' 'briopt' string (default empty) | |
1403 local to window | |
1404 {not available when compiled without the |+linebreak| | |
1405 feature} | |
1406 Settings for 'breakindent'. It can consist of the following optional | |
6026 | 1407 items and must be separated by a comma: |
6009 | 1408 min:{n} Minimum text width that will be kept after |
1409 applying 'breakindent', even if the resulting | |
1410 text should normally be narrower. This prevents | |
1411 text indented almost to the right window border | |
1412 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
|
1413 (default: 20) |
6026 | 1414 shift:{n} After applying 'breakindent', the wrapped line's |
1415 beginning will be shifted by the given number of | |
1416 characters. It permits dynamic French paragraph | |
6009 | 1417 indentation (negative) or emphasizing the line |
1418 continuation (positive). | |
28716
2bd5cb054180
patch 8.2.4882: cannot make 'breakindent' use a specific column
Bram Moolenaar <Bram@vim.org>
parents:
28517
diff
changeset
|
1419 (default: 0) |
13341
acd7eaa13d2b
Updated runtime files.
Christian Brabandt <cb@256bit.org>
parents:
13314
diff
changeset
|
1420 sbr Display the 'showbreak' value before applying the |
6009 | 1421 additional indent. |
28716
2bd5cb054180
patch 8.2.4882: cannot make 'breakindent' use a specific column
Bram Moolenaar <Bram@vim.org>
parents:
28517
diff
changeset
|
1422 (default: off) |
25322
b3d7becabe99
patch 8.2.3198: cannot use 'formatlistpat' for breakindent
Bram Moolenaar <Bram@vim.org>
parents:
25248
diff
changeset
|
1423 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
|
1424 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
|
1425 'formatlistpat' setting). |
25322
b3d7becabe99
patch 8.2.3198: cannot use 'formatlistpat' for breakindent
Bram Moolenaar <Bram@vim.org>
parents:
25248
diff
changeset
|
1426 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
|
1427 for indentation. |
28716
2bd5cb054180
patch 8.2.4882: cannot make 'breakindent' use a specific column
Bram Moolenaar <Bram@vim.org>
parents:
28517
diff
changeset
|
1428 (default: 0) |
2bd5cb054180
patch 8.2.4882: cannot make 'breakindent' use a specific column
Bram Moolenaar <Bram@vim.org>
parents:
28517
diff
changeset
|
1429 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
|
1430 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
|
1431 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
|
1432 (default: off) |
6009 | 1433 |
7 | 1434 *'browsedir'* *'bsdir'* |
29 | 1435 'browsedir' 'bsdir' string (default: "last") |
7 | 1436 global |
28379 | 1437 {only for Motif, GTK, Mac and Win32 GUI} |
7 | 1438 Which directory to use for the file browser: |
1621 | 1439 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
|
1440 file was opened or saved. |
7 | 1441 buffer Use the directory of the related buffer. |
1442 current Use the current directory. | |
1443 {path} Use the specified directory | |
1444 | |
1445 *'bufhidden'* *'bh'* | |
1446 'bufhidden' 'bh' string (default: "") | |
1447 local to buffer | |
1448 This option specifies what happens when a buffer is no longer | |
1449 displayed in a window: | |
1450 <empty> follow the global 'hidden' option | |
28379 | 1451 hide hide the buffer (don't unload it), even if 'hidden' is |
1452 not set | |
1453 unload unload the buffer, even if 'hidden' is set; the | |
29290 | 1454 |:hide| command will also unload the buffer |
28379 | 1455 delete delete the buffer from the buffer list, even if |
1456 'hidden' is set; the |:hide| command will also delete | |
1457 the buffer, making it behave like |:bdelete| | |
1458 wipe wipe the buffer from the buffer list, even if | |
1459 'hidden' is set; the |:hide| command will also wipe | |
1460 out the buffer, making it behave like |:bwipeout| | |
7 | 1461 |
82 | 1462 CAREFUL: when "unload", "delete" or "wipe" is used changes in a buffer |
3224 | 1463 are lost without a warning. Also, these values may break autocommands |
1464 that switch between buffers temporarily. | |
7 | 1465 This option is used together with 'buftype' and 'swapfile' to specify |
1466 special kinds of buffers. See |special-buffers|. | |
1467 | |
1468 *'buflisted'* *'bl'* *'nobuflisted'* *'nobl'* *E85* | |
1469 'buflisted' 'bl' boolean (default: on) | |
1470 local to buffer | |
1471 When this option is set, the buffer shows up in the buffer list. If | |
1472 it is reset it is not used for ":bnext", "ls", the Buffers menu, etc. | |
1473 This option is reset by Vim for buffers that are only used to remember | |
1474 a file name or marks. Vim sets it when starting to edit a buffer. | |
1475 But not when moving to a buffer with ":buffer". | |
1476 | |
1477 *'buftype'* *'bt'* *E382* | |
1478 'buftype' 'bt' string (default: "") | |
1479 local to buffer | |
1480 The value of this option specifies the type of a buffer: | |
1481 <empty> normal buffer | |
1482 nofile buffer which is not related to a file and will not be | |
1483 written | |
1484 nowrite buffer which will not be written | |
17 | 1485 acwrite buffer which will always be written with BufWriteCmd |
13437 | 1486 autocommands. |
7 | 1487 quickfix quickfix buffer, contains list of errors |:cwindow| |
648 | 1488 or list of locations |:lwindow| |
7 | 1489 help help buffer (you are not supposed to set this |
1490 manually) | |
11757
74abb6c84984
patch 8.0.0761: options not set properly for a terminal buffer
Christian Brabandt <cb@256bit.org>
parents:
11666
diff
changeset
|
1491 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
|
1492 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
|
1493 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
|
1494 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
|
1495 {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
|
1496 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
|
1497 {only when compiled with the |+textprop| feature} |
7 | 1498 |
1499 This option is used together with 'bufhidden' and 'swapfile' to | |
1500 specify special kinds of buffers. See |special-buffers|. | |
19404 | 1501 Also see |win_gettype()|, which returns the type of the window. |
7 | 1502 |
1503 Be careful with changing this option, it can have many side effects! | |
26100 | 1504 One such effect is that Vim will not check the timestamp of the file, |
1505 if the file is changed by another program this will not be noticed. | |
7 | 1506 |
648 | 1507 A "quickfix" buffer is only used for the error list and the location |
1508 list. This value is set by the |:cwindow| and |:lwindow| commands and | |
1509 you are not supposed to change it. | |
7 | 1510 |
1511 "nofile" and "nowrite" buffers are similar: | |
1512 both: The buffer is not to be written to disk, ":w" doesn't | |
1513 work (":w filename" does work though). | |
1514 both: The buffer is never considered to be |'modified'|. | |
1515 There is no warning when the changes will be lost, for | |
1516 example when you quit Vim. | |
1517 both: A swap file is only created when using too much memory | |
1518 (when 'swapfile' has been reset there is never a swap | |
1519 file). | |
1520 nofile only: The buffer name is fixed, it is not handled like a | |
1521 file name. It is not modified in response to a |:cd| | |
1522 command. | |
6647 | 1523 both: When using ":e bufname" and already editing "bufname" |
1524 the buffer is made empty and autocommands are | |
1525 triggered as usual for |:edit|. | |
17 | 1526 *E676* |
1527 "acwrite" implies that the buffer name is not related to a file, like | |
1528 "nofile", but it will be written. Thus, in contrast to "nofile" and | |
1529 "nowrite", ":w" does work and a modified buffer can't be abandoned | |
1530 without saving. For writing there must be matching |BufWriteCmd|, | |
1531 |FileWriteCmd| or |FileAppendCmd| autocommands. | |
7 | 1532 |
1533 *'casemap'* *'cmp'* | |
1534 'casemap' 'cmp' string (default: "internal,keepascii") | |
1535 global | |
1536 Specifies details about changing the case of letters. It may contain | |
1537 these words, separated by a comma: | |
1538 internal Use internal case mapping functions, the current | |
1539 locale does not change the case mapping. This only | |
493 | 1540 matters when 'encoding' is a Unicode encoding, |
1541 "latin1" or "iso-8859-15". When "internal" is | |
1542 omitted, the towupper() and towlower() system library | |
1543 functions are used when available. | |
7 | 1544 keepascii For the ASCII characters (0x00 to 0x7f) use the US |
1545 case mapping, the current locale is not effective. | |
1546 This probably only matters for Turkish. | |
1547 | |
26508
a0bc10e83cf8
patch 8.2.3784: the help for options is outdated
Bram Moolenaar <Bram@vim.org>
parents:
26441
diff
changeset
|
1548 *'cdhome'* *'cdh'* |
a0bc10e83cf8
patch 8.2.3784: the help for options is outdated
Bram Moolenaar <Bram@vim.org>
parents:
26441
diff
changeset
|
1549 '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
|
1550 global |
a0bc10e83cf8
patch 8.2.3784: the help for options is outdated
Bram Moolenaar <Bram@vim.org>
parents:
26441
diff
changeset
|
1551 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
|
1552 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
|
1553 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
|
1554 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
|
1555 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
|
1556 |
7 | 1557 *'cdpath'* *'cd'* *E344* *E346* |
1558 'cdpath' 'cd' string (default: equivalent to $CDPATH or ",,") | |
1559 global | |
1560 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
|
1561 |: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
|
1562 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
|
1563 "/", "./" or "../", the 'cdpath' option is not used then. |
7 | 1564 The 'cdpath' option's value has the same form and semantics as |
1565 |'path'|. Also see |file-searching|. | |
1566 The default value is taken from $CDPATH, with a "," prepended to look | |
1567 in the current directory first. | |
1568 If the default value taken from $CDPATH is not what you want, include | |
1569 a modified version of the following command in your vimrc file to | |
1570 override it: > | |
27903 | 1571 :let &cdpath = ',' .. substitute(substitute($CDPATH, '[, ]', '\\\0', 'g'), ':', ',', 'g') |
7 | 1572 < This option cannot be set from a |modeline| or in the |sandbox|, for |
1573 security reasons. | |
1574 (parts of 'cdpath' can be passed to the shell to expand file names). | |
1575 | |
1576 *'cedit'* | |
1577 'cedit' string (Vi default: "", Vim default: CTRL-F) | |
1578 global | |
1579 The key used in Command-line Mode to open the command-line window. | |
1580 The default is CTRL-F when 'compatible' is off. | |
1581 Only non-printable keys are allowed. | |
1582 The key can be specified as a single character, but it is difficult to | |
1583 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
|
1584 :exe "set cedit=\<C-Y>" |
619a98a67f67
commit https://github.com/vim/vim/commit/e18dbe865d190e74fb5d43ac8bc6ac22507d0223
Christian Brabandt <cb@256bit.org>
parents:
9344
diff
changeset
|
1585 :exe "set cedit=\<Esc>" |
7 | 1586 < |Nvi| also has this option, but it only uses the first character. |
1587 See |cmdwin|. | |
11160 | 1588 NOTE: This option is set to the Vim default value when 'compatible' |
1589 is reset. | |
7 | 1590 |
1591 *'charconvert'* *'ccv'* *E202* *E214* *E513* | |
1592 'charconvert' 'ccv' string (default "") | |
1593 global | |
15878 | 1594 {only available when compiled with the |+eval| feature} |
7 | 1595 An expression that is used for character encoding conversion. It is |
1596 evaluated when a file that is to be read or has been written has a | |
1597 different encoding from what is desired. | |
1598 'charconvert' is not used when the internal iconv() function is | |
1599 supported and is able to do the conversion. Using iconv() is | |
1600 preferred, because it is much faster. | |
1601 'charconvert' is not used when reading stdin |--|, because there is no | |
1602 file to convert from. You will have to save the text in a file first. | |
27459 | 1603 The expression must return zero, false or an empty string for success, |
1604 non-zero or true for failure. | |
7 | 1605 The possible encoding names encountered are in 'encoding'. |
1606 Additionally, names given in 'fileencodings' and 'fileencoding' are | |
1607 used. | |
1608 Conversion between "latin1", "unicode", "ucs-2", "ucs-4" and "utf-8" | |
1609 is done internally by Vim, 'charconvert' is not used for this. | |
1610 'charconvert' is also used to convert the viminfo file, if the 'c' | |
1611 flag is present in 'viminfo'. Also used for Unicode conversion. | |
1612 Example: > | |
1613 set charconvert=CharConvert() | |
1614 fun CharConvert() | |
1615 system("recode " | |
27903 | 1616 \ .. v:charconvert_from .. ".." .. v:charconvert_to |
1617 \ .. " <" .. v:fname_in .. " >" .. v:fname_out) | |
7 | 1618 return v:shell_error |
1619 endfun | |
1620 < The related Vim variables are: | |
1621 v:charconvert_from name of the current encoding | |
1622 v:charconvert_to name of the desired encoding | |
1623 v:fname_in name of the input file | |
1624 v:fname_out name of the output file | |
1625 Note that v:fname_in and v:fname_out will never be the same. | |
1626 Note that v:charconvert_from and v:charconvert_to may be different | |
1627 from 'encoding'. Vim internally uses UTF-8 instead of UCS-2 or UCS-4. | |
27459 | 1628 |
30598
37aa9fd2ed72
patch 9.0.0634: evaluating "expr" options has more overhead than needed
Bram Moolenaar <Bram@vim.org>
parents:
30547
diff
changeset
|
1629 The advantage of using a function call without arguments is that it is |
37aa9fd2ed72
patch 9.0.0634: evaluating "expr" options has more overhead than needed
Bram Moolenaar <Bram@vim.org>
parents:
30547
diff
changeset
|
1630 faster, see |expr-option-function|. |
37aa9fd2ed72
patch 9.0.0634: evaluating "expr" options has more overhead than needed
Bram Moolenaar <Bram@vim.org>
parents:
30547
diff
changeset
|
1631 |
7 | 1632 Encryption is not done by Vim when using 'charconvert'. If you want |
1633 to encrypt the file after conversion, 'charconvert' should take care | |
1634 of this. | |
27459 | 1635 |
1636 If the 'charconvert' expression starts with s: or |<SID>|, then it is | |
1637 replaced with the script ID (|local-function|). Example: > | |
1638 set charconvert=s:MyConvert() | |
1639 set charconvert=<SID>SomeConvert() | |
1640 < Otherwise the expression is evaluated in the context of the script | |
1641 where the option was set, thus script-local items are available. | |
1642 | |
7 | 1643 This option cannot be set from a |modeline| or in the |sandbox|, for |
1644 security reasons. | |
1645 | |
1646 *'cindent'* *'cin'* *'nocindent'* *'nocin'* | |
1647 'cindent' 'cin' boolean (default off) | |
1648 local to buffer | |
1621 | 1649 Enables automatic C program indenting. See 'cinkeys' to set the keys |
7 | 1650 that trigger reindenting in insert mode and 'cinoptions' to set your |
1651 preferred indent style. | |
1652 If 'indentexpr' is not empty, it overrules 'cindent'. | |
1653 If 'lisp' is not on and both 'indentexpr' and 'equalprg' are empty, | |
1654 the "=" operator indents using this algorithm rather than calling an | |
1655 external program. | |
1656 See |C-indenting|. | |
1657 When you don't like the way 'cindent' works, try the 'smartindent' | |
1658 option or 'indentexpr'. | |
1659 This option is not used when 'paste' is set. | |
1660 NOTE: This option is reset when 'compatible' is set. | |
1661 | |
1662 *'cinkeys'* *'cink'* | |
15701
9cd11f6beb70
patch 8.1.0858: 'indentkeys' and 'cinkeys' defaults are different
Bram Moolenaar <Bram@vim.org>
parents:
15512
diff
changeset
|
1663 'cinkeys' 'cink' string (default "0{,0},0),0],:,0#,!^F,o,O,e") |
7 | 1664 local to buffer |
1665 A list of keys that, when typed in Insert mode, cause reindenting of | |
1666 the current line. Only used if 'cindent' is on and 'indentexpr' is | |
1667 empty. | |
1668 For the format of this option see |cinkeys-format|. | |
1669 See |C-indenting|. | |
1670 | |
1671 *'cinoptions'* *'cino'* | |
1672 'cinoptions' 'cino' string (default "") | |
1673 local to buffer | |
1674 The 'cinoptions' affect the way 'cindent' reindents lines in a C | |
1675 program. See |cinoptions-values| for the values of this option, and | |
1676 |C-indenting| for info on C indenting in general. | |
1677 | |
1678 | |
1679 *'cinwords'* *'cinw'* | |
1680 'cinwords' 'cinw' string (default "if,else,while,do,for,switch") | |
1681 local to buffer | |
1682 These keywords start an extra indent in the next line when | |
1683 'smartindent' or 'cindent' is set. For 'cindent' this is only done at | |
1684 an appropriate place (inside {}). | |
1685 Note that 'ignorecase' isn't used for 'cinwords'. If case doesn't | |
1686 matter, include the keyword both the uppercase and lowercase: | |
1687 "if,If,IF". | |
1688 | |
28353
8bc8071928ed
patch 8.2.4702: C++ scope labels are hard-coded
Bram Moolenaar <Bram@vim.org>
parents:
28297
diff
changeset
|
1689 *'cinscopedecls'* *'cinsd'* |
8bc8071928ed
patch 8.2.4702: C++ scope labels are hard-coded
Bram Moolenaar <Bram@vim.org>
parents:
28297
diff
changeset
|
1690 '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
|
1691 local to buffer |
8bc8071928ed
patch 8.2.4702: C++ scope labels are hard-coded
Bram Moolenaar <Bram@vim.org>
parents:
28297
diff
changeset
|
1692 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
|
1693 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
|
1694 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
|
1695 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
|
1696 |
8bc8071928ed
patch 8.2.4702: C++ scope labels are hard-coded
Bram Moolenaar <Bram@vim.org>
parents:
28297
diff
changeset
|
1697 < *'clipboard'* *'cb'* |
7 | 1698 'clipboard' 'cb' string (default "autoselect,exclude:cons\|linux" |
1699 for X-windows, "" otherwise) | |
1700 global | |
1701 {only in GUI versions or when the |+xterm_clipboard| | |
1702 feature is included} | |
28353
8bc8071928ed
patch 8.2.4702: C++ scope labels are hard-coded
Bram Moolenaar <Bram@vim.org>
parents:
28297
diff
changeset
|
1703 This option is a list of comma-separated names. |
23931 | 1704 Note: if one of the items is "exclude:", then you can't add an item |
29403 | 1705 after that. Therefore do not append an item with += but use ^= to |
23931 | 1706 prepend, e.g.: > |
1707 set clipboard^=unnamed | |
30547 | 1708 < When using the GUI see |'go-A'|. |
1709 These names are recognized: | |
7 | 1710 |
3674 | 1711 *clipboard-unnamed* |
7 | 1712 unnamed When included, Vim will use the clipboard register '*' |
1713 for all yank, delete, change and put operations which | |
1714 would normally go to the unnamed register. When a | |
1715 register is explicitly specified, it will always be | |
1716 used regardless of whether "unnamed" is in 'clipboard' | |
1717 or not. The clipboard register can always be | |
1718 explicitly accessed using the "* notation. Also see | |
1719 |gui-clipboard|. | |
1720 | |
3682 | 1721 *clipboard-unnamedplus* |
4119 | 1722 unnamedplus A variant of the "unnamed" flag which uses the |
1723 clipboard register '+' (|quoteplus|) instead of | |
1724 register '*' for all yank, delete, change and put | |
1725 operations which would normally go to the unnamed | |
1726 register. When "unnamed" is also included to the | |
1727 option, yank operations (but not delete, change or | |
1728 put) will additionally copy the text into register | |
1729 '*'. | |
2662 | 1730 Only available with the |+X11| feature. |
2654 | 1731 Availability can be checked with: > |
1732 if has('unnamedplus') | |
1733 < | |
3682 | 1734 *clipboard-autoselect* |
7 | 1735 autoselect Works like the 'a' flag in 'guioptions': If present, |
1736 then whenever Visual mode is started, or the Visual | |
1737 area extended, Vim tries to become the owner of the | |
1738 windowing system's global selection or put the | |
1739 selected text on the clipboard used by the selection | |
14999 | 1740 register "*. See |'go-a'| and |quotestar| for details. |
1741 When the GUI is active, the 'a' flag in 'guioptions' | |
1742 is used, when the GUI is not active, this "autoselect" | |
1743 flag is used. | |
7 | 1744 Also applies to the modeless selection. |
1745 | |
3674 | 1746 *clipboard-autoselectplus* |
1747 autoselectplus Like "autoselect" but using the + register instead of | |
1748 the * register. Compare to the 'P' flag in | |
1749 'guioptions'. | |
1750 | |
1751 *clipboard-autoselectml* | |
7 | 1752 autoselectml Like "autoselect", but for the modeless selection |
1753 only. Compare to the 'A' flag in 'guioptions'. | |
1754 | |
3674 | 1755 *clipboard-html* |
1904 | 1756 html When the clipboard contains HTML, use this when |
1757 pasting. When putting text on the clipboard, mark it | |
1758 as HTML. This works to copy rendered HTML from | |
1759 Firefox, paste it as raw HTML in Vim, select the HTML | |
1760 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
|
1761 You probably want to add this only temporarily, |
6b4879aea261
Add test for gettabvar() and settabvar().
Bram Moolenaar <bram@vim.org>
parents:
2220
diff
changeset
|
1762 possibly use BufEnter autocommands. |
1904 | 1763 Only supported for GTK version 2 and later. |
1764 | |
3674 | 1765 *clipboard-exclude* |
7 | 1766 exclude:{pattern} |
1767 Defines a pattern that is matched against the name of | |
1768 the terminal 'term'. If there is a match, no | |
1769 connection will be made to the X server. This is | |
1770 useful in this situation: | |
1771 - Running Vim in a console. | |
1772 - $DISPLAY is set to start applications on another | |
1773 display. | |
1774 - You do not want to connect to the X server in the | |
1775 console, but do want this in a terminal emulator. | |
1776 To never connect to the X server use: > | |
1777 exclude:.* | |
1778 < This has the same effect as using the |-X| argument. | |
1779 Note that when there is no connection to the X server | |
1780 the window title won't be restored and the clipboard | |
1781 cannot be accessed. | |
1782 The value of 'magic' is ignored, {pattern} is | |
1783 interpreted as if 'magic' was on. | |
1784 The rest of the option value will be used for | |
1785 {pattern}, this must be the last entry. | |
1786 | |
1787 *'cmdheight'* *'ch'* | |
1788 'cmdheight' 'ch' number (default 1) | |
29546
8a243ecfe2dd
patch 9.0.0114: the command line takes up space even when not used
Bram Moolenaar <Bram@vim.org>
parents:
29450
diff
changeset
|
1789 global or local to tab page |
30005
bb0e525e1393
patch 9.0.0340: the 'cmdheight' zero support causes too much trouble
Bram Moolenaar <Bram@vim.org>
parents:
29900
diff
changeset
|
1790 Number of screen lines to use for the command-line. A larger value |
bb0e525e1393
patch 9.0.0340: the 'cmdheight' zero support causes too much trouble
Bram Moolenaar <Bram@vim.org>
parents:
29900
diff
changeset
|
1791 helps avoiding |hit-enter| prompts. |
824 | 1792 The value of this option is stored with the tab page, so that each tab |
1793 page can have a different value. | |
7 | 1794 |
1795 *'cmdwinheight'* *'cwh'* | |
1796 'cmdwinheight' 'cwh' number (default 7) | |
1797 global | |
1798 Number of screen lines to use for the command-line window. |cmdwin| | |
1799 | |
2608
7d8af31066c8
Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents:
2607
diff
changeset
|
1800 *'colorcolumn'* *'cc'* |
7d8af31066c8
Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents:
2607
diff
changeset
|
1801 'colorcolumn' 'cc' string (default "") |
7d8af31066c8
Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents:
2607
diff
changeset
|
1802 local to window |
7d8af31066c8
Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents:
2607
diff
changeset
|
1803 {not available when compiled without the |+syntax| |
7d8af31066c8
Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents:
2607
diff
changeset
|
1804 feature} |
28379 | 1805 '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
|
1806 highlighted with ColorColumn |hl-ColorColumn|. Useful to align |
7d8af31066c8
Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents:
2607
diff
changeset
|
1807 text. Will make screen redrawing slower. |
7d8af31066c8
Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents:
2607
diff
changeset
|
1808 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
|
1809 '+' or '-', which is added to or subtracted from 'textwidth'. > |
7d8af31066c8
Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents:
2607
diff
changeset
|
1810 |
7d8af31066c8
Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents:
2607
diff
changeset
|
1811 :set cc=+1 " highlight column after 'textwidth' |
7d8af31066c8
Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents:
2607
diff
changeset
|
1812 :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
|
1813 :hi ColorColumn ctermbg=lightgrey guibg=lightgrey |
7d8af31066c8
Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents:
2607
diff
changeset
|
1814 < |
7d8af31066c8
Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents:
2607
diff
changeset
|
1815 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
|
1816 A maximum of 256 columns are highlighted. |
7d8af31066c8
Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents:
2607
diff
changeset
|
1817 |
7 | 1818 *'columns'* *'co'* *E594* |
1819 'columns' 'co' number (default 80 or terminal width) | |
1820 global | |
1821 Number of columns of the screen. Normally this is set by the terminal | |
161 | 1822 initialization and does not have to be set by hand. Also see |
1823 |posix-screen-size|. | |
7 | 1824 When Vim is running in the GUI or in a resizable window, setting this |
1825 option will cause the window size to be changed. When you only want | |
1826 to use the size for the GUI, put the command in your |gvimrc| file. | |
1827 When you set this option and Vim is unable to change the physical | |
1152 | 1828 number of columns of the display, the display may be messed up. For |
1829 the GUI it is always possible and Vim limits the number of columns to | |
1830 what fits on the screen. You can use this command to get the widest | |
1831 window possible: > | |
1832 :set columns=9999 | |
1833 < Minimum value is 12, maximum value is 10000. | |
7 | 1834 |
1835 *'comments'* *'com'* *E524* *E525* | |
1836 'comments' 'com' string (default | |
1837 "s1:/*,mb:*,ex:*/,://,b:#,:%,:XCOMM,n:>,fb:-") | |
1838 local to buffer | |
28379 | 1839 A comma-separated list of strings that can start a comment line. See |
7 | 1840 |format-comments|. See |option-backslash| about using backslashes to |
1841 insert a space. | |
1842 | |
1843 *'commentstring'* *'cms'* *E537* | |
1844 'commentstring' 'cms' string (default "/*%s*/") | |
1845 local to buffer | |
1846 {not available when compiled without the |+folding| | |
1847 feature} | |
1848 A template for a comment. The "%s" in the value is replaced with the | |
1849 comment text. Currently only used to add markers for folding, see | |
1850 |fold-marker|. | |
1851 | |
1852 *'compatible'* *'cp'* *'nocompatible'* *'nocp'* | |
819 | 1853 '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
|
1854 file is found, reset in |defaults.vim|) |
7 | 1855 global |
1856 This option has the effect of making Vim either more Vi-compatible, or | |
1857 make Vim behave in a more useful way. | |
11062 | 1858 |
7 | 1859 This is a special kind of option, because when it's set or reset, |
11062 | 1860 other options are also changed as a side effect. |
1861 NOTE: Setting or resetting this option can have a lot of unexpected | |
1862 effects: Mappings are interpreted in another way, undo behaves | |
1863 differently, etc. If you set this option in your vimrc file, you | |
1864 should probably put it at the very start. | |
1865 | |
7 | 1866 By default this option is on and the Vi defaults are used for the |
1867 options. This default was chosen for those people who want to use Vim | |
1868 just like Vi, and don't even (want to) know about the 'compatible' | |
1869 option. | |
819 | 1870 When a |vimrc| or |gvimrc| file is found while Vim is starting up, |
378 | 1871 this option is switched off, and all options that have not been |
1872 modified will be set to the Vim defaults. Effectively, this means | |
819 | 1873 that when a |vimrc| or |gvimrc| file exists, Vim will use the Vim |
378 | 1874 defaults, otherwise it will use the Vi defaults. (Note: This doesn't |
1152 | 1875 happen for the system-wide vimrc or gvimrc file, nor for a file given |
1876 with the |-u| argument). Also see |compatible-default| and | |
1877 |posix-compliance|. | |
7 | 1878 You can also set this option with the "-C" argument, and reset it with |
1879 "-N". See |-C| and |-N|. | |
11062 | 1880 See 'cpoptions' for more fine tuning of Vi compatibility. |
1881 | |
1882 When this option is set, numerous other options are set to make Vim as | |
1883 Vi-compatible as possible. When this option is unset, various options | |
1884 are set to make Vim more useful. The table below lists all the | |
1885 options affected. | |
1886 The {?} column indicates when the options are affected: | |
1887 + Means that the option is set to the value given in {set value} when | |
1888 'compatible' is set. | |
1889 & Means that the option is set to the value given in {set value} when | |
1890 'compatible' is set AND is set to its Vim default value when | |
1891 'compatible' is unset. | |
1892 - Means the option is NOT changed when setting 'compatible' but IS | |
1893 set to its Vim default when 'compatible' is unset. | |
1894 The {effect} column summarises the change when 'compatible' is set. | |
1895 | |
11160 | 1896 option ? set value effect ~ |
11062 | 1897 |
1898 'allowrevins' + off no CTRL-_ command | |
1899 'antialias' + off don't use antialiased fonts | |
1900 'arabic' + off reset arabic-related options | |
1901 'arabicshape' + on correct character shapes | |
1902 'backspace' + "" normal backspace | |
1903 'backup' + off no backup file | |
1904 'backupcopy' & Unix: "yes" backup file is a copy | |
1905 else: "auto" copy or rename backup file | |
1906 'balloonexpr' + "" text to show in evaluation balloon | |
1907 'breakindent' + off don't indent when wrapping lines | |
1908 '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
|
1909 'cdhome' + off ":cd" don't chdir to home on non-Unix |
11062 | 1910 'cindent' + off no C code indentation |
1911 'compatible' - {unchanged} {set vim default only on resetting 'cp'} | |
1912 'copyindent' + off don't copy indent structure | |
1913 'cpoptions' & (all flags) Vi-compatible flags | |
1914 'cscopepathcomp'+ 0 don't show directories in tags list | |
13341
acd7eaa13d2b
Updated runtime files.
Christian Brabandt <cb@256bit.org>
parents:
13314
diff
changeset
|
1915 'cscoperelative'+ off don't use basename of path as prefix |
11062 | 1916 'cscopetag' + off don't use cscope for ":tag" |
11160 | 1917 'cscopetagorder'+ 0 see |cscopetagorder| |
11062 | 1918 'cscopeverbose' + off see |cscopeverbose| |
1919 'delcombine' + off unicode: delete whole char combination | |
1920 'digraph' + off no digraphs | |
1921 'esckeys' & off no <Esc>-keys in Insert mode | |
1922 'expandtab' + off tabs not expanded to spaces | |
1923 '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
|
1924 "dos,unix" except for MS-Windows |
11062 | 1925 'formatexpr' + "" use 'formatprg' for auto-formatting |
1926 'formatoptions' & "vt" Vi compatible formatting | |
1927 'gdefault' + off no default 'g' flag for ":s" | |
1928 'history' & 0 no commandline history | |
1929 'hkmap' + off no Hebrew keyboard mapping | |
1930 'hkmapp' + off no phonetic Hebrew keyboard mapping | |
1931 'hlsearch' + off no highlighting of search matches | |
1932 'incsearch' + off no incremental searching | |
1933 'indentexpr' + "" no indenting by expression | |
1934 'insertmode' + off do not start in Insert mode | |
1935 'iskeyword' & "@,48-57,_" keywords contain alphanumeric | |
7 | 1936 characters and '_' |
11062 | 1937 'joinspaces' + on insert 2 spaces after period |
1938 'modeline' & off no modelines | |
1939 'more' & off no pauses in listings | |
1940 'mzquantum' - {unchanged} {set vim default only on resetting 'cp'} | |
1941 'numberwidth' & 8 min number of columns for line number | |
1942 'preserveindent'+ off don't preserve current indent structure | |
1943 when changing it | |
1944 'revins' + off no reverse insert | |
1945 'ruler' + off no ruler | |
1946 'scrolljump' + 1 no jump scroll | |
1947 'scrolloff' + 0 no scroll offset | |
1948 'shelltemp' - {unchanged} {set vim default only on resetting 'cp'} | |
1949 '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
|
1950 'shortmess' & "S" no shortening of messages |
11062 | 1951 'showcmd' & off command characters not shown |
1952 'showmode' & off current mode not shown | |
1953 'sidescrolloff' + 0 cursor moves to edge of screen in scroll | |
1954 'smartcase' + off no automatic ignore case switch | |
1955 'smartindent' + off no smart indentation | |
1956 'smarttab' + off no smart tab size | |
1957 'softtabstop' + 0 tabs are always 'tabstop' positions | |
1958 'startofline' + on goto startofline with some commands | |
1959 'tagcase' & "followic" 'ignorecase' when searching tags file | |
1960 'tagrelative' & off tag file names are not relative | |
1961 'termguicolors' + off don't use highlight-(guifg|guibg) | |
1962 'textauto' & off no automatic textmode detection | |
1963 'textwidth' + 0 no automatic line wrap | |
1964 'tildeop' + off tilde is not an operator | |
1965 'ttimeout' + off no terminal timeout | |
1966 'undofile' + off don't use an undo file | |
11160 | 1967 'viminfo' - {unchanged} {set Vim default only on resetting 'cp'} |
11062 | 1968 'virtualedit' + "" cursor can only be placed on characters |
1969 'whichwrap' & "" left-right movements don't wrap | |
1970 'wildchar' & CTRL-E only when the current value is <Tab> | |
7 | 1971 use CTRL-E for cmdline completion |
11062 | 1972 'writebackup' + on or off depends on the |+writebackup| feature |
7 | 1973 |
1974 *'complete'* *'cpt'* *E535* | |
1975 'complete' 'cpt' string (default: ".,w,b,u,t,i") | |
1976 local to buffer | |
1977 This option specifies how keyword completion |ins-completion| works | |
1978 when CTRL-P or CTRL-N are used. It is also used for whole-line | |
1979 completion |i_CTRL-X_CTRL-L|. It indicates the type of completion | |
28379 | 1980 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
|
1981 . scan the current buffer ('wrapscan' is ignored) |
7 | 1982 w scan buffers from other windows |
1983 b scan other loaded buffers that are in the buffer list | |
1984 u scan the unloaded buffers that are in the buffer list | |
1985 U scan the buffers that are not in the buffer list | |
1986 k scan the files given with the 'dictionary' option | |
703 | 1987 kspell use the currently active spell checking |spell| |
7 | 1988 k{dict} scan the file {dict}. Several "k" flags can be given, |
1989 patterns are valid too. For example: > | |
1990 :set cpt=k/usr/dict/*,k~/spanish | |
1991 < s scan the files given with the 'thesaurus' option | |
1992 s{tsr} scan the file {tsr}. Several "s" flags can be given, patterns | |
1993 are valid too. | |
1994 i scan current and included files | |
1995 d scan current and included files for defined name or macro | |
1996 |i_CTRL-X_CTRL-D| | |
1997 ] tag completion | |
1998 t same as "]" | |
1999 | |
2000 Unloaded buffers are not loaded, thus their autocmds |:autocmd| are | |
2001 not executed, this may lead to unexpected completions from some files | |
2002 (gzipped files for example). Unloaded buffers are not scanned for | |
2003 whole-line completion. | |
2004 | |
2005 The default is ".,w,b,u,t,i", which means to scan: | |
2006 1. the current buffer | |
2007 2. buffers in other windows | |
2008 3. other loaded buffers | |
2009 4. unloaded buffers | |
2010 5. tags | |
2011 6. included files | |
2012 | |
2013 As you can see, CTRL-N and CTRL-P can be used to do any 'iskeyword'- | |
233 | 2014 based expansion (e.g., dictionary |i_CTRL-X_CTRL-K|, included patterns |
2015 |i_CTRL-X_CTRL-I|, tags |i_CTRL-X_CTRL-]| and normal expansions). | |
7 | 2016 |
12 | 2017 *'completefunc'* *'cfu'* |
2018 'completefunc' 'cfu' string (default: empty) | |
2019 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
|
2020 {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
|
2021 feature} |
623 | 2022 This option specifies a function to be used for Insert mode completion |
2023 with CTRL-X CTRL-U. |i_CTRL-X_CTRL-U| | |
648 | 2024 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
|
2025 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
|
2026 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
|
2027 more information. |
2642 | 2028 This option cannot be set from a |modeline| or in the |sandbox|, for |
2029 security reasons. | |
14 | 2030 |
17543
77c3f6428b6c
patch 8.1.1769: 'shellslash' is also used for completion
Bram Moolenaar <Bram@vim.org>
parents:
17433
diff
changeset
|
2031 *'completeslash'* *'csl'* |
77c3f6428b6c
patch 8.1.1769: 'shellslash' is also used for completion
Bram Moolenaar <Bram@vim.org>
parents:
17433
diff
changeset
|
2032 'completeslash' 'csl' string (default: "") |
77c3f6428b6c
patch 8.1.1769: 'shellslash' is also used for completion
Bram Moolenaar <Bram@vim.org>
parents:
17433
diff
changeset
|
2033 local to buffer |
18343 | 2034 {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
|
2035 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
|
2036 - 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
|
2037 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
|
2038 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
|
2039 - 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
|
2040 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
|
2041 - 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
|
2042 'shellslash'. |
77c3f6428b6c
patch 8.1.1769: 'shellslash' is also used for completion
Bram Moolenaar <Bram@vim.org>
parents:
17433
diff
changeset
|
2043 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
|
2044 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
|
2045 |
540 | 2046 *'completeopt'* *'cot'* |
730 | 2047 'completeopt' 'cot' string (default: "menu,preview") |
540 | 2048 global |
28379 | 2049 A comma-separated list of options for Insert mode completion |
665 | 2050 |ins-completion|. The supported values are: |
540 | 2051 |
2052 menu Use a popup menu to show the possible completions. The | |
2053 menu is only shown when there is more than one match and | |
2054 sufficient colors are available. |ins-completion-menu| | |
2055 | |
707 | 2056 menuone Use the popup menu also when there is only one match. |
856 | 2057 Useful when there is additional information about the |
707 | 2058 match, e.g., what file it comes from. |
2059 | |
836 | 2060 longest Only insert the longest common text of the matches. If |
2061 the menu is displayed you can use CTRL-L to add more | |
2062 characters. Whether case is ignored depends on the kind | |
2063 of completion. For buffer text the 'ignorecase' option is | |
2064 used. | |
665 | 2065 |
730 | 2066 preview Show extra information about the currently selected |
1152 | 2067 completion in the preview window. Only works in |
2068 combination with "menu" or "menuone". | |
2069 | |
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
|
2070 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
|
2071 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
|
2072 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
|
2073 See |'completepopup'| for specifying properties. |
18343 | 2074 {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
|
2075 |
18396
ba5d8c5d77d7
patch 8.1.2192: cannot easily fill the info popup asynchronously
Bram Moolenaar <Bram@vim.org>
parents:
18372
diff
changeset
|
2076 popuphidden |
18719 | 2077 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
|
2078 |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
|
2079 |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
|
2080 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
|
2081 {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
|
2082 |
6911 | 2083 noinsert Do not insert any text for a match until the user selects |
2084 a match from the menu. Only works in combination with | |
2085 "menu" or "menuone". No effect if "longest" is present. | |
2086 | |
2087 noselect Do not select a match in the menu, force the user to | |
2088 select one from the menu. Only works in combination with | |
2089 "menu" or "menuone". | |
2090 | |
730 | 2091 |
17771
4bd21046902b
patch 8.1.1882: cannot specify properties of the info popup window
Bram Moolenaar <Bram@vim.org>
parents:
17767
diff
changeset
|
2092 *'completepopup'* *'cpp'* |
4bd21046902b
patch 8.1.1882: cannot specify properties of the info popup window
Bram Moolenaar <Bram@vim.org>
parents:
17767
diff
changeset
|
2093 '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
|
2094 global |
4bd21046902b
patch 8.1.1882: cannot specify properties of the info popup window
Bram Moolenaar <Bram@vim.org>
parents:
17767
diff
changeset
|
2095 {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
|
2096 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
|
2097 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
|
2098 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
|
2099 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
|
2100 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
|
2101 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
|
2102 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
|
2103 |
4bd21046902b
patch 8.1.1882: cannot specify properties of the info popup window
Bram Moolenaar <Bram@vim.org>
parents:
17767
diff
changeset
|
2104 |
2378
85b7dc8da5eb
Add the 'concealcursor' option to decide when the cursor line is to be
Bram Moolenaar <bram@vim.org>
parents:
2365
diff
changeset
|
2105 *'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
|
2106 '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
|
2107 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
|
2108 {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
|
2109 feature} |
85b7dc8da5eb
Add the 'concealcursor' option to decide when the cursor line is to be
Bram Moolenaar <bram@vim.org>
parents:
2365
diff
changeset
|
2110 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
|
2111 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
|
2112 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
|
2113 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
|
2114 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
|
2115 i Insert mode |
2382
3a5ededa240a
Add the 'c' flag to 'concealcursor'.
Bram Moolenaar <bram@vim.org>
parents:
2380
diff
changeset
|
2116 c Command line editing, for 'incsearch' |
3a5ededa240a
Add the 'c' flag to 'concealcursor'.
Bram Moolenaar <bram@vim.org>
parents:
2380
diff
changeset
|
2117 |
2400
e6f1424dd66a
Let 'v' flag in 'concealcursor' apply to all lines in the Visual area.
Bram Moolenaar <bram@vim.org>
parents:
2394
diff
changeset
|
2118 '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
|
2119 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
|
2120 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
|
2121 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
|
2122 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
|
2123 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
|
2124 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
|
2125 |
85b7dc8da5eb
Add the 'concealcursor' option to decide when the cursor line is to be
Bram Moolenaar <bram@vim.org>
parents:
2365
diff
changeset
|
2126 |
14864 | 2127 *'conceallevel'* *'cole'* |
2128 'conceallevel' 'cole' number (default 0) | |
2250
1bac28a53fae
Add the conceal patch from Vince Negri.
Bram Moolenaar <bram@vim.org>
parents:
2249
diff
changeset
|
2129 local to window |
1bac28a53fae
Add the conceal patch from Vince Negri.
Bram Moolenaar <bram@vim.org>
parents:
2249
diff
changeset
|
2130 {not available when compiled without the |+conceal| |
1bac28a53fae
Add the conceal patch from Vince Negri.
Bram Moolenaar <bram@vim.org>
parents:
2249
diff
changeset
|
2131 feature} |
2340
99c1eba60b2d
Make automatic prototype generation work with more interfaces.
Bram Moolenaar <bram@vim.org>
parents:
2337
diff
changeset
|
2132 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
|
2133 is shown: |
99c1eba60b2d
Make automatic prototype generation work with more interfaces.
Bram Moolenaar <bram@vim.org>
parents:
2337
diff
changeset
|
2134 |
99c1eba60b2d
Make automatic prototype generation work with more interfaces.
Bram Moolenaar <bram@vim.org>
parents:
2337
diff
changeset
|
2135 Value Effect ~ |
2250
1bac28a53fae
Add the conceal patch from Vince Negri.
Bram Moolenaar <bram@vim.org>
parents:
2249
diff
changeset
|
2136 0 Text is shown normally |
2426 | 2137 1 Each block of concealed text is replaced with one |
2138 character. If the syntax item does not have a custom | |
2139 replacement character defined (see |:syn-cchar|) the | |
2140 character defined in 'listchars' is used (default is a | |
2141 space). | |
2142 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
|
2143 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
|
2144 custom replacement character defined (see |
2426 | 2145 |: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
|
2146 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
|
2147 |
586a459f3980
Never hide text for conceal in cursor line. Do hide when there is
Bram Moolenaar <bram@vim.org>
parents:
2348
diff
changeset
|
2148 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
|
2149 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
|
2150 option. |
2250
1bac28a53fae
Add the conceal patch from Vince Negri.
Bram Moolenaar <bram@vim.org>
parents:
2249
diff
changeset
|
2151 |
7 | 2152 *'confirm'* *'cf'* *'noconfirm'* *'nocf'* |
2153 'confirm' 'cf' boolean (default off) | |
2154 global | |
2155 When 'confirm' is on, certain operations that would normally | |
2156 fail because of unsaved changes to a buffer, e.g. ":q" and ":e", | |
2157 instead raise a |dialog| asking if you wish to save the current | |
2158 file(s). You can still use a ! to unconditionally |abandon| a buffer. | |
2159 If 'confirm' is off you can still activate confirmation for one | |
2160 command only (this is most useful in mappings) with the |:confirm| | |
2161 command. | |
2162 Also see the |confirm()| function and the 'v' flag in 'guioptions'. | |
2163 | |
2164 *'conskey'* *'consk'* *'noconskey'* *'noconsk'* | |
2165 'conskey' 'consk' boolean (default off) | |
2166 global | |
8246
f16bfe02cef1
commit https://github.com/vim/vim/commit/f391327adbbffb11180cf6038a92af1ed144e907
Christian Brabandt <cb@256bit.org>
parents:
8182
diff
changeset
|
2167 This was for MS-DOS and is no longer supported. |
7 | 2168 |
2169 *'copyindent'* *'ci'* *'nocopyindent'* *'noci'* | |
2170 'copyindent' 'ci' boolean (default off) | |
2171 local to buffer | |
2172 Copy the structure of the existing lines indent when autoindenting a | |
2173 new line. Normally the new indent is reconstructed by a series of | |
2174 tabs followed by spaces as required (unless |'expandtab'| is enabled, | |
2175 in which case only spaces are used). Enabling this option makes the | |
2176 new line copy whatever characters were used for indenting on the | |
1621 | 2177 existing line. 'expandtab' has no effect on these characters, a Tab |
2178 remains a Tab. If the new indent is greater than on the existing | |
7 | 2179 line, the remaining space is filled in the normal manner. |
11160 | 2180 NOTE: This option is reset when 'compatible' is set. |
7 | 2181 Also see 'preserveindent'. |
2182 | |
8148
f5da459c5698
commit https://github.com/vim/vim/commit/e0fa3742ead676a3074a10edadbc955e1a89153d
Christian Brabandt <cb@256bit.org>
parents:
8061
diff
changeset
|
2183 *'cpoptions'* *'cpo'* *cpo* |
7 | 2184 'cpoptions' 'cpo' string (Vim default: "aABceFs", |
2185 Vi default: all flags) | |
2186 global | |
2187 A sequence of single character flags. When a character is present | |
5340 | 2188 this indicates Vi-compatible behavior. This is used for things where |
2189 not being Vi-compatible is mostly or sometimes preferred. | |
7 | 2190 'cpoptions' stands for "compatible-options". |
2191 Commas can be added for readability. | |
2192 To avoid problems with flags that are added in the future, use the | |
2193 "+=" 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
|
2194 |
7 | 2195 NOTE: This option is set to the Vi default value when 'compatible' is |
2196 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
|
2197 |
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
|
2198 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
|
2199 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
|
2200 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
|
2201 '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
|
2202 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
|
2203 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
|
2204 `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
|
2205 |
164 | 2206 NOTE: This option is set to the POSIX default value at startup when |
2207 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
|
2208 variable exists |posix|. This means Vim tries to behave like the |
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
2209 POSIX specification. |
7 | 2210 |
2211 contains behavior ~ | |
2212 *cpo-a* | |
2213 a When included, a ":read" command with a file name | |
2214 argument will set the alternate file name for the | |
2215 current window. | |
2216 *cpo-A* | |
2217 A When included, a ":write" command with a file name | |
2218 argument will set the alternate file name for the | |
2219 current window. | |
2220 *cpo-b* | |
2221 b "\|" in a ":map" command is recognized as the end of | |
2222 the map command. The '\' is included in the mapping, | |
2223 the text after the '|' is interpreted as the next | |
2224 command. Use a CTRL-V instead of a backslash to | |
2225 include the '|' in the mapping. Applies to all | |
2226 mapping, abbreviation, menu and autocmd commands. | |
2227 See also |map_bar|. | |
2228 *cpo-B* | |
2229 B A backslash has no special meaning in mappings, | |
14372 | 2230 abbreviations, user commands and the "to" part of the |
2231 menu commands. Remove this flag to be able to use a | |
2232 backslash like a CTRL-V. For example, the command | |
2233 ":map X \<Esc>" results in X being mapped to: | |
7 | 2234 'B' included: "\^[" (^[ is a real <Esc>) |
2235 'B' excluded: "<Esc>" (5 characters) | |
2236 ('<' excluded in both cases) | |
2237 *cpo-c* | |
2238 c Searching continues at the end of any match at the | |
2239 cursor position, but not further than the start of the | |
2240 next line. When not present searching continues | |
2241 one character from the cursor position. With 'c' | |
2242 "abababababab" only gets three matches when repeating | |
2243 "/abab", without 'c' there are five matches. | |
2244 *cpo-C* | |
2245 C Do not concatenate sourced lines that start with a | |
2246 backslash. See |line-continuation|. | |
2247 *cpo-d* | |
2248 d Using "./" in the 'tags' option doesn't mean to use | |
2249 the tags file relative to the current file, but the | |
2250 tags file in the current directory. | |
2251 *cpo-D* | |
2252 D Can't use CTRL-K to enter a digraph after Normal mode | |
2253 commands with a character argument, like |r|, |f| and | |
2254 |t|. | |
2255 *cpo-e* | |
2256 e When executing a register with ":@r", always add a | |
2257 <CR> to the last line, also when the register is not | |
2258 linewise. If this flag is not present, the register | |
2259 is not linewise and the last line does not end in a | |
2260 <CR>, then the last line is put on the command-line | |
2261 and can be edited before hitting <CR>. | |
2262 *cpo-E* | |
2263 E It is an error when using "y", "d", "c", "g~", "gu" or | |
2264 "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
|
2265 at least one character is to be operated on. Example: |
7 | 2266 This makes "y0" fail in the first column. |
2267 *cpo-f* | |
2268 f When included, a ":read" command with a file name | |
2269 argument will set the file name for the current buffer, | |
2270 if the current buffer doesn't have a file name yet. | |
2271 *cpo-F* | |
2272 F When included, a ":write" command with a file name | |
2273 argument will set the file name for the current | |
2274 buffer, if the current buffer doesn't have a file name | |
590 | 2275 yet. Also see |cpo-P|. |
7 | 2276 *cpo-g* |
2277 g Goto line 1 when using ":edit" without argument. | |
164 | 2278 *cpo-H* |
2279 H When using "I" on a line with only blanks, insert | |
2280 before the last blank. Without this flag insert after | |
2281 the last blank. | |
7 | 2282 *cpo-i* |
2283 i When included, interrupting the reading of a file will | |
2284 leave it modified. | |
10 | 2285 *cpo-I* |
2286 I When moving the cursor up or down just after inserting | |
2287 indent for 'autoindent', do not delete the indent. | |
7 | 2288 *cpo-j* |
2289 j When joining lines, only add two spaces after a '.', | |
2290 not after '!' or '?'. Also see 'joinspaces'. | |
2291 *cpo-J* | |
2292 J A |sentence| has to be followed by two spaces after | |
233 | 2293 the '.', '!' or '?'. A <Tab> is not recognized as |
7 | 2294 white space. |
2295 *cpo-k* | |
2296 k Disable the recognition of raw key codes in | |
2297 mappings, abbreviations, and the "to" part of menu | |
2298 commands. For example, if <Key> sends ^[OA (where ^[ | |
2299 is <Esc>), the command ":map X ^[OA" results in X | |
2300 being mapped to: | |
2301 'k' included: "^[OA" (3 characters) | |
2302 'k' excluded: "<Key>" (one key code) | |
2303 Also see the '<' flag below. | |
2304 *cpo-K* | |
2305 K Don't wait for a key code to complete when it is | |
2306 halfway a mapping. This breaks mapping <F1><F1> when | |
2307 only part of the second <F1> has been read. It | |
2308 enables cancelling the mapping by typing <F1><Esc>. | |
2309 *cpo-l* | |
2310 l Backslash in a [] range in a search pattern is taken | |
168 | 2311 literally, only "\]", "\^", "\-" and "\\" are special. |
2312 See |/[]| | |
7 | 2313 'l' included: "/[ \t]" finds <Space>, '\' and 't' |
2314 'l' excluded: "/[ \t]" finds <Space> and <Tab> | |
168 | 2315 Also see |cpo-\|. |
7 | 2316 *cpo-L* |
2317 L When the 'list' option is set, 'wrapmargin', | |
2318 'textwidth', 'softtabstop' and Virtual Replace mode | |
2319 (see |gR|) count a <Tab> as two characters, instead of | |
2320 the normal behavior of a <Tab>. | |
2321 *cpo-m* | |
2322 m When included, a showmatch will always wait half a | |
2323 second. When not included, a showmatch will wait half | |
2324 a second or until a character is typed. |'showmatch'| | |
2325 *cpo-M* | |
2326 M When excluded, "%" matching will take backslashes into | |
2327 account. Thus in "( \( )" and "\( ( \)" the outer | |
2328 parenthesis match. When included "%" ignores | |
2329 backslashes, which is Vi compatible. | |
2330 *cpo-n* | |
2178
c6f1aa1e9f32
Add 'relativenumber' patch from Markus Heidelberg.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2331 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
|
2332 '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
|
2333 lines. |
7 | 2334 *cpo-o* |
2335 o Line offset to search command is not remembered for | |
2336 next search. | |
2337 *cpo-O* | |
2338 O Don't complain if a file is being overwritten, even | |
2339 when it didn't exist when editing it. This is a | |
2340 protection against a file unexpectedly created by | |
2341 someone else. Vi didn't complain about this. | |
2342 *cpo-p* | |
2343 p Vi compatible Lisp indenting. When not present, a | |
2344 slightly better algorithm is used. | |
590 | 2345 *cpo-P* |
2346 P When included, a ":write" command that appends to a | |
2347 file will set the file name for the current buffer, if | |
2348 the current buffer doesn't have a file name yet and | |
2349 the 'F' flag is also included |cpo-F|. | |
164 | 2350 *cpo-q* |
2351 q When joining multiple lines leave the cursor at the | |
2352 position where it would be when joining two lines. | |
7 | 2353 *cpo-r* |
2354 r Redo ("." command) uses "/" to repeat a search | |
2355 command, instead of the actually used search string. | |
2356 *cpo-R* | |
2357 R Remove marks from filtered lines. Without this flag | |
2358 marks are kept like |:keepmarks| was used. | |
2359 *cpo-s* | |
2360 s Set buffer options when entering the buffer for the | |
2361 first time. This is like it is in Vim version 3.0. | |
10 | 2362 And it is the default. If not present the options are |
7 | 2363 set when the buffer is created. |
2364 *cpo-S* | |
2365 S Set buffer options always when entering a buffer | |
2366 (except 'readonly', 'fileformat', 'filetype' and | |
2367 'syntax'). This is the (most) Vi compatible setting. | |
2368 The options are set to the values in the current | |
2369 buffer. When you change an option and go to another | |
2370 buffer, the value is copied. Effectively makes the | |
2371 buffer options global to all buffers. | |
2372 | |
2373 's' 'S' copy buffer options | |
2374 no no when buffer created | |
2375 yes no when buffer first entered (default) | |
2376 X yes each time when buffer entered (vi comp.) | |
2377 *cpo-t* | |
2378 t Search pattern for the tag command is remembered for | |
2379 "n" command. Otherwise Vim only puts the pattern in | |
2380 the history for search pattern, but doesn't change the | |
2381 last used search pattern. | |
2382 *cpo-u* | |
10 | 2383 u Undo is Vi compatible. See |undo-two-ways|. |
7 | 2384 *cpo-v* |
2385 v Backspaced characters remain visible on the screen in | |
2386 Insert mode. Without this flag the characters are | |
2387 erased from the screen right away. With this flag the | |
2388 screen newly typed text overwrites backspaced | |
2389 characters. | |
2390 *cpo-w* | |
2391 w When using "cw" on a blank character, only change one | |
2392 character and not all blanks until the start of the | |
2393 next word. | |
2394 *cpo-W* | |
2395 W Don't overwrite a readonly file. When omitted, ":w!" | |
2396 overwrites a readonly file, if possible. | |
2397 *cpo-x* | |
2398 x <Esc> on the command-line executes the command-line. | |
2399 The default in Vim is to abandon the command-line, | |
2400 because <Esc> normally aborts a command. |c_<Esc>| | |
164 | 2401 *cpo-X* |
2402 X When using a count with "R" the replaced text is | |
2403 deleted only once. Also when repeating "R" with "." | |
2404 and a count. | |
7 | 2405 *cpo-y* |
15512 | 2406 y A yank command can be redone with ".". Think twice if |
2407 you really want to use this, it may break some | |
2408 plugins, since most people expect "." to only repeat a | |
2409 change. | |
164 | 2410 *cpo-Z* |
2411 Z When using "w!" while the 'readonly' option is set, | |
2412 don't reset 'readonly'. | |
7 | 2413 *cpo-!* |
2414 ! When redoing a filter command, use the last used | |
2415 external command, whatever it was. Otherwise the last | |
2416 used -filter- command is used. | |
2417 *cpo-$* | |
2418 $ When making a change to one line, don't redisplay the | |
2419 line, but put a '$' at the end of the changed text. | |
2420 The changed text will be overwritten when you type the | |
2421 new text. The line is redisplayed if you type any | |
2422 command that moves the cursor from the insertion | |
2423 point. | |
2424 *cpo-%* | |
2425 % Vi-compatible matching is done for the "%" command. | |
2426 Does not recognize "#if", "#endif", etc. | |
2427 Does not recognize "/*" and "*/". | |
2428 Parens inside single and double quotes are also | |
2429 counted, causing a string that contains a paren to | |
2430 disturb the matching. For example, in a line like | |
2431 "if (strcmp("foo(", s))" the first paren does not | |
2432 match the last one. When this flag is not included, | |
2433 parens inside single and double quotes are treated | |
2434 specially. When matching a paren outside of quotes, | |
2435 everything inside quotes is ignored. When matching a | |
2436 paren inside quotes, it will find the matching one (if | |
10 | 2437 there is one). This works very well for C programs. |
36 | 2438 This flag is also used for other features, such as |
2439 C-indenting. | |
161 | 2440 *cpo--* |
2441 - When included, a vertical movement command fails when | |
632 | 2442 it would go above the first line or below the last |
2443 line. Without it the cursor moves to the first or | |
2444 last line, unless it already was in that line. | |
161 | 2445 Applies to the commands "-", "k", CTRL-P, "+", "j", |
632 | 2446 CTRL-N, CTRL-J and ":1234". |
39 | 2447 *cpo-+* |
2448 + When included, a ":write file" command will reset the | |
2449 'modified' flag of the buffer, even though the buffer | |
2450 itself may still be different from its file. | |
856 | 2451 *cpo-star* |
7 | 2452 * Use ":*" in the same way as ":@". When not included, |
2453 ":*" is an alias for ":'<,'>", select the Visual area. | |
2454 *cpo-<* | |
2455 < Disable the recognition of special key codes in |<>| | |
2456 form in mappings, abbreviations, and the "to" part of | |
10 | 2457 menu commands. For example, the command |
7 | 2458 ":map X <Tab>" results in X being mapped to: |
2459 '<' included: "<Tab>" (5 characters) | |
2460 '<' excluded: "^I" (^I is a real <Tab>) | |
2461 Also see the 'k' flag above. | |
164 | 2462 *cpo->* |
2463 > When appending to a register, put a line break before | |
2464 the appended text. | |
2925 | 2465 *cpo-;* |
2466 ; When using |,| or |;| to repeat the last |t| search | |
2467 and the cursor is right in front of the searched | |
2468 character, the cursor won't move. When not included, | |
2469 the cursor would skip over it and jump to the | |
3557 | 2470 following occurrence. |
164 | 2471 |
2472 POSIX flags. These are not included in the Vi default value, except | |
2473 when $VIM_POSIX was set on startup. |posix| | |
2474 | |
2475 contains behavior ~ | |
856 | 2476 *cpo-#* |
164 | 2477 # A count before "D", "o" and "O" has no effect. |
168 | 2478 *cpo-&* |
2479 & When ":preserve" was used keep the swap file when | |
2480 exiting normally while this buffer is still loaded. | |
2481 This flag is tested when exiting. | |
2482 *cpo-\* | |
2483 \ Backslash in a [] range in a search pattern is taken | |
2484 literally, only "\]" is special See |/[]| | |
488 | 2485 '\' included: "/[ \-]" finds <Space>, '\' and '-' |
2486 '\' excluded: "/[ \-]" finds <Space> and '-' | |
2487 Also see |cpo-l|. | |
168 | 2488 *cpo-/* |
2489 / When "%" is used as the replacement string in a |:s| | |
2490 command, use the previous replacement string. |:s%| | |
164 | 2491 *cpo-{* |
2492 { The |{| and |}| commands also stop at a "{" character | |
2493 at the start of a line. | |
168 | 2494 *cpo-.* |
2495 . The ":chdir" and ":cd" commands fail if the current | |
2496 buffer is modified, unless ! is used. Vim doesn't | |
2497 need this, since it remembers the full path of an | |
2498 opened file. | |
164 | 2499 *cpo-bar* |
2500 | The value of the $LINES and $COLUMNS environment | |
2501 variables overrule the terminal size values obtained | |
2502 with system specific functions. | |
2503 | |
7 | 2504 |
2180
f60a0c9cbe6c
Add the blowfish encryption patch from Mohsin Ahmed. Needs more work.
Bram Moolenaar <bram@vim.org>
parents:
2178
diff
changeset
|
2505 *'cryptmethod'* *'cm'* |
15192
690da0a83419
patch 8.1.0606: 'cryptmethod' defaults to a very old method
Bram Moolenaar <Bram@vim.org>
parents:
15131
diff
changeset
|
2506 '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
|
2507 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
|
2508 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
|
2509 *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
|
2510 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
|
2511 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
|
2512 *blowfish* |
6122 | 2513 blowfish Blowfish method. Medium strong encryption but it has |
2514 an implementation flaw. Requires Vim 7.3 or later, | |
2515 files can NOT be read by Vim 7.2 and older. This adds | |
2516 a "seed" to the file, every time you write the file | |
2517 the encrypted bytes will be different. | |
2518 *blowfish2* | |
2519 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
|
2520 Vim 7.4.401 or later, files can NOT be read by Vim 7.3 |
6122 | 2521 and older. This adds a "seed" to the file, every time |
2522 you write the file the encrypted bytes will be | |
2523 different. The whole undo file is encrypted, not just | |
2524 the pieces of text. | |
27537 | 2525 *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
|
2526 *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
|
2527 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
|
2528 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
|
2529 Encryption is provided by the libsodium library, it |
25973 | 2530 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
|
2531 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
|
2532 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
|
2533 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
|
2534 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
|
2535 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
|
2536 enabled. |
7e9e53a0368f
patch 8.2.3022: available encryption methods are not strong enough
Bram Moolenaar <Bram@vim.org>
parents:
24911
diff
changeset
|
2537 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
|
2538 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
|
2539 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
|
2540 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
|
2541 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
|
2542 |
8748
b1a19a2f73f0
commit https://github.com/vim/vim/commit/4f3f668c8486444e53163c29d2fc79bf47eb3c82
Christian Brabandt <cb@256bit.org>
parents:
8629
diff
changeset
|
2543 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
|
2544 |
2180
f60a0c9cbe6c
Add the blowfish encryption patch from Mohsin Ahmed. Needs more work.
Bram Moolenaar <bram@vim.org>
parents:
2178
diff
changeset
|
2545 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
|
2546 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
|
2547 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
|
2548 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
|
2549 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
|
2550 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
|
2551 |
d8e4b27cef80
Change 'cryptmethod' from a number to a string option. Make it global-local.
Bram Moolenaar <bram@vim.org>
parents:
2350
diff
changeset
|
2552 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
|
2553 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
|
2554 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
|
2555 |
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
|
2556 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
|
2557 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
|
2558 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
|
2559 |
f60a0c9cbe6c
Add the blowfish encryption patch from Mohsin Ahmed. Needs more work.
Bram Moolenaar <bram@vim.org>
parents:
2178
diff
changeset
|
2560 |
7 | 2561 *'cscopepathcomp'* *'cspc'* |
2562 'cscopepathcomp' 'cspc' number (default 0) | |
2563 global | |
2564 {not available when compiled without the |+cscope| | |
2565 feature} | |
2566 Determines how many components of the path to show in a list of tags. | |
2567 See |cscopepathcomp|. | |
11160 | 2568 NOTE: This option is set to 0 when 'compatible' is set. |
7 | 2569 |
2570 *'cscopeprg'* *'csprg'* | |
2571 'cscopeprg' 'csprg' string (default "cscope") | |
2572 global | |
2573 {not available when compiled without the |+cscope| | |
2574 feature} | |
2575 Specifies the command to execute cscope. See |cscopeprg|. | |
2576 This option cannot be set from a |modeline| or in the |sandbox|, for | |
2577 security reasons. | |
2578 | |
2579 *'cscopequickfix'* *'csqf'* | |
2580 'cscopequickfix' 'csqf' string (default "") | |
2581 global | |
2582 {not available when compiled without the |+cscope| | |
2583 or |+quickfix| features} | |
2584 Specifies whether to use quickfix window to show cscope results. | |
2585 See |cscopequickfix|. | |
2586 | |
4869 | 2587 *'cscoperelative'* *'csre'* *'nocscoperelative'* *'nocsre'* |
2873 | 2588 'cscoperelative' 'csre' boolean (default off) |
2589 global | |
2590 {not available when compiled without the |+cscope| | |
2591 feature} | |
2592 In the absence of a prefix (-P) for cscope. setting this option enables | |
2593 to use the basename of cscope.out path as the prefix. | |
2594 See |cscoperelative|. | |
11160 | 2595 NOTE: This option is reset when 'compatible' is set. |
2873 | 2596 |
7 | 2597 *'cscopetag'* *'cst'* *'nocscopetag'* *'nocst'* |
2598 'cscopetag' 'cst' boolean (default off) | |
2599 global | |
2600 {not available when compiled without the |+cscope| | |
2601 feature} | |
2602 Use cscope for tag commands. See |cscope-options|. | |
2603 NOTE: This option is reset when 'compatible' is set. | |
2604 | |
2605 *'cscopetagorder'* *'csto'* | |
2606 'cscopetagorder' 'csto' number (default 0) | |
2607 global | |
2608 {not available when compiled without the |+cscope| | |
2609 feature} | |
2610 Determines the order in which ":cstag" performs a search. See | |
2611 |cscopetagorder|. | |
2612 NOTE: This option is set to 0 when 'compatible' is set. | |
2613 | |
2614 *'cscopeverbose'* *'csverb'* | |
2615 *'nocscopeverbose'* *'nocsverb'* | |
2616 'cscopeverbose' 'csverb' boolean (default off) | |
2617 global | |
2618 {not available when compiled without the |+cscope| | |
2619 feature} | |
2620 Give messages when adding a cscope database. See |cscopeverbose|. | |
2621 NOTE: This option is reset when 'compatible' is set. | |
2622 | |
2250
1bac28a53fae
Add the conceal patch from Vince Negri.
Bram Moolenaar <bram@vim.org>
parents:
2249
diff
changeset
|
2623 *'cursorbind'* *'crb'* *'nocursorbind'* *'nocrb'* |
1bac28a53fae
Add the conceal patch from Vince Negri.
Bram Moolenaar <bram@vim.org>
parents:
2249
diff
changeset
|
2624 'cursorbind' 'crb' boolean (default off) |
1bac28a53fae
Add the conceal patch from Vince Negri.
Bram Moolenaar <bram@vim.org>
parents:
2249
diff
changeset
|
2625 local to window |
1bac28a53fae
Add the conceal patch from Vince Negri.
Bram Moolenaar <bram@vim.org>
parents:
2249
diff
changeset
|
2626 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
|
2627 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
|
2628 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
|
2629 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
|
2630 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
|
2631 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
|
2632 taken into account. |
2250
1bac28a53fae
Add the conceal patch from Vince Negri.
Bram Moolenaar <bram@vim.org>
parents:
2249
diff
changeset
|
2633 |
743 | 2634 |
2635 *'cursorcolumn'* *'cuc'* *'nocursorcolumn'* *'nocuc'* | |
2636 'cursorcolumn' 'cuc' boolean (default off) | |
2637 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
|
2638 {not available when compiled without the |+syntax| |
743 | 2639 feature} |
2640 Highlight the screen column of the cursor with CursorColumn | |
2641 |hl-CursorColumn|. Useful to align text. Will make screen redrawing | |
2642 slower. | |
826 | 2643 If you only want the highlighting in the current window you can use |
2644 these autocommands: > | |
2645 au WinLeave * set nocursorline nocursorcolumn | |
2646 au WinEnter * set cursorline cursorcolumn | |
2647 < | |
743 | 2648 |
2649 *'cursorline'* *'cul'* *'nocursorline'* *'nocul'* | |
2650 'cursorline' 'cul' boolean (default off) | |
2651 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
|
2652 {not available when compiled without the |+syntax| |
743 | 2653 feature} |
18047
6650e3dff8d4
patch 8.1.2019: 'cursorline' always highlights the whole line
Bram Moolenaar <Bram@vim.org>
parents:
17909
diff
changeset
|
2654 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
|
2655 Useful to easily spot the cursor. Will make screen redrawing slower. |
818 | 2656 When Visual mode is active the highlighting isn't used to make it |
825 | 2657 easier to see the selected text. |
743 | 2658 |
2659 | |
18047
6650e3dff8d4
patch 8.1.2019: 'cursorline' always highlights the whole line
Bram Moolenaar <Bram@vim.org>
parents:
17909
diff
changeset
|
2660 *'cursorlineopt'* *'culopt'* |
18068
1101eacc1444
patch 8.1.2029: cannot control 'cursorline' highlighting well
Bram Moolenaar <Bram@vim.org>
parents:
18053
diff
changeset
|
2661 '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
|
2662 local to window |
6650e3dff8d4
patch 8.1.2019: 'cursorline' always highlights the whole line
Bram Moolenaar <Bram@vim.org>
parents:
17909
diff
changeset
|
2663 {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
|
2664 feature} |
28379 | 2665 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
|
2666 Valid values: |
1101eacc1444
patch 8.1.2029: cannot control 'cursorline' highlighting well
Bram Moolenaar <Bram@vim.org>
parents:
18053
diff
changeset
|
2667 "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
|
2668 CursorLine |hl-CursorLine|. |
1101eacc1444
patch 8.1.2029: cannot control 'cursorline' highlighting well
Bram Moolenaar <Bram@vim.org>
parents:
18053
diff
changeset
|
2669 "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
|
2670 CursorLine |hl-CursorLine|. |
18068
1101eacc1444
patch 8.1.2029: cannot control 'cursorline' highlighting well
Bram Moolenaar <Bram@vim.org>
parents:
18053
diff
changeset
|
2671 "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
|
2672 CursorLineNr |hl-CursorLineNr|. |
18068
1101eacc1444
patch 8.1.2029: cannot control 'cursorline' highlighting well
Bram Moolenaar <Bram@vim.org>
parents:
18053
diff
changeset
|
2673 |
1101eacc1444
patch 8.1.2029: cannot control 'cursorline' highlighting well
Bram Moolenaar <Bram@vim.org>
parents:
18053
diff
changeset
|
2674 Special value: |
1101eacc1444
patch 8.1.2029: cannot control 'cursorline' highlighting well
Bram Moolenaar <Bram@vim.org>
parents:
18053
diff
changeset
|
2675 "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
|
2676 |
1101eacc1444
patch 8.1.2029: cannot control 'cursorline' highlighting well
Bram Moolenaar <Bram@vim.org>
parents:
18053
diff
changeset
|
2677 "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
|
2678 |
6650e3dff8d4
patch 8.1.2019: 'cursorline' always highlights the whole line
Bram Moolenaar <Bram@vim.org>
parents:
17909
diff
changeset
|
2679 |
7 | 2680 *'debug'* |
2681 'debug' string (default "") | |
2682 global | |
839 | 2683 These values can be used: |
2684 msg Error messages that would otherwise be omitted will be given | |
2685 anyway. | |
2686 throw Error messages that would otherwise be omitted will be given | |
2687 anyway and also throw an exception and set |v:errmsg|. | |
2688 beep A message will be given when otherwise only a beep would be | |
2689 produced. | |
168 | 2690 The values can be combined, separated by a comma. |
839 | 2691 "msg" and "throw" are useful for debugging 'foldexpr', 'formatexpr' or |
2692 'indentexpr'. | |
7 | 2693 |
2694 *'define'* *'def'* | |
2695 'define' 'def' string (default "^\s*#\s*define") | |
2696 global or local to buffer |global-local| | |
10 | 2697 Pattern to be used to find a macro definition. It is a search |
7 | 2698 pattern, just like for the "/" command. This option is used for the |
2699 commands like "[i" and "[d" |include-search|. The 'isident' option is | |
2700 used to recognize the defined name after the match: | |
2701 {match with 'define'}{non-ID chars}{defined name}{non-ID char} | |
2702 See |option-backslash| about inserting backslashes to include a space | |
2703 or backslash. | |
2704 The default value is for C programs. For C++ this value would be | |
2705 useful, to include const type declarations: > | |
2706 ^\(#\s*define\|[a-z]*\s*const\s*[a-z]*\) | |
16086 | 2707 < You can also use "\ze" just before the name and continue the pattern |
2708 to check what is following. E.g. for Javascript, if a function is | |
2709 defined with "func_name = function(args)": > | |
2710 ^\s*\ze\i\+\s*=\s*function( | |
2711 < If the function is defined with "func_name : function() {...": > | |
2712 ^\s*\ze\i\+\s*[:]\s*(*function\s*( | |
7 | 2713 < When using the ":set" command, you need to double the backslashes! |
16086 | 2714 To avoid that use `:let` with a single quote string: > |
2715 let &l:define = '^\s*\ze\k\+\s*=\s*function(' | |
16380 | 2716 < |
7 | 2717 |
2718 *'delcombine'* *'deco'* *'nodelcombine'* *'nodeco'* | |
2719 'delcombine' 'deco' boolean (default off) | |
2720 global | |
2721 If editing Unicode and this option is set, backspace and Normal mode | |
2722 "x" delete each combining character on its own. When it is off (the | |
2723 default) the character along with its combining characters are | |
2724 deleted. | |
22565 | 2725 Note: When 'delcombine' is set "xx" may work differently from "2x"! |
7 | 2726 |
2727 This is useful for Arabic, Hebrew and many other languages where one | |
2728 may have combining characters overtop of base characters, and want | |
2729 to remove only the combining ones. | |
11160 | 2730 NOTE: This option is reset when 'compatible' is set. |
7 | 2731 |
2732 *'dictionary'* *'dict'* | |
2733 'dictionary' 'dict' string (default "") | |
2734 global or local to buffer |global-local| | |
2735 List of file names, separated by commas, that are used to lookup words | |
2736 for keyword completion commands |i_CTRL-X_CTRL-K|. Each file should | |
2737 contain a list of words. This can be one word per line, or several | |
2738 words per line, separated by non-keyword characters (white space is | |
2739 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
|
2740 |
741b1feeac9f
patch 8.0.1845: various comment updates needed, missing white space
Christian Brabandt <cb@256bit.org>
parents:
13818
diff
changeset
|
2741 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
|
2742 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
|
2743 '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
|
2744 |
10 | 2745 To include a comma in a file name precede it with a backslash. Spaces |
7 | 2746 after a comma are ignored, otherwise spaces are included in the file |
2747 name. See |option-backslash| about using backslashes. | |
99 | 2748 This has nothing to do with the |Dictionary| variable type. |
7 | 2749 Where to find a list of words? |
2750 - On FreeBSD, there is the file "/usr/share/dict/words". | |
2751 - In the Simtel archive, look in the "msdos/linguist" directory. | |
2752 - In "miscfiles" of the GNU collection. | |
2753 The use of |:set+=| and |:set-=| is preferred when adding or removing | |
2754 directories from the list. This avoids problems when a future version | |
2755 uses another default. | |
2756 Backticks cannot be used in this option for security reasons. | |
2757 | |
2758 *'diff'* *'nodiff'* | |
2759 'diff' boolean (default off) | |
2760 local to window | |
2761 {not available when compiled without the |+diff| | |
2762 feature} | |
2763 Join the current window in the group of windows that shows differences | |
10 | 2764 between files. See |vimdiff|. |
7 | 2765 |
2766 *'dex'* *'diffexpr'* | |
2767 'diffexpr' 'dex' string (default "") | |
2768 global | |
2769 {not available when compiled without the |+diff| | |
2770 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
|
2771 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
|
2772 or unified-style) from two versions of a file. See |diff-diffexpr|. |
7 | 2773 This option cannot be set from a |modeline| or in the |sandbox|, for |
2774 security reasons. | |
2775 | |
2776 *'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
|
2777 'diffopt' 'dip' string (default "internal,filler,closeoff") |
7 | 2778 global |
2779 {not available when compiled without the |+diff| | |
2780 feature} | |
10 | 2781 Option settings for diff mode. It can consist of the following items. |
7 | 2782 All are optional. Items must be separated by a comma. |
2783 | |
2784 filler Show filler lines, to keep the text | |
2785 synchronized with a window that has inserted | |
2786 lines at the same position. Mostly useful | |
2787 when windows are side-by-side and 'scrollbind' | |
2788 is set. | |
2789 | |
2790 context:{n} Use a context of {n} lines between a change | |
2791 and a fold that contains unchanged lines. | |
2792 When omitted a context of six lines is used. | |
15932 | 2793 When using zero the context is actually one, |
2794 since folds require a line in between, also | |
2795 for a deleted line. | |
7 | 2796 See |fold-diff|. |
2797 | |
14864 | 2798 iblank Ignore changes where lines are all blank. Adds |
2799 the "-B" flag to the "diff" command if | |
2800 'diffexpr' is empty. Check the documentation | |
2801 of the "diff" command for what this does | |
2802 exactly. | |
2803 NOTE: the diff windows will get out of sync, | |
2804 because no differences between blank lines are | |
2805 taken into account. | |
2806 | |
7 | 2807 icase Ignore changes in case of text. "a" and "A" |
2808 are considered the same. Adds the "-i" flag | |
2809 to the "diff" command if 'diffexpr' is empty. | |
2810 | |
2811 iwhite Ignore changes in amount of white space. Adds | |
2812 the "-b" flag to the "diff" command if | |
2813 'diffexpr' is empty. Check the documentation | |
2814 of the "diff" command for what this does | |
2815 exactly. It should ignore adding trailing | |
2816 white space, but not leading white space. | |
2817 | |
14864 | 2818 iwhiteall Ignore all white space changes. Adds |
2819 the "-w" flag to the "diff" command if | |
2820 'diffexpr' is empty. Check the documentation | |
2821 of the "diff" command for what this does | |
2822 exactly. | |
2823 | |
2824 iwhiteeol Ignore white space changes at end of line. | |
2825 Adds the "-Z" flag to the "diff" command if | |
2826 'diffexpr' is empty. Check the documentation | |
2827 of the "diff" command for what this does | |
2828 exactly. | |
2829 | |
766 | 2830 horizontal Start diff mode with horizontal splits (unless |
2831 explicitly specified otherwise). | |
2832 | |
2833 vertical Start diff mode with vertical splits (unless | |
2834 explicitly specified otherwise). | |
2835 | |
18590
41484f342f80
patch 8.1.2289: after :diffsplit closing the window does not disable diff
Bram Moolenaar <Bram@vim.org>
parents:
18574
diff
changeset
|
2836 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
|
2837 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
|
2838 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
|
2839 `: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
|
2840 `: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
|
2841 |
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
|
2842 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
|
2843 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
|
2844 |
766 | 2845 foldcolumn:{n} Set the 'foldcolumn' option to {n} when |
2846 starting diff mode. Without this 2 is used. | |
2847 | |
23895
e313b6ee2d9c
patch 8.2.2490: 'wrap' option is always reset when starting diff mode
Bram Moolenaar <Bram@vim.org>
parents:
23825
diff
changeset
|
2848 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
|
2849 |
14696
195e8b1fcbbf
patch 8.1.0360: using an external diff program is slow and inflexible
Christian Brabandt <cb@256bit.org>
parents:
14695
diff
changeset
|
2850 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
|
2851 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
|
2852 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
|
2853 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
|
2854 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
|
2855 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
|
2856 |
195e8b1fcbbf
patch 8.1.0360: using an external diff program is slow and inflexible
Christian Brabandt <cb@256bit.org>
parents:
14695
diff
changeset
|
2857 indent-heuristic |
15033 | 2858 Use the indent heuristic for the internal |
2859 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
|
2860 |
195e8b1fcbbf
patch 8.1.0360: using an external diff program is slow and inflexible
Christian Brabandt <cb@256bit.org>
parents:
14695
diff
changeset
|
2861 algorithm:{text} Use the specified diff algorithm with the |
15033 | 2862 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
|
2863 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
|
2864 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
|
2865 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
|
2866 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
|
2867 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
|
2868 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
|
2869 |
7 | 2870 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
|
2871 :set diffopt=internal,filler,context:4 |
7 | 2872 :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
|
2873 :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
|
2874 :set diffopt-=internal " do NOT use the internal diff parser |
7 | 2875 < |
2876 *'digraph'* *'dg'* *'nodigraph'* *'nodg'* | |
2877 'digraph' 'dg' boolean (default off) | |
2878 global | |
2879 {not available when compiled without the |+digraphs| | |
2880 feature} | |
2881 Enable the entering of digraphs in Insert mode with {char1} <BS> | |
2882 {char2}. See |digraphs|. | |
2883 NOTE: This option is reset when 'compatible' is set. | |
2884 | |
2885 *'directory'* *'dir'* | |
2886 'directory' 'dir' string (default for Amiga: ".,t:", | |
18972 | 2887 for Win32: ".,$TEMP,c:\tmp,c:\temp" |
7 | 2888 for Unix: ".,~/tmp,/var/tmp,/tmp") |
2889 global | |
2890 List of directory names for the swap file, separated with commas. | |
21676 | 2891 Recommended value: ".,~/vimswap//" - this will put the swap file next |
2892 to the edited file if possible, and in your personal swap directory | |
2893 otherwise. Make sure "~/vimswap//" is only readable for you. | |
2894 | |
2895 Possible items: | |
7 | 2896 - The swap file will be created in the first directory where this is |
2897 possible. | |
2898 - 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
|
2899 impossible!) and no |E303| error will be given. |
7 | 2900 - A directory "." means to put the swap file in the same directory as |
2901 the edited file. On Unix, a dot is prepended to the file name, so | |
2902 it doesn't show in a directory listing. On MS-Windows the "hidden" | |
2903 attribute is set and a dot prepended if possible. | |
19116 | 2904 - A directory starting with "./" (or ".\" for MS-Windows) means to put |
2905 the swap file relative to where the edited file is. The leading "." | |
2906 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
|
2907 - 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
|
2908 the swap file name will be built from the complete path to the file |
21991 | 2909 with all path separators replaced by percent '%' signs (including |
2910 the colon following the drive letter on Win32). This will ensure | |
2911 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
|
2912 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
|
2913 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
|
2914 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
|
2915 use '//', instead of '\\'. |
7 | 2916 - Spaces after the comma are ignored, other spaces are considered part |
2917 of the directory name. To have a space at the start of a directory | |
2918 name, precede it with a backslash. | |
2919 - To include a comma in a directory name precede it with a backslash. | |
2920 - A directory name may end in an ':' or '/'. | |
2921 - Environment variables are expanded |:set_env|. | |
2922 - Careful with '\' characters, type one before a space, type two to | |
2923 get one in the option (see |option-backslash|), for example: > | |
2924 :set dir=c:\\tmp,\ dir\\,with\\,commas,\\\ dir\ with\ spaces | |
2925 < - For backwards compatibility with Vim version 3.0 a '>' at the start | |
2926 of the option is removed. | |
2927 Using "." first in the list is recommended. This means that editing | |
2928 the same file twice will result in a warning. Using "/tmp" on Unix is | |
2929 discouraged: When the system crashes you lose the swap file. | |
2930 "/var/tmp" is often not cleared when rebooting, thus is a better | |
21676 | 2931 choice than "/tmp". But others on the computer may be able to see the |
2932 files, and it can contain a lot of files, your swap files get lost in | |
2933 the crowd. That is why a "tmp" directory in your home directory is | |
2934 tried first. | |
7 | 2935 The use of |:set+=| and |:set-=| is preferred when adding or removing |
2936 directories from the list. This avoids problems when a future version | |
2937 uses another default. | |
2938 This option cannot be set from a |modeline| or in the |sandbox|, for | |
2939 security reasons. | |
2940 | |
2941 *'display'* *'dy'* | |
9737
35ce559b8553
commit https://github.com/vim/vim/commit/bc8801c9317eb721a2ee91322669f2dd5d136380
Christian Brabandt <cb@256bit.org>
parents:
9669
diff
changeset
|
2942 '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
|
2943 |defaults.vim|) |
7 | 2944 global |
30634 | 2945 Change the way text is displayed. This is a comma-separated list of |
7 | 2946 flags: |
2947 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
|
2948 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
|
2949 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
|
2950 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
|
2951 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
|
2952 column of the last screen line. Overrules "lastline". |
7 | 2953 uhex Show unprintable characters hexadecimal as <xx> |
2954 instead of using ^C and ~C. | |
2955 | |
10211
b7da8d4c594c
commit https://github.com/vim/vim/commit/d07969093a9b3051511c478d71c36de6fc33c0d6
Christian Brabandt <cb@256bit.org>
parents:
10198
diff
changeset
|
2956 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
|
2957 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
|
2958 |
30643
dfb02f9dcbe8
patch 9.0.0656: cannot specify another character to use instead of '@'
Bram Moolenaar <Bram@vim.org>
parents:
30634
diff
changeset
|
2959 The "@" character can be changed by setting the "lastline" item in |
dfb02f9dcbe8
patch 9.0.0656: cannot specify another character to use instead of '@'
Bram Moolenaar <Bram@vim.org>
parents:
30634
diff
changeset
|
2960 'fillchars'. The character is highlighted with |hl-NonText|. |
dfb02f9dcbe8
patch 9.0.0656: cannot specify another character to use instead of '@'
Bram Moolenaar <Bram@vim.org>
parents:
30634
diff
changeset
|
2961 |
7 | 2962 *'eadirection'* *'ead'* |
2963 'eadirection' 'ead' string (default "both") | |
2964 global | |
2965 Tells when the 'equalalways' option applies: | |
2966 ver vertically, width of windows is not affected | |
2967 hor horizontally, height of windows is not affected | |
2968 both width and height of windows is affected | |
2969 | |
2970 *'ed'* *'edcompatible'* *'noed'* *'noedcompatible'* | |
2971 'edcompatible' 'ed' boolean (default off) | |
2972 global | |
2973 Makes the 'g' and 'c' flags of the ":substitute" command to be | |
2974 toggled each time the flag is given. See |complex-change|. See | |
2975 also 'gdefault' option. | |
11442 | 2976 Switching this option on may break plugins! |
23305 | 2977 This option is not used in |Vim9| script. |
7 | 2978 |
8876
47f17f66da3d
commit https://github.com/vim/vim/commit/03413f44167c4b5cd0012def9bb331e2518c83cf
Christian Brabandt <cb@256bit.org>
parents:
8835
diff
changeset
|
2979 *'emoji'* *'emo'* *'noemoji'* *'noemo'* |
8629
54ac275e3fc4
commit https://github.com/vim/vim/commit/3848e00e0177abdb31bc600234967863ec487233
Christian Brabandt <cb@256bit.org>
parents:
8560
diff
changeset
|
2980 'emoji' 'emo' boolean (default: on) |
54ac275e3fc4
commit https://github.com/vim/vim/commit/3848e00e0177abdb31bc600234967863ec487233
Christian Brabandt <cb@256bit.org>
parents:
8560
diff
changeset
|
2981 global |
54ac275e3fc4
commit https://github.com/vim/vim/commit/3848e00e0177abdb31bc600234967863ec487233
Christian Brabandt <cb@256bit.org>
parents:
8560
diff
changeset
|
2982 When on all Unicode emoji characters are considered to be full width. |
22328 | 2983 This excludes "text emoji" characters, which are normally displayed as |
2984 single width. Unfortunately there is no good specification for this | |
2985 and it has been determined on trial-and-error basis. Use the | |
2986 |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
|
2987 |
7 | 2988 *'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
|
2989 '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
|
2990 otherwise: value from $LANG or "latin1") |
7 | 2991 global |
2992 Sets the character encoding used inside Vim. It applies to text in | |
2993 the buffers, registers, Strings in expressions, text stored in the | |
2994 viminfo file, etc. It sets the kind of characters which Vim can work | |
2995 with. See |encoding-names| for the possible values. | |
2996 | |
2997 NOTE: Changing this option will not change the encoding of the | |
39 | 2998 existing text in Vim. It may cause non-ASCII text to become invalid. |
7 | 2999 It should normally be kept at its default value, or set when Vim |
1152 | 3000 starts up. See |multibyte|. To reload the menus see |:menutrans|. |
7 | 3001 |
2317
2b2cd34569eb
Disallow setting 'enc' in a modeline. (Patrick Texier)
Bram Moolenaar <bram@vim.org>
parents:
2314
diff
changeset
|
3002 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
|
3003 corrupt the text. |
2b2cd34569eb
Disallow setting 'enc' in a modeline. (Patrick Texier)
Bram Moolenaar <bram@vim.org>
parents:
2314
diff
changeset
|
3004 |
10895
c391bfbdb452
Updated runtime files.
Christian Brabandt <cb@256bit.org>
parents:
10734
diff
changeset
|
3005 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
|
3006 to "utf-8". Although care has been taken to allow different values of |
7 | 3007 'encoding', "utf-8" is the natural choice for the environment and |
3008 avoids unnecessary conversion overhead. "utf-8" has not been made | |
10 | 3009 the default to prevent different behavior of the GUI and terminal |
7 | 3010 versions, and to avoid changing the encoding of newly created files |
3011 without your knowledge (in case 'fileencodings' is empty). | |
3012 | |
3013 The character encoding of files can be different from 'encoding'. | |
10 | 3014 This is specified with 'fileencoding'. The conversion is done with |
7 | 3015 iconv() or as specified with 'charconvert'. |
3016 | |
21991 | 3017 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
|
3018 can use: > |
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
3019 if has("multi_byte_encoding") |
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
3020 < |
7 | 3021 Normally 'encoding' will be equal to your current locale. This will |
3022 be the default if Vim recognizes your environment settings. If | |
3023 'encoding' is not set to the current locale, 'termencoding' must be | |
3024 set to convert typed and displayed text. See |encoding-table|. | |
3025 | |
3026 When you set this option, it fires the |EncodingChanged| autocommand | |
3027 event so that you can set up fonts if necessary. | |
3028 | |
3029 When the option is set, the value is converted to lowercase. Thus | |
3030 you can set it with uppercase values too. Underscores are translated | |
3031 to '-' signs. | |
3032 When the encoding is recognized, it is changed to the standard name. | |
3033 For example "Latin-1" becomes "latin1", "ISO_88592" becomes | |
3034 "iso-8859-2" and "utf8" becomes "utf-8". | |
3035 | |
3036 Note: "latin1" is also used when the encoding could not be detected. | |
3037 This only works when editing files in the same encoding! When the | |
3038 actual character set is not latin1, make sure 'fileencoding' and | |
3039 'fileencodings' are empty. When conversion is needed, switch to using | |
3040 utf-8. | |
3041 | |
3042 When "unicode", "ucs-2" or "ucs-4" is used, Vim internally uses utf-8. | |
3043 You don't notice this while editing, but it does matter for the | |
3044 |viminfo-file|. And Vim expects the terminal to use utf-8 too. Thus | |
3045 setting 'encoding' to one of these values instead of utf-8 only has | |
3046 effect for encoding used for files when 'fileencoding' is empty. | |
448 | 3047 |
3048 When 'encoding' is set to a Unicode encoding, and 'fileencodings' was | |
3049 not set yet, the default for 'fileencodings' is changed. | |
7 | 3050 |
30967 | 3051 *'endoffile'* *'eof'* *'noendoffile'* *'noeof'* |
31055
5a95f0c630b1
patch 9.0.0862: default value of 'endoffile' is wrong
Bram Moolenaar <Bram@vim.org>
parents:
30982
diff
changeset
|
3052 'endoffile' 'eof' boolean (default off) |
7 | 3053 local to buffer |
30967 | 3054 Indicates that a CTRL-Z character was found at the end of the file |
3055 when reading it. Normally only happens when 'fileformat' is "dos". | |
7 | 3056 When writing a file and this option is off and the 'binary' option |
30967 | 3057 is on, or 'fixeol' option is off, no CTRL-Z will be written at the |
30962 | 3058 end of the file. |
30982
92b1338023ee
patch 9.0.0826: if 'endofline' is set CTRL-Z may be written in a wrong place
Bram Moolenaar <Bram@vim.org>
parents:
30967
diff
changeset
|
3059 See |eol-and-eof| for example settings. |
30962 | 3060 |
3061 *'endofline'* *'eol'* *'noendofline'* *'noeol'* | |
3062 'endofline' 'eol' boolean (default on) | |
3063 local to buffer | |
3064 When writing a file and this option is off and the 'binary' option | |
6933 | 3065 is on, or 'fixeol' option is off, no <EOL> will be written for the |
3066 last line in the file. This option is automatically set or reset when | |
3067 starting to edit a new file, depending on whether file has an <EOL> | |
3068 for the last line in the file. Normally you don't have to set or | |
3069 reset this option. | |
3070 When 'binary' is off and 'fixeol' is on the value is not used when | |
3071 writing the file. When 'binary' is on or 'fixeol' is off it is used | |
3072 to remember the presence of a <EOL> for the last line in the file, so | |
3073 that when you write the file the situation from the original file can | |
3074 be kept. But you can change it if you want to. | |
30982
92b1338023ee
patch 9.0.0826: if 'endofline' is set CTRL-Z may be written in a wrong place
Bram Moolenaar <Bram@vim.org>
parents:
30967
diff
changeset
|
3075 See |eol-and-eof| for example settings. |
7 | 3076 |
3077 *'equalalways'* *'ea'* *'noequalalways'* *'noea'* | |
3078 'equalalways' 'ea' boolean (default on) | |
3079 global | |
3080 When on, all the windows are automatically made the same size after | |
33 | 3081 splitting or closing a window. This also happens the moment the |
3082 option is switched on. When off, splitting a window will reduce the | |
3083 size of the current window and leave the other windows the same. When | |
3084 closing a window the extra lines are given to the window next to it | |
3085 (depending on 'splitbelow' and 'splitright'). | |
7 | 3086 When mixing vertically and horizontally split windows, a minimal size |
3087 is computed and some windows may be larger if there is room. The | |
3088 'eadirection' option tells in which direction the size is affected. | |
1354 | 3089 Changing the height and width of a window can be avoided by setting |
3090 'winfixheight' and 'winfixwidth', respectively. | |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
3091 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
|
3092 currently not equalized (it's complicated, but may be implemented in |
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
3093 the future). |
7 | 3094 |
3095 *'equalprg'* *'ep'* | |
3096 'equalprg' 'ep' string (default "") | |
3097 global or local to buffer |global-local| | |
3098 External program to use for "=" command. When this option is empty | |
1621 | 3099 the internal formatting functions are used; either 'lisp', 'cindent' |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
3100 or 'indentexpr'. When Vim was compiled without internal formatting, |
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
3101 the "indent" program is used. |
10 | 3102 Environment variables are expanded |:set_env|. See |option-backslash| |
7 | 3103 about including spaces and backslashes. |
3104 This option cannot be set from a |modeline| or in the |sandbox|, for | |
3105 security reasons. | |
3106 | |
3107 *'errorbells'* *'eb'* *'noerrorbells'* *'noeb'* | |
3108 'errorbells' 'eb' boolean (default off) | |
3109 global | |
3110 Ring the bell (beep or screen flash) for error messages. This only | |
3111 makes a difference for error messages, the bell will be used always | |
3112 for a lot of errors without a message (e.g., hitting <Esc> in Normal | |
10 | 3113 mode). See 'visualbell' on how to make the bell behave like a beep, |
6949 | 3114 screen flash or do nothing. See 'belloff' to finetune when to ring the |
3115 bell. | |
7 | 3116 |
3117 *'errorfile'* *'ef'* | |
3118 'errorfile' 'ef' string (Amiga default: "AztecC.Err", | |
3119 others: "errors.err") | |
3120 global | |
3121 {not available when compiled without the |+quickfix| | |
3122 feature} | |
3123 Name of the errorfile for the QuickFix mode (see |:cf|). | |
3124 When the "-q" command-line argument is used, 'errorfile' is set to the | |
3125 following argument. See |-q|. | |
3126 NOT used for the ":make" command. See 'makeef' for that. | |
3127 Environment variables are expanded |:set_env|. | |
3128 See |option-backslash| about including spaces and backslashes. | |
3129 This option cannot be set from a |modeline| or in the |sandbox|, for | |
3130 security reasons. | |
3131 | |
3132 *'errorformat'* *'efm'* | |
3133 'errorformat' 'efm' string (default is very long) | |
3134 global or local to buffer |global-local| | |
3135 {not available when compiled without the |+quickfix| | |
3136 feature} | |
3137 Scanf-like description of the format for the lines in the error file | |
3138 (see |errorformat|). | |
3139 | |
3140 *'esckeys'* *'ek'* *'noesckeys'* *'noek'* | |
3141 'esckeys' 'ek' boolean (Vim default: on, Vi default: off) | |
3142 global | |
3143 Function keys that start with an <Esc> are recognized in Insert | |
3144 mode. When this option is off, the cursor and function keys cannot be | |
3145 used in Insert mode if they start with an <Esc>. The advantage of | |
3146 this is that the single <Esc> is recognized immediately, instead of | |
3147 after one second. Instead of resetting this option, you might want to | |
3148 try changing the values for 'timeoutlen' and 'ttimeoutlen'. Note that | |
3149 when 'esckeys' is off, you can still map anything, but the cursor keys | |
3150 won't work by default. | |
3151 NOTE: This option is set to the Vi default value when 'compatible' is | |
3152 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
|
3153 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
|
3154 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
|
3155 key that has a modifier. |
7 | 3156 |
3157 *'eventignore'* *'ei'* | |
3158 'eventignore' 'ei' string (default "") | |
3159 global | |
3160 A list of autocommand event names, which are to be ignored. | |
844 | 3161 When set to "all" or when "all" is one of the items, all autocommand |
3162 events are ignored, autocommands will not be executed. | |
28379 | 3163 Otherwise this is a comma-separated list of event names. Example: > |
7 | 3164 :set ei=WinEnter,WinLeave |
3165 < | |
3166 *'expandtab'* *'et'* *'noexpandtab'* *'noet'* | |
3167 'expandtab' 'et' boolean (default off) | |
3168 local to buffer | |
3169 In Insert mode: Use the appropriate number of spaces to insert a | |
10 | 3170 <Tab>. Spaces are used in indents with the '>' and '<' commands and |
7 | 3171 when 'autoindent' is on. To insert a real tab when 'expandtab' is |
3172 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
|
3173 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
|
3174 the 'paste' option is reset. |
7 | 3175 NOTE: This option is reset when 'compatible' is set. |
3176 | |
3177 *'exrc'* *'ex'* *'noexrc'* *'noex'* | |
3178 'exrc' 'ex' boolean (default off) | |
3179 global | |
3180 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
|
3181 directory. |
018fead968c1
commit https://github.com/vim/vim/commit/36f44c21da2e912c008683a0c4447fca2a071e9a
Christian Brabandt <cb@256bit.org>
parents:
9975
diff
changeset
|
3182 |
018fead968c1
commit https://github.com/vim/vim/commit/36f44c21da2e912c008683a0c4447fca2a071e9a
Christian Brabandt <cb@256bit.org>
parents:
9975
diff
changeset
|
3183 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
|
3184 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
|
3185 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
|
3186 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
|
3187 matching directory. |
018fead968c1
commit https://github.com/vim/vim/commit/36f44c21da2e912c008683a0c4447fca2a071e9a
Christian Brabandt <cb@256bit.org>
parents:
9975
diff
changeset
|
3188 |
018fead968c1
commit https://github.com/vim/vim/commit/36f44c21da2e912c008683a0c4447fca2a071e9a
Christian Brabandt <cb@256bit.org>
parents:
9975
diff
changeset
|
3189 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
|
3190 'secure' option (see |initialization|). |
018fead968c1
commit https://github.com/vim/vim/commit/36f44c21da2e912c008683a0c4447fca2a071e9a
Christian Brabandt <cb@256bit.org>
parents:
9975
diff
changeset
|
3191 Also see |.vimrc| and |gui-init|. |
7 | 3192 This option cannot be set from a |modeline| or in the |sandbox|, for |
3193 security reasons. | |
3194 | |
3195 *'fileencoding'* *'fenc'* *E213* | |
3196 'fileencoding' 'fenc' string (default: "") | |
3197 local to buffer | |
3198 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
|
3199 |
7 | 3200 When 'fileencoding' is different from 'encoding', conversion will be |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
3201 done when writing the file. For reading see below. |
7 | 3202 When 'fileencoding' is empty, the same value as 'encoding' will be |
3203 used (no conversion when reading or writing a file). | |
11062 | 3204 No error will be given when the value is set, only when it is used, |
3205 only when writing a file. | |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
3206 Conversion will also be done when 'encoding' and 'fileencoding' are |
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
3207 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
|
3208 because internally Unicode is always stored as utf-8. |
7 | 3209 WARNING: Conversion can cause loss of information! When |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
3210 'encoding' is "utf-8" or another Unicode encoding, conversion |
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
3211 is most likely done in a way that the reverse conversion |
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
3212 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
|
3213 characters may be lost! |
2317
2b2cd34569eb
Disallow setting 'enc' in a modeline. (Patrick Texier)
Bram Moolenaar <bram@vim.org>
parents:
2314
diff
changeset
|
3214 |
7 | 3215 See 'encoding' for the possible values. Additionally, values may be |
3216 specified that can be handled by the converter, see | |
3217 |mbyte-conversion|. | |
2317
2b2cd34569eb
Disallow setting 'enc' in a modeline. (Patrick Texier)
Bram Moolenaar <bram@vim.org>
parents:
2314
diff
changeset
|
3218 |
7 | 3219 When reading a file 'fileencoding' will be set from 'fileencodings'. |
3220 To read a file in a certain encoding it won't work by setting | |
1152 | 3221 'fileencoding', use the |++enc| argument. One exception: when |
3222 'fileencodings' is empty the value of 'fileencoding' is used. | |
692 | 3223 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
|
3224 |
7 | 3225 Prepending "8bit-" and "2byte-" has no meaning here, they are ignored. |
3226 When the option is set, the value is converted to lowercase. Thus | |
3227 you can set it with uppercase values too. '_' characters are | |
3228 replaced with '-'. If a name is recognized from the list for | |
3229 'encoding', it is replaced by the standard name. For example | |
3230 "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
|
3231 |
7 | 3232 When this option is set, after starting to edit a file, the 'modified' |
3233 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
|
3234 |
2b2cd34569eb
Disallow setting 'enc' in a modeline. (Patrick Texier)
Bram Moolenaar <bram@vim.org>
parents:
2314
diff
changeset
|
3235 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
|
3236 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
|
3237 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
|
3238 '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
|
3239 |
7 | 3240 This option can not be changed when 'modifiable' is off. |
3241 | |
3242 *'fe'* | |
3243 NOTE: Before version 6.0 this option specified the encoding for the | |
10 | 3244 whole of Vim, this was a mistake. Now use 'encoding' instead. The |
7 | 3245 old short name was 'fe', which is no longer used. |
3246 | |
3247 *'fileencodings'* *'fencs'* | |
39 | 3248 'fileencodings' 'fencs' string (default: "ucs-bom", |
3249 "ucs-bom,utf-8,default,latin1" when | |
3250 'encoding' is set to a Unicode value) | |
7 | 3251 global |
3252 This is a list of character encodings considered when starting to edit | |
3253 an existing file. When a file is read, Vim tries to use the first | |
3254 mentioned character encoding. If an error is detected, the next one | |
3255 in the list is tried. When an encoding is found that works, | |
10 | 3256 'fileencoding' is set to it. If all fail, 'fileencoding' is set to |
7 | 3257 an empty string, which means the value of 'encoding' is used. |
3258 WARNING: Conversion can cause loss of information! When | |
3259 'encoding' is "utf-8" (or one of the other Unicode variants) | |
3260 conversion is most likely done in a way that the reverse | |
3261 conversion results in the same text. When 'encoding' is not | |
596 | 3262 "utf-8" some non-ASCII characters may be lost! You can use |
3263 the |++bad| argument to specify what is done with characters | |
3264 that can't be converted. | |
7 | 3265 For an empty file or a file with only ASCII characters most encodings |
3266 will work and the first entry of 'fileencodings' will be used (except | |
3267 "ucs-bom", which requires the BOM to be present). If you prefer | |
3268 another encoding use an BufReadPost autocommand event to test if your | |
3269 preferred encoding is to be used. Example: > | |
3270 au BufReadPost * if search('\S', 'w') == 0 | | |
3271 \ set fenc=iso-2022-jp | endif | |
3272 < This sets 'fileencoding' to "iso-2022-jp" if the file does not contain | |
3273 non-blank characters. | |
596 | 3274 When the |++enc| argument is used then the value of 'fileencodings' is |
3275 not used. | |
692 | 3276 Note that 'fileencodings' is not used for a new file, the global value |
3277 of 'fileencoding' is used instead. You can set it with: > | |
3278 :setglobal fenc=iso-8859-2 | |
3279 < This means that a non-existing file may get a different encoding than | |
3280 an empty file. | |
7 | 3281 The special value "ucs-bom" can be used to check for a Unicode BOM |
3282 (Byte Order Mark) at the start of the file. It must not be preceded | |
3283 by "utf-8" or another Unicode encoding for this to work properly. | |
3284 An entry for an 8-bit encoding (e.g., "latin1") should be the last, | |
3285 because Vim cannot detect an error, thus the encoding is always | |
3286 accepted. | |
39 | 3287 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
|
3288 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
|
3289 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
|
3290 '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
|
3291 encoding, such as Russian. |
777 | 3292 When 'encoding' is "utf-8" and a file contains an illegal byte |
3293 sequence it won't be recognized as UTF-8. You can use the |8g8| | |
3294 command to find the illegal byte sequence. | |
7 | 3295 WRONG VALUES: WHAT'S WRONG: |
3296 latin1,utf-8 "latin1" will always be used | |
3297 utf-8,ucs-bom,latin1 BOM won't be recognized in an utf-8 | |
3298 file | |
3299 cp1250,latin1 "cp1250" will always be used | |
3300 If 'fileencodings' is empty, 'fileencoding' is not modified. | |
3301 See 'fileencoding' for the possible values. | |
3302 Setting this option does not have an effect until the next time a file | |
3303 is read. | |
3304 | |
3305 *'fileformat'* *'ff'* | |
15840
734b1928a5aa
patch 8.1.0927: USE_CR is never defined
Bram Moolenaar <Bram@vim.org>
parents:
15804
diff
changeset
|
3306 '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
|
3307 Unix, macOS default: "unix") |
7 | 3308 local to buffer |
3309 This gives the <EOL> of the current buffer, which is used for | |
3310 reading/writing the buffer from/to a file: | |
23305 | 3311 dos <CR><NL> |
7 | 3312 unix <NL> |
3313 mac <CR> | |
3314 When "dos" is used, CTRL-Z at the end of a file is ignored. | |
3315 See |file-formats| and |file-read|. | |
3316 For the character encoding of the file see 'fileencoding'. | |
3317 When 'binary' is set, the value of 'fileformat' is ignored, file I/O | |
4264 | 3318 works like it was set to "unix". |
7 | 3319 This option is set automatically when starting to edit a file and |
3320 'fileformats' is not empty and 'binary' is off. | |
3321 When this option is set, after starting to edit a file, the 'modified' | |
3322 option is set, because the file would be different when written. | |
3323 This option can not be changed when 'modifiable' is off. | |
3324 For backwards compatibility: When this option is set to "dos", | |
3325 'textmode' is set, otherwise 'textmode' is reset. | |
3326 | |
3327 *'fileformats'* *'ffs'* | |
3328 'fileformats' 'ffs' string (default: | |
15840
734b1928a5aa
patch 8.1.0927: USE_CR is never defined
Bram Moolenaar <Bram@vim.org>
parents:
15804
diff
changeset
|
3329 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
|
3330 Vim Unix, macOS: "unix,dos", |
7 | 3331 Vi Cygwin: "unix,dos", |
3332 Vi others: "") | |
3333 global | |
3334 This gives the end-of-line (<EOL>) formats that will be tried when | |
3335 starting to edit a new buffer and when reading a file into an existing | |
3336 buffer: | |
3337 - When empty, the format defined with 'fileformat' will be used | |
3338 always. It is not set automatically. | |
3339 - When set to one name, that format will be used whenever a new buffer | |
10 | 3340 is opened. 'fileformat' is set accordingly for that buffer. The |
7 | 3341 'fileformats' name will be used when a file is read into an existing |
3342 buffer, no matter what 'fileformat' for that buffer is set to. | |
3343 - When more than one name is present, separated by commas, automatic | |
3344 <EOL> detection will be done when reading a file. When starting to | |
3345 edit a file, a check is done for the <EOL>: | |
3346 1. If all lines end in <CR><NL>, and 'fileformats' includes "dos", | |
3347 'fileformat' is set to "dos". | |
3348 2. If a <NL> is found and 'fileformats' includes "unix", 'fileformat' | |
10 | 3349 is set to "unix". Note that when a <NL> is found without a |
7 | 3350 preceding <CR>, "unix" is preferred over "dos". |
6647 | 3351 3. If 'fileformat' has not yet been set, and if a <CR> is found, and |
3352 if 'fileformats' includes "mac", 'fileformat' is set to "mac". | |
2587 | 3353 This means that "mac" is only chosen when: |
3354 "unix" is not present or no <NL> is found in the file, and | |
3355 "dos" is not present or no <CR><NL> is found in the file. | |
3356 Except: if "unix" was chosen, but there is a <CR> before | |
3357 the first <NL>, and there appear to be more <CR>s than <NL>s in | |
2642 | 3358 the first few lines, "mac" is used. |
7 | 3359 4. If 'fileformat' is still not set, the first name from |
3360 'fileformats' is used. | |
3361 When reading a file into an existing buffer, the same is done, but | |
3362 this happens like 'fileformat' has been set appropriately for that | |
3363 file only, the option is not changed. | |
3364 When 'binary' is set, the value of 'fileformats' is not used. | |
3365 | |
8748
b1a19a2f73f0
commit https://github.com/vim/vim/commit/4f3f668c8486444e53163c29d2fc79bf47eb3c82
Christian Brabandt <cb@256bit.org>
parents:
8629
diff
changeset
|
3366 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
|
3367 can overrule this by setting 'fileformat' in your .vimrc. |
2662 | 3368 |
7 | 3369 For systems with a Dos-like <EOL> (<CR><NL>), when reading files that |
3370 are ":source"ed and for vimrc files, automatic <EOL> detection may be | |
3371 done: | |
3372 - When 'fileformats' is empty, there is no automatic detection. Dos | |
3373 format will be used. | |
3374 - When 'fileformats' is set to one or more names, automatic detection | |
3375 is done. This is based on the first <NL> in the file: If there is a | |
3376 <CR> in front of it, Dos format is used, otherwise Unix format is | |
3377 used. | |
3378 Also see |file-formats|. | |
3379 For backwards compatibility: When this option is set to an empty | |
3380 string or one format (no comma is included), 'textauto' is reset, | |
3381 otherwise 'textauto' is set. | |
3382 NOTE: This option is set to the Vi default value when 'compatible' is | |
3383 set and to the Vim default value when 'compatible' is reset. | |
3384 | |
4264 | 3385 *'fileignorecase'* *'fic'* *'nofileignorecase'* *'nofic'* |
3386 'fileignorecase' 'fic' boolean (default on for systems where case in file | |
3387 names is normally ignored) | |
4242 | 3388 global |
3389 When set case is ignored when using file names and directories. | |
3390 See 'wildignorecase' for only ignoring case when doing completion. | |
3391 | |
7 | 3392 *'filetype'* *'ft'* |
3393 'filetype' 'ft' string (default: "") | |
3394 local to buffer | |
3395 When this option is set, the FileType autocommand event is triggered. | |
3396 All autocommands that match with the value of this option will be | |
3397 executed. Thus the value of 'filetype' is used in place of the file | |
3398 name. | |
3399 Otherwise this option does not always reflect the current file type. | |
3400 This option is normally set when the file type is detected. To enable | |
3401 this use the ":filetype on" command. |:filetype| | |
3402 Setting this option to a different value is most useful in a modeline, | |
3403 for a file for which the file type is not automatically recognized. | |
782 | 3404 Example, for in an IDL file: |
3405 /* vim: set filetype=idl : */ ~ | |
3406 |FileType| |filetypes| | |
3407 When a dot appears in the value then this separates two filetype | |
3408 names. Example: | |
3409 /* vim: set filetype=c.doxygen : */ ~ | |
3410 This will use the "c" filetype first, then the "doxygen" filetype. | |
3411 This works both for filetype plugins and for syntax files. More than | |
3412 one dot may appear. | |
7 | 3413 This option is not copied to another buffer, independent of the 's' or |
3414 'S' flag in 'cpoptions'. | |
36 | 3415 Only normal file name characters can be used, "/\*?[|<>" are illegal. |
7 | 3416 |
3417 *'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
|
3418 'fillchars' 'fcs' string (default "vert:|,fold:-,eob:~") |
29387
9dce192d1ac2
patch 9.0.0036: 'fillchars' cannot have window-local values
Bram Moolenaar <Bram@vim.org>
parents:
29328
diff
changeset
|
3419 global or local to window |global-local| |
17771
4bd21046902b
patch 8.1.1882: cannot specify properties of the info popup window
Bram Moolenaar <Bram@vim.org>
parents:
17767
diff
changeset
|
3420 {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
|
3421 feature} |
29387
9dce192d1ac2
patch 9.0.0036: 'fillchars' cannot have window-local values
Bram Moolenaar <Bram@vim.org>
parents:
29328
diff
changeset
|
3422 Characters to fill the statuslines, vertical separators and special |
9dce192d1ac2
patch 9.0.0036: 'fillchars' cannot have window-local values
Bram Moolenaar <Bram@vim.org>
parents:
29328
diff
changeset
|
3423 lines in the window. |
9dce192d1ac2
patch 9.0.0036: 'fillchars' cannot have window-local values
Bram Moolenaar <Bram@vim.org>
parents:
29328
diff
changeset
|
3424 It is a comma-separated list of items. Each item has a name, a colon |
9dce192d1ac2
patch 9.0.0036: 'fillchars' cannot have window-local values
Bram Moolenaar <Bram@vim.org>
parents:
29328
diff
changeset
|
3425 and the value of that item: |
9dce192d1ac2
patch 9.0.0036: 'fillchars' cannot have window-local values
Bram Moolenaar <Bram@vim.org>
parents:
29328
diff
changeset
|
3426 |
9dce192d1ac2
patch 9.0.0036: 'fillchars' cannot have window-local values
Bram Moolenaar <Bram@vim.org>
parents:
29328
diff
changeset
|
3427 item name default Used for ~ |
9dce192d1ac2
patch 9.0.0036: 'fillchars' cannot have window-local values
Bram Moolenaar <Bram@vim.org>
parents:
29328
diff
changeset
|
3428 stl ' ' or '^' statusline of the current window |
9dce192d1ac2
patch 9.0.0036: 'fillchars' cannot have window-local values
Bram Moolenaar <Bram@vim.org>
parents:
29328
diff
changeset
|
3429 stlnc ' ' or '=' statusline of the non-current windows |
9dce192d1ac2
patch 9.0.0036: 'fillchars' cannot have window-local values
Bram Moolenaar <Bram@vim.org>
parents:
29328
diff
changeset
|
3430 vert '|' vertical separators |:vsplit| |
9dce192d1ac2
patch 9.0.0036: 'fillchars' cannot have window-local values
Bram Moolenaar <Bram@vim.org>
parents:
29328
diff
changeset
|
3431 fold '-' filling 'foldtext' |
9dce192d1ac2
patch 9.0.0036: 'fillchars' cannot have window-local values
Bram Moolenaar <Bram@vim.org>
parents:
29328
diff
changeset
|
3432 foldopen '-' mark the beginning of a fold |
9dce192d1ac2
patch 9.0.0036: 'fillchars' cannot have window-local values
Bram Moolenaar <Bram@vim.org>
parents:
29328
diff
changeset
|
3433 foldclose '+' show a closed fold |
9dce192d1ac2
patch 9.0.0036: 'fillchars' cannot have window-local values
Bram Moolenaar <Bram@vim.org>
parents:
29328
diff
changeset
|
3434 foldsep '|' open fold middle character |
9dce192d1ac2
patch 9.0.0036: 'fillchars' cannot have window-local values
Bram Moolenaar <Bram@vim.org>
parents:
29328
diff
changeset
|
3435 diff '-' deleted lines of the 'diff' option |
9dce192d1ac2
patch 9.0.0036: 'fillchars' cannot have window-local values
Bram Moolenaar <Bram@vim.org>
parents:
29328
diff
changeset
|
3436 eob '~' empty lines below the end of a buffer |
30643
dfb02f9dcbe8
patch 9.0.0656: cannot specify another character to use instead of '@'
Bram Moolenaar <Bram@vim.org>
parents:
30634
diff
changeset
|
3437 lastline '@' 'display' contains lastline/truncate |
7 | 3438 |
10 | 3439 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
|
3440 "stlnc" the space will be used when there is highlighting, '^' or '=' |
7 | 3441 otherwise. |
3442 | |
3443 Example: > | |
8061
abd64cf67bcf
commit https://github.com/vim/vim/commit/38a55639d603823efcf2d2fdf542dbffdeb60b75
Christian Brabandt <cb@256bit.org>
parents:
7876
diff
changeset
|
3444 :set fillchars=stl:^,stlnc:=,vert:\|,fold:-,diff:- |
7 | 3445 < This is similar to the default, except that these characters will also |
3446 be used when there is highlighting. | |
3447 | |
29269 | 3448 For the "stl", "stlnc", "foldopen", "foldclose" and "foldsep" items |
3449 single-byte and multibyte characters are supported. But double-width | |
3450 characters are not supported. | |
819 | 3451 |
7 | 3452 The highlighting used for these items: |
29387
9dce192d1ac2
patch 9.0.0036: 'fillchars' cannot have window-local values
Bram Moolenaar <Bram@vim.org>
parents:
29328
diff
changeset
|
3453 item name highlight group ~ |
9dce192d1ac2
patch 9.0.0036: 'fillchars' cannot have window-local values
Bram Moolenaar <Bram@vim.org>
parents:
29328
diff
changeset
|
3454 stl StatusLine |hl-StatusLine| |
9dce192d1ac2
patch 9.0.0036: 'fillchars' cannot have window-local values
Bram Moolenaar <Bram@vim.org>
parents:
29328
diff
changeset
|
3455 stlnc StatusLineNC |hl-StatusLineNC| |
9dce192d1ac2
patch 9.0.0036: 'fillchars' cannot have window-local values
Bram Moolenaar <Bram@vim.org>
parents:
29328
diff
changeset
|
3456 vert VertSplit |hl-VertSplit| |
9dce192d1ac2
patch 9.0.0036: 'fillchars' cannot have window-local values
Bram Moolenaar <Bram@vim.org>
parents:
29328
diff
changeset
|
3457 fold Folded |hl-Folded| |
9dce192d1ac2
patch 9.0.0036: 'fillchars' cannot have window-local values
Bram Moolenaar <Bram@vim.org>
parents:
29328
diff
changeset
|
3458 diff DiffDelete |hl-DiffDelete| |
9dce192d1ac2
patch 9.0.0036: 'fillchars' cannot have window-local values
Bram Moolenaar <Bram@vim.org>
parents:
29328
diff
changeset
|
3459 eob EndOfBuffer |hl-EndOfBuffer| |
30643
dfb02f9dcbe8
patch 9.0.0656: cannot specify another character to use instead of '@'
Bram Moolenaar <Bram@vim.org>
parents:
30634
diff
changeset
|
3460 lastline NonText |hl-NonText| |
7 | 3461 |
6933 | 3462 *'fixendofline'* *'fixeol'* *'nofixendofline'* *'nofixeol'* |
3463 'fixendofline' 'fixeol' boolean (default on) | |
3464 local to buffer | |
3465 When writing a file and this option is on, <EOL> at the end of file | |
30962 | 3466 will be restored if missing. Turn this option off if you want to |
6933 | 3467 preserve the situation from the original file. |
3468 When the 'binary' option is set the value of this option doesn't | |
3469 matter. | |
3470 See the 'endofline' option. | |
30982
92b1338023ee
patch 9.0.0826: if 'endofline' is set CTRL-Z may be written in a wrong place
Bram Moolenaar <Bram@vim.org>
parents:
30967
diff
changeset
|
3471 See |eol-and-eof| for example settings. |
6933 | 3472 |
7 | 3473 *'fkmap'* *'fk'* *'nofkmap'* *'nofk'* |
23666 | 3474 'fkmap' 'fk' boolean (default off) |
7 | 3475 global |
3476 {only available when compiled with the |+rightleft| | |
3477 feature} | |
15850
a6ca8cf07a98
patch 8.1.0932: Farsi support is outdated and unused
Bram Moolenaar <Bram@vim.org>
parents:
15840
diff
changeset
|
3478 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
|
3479 |farsi.txt|. |
7 | 3480 |
3481 *'foldclose'* *'fcl'* | |
3482 'foldclose' 'fcl' string (default "") | |
3483 global | |
3484 {not available when compiled without the |+folding| | |
3485 feature} | |
3486 When set to "all", a fold is closed when the cursor isn't in it and | |
3487 its level is higher than 'foldlevel'. Useful if you want folds to | |
3488 automatically close when moving out of them. | |
3489 | |
3490 *'foldcolumn'* *'fdc'* | |
3491 'foldcolumn' 'fdc' number (default 0) | |
3492 local to window | |
3493 {not available when compiled without the |+folding| | |
3494 feature} | |
3495 When non-zero, a column with the specified width is shown at the side | |
3496 of the window which indicates open and closed folds. The maximum | |
3497 value is 12. | |
3498 See |folding|. | |
3499 | |
3500 *'foldenable'* *'fen'* *'nofoldenable'* *'nofen'* | |
3501 'foldenable' 'fen' boolean (default on) | |
3502 local to window | |
3503 {not available when compiled without the |+folding| | |
3504 feature} | |
3505 When off, all folds are open. This option can be used to quickly | |
3506 switch between showing all text unfolded and viewing the text with | |
3507 folds (including manually opened or closed folds). It can be toggled | |
10 | 3508 with the |zi| command. The 'foldcolumn' will remain blank when |
7 | 3509 'foldenable' is off. |
3510 This option is set by commands that create a new fold or close a fold. | |
3511 See |folding|. | |
3512 | |
3513 *'foldexpr'* *'fde'* | |
3514 'foldexpr' 'fde' string (default: "0") | |
3515 local to window | |
3516 {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
|
3517 or |+eval| features} |
7 | 3518 The expression used for when 'foldmethod' is "expr". It is evaluated |
27321 | 3519 for each line to obtain its fold level. The context is set to the |
3520 script where 'foldexpr' was set, script-local items can be accessed. | |
3521 See |fold-expr| for the usage. | |
782 | 3522 |
3682 | 3523 The expression will be evaluated in the |sandbox| if set from a |
3524 modeline, see |sandbox-option|. | |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
3525 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
|
3526 on or the 'modelineexpr' option is off. |
634 | 3527 |
3528 It is not allowed to change text or jump to another window while | |
3529 evaluating 'foldexpr' |textlock|. | |
7 | 3530 |
3531 *'foldignore'* *'fdi'* | |
3532 'foldignore' 'fdi' string (default: "#") | |
3533 local to window | |
3534 {not available when compiled without the |+folding| | |
3535 feature} | |
3536 Used only when 'foldmethod' is "indent". Lines starting with | |
3537 characters in 'foldignore' will get their fold level from surrounding | |
10 | 3538 lines. White space is skipped before checking for this character. |
7 | 3539 The default "#" works well for C programs. See |fold-indent|. |
3540 | |
3541 *'foldlevel'* *'fdl'* | |
3542 'foldlevel' 'fdl' number (default: 0) | |
3543 local to window | |
3544 {not available when compiled without the |+folding| | |
3545 feature} | |
3546 Sets the fold level: Folds with a higher level will be closed. | |
3547 Setting this option to zero will close all folds. Higher numbers will | |
3548 close fewer folds. | |
3549 This option is set by commands like |zm|, |zM| and |zR|. | |
3550 See |fold-foldlevel|. | |
3551 | |
3552 *'foldlevelstart'* *'fdls'* | |
3553 'foldlevelstart' 'fdls' number (default: -1) | |
3554 global | |
3555 {not available when compiled without the |+folding| | |
3556 feature} | |
3557 Sets 'foldlevel' when starting to edit another buffer in a window. | |
3558 Useful to always start editing with all folds closed (value zero), | |
3559 some folds closed (one) or no folds closed (99). | |
3560 This is done before reading any modeline, thus a setting in a modeline | |
10 | 3561 overrules this option. Starting to edit a file for |diff-mode| also |
7 | 3562 ignores this option and closes all folds. |
3563 It is also done before BufReadPre autocommands, to allow an autocmd to | |
3564 overrule the 'foldlevel' value for specific files. | |
3565 When the value is negative, it is not used. | |
3566 | |
3567 *'foldmarker'* *'fmr'* *E536* | |
3568 'foldmarker' 'fmr' string (default: "{{{,}}}") | |
3569 local to window | |
3570 {not available when compiled without the |+folding| | |
3571 feature} | |
3572 The start and end marker used when 'foldmethod' is "marker". There | |
3573 must be one comma, which separates the start and end marker. The | |
3574 marker is a literal string (a regular expression would be too slow). | |
3575 See |fold-marker|. | |
3576 | |
3577 *'foldmethod'* *'fdm'* | |
3578 'foldmethod' 'fdm' string (default: "manual") | |
3579 local to window | |
3580 {not available when compiled without the |+folding| | |
3581 feature} | |
3582 The kind of folding used for the current window. Possible values: | |
3583 |fold-manual| manual Folds are created manually. | |
3584 |fold-indent| indent Lines with equal indent form a fold. | |
3585 |fold-expr| expr 'foldexpr' gives the fold level of a line. | |
3586 |fold-marker| marker Markers are used to specify folds. | |
3587 |fold-syntax| syntax Syntax highlighting items specify folds. | |
3588 |fold-diff| diff Fold text that is not changed. | |
3589 | |
3590 *'foldminlines'* *'fml'* | |
3591 'foldminlines' 'fml' number (default: 1) | |
3592 local to window | |
3593 {not available when compiled without the |+folding| | |
3594 feature} | |
2709 | 3595 Sets the number of screen lines above which a fold can be displayed |
3596 closed. Also for manually closed folds. With the default value of | |
3597 one a fold can only be closed if it takes up two or more screen lines. | |
3598 Set to zero to be able to close folds of just one screen line. | |
2826 | 3599 Note that this only has an effect on what is displayed. After using |
7 | 3600 "zc" to close a fold, which is displayed open because it's smaller |
3601 than 'foldminlines', a following "zc" may close a containing fold. | |
3602 | |
3603 *'foldnestmax'* *'fdn'* | |
3604 'foldnestmax' 'fdn' number (default: 20) | |
3605 local to window | |
3606 {not available when compiled without the |+folding| | |
3607 feature} | |
3608 Sets the maximum nesting of folds for the "indent" and "syntax" | |
3609 methods. This avoids that too many folds will be created. Using more | |
3610 than 20 doesn't work, because the internal limit is 20. | |
3611 | |
3612 *'foldopen'* *'fdo'* | |
3613 'foldopen' 'fdo' string (default: "block,hor,mark,percent,quickfix, | |
3614 search,tag,undo") | |
3615 global | |
3616 {not available when compiled without the |+folding| | |
3617 feature} | |
3618 Specifies for which type of commands folds will be opened, if the | |
28379 | 3619 command moves the cursor into a closed fold. It is a comma-separated |
7 | 3620 list of items. |
2625 | 3621 NOTE: When the command is part of a mapping this option is not used. |
3622 Add the |zv| command to the mapping to get the same effect. | |
3623 (rationale: the mapping may want to control opening folds itself) | |
3624 | |
7 | 3625 item commands ~ |
3626 all any | |
3627 block "(", "{", "[[", "[{", etc. | |
3628 hor horizontal movements: "l", "w", "fx", etc. | |
3629 insert any command in Insert mode | |
3630 jump far jumps: "G", "gg", etc. | |
3631 mark jumping to a mark: "'m", CTRL-O, etc. | |
3632 percent "%" | |
3633 quickfix ":cn", ":crew", ":make", etc. | |
3634 search search for a pattern: "/", "n", "*", "gd", etc. | |
3635 (not for a search pattern in a ":" command) | |
819 | 3636 Also for |[s| and |]s|. |
7 | 3637 tag jumping to a tag: ":ta", CTRL-T, etc. |
3638 undo undo or redo: "u" and CTRL-R | |
3639 When a movement command is used for an operator (e.g., "dl" or "y%") | |
3640 this option is not used. This means the operator will include the | |
3641 whole closed fold. | |
3642 Note that vertical movements are not here, because it would make it | |
3643 very difficult to move onto a closed fold. | |
3644 In insert mode the folds containing the cursor will always be open | |
3645 when text is inserted. | |
3646 To close folds you can re-apply 'foldlevel' with the |zx| command or | |
3647 set the 'foldclose' option to "all". | |
3648 | |
3649 *'foldtext'* *'fdt'* | |
3650 'foldtext' 'fdt' string (default: "foldtext()") | |
3651 local to window | |
3652 {not available when compiled without the |+folding| | |
3653 feature} | |
3654 An expression which is used to specify the text displayed for a closed | |
27321 | 3655 fold. The context is set to the script where 'foldexpr' was set, |
3656 script-local items can be accessed. See |fold-foldtext| for the | |
3657 usage. | |
7 | 3658 |
3682 | 3659 The expression will be evaluated in the |sandbox| if set from a |
3660 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
|
3661 This option cannot be set in a modeline when 'modelineexpr' is off. |
634 | 3662 |
3663 It is not allowed to change text or jump to another window while | |
3664 evaluating 'foldtext' |textlock|. | |
3665 | |
9286
64035abb986b
commit https://github.com/vim/vim/commit/c95a302a4c42ec8230473cd4a5e0064d0a143aa8
Christian Brabandt <cb@256bit.org>
parents:
9227
diff
changeset
|
3666 *'formatexpr'* *'fex'* |
64035abb986b
commit https://github.com/vim/vim/commit/c95a302a4c42ec8230473cd4a5e0064d0a143aa8
Christian Brabandt <cb@256bit.org>
parents:
9227
diff
changeset
|
3667 'formatexpr' 'fex' string (default "") |
64035abb986b
commit https://github.com/vim/vim/commit/c95a302a4c42ec8230473cd4a5e0064d0a143aa8
Christian Brabandt <cb@256bit.org>
parents:
9227
diff
changeset
|
3668 local to buffer |
64035abb986b
commit https://github.com/vim/vim/commit/c95a302a4c42ec8230473cd4a5e0064d0a143aa8
Christian Brabandt <cb@256bit.org>
parents:
9227
diff
changeset
|
3669 {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
|
3670 feature} |
64035abb986b
commit https://github.com/vim/vim/commit/c95a302a4c42ec8230473cd4a5e0064d0a143aa8
Christian Brabandt <cb@256bit.org>
parents:
9227
diff
changeset
|
3671 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
|
3672 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
|
3673 option is empty 'formatprg' is used. |
64035abb986b
commit https://github.com/vim/vim/commit/c95a302a4c42ec8230473cd4a5e0064d0a143aa8
Christian Brabandt <cb@256bit.org>
parents:
9227
diff
changeset
|
3674 |
64035abb986b
commit https://github.com/vim/vim/commit/c95a302a4c42ec8230473cd4a5e0064d0a143aa8
Christian Brabandt <cb@256bit.org>
parents:
9227
diff
changeset
|
3675 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
|
3676 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
|
3677 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
|
3678 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
|
3679 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
|
3680 it yet! |
64035abb986b
commit https://github.com/vim/vim/commit/c95a302a4c42ec8230473cd4a5e0064d0a143aa8
Christian Brabandt <cb@256bit.org>
parents:
9227
diff
changeset
|
3681 |
64035abb986b
commit https://github.com/vim/vim/commit/c95a302a4c42ec8230473cd4a5e0064d0a143aa8
Christian Brabandt <cb@256bit.org>
parents:
9227
diff
changeset
|
3682 Example: > |
64035abb986b
commit https://github.com/vim/vim/commit/c95a302a4c42ec8230473cd4a5e0064d0a143aa8
Christian Brabandt <cb@256bit.org>
parents:
9227
diff
changeset
|
3683 :set formatexpr=mylang#Format() |
64035abb986b
commit https://github.com/vim/vim/commit/c95a302a4c42ec8230473cd4a5e0064d0a143aa8
Christian Brabandt <cb@256bit.org>
parents:
9227
diff
changeset
|
3684 < 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
|
3685 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
|
3686 |
30598
37aa9fd2ed72
patch 9.0.0634: evaluating "expr" options has more overhead than needed
Bram Moolenaar <Bram@vim.org>
parents:
30547
diff
changeset
|
3687 The advantage of using a function call without arguments is that it is |
37aa9fd2ed72
patch 9.0.0634: evaluating "expr" options has more overhead than needed
Bram Moolenaar <Bram@vim.org>
parents:
30547
diff
changeset
|
3688 faster, see |expr-option-function|. |
37aa9fd2ed72
patch 9.0.0634: evaluating "expr" options has more overhead than needed
Bram Moolenaar <Bram@vim.org>
parents:
30547
diff
changeset
|
3689 |
9286
64035abb986b
commit https://github.com/vim/vim/commit/c95a302a4c42ec8230473cd4a5e0064d0a143aa8
Christian Brabandt <cb@256bit.org>
parents:
9227
diff
changeset
|
3690 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
|
3691 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
|
3692 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
|
3693 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
|
3694 return "i" or "R" in this situation. |
13341
acd7eaa13d2b
Updated runtime files.
Christian Brabandt <cb@256bit.org>
parents:
13314
diff
changeset
|
3695 |
9286
64035abb986b
commit https://github.com/vim/vim/commit/c95a302a4c42ec8230473cd4a5e0064d0a143aa8
Christian Brabandt <cb@256bit.org>
parents:
9227
diff
changeset
|
3696 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
|
3697 the internal format mechanism. |
64035abb986b
commit https://github.com/vim/vim/commit/c95a302a4c42ec8230473cd4a5e0064d0a143aa8
Christian Brabandt <cb@256bit.org>
parents:
9227
diff
changeset
|
3698 |
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
|
3699 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
|
3700 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
|
3701 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
|
3702 set formatexpr=<SID>SomeFormatExpr() |
27321 | 3703 < Otherwise, the expression is evaluated in the context of the script |
3704 where the option was set, thus script-local items are available. | |
3705 | |
9286
64035abb986b
commit https://github.com/vim/vim/commit/c95a302a4c42ec8230473cd4a5e0064d0a143aa8
Christian Brabandt <cb@256bit.org>
parents:
9227
diff
changeset
|
3706 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
|
3707 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
|
3708 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
|
3709 This option cannot be set in a modeline when 'modelineexpr' is off. |
11160 | 3710 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
|
3711 |
41 | 3712 *'formatlistpat'* *'flp'* |
3713 'formatlistpat' 'flp' string (default: "^\s*\d\+[\]:.)}\t ]\s*") | |
3714 local to buffer | |
3715 A pattern that is used to recognize a list header. This is used for | |
3716 the "n" flag in 'formatoptions'. | |
3717 The pattern must match exactly the text that will be the indent for | |
140 | 3718 the line below it. You can use |/\ze| to mark the end of the match |
41 | 3719 while still checking more characters. There must be a character |
3720 following the pattern, when it matches the whole line it is handled | |
3721 like there is no match. | |
3722 The default recognizes a number, followed by an optional punctuation | |
3723 character and white space. | |
3724 | |
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
|
3725 *'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
|
3726 '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
|
3727 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
|
3728 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
|
3729 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
|
3730 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
|
3731 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
|
3732 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
|
3733 "+=" 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
|
3734 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
|
3735 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
|
3736 |
7 | 3737 *'formatprg'* *'fp'* |
3738 '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
|
3739 global or local to buffer |global-local| |
7 | 3740 The name of an external program that will be used to format the lines |
667 | 3741 selected with the |gq| operator. The program must take the input on |
7 | 3742 stdin and produce the output on stdout. The Unix program "fmt" is |
557 | 3743 such a program. |
667 | 3744 If the 'formatexpr' option is not empty it will be used instead. |
3745 Otherwise, if 'formatprg' option is an empty string, the internal | |
3746 format function will be used |C-indenting|. | |
557 | 3747 Environment variables are expanded |:set_env|. See |option-backslash| |
3748 about including spaces and backslashes. | |
3682 | 3749 This option cannot be set from a |modeline| or in the |sandbox|, for |
3750 security reasons. | |
667 | 3751 |
7196
42717d048817
commit https://github.com/vim/vim/commit/d94464ee294a351ce7b6ba18e8bd3f24f1bef920
Christian Brabandt <cb@256bit.org>
parents:
7147
diff
changeset
|
3752 *'fsync'* *'fs'* *'nofsync'* *'nofs'* |
36 | 3753 'fsync' 'fs' boolean (default on) |
3754 global | |
3755 When on, the library function fsync() will be called after writing a | |
3756 file. This will flush a file to disk, ensuring that it is safely | |
3757 written even on filesystems which do metadata-only journaling. This | |
3758 will force the harddrive to spin up on Linux systems running in laptop | |
3759 mode, so it may be undesirable in some situations. Be warned that | |
3760 turning this off increases the chances of data loss after a crash. On | |
3761 systems without an fsync() implementation, this variable is always | |
3762 off. | |
3763 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
|
3764 '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
|
3765 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
|
3766 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
|
3767 security reasons. |
36 | 3768 |
7 | 3769 *'gdefault'* *'gd'* *'nogdefault'* *'nogd'* |
3770 'gdefault' 'gd' boolean (default off) | |
3771 global | |
3772 When on, the ":substitute" flag 'g' is default on. This means that | |
3773 all matches in a line are substituted instead of one. When a 'g' flag | |
3774 is given to a ":substitute" command, this will toggle the substitution | |
3775 of all or one match. See |complex-change|. | |
3776 | |
3777 command 'gdefault' on 'gdefault' off ~ | |
3778 :s/// subst. all subst. one | |
3779 :s///g subst. one subst. all | |
3780 :s///gg subst. all subst. one | |
3781 | |
3782 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
|
3783 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
|
3784 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
|
3785 has the opposite effect of that it normally does. |
23305 | 3786 This option is not used in |Vim9| script. |
7 | 3787 |
3788 *'grepformat'* *'gfm'* | |
6213 | 3789 'grepformat' 'gfm' string (default "%f:%l:%m,%f:%l%m,%f %l%m") |
7 | 3790 global |
3791 Format to recognize for the ":grep" command output. | |
3792 This is a scanf-like string that uses the same format as the | |
3793 'errorformat' option: see |errorformat|. | |
3794 | |
3795 *'grepprg'* *'gp'* | |
3796 'grepprg' 'gp' string (default "grep -n ", | |
3797 Unix: "grep -n $* /dev/null", | |
3798 Win32: "findstr /n" or "grep -n", | |
3799 VMS: "SEARCH/NUMBERS ") | |
3800 global or local to buffer |global-local| | |
233 | 3801 Program to use for the |:grep| command. This option may contain '%' |
7 | 3802 and '#' characters, which are expanded like when used in a command- |
3803 line. The placeholder "$*" is allowed to specify where the arguments | |
3804 will be included. Environment variables are expanded |:set_env|. See | |
3805 |option-backslash| about including spaces and backslashes. | |
3806 When your "grep" accepts the "-H" argument, use this to make ":grep" | |
3807 also work well with a single file: > | |
3808 :set grepprg=grep\ -nH | |
161 | 3809 < Special value: When 'grepprg' is set to "internal" the |:grep| command |
657 | 3810 works like |:vimgrep|, |:lgrep| like |:lvimgrep|, |:grepadd| like |
3811 |:vimgrepadd| and |:lgrepadd| like |:lvimgrepadd|. | |
41 | 3812 See also the section |:make_makeprg|, since most of the comments there |
7 | 3813 apply equally to 'grepprg'. |
3814 For Win32, the default is "findstr /n" if "findstr.exe" can be found, | |
3815 otherwise it's "grep -n". | |
3816 This option cannot be set from a |modeline| or in the |sandbox|, for | |
3817 security reasons. | |
3818 | |
3819 *'guicursor'* *'gcr'* *E545* *E546* *E548* *E549* | |
3820 'guicursor' 'gcr' string (default "n-v-c:block-Cursor/lCursor, | |
3821 ve:ver35-Cursor, | |
3822 o:hor50-Cursor, | |
3823 i-ci:ver25-Cursor/lCursor, | |
3824 r-cr:hor20-Cursor/lCursor, | |
3825 sm:block-Cursor | |
3826 -blinkwait175-blinkoff150-blinkon175", | |
18972 | 3827 for Win32 console: |
7 | 3828 "n-v-c:block,o:hor50,i-ci:hor15, |
3829 r-cr:hor30,sm:block") | |
3830 global | |
3831 {only available when compiled with GUI enabled, and | |
18972 | 3832 for Win32 console} |
7 | 3833 This option tells Vim what the cursor should look like in different |
19116 | 3834 modes. It fully works in the GUI. In a Win32 console, only the |
18972 | 3835 height of the cursor can be changed. This can be done by specifying a |
3836 block cursor, or a percentage for a vertical or horizontal cursor. | |
6727 | 3837 For a console the 't_SI', 't_SR', and 't_EI' escape sequences are |
3838 used. | |
7 | 3839 |
28379 | 3840 The option is a comma-separated list of parts. Each part consist of a |
7 | 3841 mode-list and an argument-list: |
3842 mode-list:argument-list,mode-list:argument-list,.. | |
3843 The mode-list is a dash separated list of these modes: | |
3844 n Normal mode | |
3845 v Visual mode | |
3846 ve Visual mode with 'selection' "exclusive" (same as 'v', | |
3847 if not specified) | |
3848 o Operator-pending mode | |
3849 i Insert mode | |
3850 r Replace mode | |
3851 c Command-line Normal (append) mode | |
3852 ci Command-line Insert mode | |
3853 cr Command-line Replace mode | |
3854 sm showmatch in Insert mode | |
3855 a all modes | |
3856 The argument-list is a dash separated list of these arguments: | |
3857 hor{N} horizontal bar, {N} percent of the character height | |
3858 ver{N} vertical bar, {N} percent of the character width | |
3859 block block cursor, fills the whole character | |
3860 [only one of the above three should be present] | |
3861 blinkwait{N} *cursor-blinking* | |
3862 blinkon{N} | |
3863 blinkoff{N} | |
3864 blink times for cursor: blinkwait is the delay before | |
3865 the cursor starts blinking, blinkon is the time that | |
3866 the cursor is shown and blinkoff is the time that the | |
3867 cursor is not shown. The times are in msec. When one | |
3868 of the numbers is zero, there is no blinking. The | |
3869 default is: "blinkwait700-blinkon400-blinkoff250". | |
3870 These numbers are used for a missing entry. This | |
3871 means that blinking is enabled by default. To switch | |
3872 blinking off you can use "blinkon0". The cursor only | |
3873 blinks when Vim is waiting for input, not while | |
3874 executing a command. | |
3875 To make the cursor blink in an xterm, see | |
3876 |xterm-blink|. | |
3877 {group-name} | |
3878 a highlight group name, that sets the color and font | |
3879 for the cursor | |
3880 {group-name}/{group-name} | |
3881 Two highlight group names, the first is used when | |
3882 no language mappings are used, the other when they | |
3883 are. |language-mapping| | |
3884 | |
3885 Examples of parts: | |
3886 n-c-v:block-nCursor in Normal, Command-line and Visual mode, use a | |
3887 block cursor with colors from the "nCursor" | |
3888 highlight group | |
3889 i-ci:ver30-iCursor-blinkwait300-blinkon200-blinkoff150 | |
3890 In Insert and Command-line Insert mode, use a | |
3891 30% vertical bar cursor with colors from the | |
3892 "iCursor" highlight group. Blink a bit | |
3893 faster. | |
3894 | |
3895 The 'a' mode is different. It will set the given argument-list for | |
3896 all modes. It does not reset anything to defaults. This can be used | |
3897 to do a common setting for all modes. For example, to switch off | |
3898 blinking: "a:blinkon0" | |
3899 | |
3900 Examples of cursor highlighting: > | |
3901 :highlight Cursor gui=reverse guifg=NONE guibg=NONE | |
3902 :highlight Cursor gui=NONE guifg=bg guibg=fg | |
3903 < | |
3904 *'guifont'* *'gfn'* | |
2908 | 3905 *E235* *E596* |
7 | 3906 'guifont' 'gfn' string (default "") |
3907 global | |
3908 {only available when compiled with GUI enabled} | |
3909 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
|
3910 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
|
3911 See |gui-font| for the details. |
7 | 3912 |
3913 *'guifontset'* *'gfs'* | |
3914 *E250* *E252* *E234* *E597* *E598* | |
3915 'guifontset' 'gfs' string (default "") | |
3916 global | |
3917 {only available when compiled with GUI enabled and | |
3918 with the |+xfontset| feature} | |
10895
c391bfbdb452
Updated runtime files.
Christian Brabandt <cb@256bit.org>
parents:
10734
diff
changeset
|
3919 {not available in the GTK+ GUI} |
7 | 3920 When not empty, specifies two (or more) fonts to be used. The first |
3921 one for normal English, the second one for your special language. See | |
3922 |xfontset|. | |
16439
9d20e26dc13c
patch 8.1.1224: MS-Windows: cannot specify font weight
Bram Moolenaar <Bram@vim.org>
parents:
16427
diff
changeset
|
3923 |
7 | 3924 *'guifontwide'* *'gfw'* *E231* *E533* *E534* |
3925 'guifontwide' 'gfw' string (default "") | |
3926 global | |
3927 {only available when compiled with GUI enabled} | |
3928 When not empty, specifies a comma-separated list of fonts to be used | |
3929 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
|
3930 used. See |gui-fontwide|. |
4055 | 3931 |
7 | 3932 *'guiheadroom'* *'ghr'* |
3933 'guiheadroom' 'ghr' number (default 50) | |
3934 global | |
16728
e55c26aaf484
patch 8.1.1366: using expressions in a modeline is unsafe
Bram Moolenaar <Bram@vim.org>
parents:
16610
diff
changeset
|
3935 {only for GTK and X11 GUI} |
7 | 3936 The number of pixels subtracted from the screen height when fitting |
3937 the GUI window on the screen. Set this before the GUI is started, | |
3938 e.g., in your |gvimrc| file. When zero, the whole screen height will | |
10 | 3939 be used by the window. When positive, the specified number of pixel |
7 | 3940 lines will be left for window decorations and other items on the |
3941 screen. Set it to a negative value to allow windows taller than the | |
3942 screen. | |
3943 | |
25982
aade8ef975d5
patch 8.2.3524: GUI: ligatures are not used
Bram Moolenaar <Bram@vim.org>
parents:
25978
diff
changeset
|
3944 *'guiligatures'* *'gli'* *E1243* |
aade8ef975d5
patch 8.2.3524: GUI: ligatures are not used
Bram Moolenaar <Bram@vim.org>
parents:
25978
diff
changeset
|
3945 'guiligatures' 'gli' string (default "") |
aade8ef975d5
patch 8.2.3524: GUI: ligatures are not used
Bram Moolenaar <Bram@vim.org>
parents:
25978
diff
changeset
|
3946 global |
aade8ef975d5
patch 8.2.3524: GUI: ligatures are not used
Bram Moolenaar <Bram@vim.org>
parents:
25978
diff
changeset
|
3947 {only for GTK GUI} |
aade8ef975d5
patch 8.2.3524: GUI: ligatures are not used
Bram Moolenaar <Bram@vim.org>
parents:
25978
diff
changeset
|
3948 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
|
3949 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
|
3950 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
|
3951 Example: > |
aade8ef975d5
patch 8.2.3524: GUI: ligatures are not used
Bram Moolenaar <Bram@vim.org>
parents:
25978
diff
changeset
|
3952 :set guiligatures=!\"#$%&()*+-./:<=>?@[]^_{\|~ |
aade8ef975d5
patch 8.2.3524: GUI: ligatures are not used
Bram Moolenaar <Bram@vim.org>
parents:
25978
diff
changeset
|
3953 < 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
|
3954 empty string to disable ligatures. |
aade8ef975d5
patch 8.2.3524: GUI: ligatures are not used
Bram Moolenaar <Bram@vim.org>
parents:
25978
diff
changeset
|
3955 |
7 | 3956 *'guioptions'* *'go'* |
14945 | 3957 'guioptions' 'go' string (default "egmrLtT" (MS-Windows, |
3958 "t" is removed in |defaults.vim|), | |
28379 | 3959 "aegimrLtT" (GTK and Motif), |
9669
284b4eb307fc
commit https://github.com/vim/vim/commit/8c08b5b569e2a9e9f63dea514591ecfa2d3bb392
Christian Brabandt <cb@256bit.org>
parents:
9665
diff
changeset
|
3960 ) |
7 | 3961 global |
3962 {only available when compiled with GUI enabled} | |
8 | 3963 This option only has an effect in the GUI version of Vim. It is a |
7 | 3964 sequence of letters which describes what components and options of the |
3965 GUI should be used. | |
3966 To avoid problems with flags that are added in the future, use the | |
3967 "+=" and "-=" feature of ":set" |add-option-flags|. | |
3968 | |
13470
6faef782f50b
patch 8.0.1609: shell commands in the GUI use a dumb terminal
Christian Brabandt <cb@256bit.org>
parents:
13437
diff
changeset
|
3969 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
|
3970 *'go-!'* |
6faef782f50b
patch 8.0.1609: shell commands in the GUI use a dumb terminal
Christian Brabandt <cb@256bit.org>
parents:
13437
diff
changeset
|
3971 '!' 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
|
3972 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
|
3973 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
|
3974 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
|
3975 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
|
3976 upwards as needed. |
14999 | 3977 *'go-a'* |
7 | 3978 'a' Autoselect: If present, then whenever VISUAL mode is started, |
3979 or the Visual area extended, Vim tries to become the owner of | |
3980 the windowing system's global selection. This means that the | |
3981 Visually highlighted text is available for pasting into other | |
3982 applications as well as into Vim itself. When the Visual mode | |
3983 ends, possibly due to an operation on the text, or when an | |
3984 application wants to paste the selection, the highlighted text | |
3985 is automatically yanked into the "* selection register. | |
3986 Thus the selection is still available for pasting into other | |
3987 applications after the VISUAL mode has ended. | |
3988 If not present, then Vim won't become the owner of the | |
3989 windowing system's global selection unless explicitly told to | |
3990 by a yank or delete operation for the "* register. | |
3991 The same applies to the modeless selection. | |
3674 | 3992 *'go-P'* |
3993 '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
|
3994 register. |
1152 | 3995 *'go-A'* |
10 | 3996 'A' Autoselect for the modeless selection. Like 'a', but only |
7 | 3997 applies to the modeless selection. |
3998 | |
3999 'guioptions' autoselect Visual autoselect modeless ~ | |
4000 "" - - | |
4001 "a" yes yes | |
4002 "A" - yes | |
4003 "aA" yes yes | |
4004 | |
30547 | 4005 When using a terminal see the 'clipboard' option. |
4006 | |
1152 | 4007 *'go-c'* |
7 | 4008 'c' Use console dialogs instead of popup dialogs for simple |
4009 choices. | |
18078
5ae41d0ea397
patch 8.1.2034: dark them of GTK 3 not supported
Bram Moolenaar <Bram@vim.org>
parents:
18068
diff
changeset
|
4010 *'go-d'* |
5ae41d0ea397
patch 8.1.2034: dark them of GTK 3 not supported
Bram Moolenaar <Bram@vim.org>
parents:
18068
diff
changeset
|
4011 '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
|
4012 GTK+ GUI. |
1152 | 4013 *'go-e'* |
697 | 4014 'e' Add tab pages when indicated with 'showtabline'. |
688 | 4015 'guitablabel' can be used to change the text in the labels. |
4016 When 'e' is missing a non-GUI tab pages line may be used. | |
857 | 4017 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
|
4018 GTK, Motif, Mac OS/X, Haiku, and MS-Windows. |
1152 | 4019 *'go-f'* |
7 | 4020 'f' Foreground: Don't use fork() to detach the GUI from the shell |
4021 where it was started. Use this for programs that wait for the | |
4022 editor to finish (e.g., an e-mail program). Alternatively you | |
4023 can use "gvim -f" or ":gui -f" to start the GUI in the | |
4024 foreground. |gui-fork| | |
4025 Note: Set this option in the vimrc file. The forking may have | |
819 | 4026 happened already when the |gvimrc| file is read. |
1152 | 4027 *'go-i'* |
7 | 4028 'i' Use a Vim icon. For GTK with KDE it is used in the left-upper |
4029 corner of the window. It's black&white on non-GTK, because of | |
4030 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
|
4031 *'go-m'* |
7 | 4032 'm' Menu bar is present. |
2290
22529abcd646
Fixed ":s" message. Docs updates.
Bram Moolenaar <bram@vim.org>
parents:
2283
diff
changeset
|
4033 *'go-M'* |
10 | 4034 'M' The system menu "$VIMRUNTIME/menu.vim" is not sourced. Note |
7 | 4035 that this flag must be added in the .vimrc file, before |
819 | 4036 switching on syntax or filetype recognition (when the |gvimrc| |
7 | 4037 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
|
4038 `: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
|
4039 *'go-g'* |
7 | 4040 'g' Grey menu items: Make menu items that are not active grey. If |
4041 'g' is not included inactive menu items are not shown at all. | |
1152 | 4042 *'go-t'* |
7 | 4043 't' Include tearoff menu items. Currently only works for Win32, |
4044 GTK+, and Motif 1.2 GUI. | |
1152 | 4045 *'go-T'* |
28379 | 4046 'T' Include Toolbar. Currently only in Win32, GTK+, Motif and |
4047 Photon GUIs. | |
1152 | 4048 *'go-r'* |
7 | 4049 'r' Right-hand scrollbar is always present. |
2290
22529abcd646
Fixed ":s" message. Docs updates.
Bram Moolenaar <bram@vim.org>
parents:
2283
diff
changeset
|
4050 *'go-R'* |
7 | 4051 'R' Right-hand scrollbar is present when there is a vertically |
4052 split window. | |
2290
22529abcd646
Fixed ":s" message. Docs updates.
Bram Moolenaar <bram@vim.org>
parents:
2283
diff
changeset
|
4053 *'go-l'* |
7 | 4054 'l' Left-hand scrollbar is always present. |
2290
22529abcd646
Fixed ":s" message. Docs updates.
Bram Moolenaar <bram@vim.org>
parents:
2283
diff
changeset
|
4055 *'go-L'* |
7 | 4056 'L' Left-hand scrollbar is present when there is a vertically |
4057 split window. | |
1152 | 4058 *'go-b'* |
7 | 4059 'b' Bottom (horizontal) scrollbar is present. Its size depends on |
4060 the longest visible line, or on the cursor line if the 'h' | |
4061 flag is included. |gui-horiz-scroll| | |
2290
22529abcd646
Fixed ":s" message. Docs updates.
Bram Moolenaar <bram@vim.org>
parents:
2283
diff
changeset
|
4062 *'go-h'* |
7 | 4063 'h' Limit horizontal scrollbar size to the length of the cursor |
4064 line. Reduces computations. |gui-horiz-scroll| | |
4065 | |
4066 And yes, you may even have scrollbars on the left AND the right if | |
4067 you really want to :-). See |gui-scrollbars| for more information. | |
4068 | |
2290
22529abcd646
Fixed ":s" message. Docs updates.
Bram Moolenaar <bram@vim.org>
parents:
2283
diff
changeset
|
4069 *'go-v'* |
7 | 4070 'v' Use a vertical button layout for dialogs. When not included, |
4071 a horizontal layout is preferred, but when it doesn't fit a | |
24278 | 4072 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
|
4073 *'go-p'* |
7 | 4074 'p' Use Pointer callbacks for X11 GUI. This is required for some |
4075 window managers. If the cursor is not blinking or hollow at | |
4076 the right moment, try adding this flag. This must be done | |
819 | 4077 before starting the GUI. Set it in your |gvimrc|. Adding or |
7 | 4078 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
|
4079 *'go-F'* |
10 | 4080 '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
|
4081 *'go-k'* |
29a728529f92
patch 8.0.1278: GUI window always resizes when adding scrollbar
Christian Brabandt <cb@256bit.org>
parents:
12785
diff
changeset
|
4082 '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
|
4083 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
|
4084 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
|
4085 '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
|
4086 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
|
4087 removing GUI components. |
1152 | 4088 |
7 | 4089 *'guipty'* *'noguipty'* |
4090 'guipty' boolean (default on) | |
4091 global | |
4092 {only available when compiled with GUI enabled} | |
4093 Only in the GUI: If on, an attempt is made to open a pseudo-tty for | |
4094 I/O to/from shell commands. See |gui-pty|. | |
4095 | |
688 | 4096 *'guitablabel'* *'gtl'* |
4097 'guitablabel' 'gtl' string (default empty) | |
4098 global | |
17771
4bd21046902b
patch 8.1.1882: cannot specify properties of the info popup window
Bram Moolenaar <Bram@vim.org>
parents:
17767
diff
changeset
|
4099 {only available when compiled with GUI enabled} |
27804 | 4100 When non-empty describes the text to use in a label of the GUI tab |
857 | 4101 pages line. When empty and when the result is empty Vim will use a |
4102 default label. See |setting-guitablabel| for more info. | |
688 | 4103 |
692 | 4104 The format of this option is like that of 'statusline'. |
839 | 4105 '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
|
4106 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
|
4107 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
|
4108 This option cannot be set in a modeline when 'modelineexpr' is off. |
692 | 4109 |
688 | 4110 Only used when the GUI tab pages line is displayed. 'e' must be |
4111 present in 'guioptions'. For the non-GUI tab pages line 'tabline' is | |
4112 used. | |
4113 | |
839 | 4114 *'guitabtooltip'* *'gtt'* |
4115 'guitabtooltip' 'gtt' string (default empty) | |
4116 global | |
17771
4bd21046902b
patch 8.1.1882: cannot specify properties of the info popup window
Bram Moolenaar <Bram@vim.org>
parents:
17767
diff
changeset
|
4117 {only available when compiled with GUI enabled} |
27804 | 4118 When non-empty describes the text to use in a tooltip for the GUI tab |
839 | 4119 pages line. When empty Vim will use a default tooltip. |
4120 This option is otherwise just like 'guitablabel' above. | |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
4121 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
|
4122 :let &guitabtooltip = "line one\nline two" |
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
4123 < |
839 | 4124 |
7 | 4125 *'helpfile'* *'hf'* |
18972 | 4126 'helpfile' 'hf' string (default (MS-Windows) "$VIMRUNTIME\doc\help.txt" |
7 | 4127 (others) "$VIMRUNTIME/doc/help.txt") |
4128 global | |
4129 Name of the main help file. All distributed help files should be | |
4130 placed together in one directory. Additionally, all "doc" directories | |
4131 in 'runtimepath' will be used. | |
4132 Environment variables are expanded |:set_env|. For example: | |
4133 "$VIMRUNTIME/doc/help.txt". If $VIMRUNTIME is not set, $VIM is also | |
10 | 4134 tried. Also see |$VIMRUNTIME| and |option-backslash| about including |
7 | 4135 spaces and backslashes. |
4136 This option cannot be set from a |modeline| or in the |sandbox|, for | |
4137 security reasons. | |
4138 | |
4139 *'helpheight'* *'hh'* | |
4140 'helpheight' 'hh' number (default 20) | |
4141 global | |
4142 Minimal initial height of the help window when it is opened with the | |
4143 ":help" command. The initial height of the help window is half of the | |
4144 current window, or (when the 'ea' option is on) the same as other | |
4145 windows. When the height is less than 'helpheight', the height is | |
4146 set to 'helpheight'. Set to zero to disable. | |
4147 | |
4148 *'helplang'* *'hlg'* | |
4149 'helplang' 'hlg' string (default: messages language or empty) | |
4150 global | |
4151 {only available when compiled with the |+multi_lang| | |
4152 feature} | |
28379 | 4153 Comma-separated list of languages. Vim will use the first language |
7 | 4154 for which the desired help can be found. The English help will always |
4155 be used as a last resort. You can add "en" to prefer English over | |
4156 another language, but that will only find tags that exist in that | |
4157 language and not in the English help. | |
4158 Example: > | |
4159 :set helplang=de,it | |
4160 < This will first search German, then Italian and finally English help | |
4161 files. | |
4162 When using |CTRL-]| and ":help!" in a non-English help file Vim will | |
4163 try to find the tag in the current language before using this option. | |
4164 See |help-translated|. | |
4165 | |
4166 *'hidden'* *'hid'* *'nohidden'* *'nohid'* | |
4167 'hidden' 'hid' boolean (default off) | |
4168 global | |
4169 When off a buffer is unloaded when it is |abandon|ed. When on a | |
4170 buffer becomes hidden when it is |abandon|ed. If the buffer is still | |
4171 displayed in another window, it does not become hidden, of course. | |
28379 | 4172 |
7 | 4173 The commands that move through the buffer list sometimes make a buffer |
28379 | 4174 hidden even if the 'hidden' option is off when these three are true: |
4175 - the buffer is modified | |
4176 - 'autowrite' is off or writing is not possible | |
4177 - the '!' flag was used | |
4178 Also see |windows.txt|. | |
4179 | |
12 | 4180 To only make one buffer hidden use the 'bufhidden' option. |
7 | 4181 This option is set for one command with ":hide {command}" |:hide|. |
4182 WARNING: It's easy to forget that you have changes in hidden buffers. | |
4183 Think twice when using ":q!" or ":qa!". | |
4184 | |
4185 *'highlight'* *'hl'* | |
4186 '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
|
4187 "8:SpecialKey,~:EndOfBuffer,@:NonText, |
7da89d9c744b
commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents:
9860
diff
changeset
|
4188 d:Directory,e:ErrorMsg,i:IncSearch, |
7da89d9c744b
commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents:
9860
diff
changeset
|
4189 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
|
4190 a:LineNrAbove,b:LineNrBelow, |
9877
7da89d9c744b
commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents:
9860
diff
changeset
|
4191 N:CursorLineNr,r:Question,s:StatusLine, |
7da89d9c744b
commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents:
9860
diff
changeset
|
4192 S:StatusLineNC,c:VertSplit,t:Title, |
15194 | 4193 v:Visual,V:VisualNOS,w:WarningMsg, |
4194 W:WildMenu,f:Folded,F:FoldColumn, | |
4195 A:DiffAdd,C:DiffChange,D:DiffDelete, | |
4196 T:DiffText,>:SignColumn,-:Conceal, | |
15281 | 4197 B:SpellBad,P:SpellCap,R:SpellRare, |
15194 | 4198 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
|
4199 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
|
4200 #:TabLineSel,_:TabLineFill,!:CursorColumn, |
11914 | 4201 .:CursorLine,o:ColorColumn,q:QuickFixLine, |
12254 | 4202 z:StatusLineTerm,Z:StatusLineTermNC") |
7 | 4203 global |
4204 This option can be used to set highlighting mode for various | |
28379 | 4205 occasions. It is a comma-separated list of character pairs. The |
7 | 4206 first character in a pair gives the occasion, the second the mode to |
10 | 4207 use for that occasion. The occasions are: |
7 | 4208 |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
|
4209 |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
|
4210 |hl-NonText| @ '@' at the end of the window and |
7 | 4211 characters from 'showbreak' |
4212 |hl-Directory| d directories in CTRL-D listing and other special | |
4213 things in listings | |
4214 |hl-ErrorMsg| e error messages | |
4215 h (obsolete, ignored) | |
4216 |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
|
4217 |hl-CurSearch| y current instance of last search pattern |
7 | 4218 |hl-Search| l last search pattern highlighting (see 'hlsearch') |
4219 |hl-MoreMsg| m |more-prompt| | |
4220 |hl-ModeMsg| M Mode (e.g., "-- INSERT --") | |
2178
c6f1aa1e9f32
Add 'relativenumber' patch from Markus Heidelberg.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
4221 |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
|
4222 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
|
4223 |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
|
4224 '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
|
4225 |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
|
4226 'relativenumber' option is set. |
4073 | 4227 |hl-CursorLineNr| N like n for when 'cursorline' or 'relativenumber' is |
4228 set. | |
7 | 4229 |hl-Question| r |hit-enter| prompt and yes/no questions |
4230 |hl-StatusLine| s status line of current window |status-line| | |
12785 | 4231 |hl-StatusLineNC| S status lines of not-current windows |
7 | 4232 |hl-Title| t Titles for output from ":set all", ":autocmd" etc. |
4233 |hl-VertSplit| c column used to separate vertically split windows | |
4234 |hl-Visual| v Visual mode | |
4235 |hl-VisualNOS| V Visual mode when Vim does is "Not Owning the | |
4236 Selection" Only X11 Gui's |gui-x11| and | |
4237 |xterm-clipboard|. | |
4238 |hl-WarningMsg| w warning messages | |
4239 |hl-WildMenu| W wildcard matches displayed for 'wildmenu' | |
4240 |hl-Folded| f line used for closed folds | |
4241 |hl-FoldColumn| F 'foldcolumn' | |
386 | 4242 |hl-DiffAdd| A added line in diff mode |
4243 |hl-DiffChange| C changed line in diff mode | |
4244 |hl-DiffDelete| D deleted line in diff mode | |
4245 |hl-DiffText| T inserted text in diff mode | |
7 | 4246 |hl-SignColumn| > column used for |signs| |
15194 | 4247 |hl-Conceal| - the placeholders used for concealed characters |
4248 (see 'conceallevel') | |
221 | 4249 |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
|
4250 |hl-SpellCap| P word that should start with capital |spell| |
221 | 4251 |hl-SpellRare| R rare word |spell| |
4252 |hl-SpellLocal| L word from other region |spell| | |
15194 | 4253 |hl-Pmenu| + popup menu normal line |
4254 |hl-PmenuSel| = popup menu selected line | |
4255 |hl-PmenuSbar| x popup menu scrollbar | |
4256 |hl-PmenuThumb| X popup menu scrollbar thumb | |
7 | 4257 |
4258 The display modes are: | |
4259 r reverse (termcap entry "mr" and "me") | |
4260 i italic (termcap entry "ZH" and "ZR") | |
4261 b bold (termcap entry "md" and "me") | |
4262 s standout (termcap entry "so" and "se") | |
4263 u underline (termcap entry "us" and "ue") | |
29328
60977de70684
patch 9.0.0007: no support for double, dotted and dashed underlines
Bram Moolenaar <Bram@vim.org>
parents:
29314
diff
changeset
|
4264 c undercurl (termcap entry "Us" and "Ce") |
60977de70684
patch 9.0.0007: no support for double, dotted and dashed underlines
Bram Moolenaar <Bram@vim.org>
parents:
29314
diff
changeset
|
4265 2 double underline (termcap entry "Ds" and "Ce") |
60977de70684
patch 9.0.0007: no support for double, dotted and dashed underlines
Bram Moolenaar <Bram@vim.org>
parents:
29314
diff
changeset
|
4266 d dotted underline (termcap entry "ds" and "Ce") |
60977de70684
patch 9.0.0007: no support for double, dotted and dashed underlines
Bram Moolenaar <Bram@vim.org>
parents:
29314
diff
changeset
|
4267 = dashed underline (termcap entry "Ds" and "Ce") |
12317
2a8890b80923
patch 8.0.1038: strike-through text not supported
Christian Brabandt <cb@256bit.org>
parents:
12293
diff
changeset
|
4268 t strikethrough (termcap entry "Ts" and "Te") |
7 | 4269 n no highlighting |
4270 - no highlighting | |
4271 : use a highlight group | |
4272 The default is used for occasions that are not included. | |
4273 If you want to change what the display modes do, see |dos-colors| | |
4274 for an example. | |
4275 When using the ':' display mode, this must be followed by the name of | |
4276 a highlight group. A highlight group can be used to define any type | |
4277 of highlighting, including using color. See |:highlight| on how to | |
4278 define one. The default uses a different group for each occasion. | |
4279 See |highlight-default| for the default highlight groups. | |
4280 | |
4281 *'history'* *'hi'* | |
9669
284b4eb307fc
commit https://github.com/vim/vim/commit/8c08b5b569e2a9e9f63dea514591ecfa2d3bb392
Christian Brabandt <cb@256bit.org>
parents:
9665
diff
changeset
|
4282 '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
|
4283 set to 200 in |defaults.vim|) |
7 | 4284 global |
4285 A history of ":" commands, and a history of previous search patterns | |
5991 | 4286 is remembered. This option decides how many entries may be stored in |
7 | 4287 each of these histories (see |cmdline-editing|). |
5991 | 4288 The maximum value is 10000. |
7 | 4289 NOTE: This option is set to the Vi default value when 'compatible' is |
4290 set and to the Vim default value when 'compatible' is reset. | |
4291 | |
4292 *'hkmap'* *'hk'* *'nohkmap'* *'nohk'* | |
4293 'hkmap' 'hk' boolean (default off) | |
4294 global | |
4295 {only available when compiled with the |+rightleft| | |
4296 feature} | |
4297 When on, the keyboard is mapped for the Hebrew character set. | |
4298 Normally you would set 'allowrevins' and use CTRL-_ in insert mode to | |
4299 toggle this option. See |rileft.txt|. | |
4300 NOTE: This option is reset when 'compatible' is set. | |
4301 | |
4302 *'hkmapp'* *'hkp'* *'nohkmapp'* *'nohkp'* | |
4303 'hkmapp' 'hkp' boolean (default off) | |
4304 global | |
4305 {only available when compiled with the |+rightleft| | |
4306 feature} | |
4307 When on, phonetic keyboard mapping is used. 'hkmap' must also be on. | |
4308 This is useful if you have a non-Hebrew keyboard. | |
4309 See |rileft.txt|. | |
4310 NOTE: This option is reset when 'compatible' is set. | |
4311 | |
11160 | 4312 *'hlsearch'* *'hls'* *'nohlsearch'* *'nohls'* |
4313 'hlsearch' 'hls' boolean (default off) | |
4314 global | |
4315 {not available when compiled without the | |
4316 |+extra_search| feature} | |
4317 When there is a previous search pattern, highlight all its matches. | |
4318 The type of highlighting used can be set with the 'l' occasion in the | |
4319 'highlight' option. This uses the "Search" highlight group by | |
4320 default. Note that only the matching text is highlighted, any offsets | |
29066 | 4321 are not applied. If the "CurSearch" highlight group is set then the |
4322 current match is highlighted with that. | |
11160 | 4323 See also: 'incsearch' and |:match|. |
4324 When you get bored looking at the highlighted matches, you can turn it | |
4325 off with |:nohlsearch|. This does not change the option value, as | |
4326 soon as you use a search command, the highlighting comes back. | |
4327 'redrawtime' specifies the maximum time spent on finding matches. | |
4328 When the search pattern can match an end-of-line, Vim will try to | |
4329 highlight all of the matched text. However, this depends on where the | |
4330 search starts. This will be the first line in the window or the first | |
4331 line below a closed fold. A match in a previous line which is not | |
4332 drawn may not continue in a newly drawn line. | |
4333 You can specify whether the highlight status is restored on startup | |
4334 with the 'h' flag in 'viminfo' |viminfo-h|. | |
4335 NOTE: This option is reset when 'compatible' is set. | |
4336 | |
7 | 4337 *'icon'* *'noicon'* |
4338 'icon' boolean (default off, on when title can be restored) | |
4339 global | |
4340 When on, the icon text of the window will be set to the value of | |
4341 'iconstring' (if it is not empty), or to the name of the file | |
4342 currently being edited. Only the last part of the name is used. | |
4343 Overridden by the 'iconstring' option. | |
4344 Only works if the terminal supports setting window icons (currently | |
4345 only X11 GUI and terminals with a non-empty 't_IS' option - these are | |
4346 Unix xterm and iris-ansi by default, where 't_IS' is taken from the | |
4347 builtin termcap). | |
4348 When Vim was compiled with HAVE_X11 defined, the original icon will be | |
233 | 4349 restored if possible |X11|. See |X11-icon| for changing the icon on |
7 | 4350 X11. |
6259 | 4351 For MS-Windows the icon can be changed, see |windows-icon|. |
7 | 4352 |
4353 *'iconstring'* | |
4354 'iconstring' string (default "") | |
4355 global | |
4356 When this option is not empty, it will be used for the icon text of | |
4357 the window. This happens only when the 'icon' option is on. | |
4358 Only works if the terminal supports setting window icon text | |
4359 (currently only X11 GUI and terminals with a non-empty 't_IS' option). | |
24387 | 4360 Does not work for MS-Windows. |
7 | 4361 When Vim was compiled with HAVE_X11 defined, the original icon will be |
4362 restored if possible |X11|. | |
4363 When this option contains printf-style '%' items, they will be | |
10 | 4364 expanded according to the rules used for 'statusline'. See |
7 | 4365 '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
|
4366 This option cannot be set in a modeline when 'modelineexpr' is off. |
7 | 4367 {not available when compiled without the |+statusline| feature} |
4368 | |
4369 *'ignorecase'* *'ic'* *'noignorecase'* *'noic'* | |
4370 'ignorecase' 'ic' boolean (default off) | |
4371 global | |
4372 Ignore case in search patterns. Also used when searching in the tags | |
4373 file. | |
7266
6ba7182fb7bd
commit https://github.com/vim/vim/commit/0f6562e9036f889185dff49a75c7fc5ffb28b307
Christian Brabandt <cb@256bit.org>
parents:
7245
diff
changeset
|
4374 Also see 'smartcase' and 'tagcase'. |
7 | 4375 Can be overruled by using "\c" or "\C" in the pattern, see |
4376 |/ignorecase|. | |
4377 | |
5008
3717d569027d
updated for version 7.3.1248
Bram Moolenaar <bram@vim.org>
parents:
4869
diff
changeset
|
4378 *'imactivatefunc'* *'imaf'* |
3717d569027d
updated for version 7.3.1248
Bram Moolenaar <bram@vim.org>
parents:
4869
diff
changeset
|
4379 'imactivatefunc' 'imaf' string (default "") |
3717d569027d
updated for version 7.3.1248
Bram Moolenaar <bram@vim.org>
parents:
4869
diff
changeset
|
4380 global |
3717d569027d
updated for version 7.3.1248
Bram Moolenaar <bram@vim.org>
parents:
4869
diff
changeset
|
4381 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
|
4382 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
|
4383 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
|
4384 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
|
4385 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
|
4386 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
|
4387 modeline, see |sandbox-option|. |
5008
3717d569027d
updated for version 7.3.1248
Bram Moolenaar <bram@vim.org>
parents:
4869
diff
changeset
|
4388 |
3717d569027d
updated for version 7.3.1248
Bram Moolenaar <bram@vim.org>
parents:
4869
diff
changeset
|
4389 Example: > |
3717d569027d
updated for version 7.3.1248
Bram Moolenaar <bram@vim.org>
parents:
4869
diff
changeset
|
4390 function ImActivateFunc(active) |
3717d569027d
updated for version 7.3.1248
Bram Moolenaar <bram@vim.org>
parents:
4869
diff
changeset
|
4391 if a:active |
3717d569027d
updated for version 7.3.1248
Bram Moolenaar <bram@vim.org>
parents:
4869
diff
changeset
|
4392 ... do something |
3717d569027d
updated for version 7.3.1248
Bram Moolenaar <bram@vim.org>
parents:
4869
diff
changeset
|
4393 else |
3717d569027d
updated for version 7.3.1248
Bram Moolenaar <bram@vim.org>
parents:
4869
diff
changeset
|
4394 ... do something |
3717d569027d
updated for version 7.3.1248
Bram Moolenaar <bram@vim.org>
parents:
4869
diff
changeset
|
4395 endif |
3717d569027d
updated for version 7.3.1248
Bram Moolenaar <bram@vim.org>
parents:
4869
diff
changeset
|
4396 " return value is not used |
3717d569027d
updated for version 7.3.1248
Bram Moolenaar <bram@vim.org>
parents:
4869
diff
changeset
|
4397 endfunction |
3717d569027d
updated for version 7.3.1248
Bram Moolenaar <bram@vim.org>
parents:
4869
diff
changeset
|
4398 set imactivatefunc=ImActivateFunc |
3717d569027d
updated for version 7.3.1248
Bram Moolenaar <bram@vim.org>
parents:
4869
diff
changeset
|
4399 < |
7 | 4400 *'imactivatekey'* *'imak'* |
4401 'imactivatekey' 'imak' string (default "") | |
4402 global | |
4403 {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
|
4404 |+GUI_GTK|} *E599* |
7 | 4405 Specifies the key that your Input Method in X-Windows uses for |
4406 activation. When this is specified correctly, vim can fully control | |
4407 IM with 'imcmdline', 'iminsert' and 'imsearch'. | |
4408 You can't use this option to change the activation key, the option | |
4409 tells Vim what the key is. | |
4410 Format: | |
4411 [MODIFIER_FLAG-]KEY_STRING | |
4412 | |
4413 These characters can be used for MODIFIER_FLAG (case is ignored): | |
4414 S Shift key | |
4415 L Lock key | |
4416 C Control key | |
4417 1 Mod1 key | |
4418 2 Mod2 key | |
4419 3 Mod3 key | |
4420 4 Mod4 key | |
4421 5 Mod5 key | |
4422 Combinations are allowed, for example "S-C-space" or "SC-space" are | |
4423 both shift+ctrl+space. | |
4424 See <X11/keysymdef.h> and XStringToKeysym for KEY_STRING. | |
4425 | |
4426 Example: > | |
4427 :set imactivatekey=S-space | |
4428 < "S-space" means shift+space. This is the activation key for kinput2 + | |
4429 canna (Japanese), and ami (Korean). | |
4430 | |
4431 *'imcmdline'* *'imc'* *'noimcmdline'* *'noimc'* | |
4432 'imcmdline' 'imc' boolean (default off) | |
4433 global | |
4434 When set the Input Method is always on when starting to edit a command | |
4435 line, unless entering a search pattern (see 'imsearch' for that). | |
4436 Setting this option is useful when your input method allows entering | |
4437 English characters directly, e.g., when it's used to type accented | |
4438 characters with dead keys. | |
4439 | |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
4440 *'imdisable'* *'imd'* *'noimdisable'* *'noimd'* |
7 | 4441 'imdisable' 'imd' boolean (default off, on for some systems (SGI)) |
4442 global | |
4443 When set the Input Method is never used. This is useful to disable | |
4444 the IM when it doesn't work properly. | |
4445 Currently this option is on by default for SGI/IRIX machines. This | |
4446 may change in later releases. | |
4447 | |
4448 *'iminsert'* *'imi'* | |
12469
61d910f0999d
patch 8.0.1114: default for 'iminsert' is annoying
Christian Brabandt <cb@256bit.org>
parents:
12317
diff
changeset
|
4449 'iminsert' 'imi' number (default 0) |
7 | 4450 local to buffer |
4451 Specifies whether :lmap or an Input Method (IM) is to be used in | |
4452 Insert mode. Valid values: | |
4453 0 :lmap is off and IM is off | |
4454 1 :lmap is ON and IM is off | |
4455 2 :lmap is off and IM is ON | |
4456 To always reset the option to zero when leaving Insert mode with <Esc> | |
4457 this can be used: > | |
4458 :inoremap <ESC> <ESC>:set iminsert=0<CR> | |
4459 < This makes :lmap and IM turn off automatically when leaving Insert | |
4460 mode. | |
4461 Note that this option changes when using CTRL-^ in Insert mode | |
4462 |i_CTRL-^|. | |
4463 The value is set to 1 when setting 'keymap' to a valid keymap name. | |
4464 It is also used for the argument of commands like "r" and "f". | |
28379 | 4465 The value 0 may not work correctly with Motif with some XIM |
7 | 4466 methods. Use 'imdisable' to disable XIM then. |
4467 | |
12920
327e1264b9bf
patch 8.0.1336: cannot use imactivatefunc() unless compiled with +xim
Christian Brabandt <cb@256bit.org>
parents:
12865
diff
changeset
|
4468 You can set 'imactivatefunc' and 'imstatusfunc' to handle IME/XIM |
14519 | 4469 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
|
4470 |+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
|
4471 |
7 | 4472 *'imsearch'* *'ims'* |
12469
61d910f0999d
patch 8.0.1114: default for 'iminsert' is annoying
Christian Brabandt <cb@256bit.org>
parents:
12317
diff
changeset
|
4473 'imsearch' 'ims' number (default -1) |
7 | 4474 local to buffer |
4475 Specifies whether :lmap or an Input Method (IM) is to be used when | |
4476 entering a search pattern. Valid values: | |
4477 -1 the value of 'iminsert' is used, makes it look like | |
4478 'iminsert' is also used when typing a search pattern | |
4479 0 :lmap is off and IM is off | |
4480 1 :lmap is ON and IM is off | |
4481 2 :lmap is off and IM is ON | |
4482 Note that this option changes when using CTRL-^ in Command-line mode | |
4483 |c_CTRL-^|. | |
4484 The value is set to 1 when it is not -1 and setting the 'keymap' | |
4485 option to a valid keymap name. | |
28379 | 4486 The value 0 may not work correctly with Motif with some XIM |
7 | 4487 methods. Use 'imdisable' to disable XIM then. |
4488 | |
5008
3717d569027d
updated for version 7.3.1248
Bram Moolenaar <bram@vim.org>
parents:
4869
diff
changeset
|
4489 *'imstatusfunc'* *'imsf'* |
3717d569027d
updated for version 7.3.1248
Bram Moolenaar <bram@vim.org>
parents:
4869
diff
changeset
|
4490 'imstatusfunc' 'imsf' string (default "") |
3717d569027d
updated for version 7.3.1248
Bram Moolenaar <bram@vim.org>
parents:
4869
diff
changeset
|
4491 global |
3717d569027d
updated for version 7.3.1248
Bram Moolenaar <bram@vim.org>
parents:
4869
diff
changeset
|
4492 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
|
4493 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
|
4494 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
|
4495 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
|
4496 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
|
4497 |
3717d569027d
updated for version 7.3.1248
Bram Moolenaar <bram@vim.org>
parents:
4869
diff
changeset
|
4498 Example: > |
3717d569027d
updated for version 7.3.1248
Bram Moolenaar <bram@vim.org>
parents:
4869
diff
changeset
|
4499 function ImStatusFunc() |
3717d569027d
updated for version 7.3.1248
Bram Moolenaar <bram@vim.org>
parents:
4869
diff
changeset
|
4500 let is_active = ...do something |
3717d569027d
updated for version 7.3.1248
Bram Moolenaar <bram@vim.org>
parents:
4869
diff
changeset
|
4501 return is_active ? 1 : 0 |
3717d569027d
updated for version 7.3.1248
Bram Moolenaar <bram@vim.org>
parents:
4869
diff
changeset
|
4502 endfunction |
3717d569027d
updated for version 7.3.1248
Bram Moolenaar <bram@vim.org>
parents:
4869
diff
changeset
|
4503 set imstatusfunc=ImStatusFunc |
3717d569027d
updated for version 7.3.1248
Bram Moolenaar <bram@vim.org>
parents:
4869
diff
changeset
|
4504 < |
3717d569027d
updated for version 7.3.1248
Bram Moolenaar <bram@vim.org>
parents:
4869
diff
changeset
|
4505 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
|
4506 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
|
4507 modeline, see |sandbox-option|. |
5008
3717d569027d
updated for version 7.3.1248
Bram Moolenaar <bram@vim.org>
parents:
4869
diff
changeset
|
4508 |
12293
1ff5e5dfa9b0
patch 8.0.1026: GTK on-the-spot input has problems
Christian Brabandt <cb@256bit.org>
parents:
12254
diff
changeset
|
4509 *'imstyle'* *'imst'* |
1ff5e5dfa9b0
patch 8.0.1026: GTK on-the-spot input has problems
Christian Brabandt <cb@256bit.org>
parents:
12254
diff
changeset
|
4510 '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
|
4511 global |
1ff5e5dfa9b0
patch 8.0.1026: GTK on-the-spot input has problems
Christian Brabandt <cb@256bit.org>
parents:
12254
diff
changeset
|
4512 {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
|
4513 |+GUI_GTK|} |
12499 | 4514 This option specifies the input style of Input Method: |
4515 0 use on-the-spot style | |
4516 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
|
4517 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
|
4518 |
12559 | 4519 For a long time on-the-spot style had been used in the GTK version of |
4520 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
|
4521 |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
|
4522 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
|
4523 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
|
4524 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
|
4525 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
|
4526 |
7 | 4527 *'include'* *'inc'* |
4528 'include' 'inc' string (default "^\s*#\s*include") | |
4529 global or local to buffer |global-local| | |
4530 {not available when compiled without the | |
4531 |+find_in_path| feature} | |
10 | 4532 Pattern to be used to find an include command. It is a search |
7 | 4533 pattern, just like for the "/" command (See |pattern|). The default |
4534 value is for C programs. This option is used for the commands "[i", | |
532 | 4535 "]I", "[d", etc. |
4536 Normally the 'isfname' option is used to recognize the file name that | |
534 | 4537 comes after the matched pattern. But if "\zs" appears in the pattern |
4538 then the text matched from "\zs" to the end, or until "\ze" if it | |
4539 appears, is used as the file name. Use this to include characters | |
4540 that are not in 'isfname', such as a space. You can then use | |
4541 'includeexpr' to process the matched text. | |
532 | 4542 See |option-backslash| about including spaces and backslashes. |
7 | 4543 |
4544 *'includeexpr'* *'inex'* | |
4545 'includeexpr' 'inex' string (default "") | |
4546 local to buffer | |
4547 {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
|
4548 |+find_in_path| or |+eval| features} |
7 | 4549 Expression to be used to transform the string found with the 'include' |
10 | 4550 option to a file name. Mostly useful to change "." to "/" for Java: > |
31200 | 4551 :setlocal includeexpr=substitute(v:fname,'\\.','/','g') |
7 | 4552 < The "v:fname" variable will be set to the file name that was detected. |
31200 | 4553 Note the double backslash: the `:set` command first halves them, then |
4554 one remains it the value, where "\." matches a dot literally. For | |
4555 simple character replacements `tr()` avoids the need for escaping: > | |
4556 :setlocal includeexpr=tr(v:fname,'.','/') | |
4557 < | |
7 | 4558 Also used for the |gf| command if an unmodified file name can't be |
10 | 4559 found. Allows doing "gf" on the name after an 'include' statement. |
7 | 4560 Also used for |<cfile>|. |
4561 | |
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
|
4562 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
|
4563 the script ID (|local-function|). Example: > |
31200 | 4564 setlocal includeexpr=s:MyIncludeExpr() |
4565 setlocal includeexpr=<SID>SomeIncludeExpr() | |
27321 | 4566 < Otherwise, the expression is evaluated in the context of the script |
4567 where the option was set, thus script-local items are available. | |
4568 | |
30598
37aa9fd2ed72
patch 9.0.0634: evaluating "expr" options has more overhead than needed
Bram Moolenaar <Bram@vim.org>
parents:
30547
diff
changeset
|
4569 It is more efficient if the value is just a function call without |
37aa9fd2ed72
patch 9.0.0634: evaluating "expr" options has more overhead than needed
Bram Moolenaar <Bram@vim.org>
parents:
30547
diff
changeset
|
4570 arguments, see |expr-option-function|. |
37aa9fd2ed72
patch 9.0.0634: evaluating "expr" options has more overhead than needed
Bram Moolenaar <Bram@vim.org>
parents:
30547
diff
changeset
|
4571 |
3682 | 4572 The expression will be evaluated in the |sandbox| when set from a |
4573 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
|
4574 This option cannot be set in a modeline when 'modelineexpr' is off. |
634 | 4575 |
4576 It is not allowed to change text or jump to another window while | |
4577 evaluating 'includeexpr' |textlock|. | |
4578 | |
7 | 4579 *'incsearch'* *'is'* *'noincsearch'* *'nois'* |
9669
284b4eb307fc
commit https://github.com/vim/vim/commit/8c08b5b569e2a9e9f63dea514591ecfa2d3bb392
Christian Brabandt <cb@256bit.org>
parents:
9665
diff
changeset
|
4580 'incsearch' 'is' boolean (default off, set in |defaults.vim| if the |
29290 | 4581 |+reltime| feature is supported) |
7 | 4582 global |
4583 {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
|
4584 |+extra_search| features} |
17 | 4585 While typing a search command, show where the pattern, as it was typed |
4586 so far, matches. The matched string is highlighted. If the pattern | |
4587 is invalid or not found, nothing is shown. The screen will be updated | |
4588 often, this is only useful on fast terminals. | |
14637 | 4589 Also applies to the pattern in commands: > |
4590 :global | |
4591 :lvimgrep | |
4592 :lvimgrepadd | |
4593 :smagic | |
4594 :snomagic | |
4595 :sort | |
4596 :substitute | |
4597 :vglobal | |
4598 :vimgrep | |
4599 :vimgrepadd | |
4600 < Note that the match will be shown, but the cursor will return to its | |
17 | 4601 original position when no match is found and when pressing <Esc>. You |
4602 still need to finish the search command with <Enter> to move the | |
4603 cursor to the match. | |
10261
bdd7fc1a38c0
commit https://github.com/vim/vim/commit/dc08328821a2c11e33dfb1980332e4923ec64fca
Christian Brabandt <cb@256bit.org>
parents:
10244
diff
changeset
|
4604 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
|
4605 previous match. |c_CTRL-G| |c_CTRL-T| |
1521 | 4606 When compiled with the |+reltime| feature Vim only searches for about |
4607 half a second. With a complicated pattern and/or a lot of text the | |
4608 match may not be found. This is to avoid that Vim hangs while you | |
4609 are typing the pattern. | |
17 | 4610 The highlighting can be set with the 'i' flag in 'highlight'. |
12968 | 4611 When 'hlsearch' is on, all matched strings are highlighted too while |
4612 typing a search command. See also: 'hlsearch'. | |
14519 | 4613 If you don't want to turn 'hlsearch' on, but want to highlight all |
4614 matches while searching, you can turn on and off 'hlsearch' with | |
4615 autocmd. Example: > | |
12720
37c384802df4
patch 8.0.1238: incremental search only shows one match
Christian Brabandt <cb@256bit.org>
parents:
12608
diff
changeset
|
4616 augroup vimrc-incsearch-highlight |
37c384802df4
patch 8.0.1238: incremental search only shows one match
Christian Brabandt <cb@256bit.org>
parents:
12608
diff
changeset
|
4617 autocmd! |
12744
0c704288ced4
patch 8.0.1250: 'hlsearch' highlighting not removed after incsearch
Christian Brabandt <cb@256bit.org>
parents:
12720
diff
changeset
|
4618 autocmd CmdlineEnter /,\? :set hlsearch |
0c704288ced4
patch 8.0.1250: 'hlsearch' highlighting not removed after incsearch
Christian Brabandt <cb@256bit.org>
parents:
12720
diff
changeset
|
4619 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
|
4620 augroup END |
37c384802df4
patch 8.0.1238: incremental search only shows one match
Christian Brabandt <cb@256bit.org>
parents:
12608
diff
changeset
|
4621 < |
772 | 4622 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
|
4623 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
|
4624 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
|
4625 converted to lowercase. |
772 | 4626 CTRL-R CTRL-W can be used to add the word at the end of the current |
4627 match, excluding the characters that were already typed. | |
7 | 4628 NOTE: This option is reset when 'compatible' is set. |
4629 | |
4630 *'indentexpr'* *'inde'* | |
4631 'indentexpr' 'inde' string (default "") | |
4632 local to buffer | |
28942
6cdf55afaae9
patch 8.2.4993: smart/C/lisp indenting is optional
Bram Moolenaar <Bram@vim.org>
parents:
28777
diff
changeset
|
4633 {not available when compiled without the |+eval| |
6cdf55afaae9
patch 8.2.4993: smart/C/lisp indenting is optional
Bram Moolenaar <Bram@vim.org>
parents:
28777
diff
changeset
|
4634 feature} |
7 | 4635 Expression which is evaluated to obtain the proper indent for a line. |
4636 It is used when a new line is created, for the |=| operator and | |
4637 in Insert mode as specified with the 'indentkeys' option. | |
4638 When this option is not empty, it overrules the 'cindent' and | |
2833 | 4639 'smartindent' indenting. When 'lisp' is set, this option is |
30853
40df8a6515f6
patch 9.0.0761: cannot use 'indentexpr' for Lisp indenting
Bram Moolenaar <Bram@vim.org>
parents:
30825
diff
changeset
|
4640 is only used when 'lispoptions' contains "expr:1". |
7 | 4641 When 'paste' is set this option is not used for indenting. |
4642 The expression is evaluated with |v:lnum| set to the line number for | |
534 | 4643 which the indent is to be computed. The cursor is also in this line |
7 | 4644 when the expression is evaluated (but it may be moved around). |
27321 | 4645 |
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
|
4646 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
|
4647 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
|
4648 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
|
4649 set indentexpr=<SID>SomeIndentExpr() |
27321 | 4650 < Otherwise, the expression is evaluated in the context of the script |
4651 where the option was set, thus script-local items are available. | |
4652 | |
30598
37aa9fd2ed72
patch 9.0.0634: evaluating "expr" options has more overhead than needed
Bram Moolenaar <Bram@vim.org>
parents:
30547
diff
changeset
|
4653 The advantage of using a function call without arguments is that it is |
37aa9fd2ed72
patch 9.0.0634: evaluating "expr" options has more overhead than needed
Bram Moolenaar <Bram@vim.org>
parents:
30547
diff
changeset
|
4654 faster, see |expr-option-function|. |
37aa9fd2ed72
patch 9.0.0634: evaluating "expr" options has more overhead than needed
Bram Moolenaar <Bram@vim.org>
parents:
30547
diff
changeset
|
4655 |
7 | 4656 The expression must return the number of spaces worth of indent. It |
4657 can return "-1" to keep the current indent (this means 'autoindent' is | |
4658 used for the indent). | |
4659 Functions useful for computing the indent are |indent()|, |cindent()| | |
4660 and |lispindent()|. | |
4661 The evaluation of the expression must not have side effects! It must | |
4662 not change the text, jump to another window, etc. Afterwards the | |
4663 cursor position is always restored, thus the cursor may be moved. | |
4664 Normally this option would be set to call a function: > | |
4665 :set indentexpr=GetMyIndent() | |
4666 < Error messages will be suppressed, unless the 'debug' option contains | |
4667 "msg". | |
634 | 4668 See |indent-expression|. |
11160 | 4669 NOTE: This option is set to "" when 'compatible' is set. |
7 | 4670 |
3682 | 4671 The expression will be evaluated in the |sandbox| when set from a |
4672 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
|
4673 This option cannot be set in a modeline when 'modelineexpr' is off. |
634 | 4674 |
4675 It is not allowed to change text or jump to another window while | |
4676 evaluating 'indentexpr' |textlock|. | |
4677 | |
4678 | |
7 | 4679 *'indentkeys'* *'indk'* |
15701
9cd11f6beb70
patch 8.1.0858: 'indentkeys' and 'cinkeys' defaults are different
Bram Moolenaar <Bram@vim.org>
parents:
15512
diff
changeset
|
4680 'indentkeys' 'indk' string (default "0{,0},0),0],:,0#,!^F,o,O,e") |
7 | 4681 local to buffer |
4682 A list of keys that, when typed in Insert mode, cause reindenting of | |
4683 the current line. Only happens if 'indentexpr' isn't empty. | |
4684 The format is identical to 'cinkeys', see |indentkeys-format|. | |
4685 See |C-indenting| and |indent-expression|. | |
4686 | |
4687 *'infercase'* *'inf'* *'noinfercase'* *'noinf'* | |
4688 'infercase' 'inf' boolean (default off) | |
4689 local to buffer | |
4690 When doing keyword completion in insert mode |ins-completion|, and | |
1621 | 4691 'ignorecase' is also on, the case of the match is adjusted depending |
4692 on the typed text. If the typed text contains a lowercase letter | |
4693 where the match has an upper case letter, the completed part is made | |
4694 lowercase. If the typed text has no lowercase letters and the match | |
4695 has a lowercase letter where the typed text has an uppercase letter, | |
4696 and there is a letter before it, the completed part is made uppercase. | |
4697 With 'noinfercase' the match is used as-is. | |
7 | 4698 |
4699 *'insertmode'* *'im'* *'noinsertmode'* *'noim'* | |
4700 'insertmode' 'im' boolean (default off) | |
4701 global | |
4702 Makes Vim work in a way that Insert mode is the default mode. Useful | |
4703 if you want to use Vim as a modeless editor. Used for |evim|. | |
4704 These Insert mode commands will be useful: | |
4705 - 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
|
4706 - Use CTRL-O to execute one Normal mode command |i_CTRL-O|. When |
7 | 4707 this is a mapping, it is executed as if 'insertmode' was off. |
4708 Normal mode remains active until the mapping is finished. | |
4709 - Use CTRL-L to execute a number of Normal mode commands, then use | |
477 | 4710 <Esc> to get back to Insert mode. Note that CTRL-L moves the cursor |
4711 left, like <Esc> does when 'insertmode' isn't set. |i_CTRL-L| | |
7 | 4712 |
4713 These items change when 'insertmode' is set: | |
4714 - when starting to edit of a file, Vim goes to Insert mode. | |
4715 - <Esc> in Insert mode is a no-op and beeps. | |
4716 - <Esc> in Normal mode makes Vim go to Insert mode. | |
4717 - CTRL-L in Insert mode is a command, it is not inserted. | |
4718 - CTRL-Z in Insert mode suspends Vim, see |CTRL-Z|. *i_CTRL-Z* | |
4719 However, when <Esc> is used inside a mapping, it behaves like | |
4720 'insertmode' was not set. This was done to be able to use the same | |
4721 mappings with 'insertmode' set or not set. | |
4722 When executing commands with |:normal| 'insertmode' is not used. | |
4723 | |
4724 NOTE: This option is reset when 'compatible' is set. | |
4725 | |
4726 *'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
|
4727 'isfname' 'isf' string (default for Win32: |
7 | 4728 "@,48-57,/,\,.,-,_,+,,,#,$,%,{,},[,],:,@-@,!,~,=" |
4729 for AMIGA: "@,48-57,/,.,-,_,+,,,$,:" | |
4730 for VMS: "@,48-57,/,.,-,_,+,,,#,$,%,<,>,[,],:,;,~" | |
4731 for OS/390: "@,240-249,/,.,-,_,+,,,#,$,%,~,=" | |
4732 otherwise: "@,48-57,/,.,-,_,+,,,#,$,%,~,=") | |
4733 global | |
4734 The characters specified by this option are included in file names and | |
4735 path names. Filenames are used for commands like "gf", "[i" and in | |
10 | 4736 the tags file. It is also used for "\f" in a |pattern|. |
7 | 4737 Multi-byte characters 256 and above are always included, only the |
4738 characters up to 255 are specified with this option. | |
4739 For UTF-8 the characters 0xa0 to 0xff are included as well. | |
1621 | 4740 Think twice before adding white space to this option. Although a |
4741 space may appear inside a file name, the effect will be that Vim | |
4742 doesn't know where a file name starts or ends when doing completion. | |
4743 It most likely works better without a space in 'isfname'. | |
7 | 4744 |
4745 Note that on systems using a backslash as path separator, Vim tries to | |
4746 do its best to make it work as you would expect. That is a bit | |
4747 tricky, since Vi originally used the backslash to escape special | |
4748 characters. Vim will not remove a backslash in front of a normal file | |
4749 name character on these systems, but it will on Unix and alikes. The | |
4750 '&' and '^' are not included by default, because these are special for | |
4751 cmd.exe. | |
4752 | |
4753 The format of this option is a list of parts, separated with commas. | |
10 | 4754 Each part can be a single character number or a range. A range is two |
4755 character numbers with '-' in between. A character number can be a | |
7 | 4756 decimal number between 0 and 255 or the ASCII character itself (does |
4757 not work for digits). Example: | |
4758 "_,-,128-140,#-43" (include '_' and '-' and the range | |
4759 128 to 140 and '#' to 43) | |
4760 If a part starts with '^', the following character number or range | |
4761 will be excluded from the option. The option is interpreted from left | |
4762 to right. Put the excluded character after the range where it is | |
4763 included. To include '^' itself use it as the last character of the | |
4764 option or the end of a range. Example: | |
4765 "^a-z,#,^" (exclude 'a' to 'z', include '#' and '^') | |
4766 If the character is '@', all characters where isalpha() returns TRUE | |
4767 are included. Normally these are the characters a to z and A to Z, | |
4768 plus accented characters. To include '@' itself use "@-@". Examples: | |
4769 "@,^a-z" All alphabetic characters, excluding lower | |
1621 | 4770 case ASCII letters. |
7 | 4771 "a-z,A-Z,@-@" All letters plus the '@' character. |
4772 A comma can be included by using it where a character number is | |
4773 expected. Example: | |
4774 "48-57,,,_" Digits, comma and underscore. | |
4775 A comma can be excluded by prepending a '^'. Example: | |
4776 " -~,^,,9" All characters from space to '~', excluding | |
4777 comma, plus <Tab>. | |
4778 See |option-backslash| about including spaces and backslashes. | |
4779 | |
4780 *'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
|
4781 'isident' 'isi' string (default for Win32: |
7 | 4782 "@,48-57,_,128-167,224-235" |
4783 otherwise: "@,48-57,_,192-255") | |
4784 global | |
4785 The characters given by this option are included in identifiers. | |
4786 Identifiers are used in recognizing environment variables and after a | |
4787 match of the 'define' option. It is also used for "\i" in a | |
233 | 4788 |pattern|. See 'isfname' for a description of the format of this |
14864 | 4789 option. For '@' only characters up to 255 are used. |
7 | 4790 Careful: If you change this option, it might break expanding |
10 | 4791 environment variables. E.g., when '/' is included and Vim tries to |
7 | 4792 expand "$HOME/.viminfo". Maybe you should change 'iskeyword' instead. |
4793 | |
4794 *'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
|
4795 'iskeyword' 'isk' string (Vim default for Win32: |
7 | 4796 "@,48-57,_,128-167,224-235" |
4797 otherwise: "@,48-57,_,192-255" | |
4798 Vi default: "@,48-57,_") | |
4799 local to buffer | |
4800 Keywords are used in searching and recognizing with many commands: | |
10 | 4801 "w", "*", "[i", etc. It is also used for "\k" in a |pattern|. See |
14864 | 4802 'isfname' for a description of the format of this option. For '@' |
24569 | 4803 characters above 255 check the "word" character class (any character |
4804 that is not white space or punctuation). | |
14864 | 4805 For C programs you could use "a-z,A-Z,48-57,_,.,-,>". |
7 | 4806 For a help file it is set to all non-blank printable characters except |
4807 '*', '"' and '|' (so that CTRL-] on a command finds the help for that | |
4808 command). | |
4809 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
|
4810 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
|
4811 uses |:syn-iskeyword|. |
7 | 4812 NOTE: This option is set to the Vi default value when 'compatible' is |
4813 set and to the Vim default value when 'compatible' is reset. | |
4814 | |
4815 *'isprint'* *'isp'* | |
21825 | 4816 'isprint' 'isp' string (default for Win32 and macOS: |
7 | 4817 "@,~-255"; otherwise: "@,161-255") |
4818 global | |
4819 The characters given by this option are displayed directly on the | |
4820 screen. It is also used for "\p" in a |pattern|. The characters from | |
4821 space (ASCII 32) to '~' (ASCII 126) are always displayed directly, | |
4822 even when they are not included in 'isprint' or excluded. See | |
4823 'isfname' for a description of the format of this option. | |
4824 | |
4825 Non-printable characters are displayed with two characters: | |
4826 0 - 31 "^@" - "^_" | |
4827 32 - 126 always single characters | |
4828 127 "^?" | |
4829 128 - 159 "~@" - "~_" | |
4830 160 - 254 "| " - "|~" | |
4831 255 "~?" | |
4832 When 'encoding' is a Unicode one, illegal bytes from 128 to 255 are | |
4833 displayed as <xx>, with the hexadecimal value of the byte. | |
4834 When 'display' contains "uhex" all unprintable characters are | |
4835 displayed as <xx>. | |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
4836 The SpecialKey highlighting will be used for unprintable characters. |
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
4837 |hl-SpecialKey| |
7 | 4838 |
4839 Multi-byte characters 256 and above are always included, only the | |
4840 characters up to 255 are specified with this option. When a character | |
4841 is printable but it is not available in the current font, a | |
4842 replacement character will be shown. | |
4843 Unprintable and zero-width Unicode characters are displayed as <xxxx>. | |
4844 There is no option to specify these characters. | |
4845 | |
4846 *'joinspaces'* *'js'* *'nojoinspaces'* *'nojs'* | |
4847 'joinspaces' 'js' boolean (default on) | |
4848 global | |
4849 Insert two spaces after a '.', '?' and '!' with a join command. | |
4850 When 'cpoptions' includes the 'j' flag, only do this after a '.'. | |
4851 Otherwise only one space is inserted. | |
4852 NOTE: This option is set when 'compatible' is set. | |
4853 | |
4854 *'key'* | |
4855 'key' string (default "") | |
4856 local to buffer | |
2283
7e1bd501306d
Mainly documentation updates.
Bram Moolenaar <bram@vim.org>
parents:
2265
diff
changeset
|
4857 {only available when compiled with the |+cryptv| |
7e1bd501306d
Mainly documentation updates.
Bram Moolenaar <bram@vim.org>
parents:
2265
diff
changeset
|
4858 feature} |
7 | 4859 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
|
4860 See |encryption| and 'cryptmethod'. |
7 | 4861 Careful: Do not set the key value by hand, someone might see the typed |
4862 key. Use the |:X| command. But you can make 'key' empty: > | |
4863 :set key= | |
4864 < It is not possible to get the value of this option with ":set key" or | |
4865 "echo &key". This is to avoid showing it to someone who shouldn't | |
4866 know. It also means you cannot see it yourself once you have set it, | |
4867 be careful not to make a typing error! | |
2698
b6471224d2af
Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents:
2681
diff
changeset
|
4868 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
|
4869 enabled. When 'key' is set it returns "*****" (five stars). |
7 | 4870 |
4871 *'keymap'* *'kmp'* *E544* | |
4872 'keymap' 'kmp' string (default "") | |
4873 local to buffer | |
4874 {only available when compiled with the |+keymap| | |
4875 feature} | |
4876 Name of a keyboard mapping. See |mbyte-keymap|. | |
4877 Setting this option to a valid keymap name has the side effect of | |
4878 setting 'iminsert' to one, so that the keymap becomes effective. | |
4879 'imsearch' is also set to one, unless it was -1 | |
36 | 4880 Only normal file name characters can be used, "/\*?[|<>" are illegal. |
7 | 4881 |
4882 *'keymodel'* *'km'* | |
4883 'keymodel' 'km' string (default "") | |
4884 global | |
28379 | 4885 List of comma-separated words, which enable special things that keys |
7 | 4886 can do. These values can be used: |
4887 startsel Using a shifted special key starts selection (either | |
4888 Select mode or Visual mode, depending on "key" being | |
4889 present in 'selectmode'). | |
4890 stopsel Using a not-shifted special key stops selection. | |
4891 Special keys in this context are the cursor keys, <End>, <Home>, | |
4892 <PageUp> and <PageDown>. | |
4893 The 'keymodel' option is set by the |:behave| command. | |
4894 | |
31192
dcde141f2d1e
patch 9.0.0930: cannot debug the Kitty keyboard protocol with TermDebug
Bram Moolenaar <Bram@vim.org>
parents:
31139
diff
changeset
|
4895 *'keyprotocol'* *'kpc'* |
dcde141f2d1e
patch 9.0.0930: cannot debug the Kitty keyboard protocol with TermDebug
Bram Moolenaar <Bram@vim.org>
parents:
31139
diff
changeset
|
4896 'keyprotocol' 'kpc' string (default: see below) |
dcde141f2d1e
patch 9.0.0930: cannot debug the Kitty keyboard protocol with TermDebug
Bram Moolenaar <Bram@vim.org>
parents:
31139
diff
changeset
|
4897 global |
dcde141f2d1e
patch 9.0.0930: cannot debug the Kitty keyboard protocol with TermDebug
Bram Moolenaar <Bram@vim.org>
parents:
31139
diff
changeset
|
4898 Specifies what keyboard protocol to use depending on the value of |
dcde141f2d1e
patch 9.0.0930: cannot debug the Kitty keyboard protocol with TermDebug
Bram Moolenaar <Bram@vim.org>
parents:
31139
diff
changeset
|
4899 'term'. The supported keyboard protocols names are: |
dcde141f2d1e
patch 9.0.0930: cannot debug the Kitty keyboard protocol with TermDebug
Bram Moolenaar <Bram@vim.org>
parents:
31139
diff
changeset
|
4900 none whatever the terminal uses |
dcde141f2d1e
patch 9.0.0930: cannot debug the Kitty keyboard protocol with TermDebug
Bram Moolenaar <Bram@vim.org>
parents:
31139
diff
changeset
|
4901 mok2 modifyOtherKeys level 2, as supported by xterm |
dcde141f2d1e
patch 9.0.0930: cannot debug the Kitty keyboard protocol with TermDebug
Bram Moolenaar <Bram@vim.org>
parents:
31139
diff
changeset
|
4902 kitty Kitty keyboard protocol, as supported by Kitty |
dcde141f2d1e
patch 9.0.0930: cannot debug the Kitty keyboard protocol with TermDebug
Bram Moolenaar <Bram@vim.org>
parents:
31139
diff
changeset
|
4903 |
31285
76acee969543
patch 9.0.0976: enabling the kitty keyboard protocol uses push/pop
Bram Moolenaar <Bram@vim.org>
parents:
31229
diff
changeset
|
4904 The option value is a list of comma separated items. Each item has |
31192
dcde141f2d1e
patch 9.0.0930: cannot debug the Kitty keyboard protocol with TermDebug
Bram Moolenaar <Bram@vim.org>
parents:
31139
diff
changeset
|
4905 a pattern that is matched against the 'term' option, a colon and the |
dcde141f2d1e
patch 9.0.0930: cannot debug the Kitty keyboard protocol with TermDebug
Bram Moolenaar <Bram@vim.org>
parents:
31139
diff
changeset
|
4906 protocol name to be used. To illustrate this, the default value would |
dcde141f2d1e
patch 9.0.0930: cannot debug the Kitty keyboard protocol with TermDebug
Bram Moolenaar <Bram@vim.org>
parents:
31139
diff
changeset
|
4907 be set with: > |
dcde141f2d1e
patch 9.0.0930: cannot debug the Kitty keyboard protocol with TermDebug
Bram Moolenaar <Bram@vim.org>
parents:
31139
diff
changeset
|
4908 set keyprotocol=kitty:kitty,foot:kitty,wezterm:kitty,xterm:mok2 |
dcde141f2d1e
patch 9.0.0930: cannot debug the Kitty keyboard protocol with TermDebug
Bram Moolenaar <Bram@vim.org>
parents:
31139
diff
changeset
|
4909 |
dcde141f2d1e
patch 9.0.0930: cannot debug the Kitty keyboard protocol with TermDebug
Bram Moolenaar <Bram@vim.org>
parents:
31139
diff
changeset
|
4910 < This means that when 'term' contains "kitty, "foot" or "wezterm" |
dcde141f2d1e
patch 9.0.0930: cannot debug the Kitty keyboard protocol with TermDebug
Bram Moolenaar <Bram@vim.org>
parents:
31139
diff
changeset
|
4911 somewhere then the "kitty" protocol is used. When 'term' contains |
dcde141f2d1e
patch 9.0.0930: cannot debug the Kitty keyboard protocol with TermDebug
Bram Moolenaar <Bram@vim.org>
parents:
31139
diff
changeset
|
4912 "xterm" somewhere, then the "mok2" protocol is used. |
dcde141f2d1e
patch 9.0.0930: cannot debug the Kitty keyboard protocol with TermDebug
Bram Moolenaar <Bram@vim.org>
parents:
31139
diff
changeset
|
4913 |
dcde141f2d1e
patch 9.0.0930: cannot debug the Kitty keyboard protocol with TermDebug
Bram Moolenaar <Bram@vim.org>
parents:
31139
diff
changeset
|
4914 The first match is used, thus if you want to have "kitty" use the |
dcde141f2d1e
patch 9.0.0930: cannot debug the Kitty keyboard protocol with TermDebug
Bram Moolenaar <Bram@vim.org>
parents:
31139
diff
changeset
|
4915 kitty protocol, but "badkitty" not, then you should match "badkitty" |
dcde141f2d1e
patch 9.0.0930: cannot debug the Kitty keyboard protocol with TermDebug
Bram Moolenaar <Bram@vim.org>
parents:
31139
diff
changeset
|
4916 first and use the "none" value: > |
dcde141f2d1e
patch 9.0.0930: cannot debug the Kitty keyboard protocol with TermDebug
Bram Moolenaar <Bram@vim.org>
parents:
31139
diff
changeset
|
4917 set keyprotocol=badkitty:none,kitty:kitty |
dcde141f2d1e
patch 9.0.0930: cannot debug the Kitty keyboard protocol with TermDebug
Bram Moolenaar <Bram@vim.org>
parents:
31139
diff
changeset
|
4918 < |
dcde141f2d1e
patch 9.0.0930: cannot debug the Kitty keyboard protocol with TermDebug
Bram Moolenaar <Bram@vim.org>
parents:
31139
diff
changeset
|
4919 The option is used after 'term' has been changed. First the termcap |
dcde141f2d1e
patch 9.0.0930: cannot debug the Kitty keyboard protocol with TermDebug
Bram Moolenaar <Bram@vim.org>
parents:
31139
diff
changeset
|
4920 entries are set, possibly using the builtin list, see |builtin-terms|. |
dcde141f2d1e
patch 9.0.0930: cannot debug the Kitty keyboard protocol with TermDebug
Bram Moolenaar <Bram@vim.org>
parents:
31139
diff
changeset
|
4921 Then this option is inspected and if there is a match and a protocol |
dcde141f2d1e
patch 9.0.0930: cannot debug the Kitty keyboard protocol with TermDebug
Bram Moolenaar <Bram@vim.org>
parents:
31139
diff
changeset
|
4922 is specified the following happens: |
dcde141f2d1e
patch 9.0.0930: cannot debug the Kitty keyboard protocol with TermDebug
Bram Moolenaar <Bram@vim.org>
parents:
31139
diff
changeset
|
4923 none Nothing, the regular t_TE and t_TI values remain |
dcde141f2d1e
patch 9.0.0930: cannot debug the Kitty keyboard protocol with TermDebug
Bram Moolenaar <Bram@vim.org>
parents:
31139
diff
changeset
|
4924 |
dcde141f2d1e
patch 9.0.0930: cannot debug the Kitty keyboard protocol with TermDebug
Bram Moolenaar <Bram@vim.org>
parents:
31139
diff
changeset
|
4925 mok2 The t_TE value is changed to: |
dcde141f2d1e
patch 9.0.0930: cannot debug the Kitty keyboard protocol with TermDebug
Bram Moolenaar <Bram@vim.org>
parents:
31139
diff
changeset
|
4926 CSI >4;m disables modifyOtherKeys |
dcde141f2d1e
patch 9.0.0930: cannot debug the Kitty keyboard protocol with TermDebug
Bram Moolenaar <Bram@vim.org>
parents:
31139
diff
changeset
|
4927 The t_TI value is changed to: |
dcde141f2d1e
patch 9.0.0930: cannot debug the Kitty keyboard protocol with TermDebug
Bram Moolenaar <Bram@vim.org>
parents:
31139
diff
changeset
|
4928 CSI >4;2m enables modifyOtherKeys |
31285
76acee969543
patch 9.0.0976: enabling the kitty keyboard protocol uses push/pop
Bram Moolenaar <Bram@vim.org>
parents:
31229
diff
changeset
|
4929 CSI ?4m request the modifyOtherKeys state |
31192
dcde141f2d1e
patch 9.0.0930: cannot debug the Kitty keyboard protocol with TermDebug
Bram Moolenaar <Bram@vim.org>
parents:
31139
diff
changeset
|
4930 |
dcde141f2d1e
patch 9.0.0930: cannot debug the Kitty keyboard protocol with TermDebug
Bram Moolenaar <Bram@vim.org>
parents:
31139
diff
changeset
|
4931 kitty The t_TE value is changed to: |
dcde141f2d1e
patch 9.0.0930: cannot debug the Kitty keyboard protocol with TermDebug
Bram Moolenaar <Bram@vim.org>
parents:
31139
diff
changeset
|
4932 CSI >4;m disables modifyOtherKeys |
31285
76acee969543
patch 9.0.0976: enabling the kitty keyboard protocol uses push/pop
Bram Moolenaar <Bram@vim.org>
parents:
31229
diff
changeset
|
4933 CSI =0;1u disables the kitty keyboard protocol |
31192
dcde141f2d1e
patch 9.0.0930: cannot debug the Kitty keyboard protocol with TermDebug
Bram Moolenaar <Bram@vim.org>
parents:
31139
diff
changeset
|
4934 The t_TI value is changed to: |
31285
76acee969543
patch 9.0.0976: enabling the kitty keyboard protocol uses push/pop
Bram Moolenaar <Bram@vim.org>
parents:
31229
diff
changeset
|
4935 CSI =1;1u enables the kitty keyboard protocol |
31192
dcde141f2d1e
patch 9.0.0930: cannot debug the Kitty keyboard protocol with TermDebug
Bram Moolenaar <Bram@vim.org>
parents:
31139
diff
changeset
|
4936 CSI ?u request kitty keyboard protocol state |
dcde141f2d1e
patch 9.0.0930: cannot debug the Kitty keyboard protocol with TermDebug
Bram Moolenaar <Bram@vim.org>
parents:
31139
diff
changeset
|
4937 CSI >c request the termresponse |
dcde141f2d1e
patch 9.0.0930: cannot debug the Kitty keyboard protocol with TermDebug
Bram Moolenaar <Bram@vim.org>
parents:
31139
diff
changeset
|
4938 |
dcde141f2d1e
patch 9.0.0930: cannot debug the Kitty keyboard protocol with TermDebug
Bram Moolenaar <Bram@vim.org>
parents:
31139
diff
changeset
|
4939 |
7 | 4940 *'keywordprg'* *'kp'* |
4941 '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
|
4942 VMS: "help") |
7 | 4943 global or local to buffer |global-local| |
4944 Program to use for the |K| command. Environment variables are | |
4945 expanded |:set_env|. ":help" may be used to access the Vim internal | |
4946 help. (Note that previously setting the global option to the empty | |
4947 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
|
4948 When the first character is ":", the command is invoked as a Vim |
29450 | 4949 Ex command with [count] added as an argument if it is not zero. |
9098
0d52ddff8db4
commit https://github.com/vim/vim/commit/2ff8b64679242e73248774a388d54931c9ce49bd
Christian Brabandt <cb@256bit.org>
parents:
9097
diff
changeset
|
4950 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
|
4951 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
|
4952 argument. For "man -s" the "-s" is removed when there is no count. |
7 | 4953 See |option-backslash| about including spaces and backslashes. |
4954 Example: > | |
4955 :set keywordprg=man\ -s | |
4956 < This option cannot be set from a |modeline| or in the |sandbox|, for | |
4957 security reasons. | |
4958 | |
4959 *'langmap'* *'lmap'* *E357* *E358* | |
4960 'langmap' 'lmap' string (default "") | |
4961 global | |
4962 {only available when compiled with the |+langmap| | |
4963 feature} | |
4964 This option allows switching your keyboard into a special language | |
10 | 4965 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
|
4966 inserted directly. When in Normal mode the 'langmap' option takes |
7 | 4967 care of translating these special characters to the original meaning |
4968 of the key. This means you don't have to change the keyboard mode to | |
4969 be able to execute Normal mode commands. | |
4970 This is the opposite of the 'keymap' option, where characters are | |
4971 mapped in Insert mode. | |
19646 | 4972 Also consider setting 'langremap' to off, to prevent 'langmap' from |
4973 applying to characters resulting from a mapping. | |
5908 | 4974 This option cannot be set from a |modeline| or in the |sandbox|, for |
4975 security reasons. | |
7 | 4976 |
699 | 4977 Example (for Greek, in UTF-8): *greek* > |
4978 :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 | 4979 < Example (exchanges meaning of z and y for commands): > |
4980 :set langmap=zy,yz,ZY,YZ | |
4981 < | |
4982 The 'langmap' option is a list of parts, separated with commas. Each | |
4983 part can be in one of two forms: | |
4984 1. A list of pairs. Each pair is a "from" character immediately | |
4985 followed by the "to" character. Examples: "aA", "aAbBcC". | |
4986 2. A list of "from" characters, a semi-colon and a list of "to" | |
4987 characters. Example: "abc;ABC" | |
4988 Example: "aA,fgh;FGH,cCdDeE" | |
4989 Special characters need to be preceded with a backslash. These are | |
22565 | 4990 ";", ',', '"', '|' and backslash itself. |
7 | 4991 |
4992 This will allow you to activate vim actions without having to switch | |
4993 back and forth between the languages. Your language characters will | |
4994 be understood as normal vim English characters (according to the | |
4995 langmap mappings) in the following cases: | |
4996 o Normal/Visual mode (commands, buffer/register names, user mappings) | |
4997 o Insert/Replace Mode: Register names after CTRL-R | |
4998 o Insert/Replace Mode: Mappings | |
4999 Characters entered in Command-line mode will NOT be affected by | |
5000 this option. Note that this option can be changed at any time | |
5001 allowing to switch between mappings for different languages/encodings. | |
5002 Use a mapping to avoid having to type it each time! | |
5003 | |
5004 *'langmenu'* *'lm'* | |
5005 'langmenu' 'lm' string (default "") | |
5006 global | |
5007 {only available when compiled with the |+menu| and | |
5008 |+multi_lang| features} | |
5009 Language to use for menu translation. Tells which file is loaded | |
5010 from the "lang" directory in 'runtimepath': > | |
27903 | 5011 "lang/menu_" .. &langmenu .. ".vim" |
7 | 5012 < (without the spaces). For example, to always use the Dutch menus, no |
5013 matter what $LANG is set to: > | |
5014 :set langmenu=nl_NL.ISO_8859-1 | |
5015 < When 'langmenu' is empty, |v:lang| is used. | |
36 | 5016 Only normal file name characters can be used, "/\*?[|<>" are illegal. |
7 | 5017 If your $LANG is set to a non-English language but you do want to use |
5018 the English menus: > | |
5019 :set langmenu=none | |
5020 < This option must be set before loading menus, switching on filetype | |
5021 detection or syntax highlighting. Once the menus are defined setting | |
5022 this option has no effect. But you could do this: > | |
5023 :source $VIMRUNTIME/delmenu.vim | |
5024 :set langmenu=de_DE.ISO_8859-1 | |
5025 :source $VIMRUNTIME/menu.vim | |
5026 < Warning: This deletes all menus that you defined yourself! | |
5027 | |
7196
42717d048817
commit https://github.com/vim/vim/commit/d94464ee294a351ce7b6ba18e8bd3f24f1bef920
Christian Brabandt <cb@256bit.org>
parents:
7147
diff
changeset
|
5028 *'langnoremap'* *'lnr'* *'nolangnoremap'* *'nolnr'* |
9669
284b4eb307fc
commit https://github.com/vim/vim/commit/8c08b5b569e2a9e9f63dea514591ecfa2d3bb392
Christian Brabandt <cb@256bit.org>
parents:
9665
diff
changeset
|
5029 'langnoremap' 'lnr' boolean (default off, set in |defaults.vim|) |
6339 | 5030 global |
5031 {only available when compiled with the |+langmap| | |
5032 feature} | |
9975
03fa8a51e9dc
commit https://github.com/vim/vim/commit/e4a3bcf28d92d0bde9ca227ccb40d401038185e5
Christian Brabandt <cb@256bit.org>
parents:
9913
diff
changeset
|
5033 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
|
5034 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
|
5035 '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
|
5036 |
03fa8a51e9dc
commit https://github.com/vim/vim/commit/e4a3bcf28d92d0bde9ca227ccb40d401038185e5
Christian Brabandt <cb@256bit.org>
parents:
9913
diff
changeset
|
5037 *'langremap'* *'lrm'* *'nolangremap'* *'nolrm'* |
19646 | 5038 '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
|
5039 global |
03fa8a51e9dc
commit https://github.com/vim/vim/commit/e4a3bcf28d92d0bde9ca227ccb40d401038185e5
Christian Brabandt <cb@256bit.org>
parents:
9913
diff
changeset
|
5040 {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
|
5041 feature} |
03fa8a51e9dc
commit https://github.com/vim/vim/commit/e4a3bcf28d92d0bde9ca227ccb40d401038185e5
Christian Brabandt <cb@256bit.org>
parents:
9913
diff
changeset
|
5042 When off, setting 'langmap' does not apply to characters resulting from |
6339 | 5043 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
|
5044 '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
|
5045 This option defaults to on for backwards compatibility. Set it off if |
6339 | 5046 that works for you to avoid mappings to break. |
5047 | |
7 | 5048 *'laststatus'* *'ls'* |
5049 'laststatus' 'ls' number (default 1) | |
5050 global | |
5051 The value of this option influences when the last window will have a | |
5052 status line: | |
5053 0: never | |
5054 1: only if there are at least two windows | |
5055 2: always | |
5056 The screen looks nicer with a status line if you have several | |
5057 windows, but it takes another screen line. |status-line| | |
5058 | |
5059 *'lazyredraw'* *'lz'* *'nolazyredraw'* *'nolz'* | |
5060 'lazyredraw' 'lz' boolean (default off) | |
5061 global | |
5062 When this option is set, the screen will not be redrawn while | |
5063 executing macros, registers and other commands that have not been | |
10 | 5064 typed. Also, updating the window title is postponed. To force an |
7 | 5065 update use |:redraw|. |
29274 | 5066 This may occasionally cause display errors. It is only meant to be set |
5067 temporarily when performing an operation where redrawing may cause | |
29269 | 5068 flickering or cause a slow down. |
7 | 5069 |
5070 *'linebreak'* *'lbr'* *'nolinebreak'* *'nolbr'* | |
5071 'linebreak' 'lbr' boolean (default off) | |
5072 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
|
5073 {not available when compiled without the |+linebreak| |
7 | 5074 feature} |
6009 | 5075 If on, Vim will wrap long lines at a character in 'breakat' rather |
7 | 5076 than at the last character that fits on the screen. Unlike |
5077 'wrapmargin' and 'textwidth', this does not insert <EOL>s in the file, | |
6009 | 5078 it only affects the way the file is displayed, not its contents. |
5079 If 'breakindent' is set, line is visually indented. Then, the value | |
5080 of 'showbreak' is used to put in front of wrapped lines. This option | |
6026 | 5081 is not used when the 'wrap' option is off. |
7 | 5082 Note that <Tab> characters after an <EOL> are mostly not displayed |
5083 with the right amount of white space. | |
5084 | |
5085 *'lines'* *E593* | |
5086 'lines' number (default 24 or terminal height) | |
5087 global | |
5088 Number of lines of the Vim window. | |
5089 Normally you don't need to set this. It is done automatically by the | |
161 | 5090 terminal initialization code. Also see |posix-screen-size|. |
7 | 5091 When Vim is running in the GUI or in a resizable window, setting this |
5092 option will cause the window size to be changed. When you only want | |
5093 to use the size for the GUI, put the command in your |gvimrc| file. | |
5094 Vim limits the number of lines to what fits on the screen. You can | |
5095 use this command to get the tallest window possible: > | |
5096 :set lines=999 | |
571 | 5097 < 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
|
5098 If you get fewer lines than expected, check the 'guiheadroom' option. |
7 | 5099 When you set this option and Vim is unable to change the physical |
5100 number of lines of the display, the display may be messed up. | |
5101 | |
5102 *'linespace'* *'lsp'* | |
5103 'linespace' 'lsp' number (default 0, 1 for Win32 GUI) | |
5104 global | |
5105 {only in the GUI} | |
5106 Number of pixel lines inserted between characters. Useful if the font | |
5107 uses the full character cell height, making lines touch each other. | |
5108 When non-zero there is room for underlining. | |
180 | 5109 With some fonts there can be too much room between lines (to have |
5110 space for ascents and descents). Then it makes sense to set | |
5111 'linespace' to a negative value. This may cause display problems | |
5112 though! | |
7 | 5113 |
5114 *'lisp'* *'nolisp'* | |
5115 'lisp' boolean (default off) | |
5116 local to buffer | |
5117 Lisp mode: When <Enter> is typed in insert mode set the indent for | |
5118 the next line to Lisp standards (well, sort of). Also happens with | |
5119 "cc" or "S". 'autoindent' must also be on for this to work. The 'p' | |
5120 flag in 'cpoptions' changes the method of indenting: Vi compatible or | |
5121 better. Also see 'lispwords'. | |
5122 The '-' character is included in keyword characters. Redefines the | |
5123 "=" operator to use this same indentation algorithm rather than | |
5124 calling an external program if 'equalprg' is empty. | |
5125 This option is not used when 'paste' is set. | |
5126 | |
30853
40df8a6515f6
patch 9.0.0761: cannot use 'indentexpr' for Lisp indenting
Bram Moolenaar <Bram@vim.org>
parents:
30825
diff
changeset
|
5127 *'lispoptions'* *'lop'* |
40df8a6515f6
patch 9.0.0761: cannot use 'indentexpr' for Lisp indenting
Bram Moolenaar <Bram@vim.org>
parents:
30825
diff
changeset
|
5128 'lispoptions' 'lop' string (default "") |
40df8a6515f6
patch 9.0.0761: cannot use 'indentexpr' for Lisp indenting
Bram Moolenaar <Bram@vim.org>
parents:
30825
diff
changeset
|
5129 local to buffer |
40df8a6515f6
patch 9.0.0761: cannot use 'indentexpr' for Lisp indenting
Bram Moolenaar <Bram@vim.org>
parents:
30825
diff
changeset
|
5130 Comma-separated list of items that influence the Lisp indenting when |
40df8a6515f6
patch 9.0.0761: cannot use 'indentexpr' for Lisp indenting
Bram Moolenaar <Bram@vim.org>
parents:
30825
diff
changeset
|
5131 enabled with the |'lisp'| option. Currently only one item is |
40df8a6515f6
patch 9.0.0761: cannot use 'indentexpr' for Lisp indenting
Bram Moolenaar <Bram@vim.org>
parents:
30825
diff
changeset
|
5132 supported: |
40df8a6515f6
patch 9.0.0761: cannot use 'indentexpr' for Lisp indenting
Bram Moolenaar <Bram@vim.org>
parents:
30825
diff
changeset
|
5133 expr:1 use 'indentexpr' for Lisp indenting when it is set |
40df8a6515f6
patch 9.0.0761: cannot use 'indentexpr' for Lisp indenting
Bram Moolenaar <Bram@vim.org>
parents:
30825
diff
changeset
|
5134 expr:0 do not use 'indentexpr' for Lisp indenting (default) |
40df8a6515f6
patch 9.0.0761: cannot use 'indentexpr' for Lisp indenting
Bram Moolenaar <Bram@vim.org>
parents:
30825
diff
changeset
|
5135 Note that when using 'indentexpr' the `=` operator indents all the |
40df8a6515f6
patch 9.0.0761: cannot use 'indentexpr' for Lisp indenting
Bram Moolenaar <Bram@vim.org>
parents:
30825
diff
changeset
|
5136 lines, otherwise the first line is not indented (Vi-compatible). |
40df8a6515f6
patch 9.0.0761: cannot use 'indentexpr' for Lisp indenting
Bram Moolenaar <Bram@vim.org>
parents:
30825
diff
changeset
|
5137 |
7 | 5138 *'lispwords'* *'lw'* |
5139 'lispwords' 'lw' string (default is very long) | |
5712 | 5140 global or local to buffer |global-local| |
29659 | 5141 Comma-separated list of words that influence the Lisp indenting when |
5142 enabled with the |'lisp'| option. | |
7 | 5143 |
5144 *'list'* *'nolist'* | |
5145 'list' boolean (default off) | |
5146 local to window | |
26100 | 5147 List mode: By default show tabs as CTRL-I is displayed, display $ |
5148 after end of line. Useful to see the difference between tabs and | |
5149 spaces and for trailing blanks. Further changed by the 'listchars' | |
5150 option. | |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
5151 |
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
5152 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
|
5153 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
|
5154 position while displaying Tabs with spaces, use: > |
5161
f7add3891e95
Updated runtime files. Fix NL translations.
Bram Moolenaar <bram@vim.org>
parents:
5146
diff
changeset
|
5155 :set list lcs=tab:\ \ |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
5156 < |
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
5157 Note that list mode will also affect formatting (set with 'textwidth' |
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
5158 or 'wrapmargin') when 'cpoptions' includes 'L'. See 'listchars' for |
7 | 5159 changing the way tabs are displayed. |
5160 | |
5161 *'listchars'* *'lcs'* | |
5162 '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
|
5163 global or local to window |global-local| |
2458 | 5164 Strings to use in 'list' mode and for the |:list| command. It is a |
28379 | 5165 comma-separated list of string settings. |
6777 | 5166 *lcs-eol* |
7 | 5167 eol:c Character to show at the end of each line. When |
5168 omitted, there is no extra character at the end of the | |
5169 line. | |
6777 | 5170 *lcs-tab* |
15502
bc17a9d37810
patch 8.1.0759: showing two characters for tab is limited
Bram Moolenaar <Bram@vim.org>
parents:
15396
diff
changeset
|
5171 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
|
5172 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
|
5173 |
bc17a9d37810
patch 8.1.0759: showing two characters for tab is limited
Bram Moolenaar <Bram@vim.org>
parents:
15396
diff
changeset
|
5174 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
|
5175 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
|
5176 > |
bc17a9d37810
patch 8.1.0759: showing two characters for tab is limited
Bram Moolenaar <Bram@vim.org>
parents:
15396
diff
changeset
|
5177 >- |
bc17a9d37810
patch 8.1.0759: showing two characters for tab is limited
Bram Moolenaar <Bram@vim.org>
parents:
15396
diff
changeset
|
5178 >-- |
bc17a9d37810
patch 8.1.0759: showing two characters for tab is limited
Bram Moolenaar <Bram@vim.org>
parents:
15396
diff
changeset
|
5179 etc. |
bc17a9d37810
patch 8.1.0759: showing two characters for tab is limited
Bram Moolenaar <Bram@vim.org>
parents:
15396
diff
changeset
|
5180 |
bc17a9d37810
patch 8.1.0759: showing two characters for tab is limited
Bram Moolenaar <Bram@vim.org>
parents:
15396
diff
changeset
|
5181 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
|
5182 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
|
5183 "tab:<->" displays: |
bc17a9d37810
patch 8.1.0759: showing two characters for tab is limited
Bram Moolenaar <Bram@vim.org>
parents:
15396
diff
changeset
|
5184 > |
bc17a9d37810
patch 8.1.0759: showing two characters for tab is limited
Bram Moolenaar <Bram@vim.org>
parents:
15396
diff
changeset
|
5185 <> |
bc17a9d37810
patch 8.1.0759: showing two characters for tab is limited
Bram Moolenaar <Bram@vim.org>
parents:
15396
diff
changeset
|
5186 <-> |
bc17a9d37810
patch 8.1.0759: showing two characters for tab is limited
Bram Moolenaar <Bram@vim.org>
parents:
15396
diff
changeset
|
5187 <--> |
bc17a9d37810
patch 8.1.0759: showing two characters for tab is limited
Bram Moolenaar <Bram@vim.org>
parents:
15396
diff
changeset
|
5188 etc. |
bc17a9d37810
patch 8.1.0759: showing two characters for tab is limited
Bram Moolenaar <Bram@vim.org>
parents:
15396
diff
changeset
|
5189 |
bc17a9d37810
patch 8.1.0759: showing two characters for tab is limited
Bram Moolenaar <Bram@vim.org>
parents:
15396
diff
changeset
|
5190 When "tab:" is omitted, a tab is shown as ^I. |
6777 | 5191 *lcs-space* |
5192 space:c Character to show for a space. When omitted, spaces | |
5193 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
|
5194 *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
|
5195 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
|
5196 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
|
5197 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
|
5198 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
|
5199 "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
|
5200 `: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
|
5201 spaces as: |
29090
9b292596a332
patch 8.2.5066: timer_create is not available on every Mac system
Bram Moolenaar <Bram@vim.org>
parents:
29066
diff
changeset
|
5202 ---+---+-- ~ |
23825
0bd44e94dd14
patch 8.2.2454: leading space can not be made visible
Bram Moolenaar <Bram@vim.org>
parents:
23666
diff
changeset
|
5203 *lcs-lead* |
0bd44e94dd14
patch 8.2.2454: leading space can not be made visible
Bram Moolenaar <Bram@vim.org>
parents:
23666
diff
changeset
|
5204 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
|
5205 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
|
5206 "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
|
5207 combine it with "tab:", for example: > |
23931 | 5208 :set listchars+=tab:>-,lead:. |
29090
9b292596a332
patch 8.2.5066: timer_create is not available on every Mac system
Bram Moolenaar <Bram@vim.org>
parents:
29066
diff
changeset
|
5209 < *lcs-leadmultispace* |
9b292596a332
patch 8.2.5066: timer_create is not available on every Mac system
Bram Moolenaar <Bram@vim.org>
parents:
29066
diff
changeset
|
5210 leadmultispace:c... |
29307 | 5211 Like the |lcs-multispace| value, but for leading |
5212 spaces only. Also overrides |lcs-lead| for leading | |
5213 multiple spaces. | |
29290 | 5214 `:set listchars=leadmultispace:---+` shows ten |
5215 consecutive leading spaces as: | |
29090
9b292596a332
patch 8.2.5066: timer_create is not available on every Mac system
Bram Moolenaar <Bram@vim.org>
parents:
29066
diff
changeset
|
5216 ---+---+--XXX ~ |
9b292596a332
patch 8.2.5066: timer_create is not available on every Mac system
Bram Moolenaar <Bram@vim.org>
parents:
29066
diff
changeset
|
5217 Where "XXX" denotes the first non-blank characters in |
9b292596a332
patch 8.2.5066: timer_create is not available on every Mac system
Bram Moolenaar <Bram@vim.org>
parents:
29066
diff
changeset
|
5218 the line. |
9b292596a332
patch 8.2.5066: timer_create is not available on every Mac system
Bram Moolenaar <Bram@vim.org>
parents:
29066
diff
changeset
|
5219 *lcs-trail* |
10 | 5220 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
|
5221 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
|
5222 "multispace" settings for trailing spaces. |
6777 | 5223 *lcs-extends* |
7 | 5224 extends:c Character to show in the last column, when 'wrap' is |
5225 off and the line continues beyond the right of the | |
5226 screen. | |
6777 | 5227 *lcs-precedes* |
18131
851a014dfd8b
patch 8.1.2060: "precedes" in 'listchars' not used properly
Bram Moolenaar <Bram@vim.org>
parents:
18130
diff
changeset
|
5228 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
|
5229 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
|
5230 character visible in the first column. |
6777 | 5231 *lcs-conceal* |
2250
1bac28a53fae
Add the conceal patch from Vince Negri.
Bram Moolenaar <bram@vim.org>
parents:
2249
diff
changeset
|
5232 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
|
5233 'conceallevel' is set to 1. |
6777 | 5234 *lcs-nbsp* |
6801 | 5235 nbsp:c Character to show for a non-breakable space character |
5236 (0xA0 (160 decimal) and U+202F). Left blank when | |
5237 omitted. | |
7 | 5238 |
10 | 5239 The characters ':' and ',' should not be used. UTF-8 characters can |
7 | 5240 be used when 'encoding' is "utf-8", otherwise only printable |
819 | 5241 characters are allowed. All characters must be single width. |
7 | 5242 |
25978
40b17deb294f
patch 8.2.3522: cannot use x and u when setting 'listchars'
Bram Moolenaar <Bram@vim.org>
parents:
25974
diff
changeset
|
5243 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
|
5244 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
|
5245 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
|
5246 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
|
5247 < 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
|
5248 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
|
5249 |
7 | 5250 Examples: > |
5251 :set lcs=tab:>-,trail:- | |
12 | 5252 :set lcs=tab:>-,eol:<,nbsp:% |
7 | 5253 :set lcs=extends:>,precedes:< |
5254 < The "NonText" highlighting will be used for "eol", "extends" and | |
25836 | 5255 "precedes". "SpecialKey" will be used for "tab", "nbsp", "space", |
5256 "multispace", "lead" and "trail". | |
1152 | 5257 |hl-NonText| |hl-SpecialKey| |
7 | 5258 |
5259 *'lpl'* *'nolpl'* *'loadplugins'* *'noloadplugins'* | |
5260 'loadplugins' 'lpl' boolean (default on) | |
5261 global | |
5262 When on the plugin scripts are loaded when starting up |load-plugins|. | |
5263 This option can be reset in your |vimrc| file to disable the loading | |
5264 of plugins. | |
11666
5cd9ba96561d
patch 8.0.0716: not easy to start Vim cleanly
Christian Brabandt <cb@256bit.org>
parents:
11659
diff
changeset
|
5265 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
|
5266 line arguments reset this option. See |-u| and |--noplugin|. |
7 | 5267 |
7196
42717d048817
commit https://github.com/vim/vim/commit/d94464ee294a351ce7b6ba18e8bd3f24f1bef920
Christian Brabandt <cb@256bit.org>
parents:
7147
diff
changeset
|
5268 *'luadll'* |
8629
54ac275e3fc4
commit https://github.com/vim/vim/commit/3848e00e0177abdb31bc600234967863ec487233
Christian Brabandt <cb@256bit.org>
parents:
8560
diff
changeset
|
5269 '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
|
5270 global |
7196
42717d048817
commit https://github.com/vim/vim/commit/d94464ee294a351ce7b6ba18e8bd3f24f1bef920
Christian Brabandt <cb@256bit.org>
parents:
7147
diff
changeset
|
5271 {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
|
5272 feature} |
7528
53163e4d9e4f
commit https://github.com/vim/vim/commit/25e4fcde767084d1a79e0926bc301c92987c0cce
Christian Brabandt <cb@256bit.org>
parents:
7477
diff
changeset
|
5273 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
|
5274 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
|
5275 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
|
5276 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
|
5277 security reasons. |
42717d048817
commit https://github.com/vim/vim/commit/d94464ee294a351ce7b6ba18e8bd3f24f1bef920
Christian Brabandt <cb@256bit.org>
parents:
7147
diff
changeset
|
5278 |
842 | 5279 *'macatsui'* *'nomacatsui'* |
5280 'macatsui' boolean (default on) | |
5281 global | |
21825 | 5282 {not supported} |
5283 No longer supported, as the Mac OS X GUI code was removed. | |
1152 | 5284 |
7 | 5285 *'magic'* *'nomagic'* |
5286 'magic' boolean (default on) | |
5287 global | |
5288 Changes the special characters that can be used in search patterns. | |
5289 See |pattern|. | |
10140
b11ceef7116e
commit https://github.com/vim/vim/commit/64d8e25bf6efe5f18b032563521c3ce278c316ab
Christian Brabandt <cb@256bit.org>
parents:
10027
diff
changeset
|
5290 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
|
5291 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
|
5292 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
|
5293 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
|
5294 when you want to |/\M|. |
23305 | 5295 In |Vim9| script the value of 'magic' is ignored, patterns behave like |
5296 it is always set. | |
7 | 5297 |
5298 *'makeef'* *'mef'* | |
5299 'makeef' 'mef' string (default: "") | |
5300 global | |
5301 {not available when compiled without the |+quickfix| | |
5302 feature} | |
5303 Name of the errorfile for the |:make| command (see |:make_makeprg|) | |
5304 and the |:grep| command. | |
5305 When it is empty, an internally generated temp file will be used. | |
5306 When "##" is included, it is replaced by a number to make the name | |
5307 unique. This makes sure that the ":make" command doesn't overwrite an | |
5308 existing file. | |
5309 NOT used for the ":cf" command. See 'errorfile' for that. | |
5310 Environment variables are expanded |:set_env|. | |
5311 See |option-backslash| about including spaces and backslashes. | |
5312 This option cannot be set from a |modeline| or in the |sandbox|, for | |
5313 security reasons. | |
5314 | |
11063
e71d3bdf3bc3
patch 8.0.0420: text garbled when the system encoding differs from 'encoding'
Christian Brabandt <cb@256bit.org>
parents:
11062
diff
changeset
|
5315 *'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
|
5316 '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
|
5317 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
|
5318 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
|
5319 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
|
5320 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
|
5321 `: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
|
5322 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
|
5323 |
e71d3bdf3bc3
patch 8.0.0420: text garbled when the system encoding differs from 'encoding'
Christian Brabandt <cb@256bit.org>
parents:
11062
diff
changeset
|
5324 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
|
5325 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
|
5326 '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
|
5327 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
|
5328 :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
|
5329 :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
|
5330 < |
7 | 5331 *'makeprg'* *'mp'* |
5332 'makeprg' 'mp' string (default "make", VMS: "MMS") | |
5333 global or local to buffer |global-local| | |
1152 | 5334 Program to use for the ":make" command. See |:make_makeprg|. |
13341
acd7eaa13d2b
Updated runtime files.
Christian Brabandt <cb@256bit.org>
parents:
13314
diff
changeset
|
5335 This option may contain '%' and '#' characters (see |:_%| and |:_#|), |
acd7eaa13d2b
Updated runtime files.
Christian Brabandt <cb@256bit.org>
parents:
13314
diff
changeset
|
5336 which are expanded to the current and alternate file name. Use |::S| |
5690 | 5337 to escape file names in case they contain special characters. |
1152 | 5338 Environment variables are expanded |:set_env|. See |option-backslash| |
5339 about including spaces and backslashes. | |
5340 Note that a '|' must be escaped twice: once for ":set" and once for | |
5341 the interpretation of a command. When you use a filter called | |
5342 "myfilter" do it like this: > | |
7 | 5343 :set makeprg=gmake\ \\\|\ myfilter |
5344 < The placeholder "$*" can be given (even multiple times) to specify | |
5345 where the arguments will be included, for example: > | |
5346 :set makeprg=latex\ \\\\nonstopmode\ \\\\input\\{$*} | |
5347 < This option cannot be set from a |modeline| or in the |sandbox|, for | |
5348 security reasons. | |
5349 | |
5350 *'matchpairs'* *'mps'* | |
5351 'matchpairs' 'mps' string (default "(:),{:},[:]") | |
5352 local to buffer | |
5353 Characters that form pairs. The |%| command jumps from one to the | |
4073 | 5354 other. |
5355 Only character pairs are allowed that are different, thus you cannot | |
5356 jump between two double quotes. | |
5357 The characters must be separated by a colon. | |
1152 | 5358 The pairs must be separated by a comma. Example for including '<' and |
24387 | 5359 '>' (for HTML): > |
7 | 5360 :set mps+=<:> |
5361 | |
5362 < A more exotic example, to jump between the '=' and ';' in an | |
5363 assignment, useful for languages like C and Java: > | |
5364 :au FileType c,cpp,java set mps+==:; | |
5365 | |
5366 < 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
|
5367 the $VIMRUNTIME/pack/dist/opt/matchit directory. |add-local-help| |
7 | 5368 |
5369 *'matchtime'* *'mat'* | |
5370 'matchtime' 'mat' number (default 5) | |
5371 global | |
5372 Tenths of a second to show the matching paren, when 'showmatch' is | |
5373 set. Note that this is not in milliseconds, like other options that | |
5374 set a time. This is to be compatible with Nvi. | |
5375 | |
714 | 5376 *'maxcombine'* *'mco'* |
5377 'maxcombine' 'mco' number (default 2) | |
5378 global | |
5379 The maximum number of combining characters supported for displaying. | |
5380 Only used when 'encoding' is "utf-8". | |
5381 The default is OK for most languages. Hebrew may require 4. | |
5382 Maximum value is 6. | |
5383 Even when this option is set to 2 you can still edit text with more | |
5384 combining characters, you just can't see them. Use |g8| or |ga|. | |
5385 See |mbyte-combining|. | |
5386 | |
7 | 5387 *'maxfuncdepth'* *'mfd'* |
5388 'maxfuncdepth' 'mfd' number (default 100) | |
5389 global | |
2570
71b56b4e7785
Make the references to features in the help more consistent. (Sylvain Hitier)
Bram Moolenaar <bram@vim.org>
parents:
2561
diff
changeset
|
5390 {not available when compiled without the |+eval| |
1152 | 5391 feature} |
7 | 5392 Maximum depth of function calls for user functions. This normally |
5393 catches endless recursion. When using a recursive function with | |
5394 more depth, set 'maxfuncdepth' to a bigger number. But this will use | |
5395 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
|
5396 Increasing this limit above 200 also changes the maximum for Ex |
14006 | 5397 command recursion, see |E169|. |
7 | 5398 See also |:function|. |
5399 | |
5400 *'maxmapdepth'* *'mmd'* *E223* | |
5401 'maxmapdepth' 'mmd' number (default 1000) | |
5402 global | |
5403 Maximum number of times a mapping is done without resulting in a | |
5404 character to be used. This normally catches endless mappings, like | |
5405 ":map x y" with ":map y x". It still does not catch ":map g wg", | |
5406 because the 'w' is used before the next mapping is done. See also | |
5407 |key-mapping|. | |
5408 | |
5409 *'maxmem'* *'mm'* | |
5410 'maxmem' 'mm' number (default between 256 to 5120 (system | |
5411 dependent) or half the amount of memory | |
5412 available) | |
5413 global | |
5414 Maximum amount of memory (in Kbyte) to use for one buffer. When this | |
5415 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
|
5416 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
|
5417 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
|
5418 limit. |
65c3e8259124
patch 8.0.1531: cannot use 24 bit colors in MS-Windows console
Christian Brabandt <cb@256bit.org>
parents:
13234
diff
changeset
|
5419 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
|
5420 Also see 'maxmemtot'. |
7 | 5421 |
189 | 5422 *'maxmempattern'* *'mmp'* |
5423 'maxmempattern' 'mmp' number (default 1000) | |
5424 global | |
5425 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
|
5426 The maximum value is about 2000000. Use this to work without a limit. |
189 | 5427 *E363* |
1152 | 5428 When Vim runs into the limit it gives an error message and mostly |
5429 behaves like CTRL-C was typed. | |
189 | 5430 Running into the limit often means that the pattern is very |
5431 inefficient or too complex. This may already happen with the pattern | |
5432 "\(.\)*" 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
|
5433 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
|
5434 text structure. |
4a588e3afd4a
Update runtime files, add Danish translations.
Christian Brabandt <cb@256bit.org>
parents:
14249
diff
changeset
|
5435 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
|
5436 which case you get an "Out of memory" error instead. |
189 | 5437 |
7 | 5438 *'maxmemtot'* *'mmt'* |
5439 'maxmemtot' 'mmt' number (default between 2048 and 10240 (system | |
5440 dependent) or half the amount of memory | |
5441 available) | |
5442 global | |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
5443 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
|
5444 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
|
5445 without a limit. |
05cf4cc72a9f
commit https://github.com/vim/vim/commit/fa7353428f705f7a13465a1943dddeede4083023
Christian Brabandt <cb@256bit.org>
parents:
7272
diff
changeset
|
5446 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
|
5447 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
|
5448 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
|
5449 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
|
5450 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
|
5451 used. |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
5452 Also see 'maxmem'. |
7 | 5453 |
5454 *'menuitems'* *'mis'* | |
5455 'menuitems' 'mis' number (default 25) | |
5456 global | |
5457 {not available when compiled without the |+menu| | |
5458 feature} | |
5459 Maximum number of items to use in a menu. Used for menus that are | |
5460 generated from a list of items, e.g., the Buffers menu. Changing this | |
5461 option has no direct effect, the menu must be refreshed first. | |
5462 | |
484 | 5463 *'mkspellmem'* *'msm'* |
5464 'mkspellmem' 'msm' string (default "460000,2000,500") | |
5465 global | |
5466 {not available when compiled without the |+syntax| | |
5467 feature} | |
5468 Parameters for |:mkspell|. This tunes when to start compressing the | |
5469 word tree. Compression can be slow when there are many words, but | |
5470 it's needed to avoid running out of memory. The amount of memory used | |
5471 per word depends very much on how similar the words are, that's why | |
5472 this tuning is complicated. | |
5473 | |
5474 There are three numbers, separated by commas: | |
5475 {start},{inc},{added} | |
5476 | |
5477 For most languages the uncompressed word tree fits in memory. {start} | |
5478 gives the amount of memory in Kbyte that can be used before any | |
5479 compression is done. It should be a bit smaller than the amount of | |
5480 memory that is available to Vim. | |
5481 | |
5482 When going over the {start} limit the {inc} number specifies the | |
5483 amount of memory in Kbyte that can be allocated before another | |
5484 compression is done. A low number means compression is done after | |
5485 less words are added, which is slow. A high number means more memory | |
5486 will be allocated. | |
5487 | |
5488 After doing compression, {added} times 1024 words can be added before | |
5489 the {inc} limit is ignored and compression is done when any extra | |
5490 amount of memory is needed. A low number means there is a smaller | |
5491 chance of hitting the {inc} limit, less memory is used but it's | |
5492 slower. | |
5493 | |
5494 The languages for which these numbers are important are Italian and | |
5495 Hungarian. The default works for when you have about 512 Mbyte. If | |
5496 you have 1 Gbyte you could use: > | |
5497 :set mkspellmem=900000,3000,800 | |
5498 < If you have less than 512 Mbyte |:mkspell| may fail for some | |
5499 languages, no matter what you set 'mkspellmem' to. | |
5500 | |
16798
63ac51f16ea1
patch 8.1.1401: misspelled mkspellmem as makespellmem
Bram Moolenaar <Bram@vim.org>
parents:
16778
diff
changeset
|
5501 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
|
5502 |
7 | 5503 *'modeline'* *'ml'* *'nomodeline'* *'noml'* |
1111 | 5504 'modeline' 'ml' boolean (Vim default: on (off for root), |
5505 Vi default: off) | |
7 | 5506 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
|
5507 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
|
5508 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
|
5509 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
|
5510 |
e55c26aaf484
patch 8.1.1366: using expressions in a modeline is unsafe
Bram Moolenaar <Bram@vim.org>
parents:
16610
diff
changeset
|
5511 *'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
|
5512 '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
|
5513 global |
e55c26aaf484
patch 8.1.1366: using expressions in a modeline is unsafe
Bram Moolenaar <Bram@vim.org>
parents:
16610
diff
changeset
|
5514 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
|
5515 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
|
5516 '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
|
5517 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
|
5518 security reasons. |
16728
e55c26aaf484
patch 8.1.1366: using expressions in a modeline is unsafe
Bram Moolenaar <Bram@vim.org>
parents:
16610
diff
changeset
|
5519 |
7 | 5520 *'modelines'* *'mls'* |
5521 'modelines' 'mls' number (default 5) | |
5522 global | |
5523 If 'modeline' is on 'modelines' gives the number of lines that is | |
5524 checked for set commands. If 'modeline' is off or 'modelines' is zero | |
5525 no lines are checked. See |modeline|. | |
5526 NOTE: 'modeline' is set to the Vi default value when 'compatible' is | |
5527 set and to the Vim default value when 'compatible' is reset. | |
5528 | |
5529 *'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
|
5530 *E21* |
7 | 5531 'modifiable' 'ma' boolean (default on) |
5532 local to buffer | |
5533 When off the buffer contents cannot be changed. The 'fileformat' and | |
5534 'fileencoding' options also can't be changed. | |
10617 | 5535 Can be reset on startup with the |-M| command line argument. |
7 | 5536 |
5537 *'modified'* *'mod'* *'nomodified'* *'nomod'* | |
5538 'modified' 'mod' boolean (default off) | |
5539 local to buffer | |
5540 When on, the buffer is considered to be modified. This option is set | |
5541 when: | |
5542 1. A change was made to the text since it was last written. Using the | |
5543 |undo| command to go back to the original text will reset the | |
5544 option. But undoing changes that were made before writing the | |
5545 buffer will set the option again, since the text is different from | |
5546 when it was written. | |
5547 2. 'fileformat' or 'fileencoding' is different from its original | |
5548 value. The original value is set when the buffer is read or | |
5549 written. A ":set nomodified" command also resets the original | |
5550 values to the current values and the 'modified' option will be | |
5551 reset. | |
8748
b1a19a2f73f0
commit https://github.com/vim/vim/commit/4f3f668c8486444e53163c29d2fc79bf47eb3c82
Christian Brabandt <cb@256bit.org>
parents:
8629
diff
changeset
|
5552 Similarly for 'eol' and 'bomb'. |
3082 | 5553 This option is not set when a change is made to the buffer as the |
5554 result of a BufNewFile, BufRead/BufReadPost, BufWritePost, | |
5555 FileAppendPost or VimLeave autocommand event. See |gzip-example| for | |
5556 an explanation. | |
7 | 5557 When 'buftype' is "nowrite" or "nofile" this option may be set, but |
5558 will be ignored. | |
13437 | 5559 Note that the text may actually be the same, e.g. 'modified' is set |
5560 when using "rA" on an "A". | |
7 | 5561 |
5562 *'more'* *'nomore'* | |
5563 'more' boolean (Vim default: on, Vi default: off) | |
5564 global | |
5565 When on, listings pause when the whole screen is filled. You will get | |
5566 the |more-prompt|. When this option is off there are no pauses, the | |
5567 listing continues until finished. | |
5568 NOTE: This option is set to the Vi default value when 'compatible' is | |
5569 set and to the Vim default value when 'compatible' is reset. | |
5570 | |
23666 | 5571 *'mouse'* |
18972 | 5572 '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
|
5573 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
|
5574 global |
18972 | 5575 Enable the use of the mouse. Works for most terminals (xterm, Win32 |
5576 |win32-mouse|, QNX pterm, *BSD console with sysmouse and Linux console | |
5577 with gpm). For using the mouse in the GUI, see |gui-mouse|. The | |
5578 mouse can be enabled for different modes: | |
12826 | 5579 n Normal mode and Terminal modes |
7 | 5580 v Visual mode |
5581 i Insert mode | |
5582 c Command-line mode | |
5583 h all previous modes when editing a help file | |
5584 a all previous modes | |
5585 r for |hit-enter| and |more-prompt| prompt | |
14864 | 5586 Normally you would enable the mouse in all five modes with: > |
7 | 5587 :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
|
5588 < 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
|
5589 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
|
5590 :set mouse=nvi |
20856 | 5591 < 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
|
5592 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
|
5593 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
|
5594 "xterm". |
d7619a9874cd
patch 8.1.2226: cannot use system copy/paste in non-xterm terminals
Bram Moolenaar <Bram@vim.org>
parents:
18463
diff
changeset
|
5595 |
d7619a9874cd
patch 8.1.2226: cannot use system copy/paste in non-xterm terminals
Bram Moolenaar <Bram@vim.org>
parents:
18463
diff
changeset
|
5596 When the mouse is not enabled, the GUI will still use the mouse for |
7 | 5597 modeless selection. This doesn't move the text cursor. |
5598 | |
5599 See |mouse-using|. Also see |'clipboard'|. | |
5600 | |
5601 Note: When enabling the mouse in a terminal, copy/paste will use the | |
10 | 5602 "* register if there is access to an X-server. The xterm handling of |
7 | 5603 the mouse buttons can still be used by keeping the shift key pressed. |
5604 Also see the 'clipboard' option. | |
5605 | |
5606 *'mousefocus'* *'mousef'* *'nomousefocus'* *'nomousef'* | |
5607 'mousefocus' 'mousef' boolean (default off) | |
5608 global | |
5609 {only works in the GUI} | |
5610 The window that the mouse pointer is on is automatically activated. | |
5611 When changing the window layout or window focus in another way, the | |
5612 mouse pointer is moved to the window with keyboard focus. Off is the | |
5613 default because it makes using the pull down menus a little goofy, as | |
5614 a pointer transit may activate a window unintentionally. | |
18594 | 5615 MS-Windows: Also see 'scrollfocus' for what window is scrolled when |
19180 | 5616 using the mouse scroll wheel. |
7 | 5617 |
5618 *'mousehide'* *'mh'* *'nomousehide'* *'nomh'* | |
5619 'mousehide' 'mh' boolean (default on) | |
5620 global | |
5621 {only works in the GUI} | |
5622 When on, the mouse pointer is hidden when characters are typed. | |
5623 The mouse pointer is restored when the mouse is moved. | |
5624 | |
5625 *'mousemodel'* *'mousem'* | |
18972 | 5626 'mousemodel' 'mousem' string (default "extend", "popup" for Win32) |
7 | 5627 global |
5628 Sets the model to use for the mouse. The name mostly specifies what | |
5629 the right mouse button is used for: | |
5630 extend Right mouse button extends a selection. This works | |
5631 like in an xterm. | |
5632 popup Right mouse button pops up a menu. The shifted left | |
5633 mouse button extends a selection. This works like | |
233 | 5634 with Microsoft Windows. |
7 | 5635 popup_setpos Like "popup", but the cursor will be moved to the |
5636 position where the mouse was clicked, and thus the | |
5637 selected operation will act upon the clicked object. | |
5638 If clicking inside a selection, that selection will | |
233 | 5639 be acted upon, i.e. no cursor move. This implies of |
7 | 5640 course, that right clicking outside a selection will |
5641 end Visual mode. | |
5642 Overview of what button does what for each model: | |
5643 mouse extend popup(_setpos) ~ | |
5644 left click place cursor place cursor | |
5645 left drag start selection start selection | |
5646 shift-left search word extend selection | |
5647 right click extend selection popup menu (place cursor) | |
5648 right drag extend selection - | |
5649 middle click paste paste | |
5650 | |
5651 In the "popup" model the right mouse button produces a pop-up menu. | |
5652 You need to define this first, see |popup-menu|. | |
5653 | |
5654 Note that you can further refine the meaning of buttons with mappings. | |
5655 See |gui-mouse-mapping|. But mappings are NOT used for modeless | |
5656 selection (because that's handled in the GUI code directly). | |
5657 | |
5658 The 'mousemodel' option is set by the |:behave| command. | |
5659 | |
28297
4190b932e6ca
patch 8.2.4674: cannot force getting MouseMove events
Bram Moolenaar <Bram@vim.org>
parents:
28246
diff
changeset
|
5660 *'mousemoveevent'* *'mousemev'* |
4190b932e6ca
patch 8.2.4674: cannot force getting MouseMove events
Bram Moolenaar <Bram@vim.org>
parents:
28246
diff
changeset
|
5661 'mousemoveevent' 'mousemev' boolean (default off) |
4190b932e6ca
patch 8.2.4674: cannot force getting MouseMove events
Bram Moolenaar <Bram@vim.org>
parents:
28246
diff
changeset
|
5662 global |
4190b932e6ca
patch 8.2.4674: cannot force getting MouseMove events
Bram Moolenaar <Bram@vim.org>
parents:
28246
diff
changeset
|
5663 {only works in the GUI} |
4190b932e6ca
patch 8.2.4674: cannot force getting MouseMove events
Bram Moolenaar <Bram@vim.org>
parents:
28246
diff
changeset
|
5664 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
|
5665 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
|
5666 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
|
5667 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
|
5668 when the mouse is moved. |
4190b932e6ca
patch 8.2.4674: cannot force getting MouseMove events
Bram Moolenaar <Bram@vim.org>
parents:
28246
diff
changeset
|
5669 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
|
5670 later. |
4190b932e6ca
patch 8.2.4674: cannot force getting MouseMove events
Bram Moolenaar <Bram@vim.org>
parents:
28246
diff
changeset
|
5671 |
7 | 5672 *'mouseshape'* *'mouses'* *E547* |
15932 | 5673 'mouseshape' 'mouses' string (default "i-r:beam,s:updown,sd:udsizing, |
5674 vs:leftright,vd:lrsizing,m:no, | |
5675 ml:up-arrow,v:rightup-arrow") | |
7 | 5676 global |
5677 {only available when compiled with the |+mouseshape| | |
5678 feature} | |
5679 This option tells Vim what the mouse pointer should look like in | |
28379 | 5680 different modes. The option is a comma-separated list of parts, much |
7 | 5681 like used for 'guicursor'. Each part consist of a mode/location-list |
5682 and an argument-list: | |
5683 mode-list:shape,mode-list:shape,.. | |
5684 The mode-list is a dash separated list of these modes/locations: | |
5685 In a normal window: ~ | |
5686 n Normal mode | |
5687 v Visual mode | |
5688 ve Visual mode with 'selection' "exclusive" (same as 'v', | |
5689 if not specified) | |
5690 o Operator-pending mode | |
5691 i Insert mode | |
5692 r Replace mode | |
5693 | |
5694 Others: ~ | |
5695 c appending to the command-line | |
5696 ci inserting in the command-line | |
5697 cr replacing in the command-line | |
5698 m at the 'Hit ENTER' or 'More' prompts | |
5699 ml idem, but cursor in the last line | |
5700 e any mode, pointer below last window | |
5701 s any mode, pointer on a status line | |
5702 sd any mode, while dragging a status line | |
5703 vs any mode, pointer on a vertical separator line | |
5704 vd any mode, while dragging a vertical separator line | |
5705 a everywhere | |
5706 | |
5707 The shape is one of the following: | |
5708 avail name looks like ~ | |
5709 w x arrow Normal mouse pointer | |
5710 w x blank no pointer at all (use with care!) | |
5711 w x beam I-beam | |
5712 w x updown up-down sizing arrows | |
5713 w x leftright left-right sizing arrows | |
5714 w x busy The system's usual busy pointer | |
5715 w x no The system's usual 'no input' pointer | |
5716 x udsizing indicates up-down resizing | |
5717 x lrsizing indicates left-right resizing | |
5718 x crosshair like a big thin + | |
5719 x hand1 black hand | |
5720 x hand2 white hand | |
5721 x pencil what you write with | |
5722 x question big ? | |
5723 x rightup-arrow arrow pointing right-up | |
5724 w x up-arrow arrow pointing up | |
5725 x <number> any X11 pointer number (see X11/cursorfont.h) | |
5726 | |
5727 The "avail" column contains a 'w' if the shape is available for Win32, | |
5728 x for X11. | |
5729 Any modes not specified or shapes not available use the normal mouse | |
5730 pointer. | |
5731 | |
5732 Example: > | |
5733 :set mouseshape=s:udsizing,m:no | |
5734 < will make the mouse turn to a sizing arrow over the status lines and | |
5735 indicate no input when the hit-enter prompt is displayed (since | |
5736 clicking the mouse has no effect in this state.) | |
5737 | |
5738 *'mousetime'* *'mouset'* | |
5739 'mousetime' 'mouset' number (default 500) | |
5740 global | |
18972 | 5741 Only for GUI, Win32 and Unix with xterm. Defines the maximum |
7 | 5742 time in msec between two mouse clicks for the second click to be |
5743 recognized as a multi click. | |
5744 | |
12608
b390f5003e2f
patch 8.0.1182: cannot see or change mzscheme dll name
Christian Brabandt <cb@256bit.org>
parents:
12559
diff
changeset
|
5745 *'mzschemedll'* |
b390f5003e2f
patch 8.0.1182: cannot see or change mzscheme dll name
Christian Brabandt <cb@256bit.org>
parents:
12559
diff
changeset
|
5746 '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
|
5747 global |
b390f5003e2f
patch 8.0.1182: cannot see or change mzscheme dll name
Christian Brabandt <cb@256bit.org>
parents:
12559
diff
changeset
|
5748 {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
|
5749 feature} |
b390f5003e2f
patch 8.0.1182: cannot see or change mzscheme dll name
Christian Brabandt <cb@256bit.org>
parents:
12559
diff
changeset
|
5750 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
|
5751 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
|
5752 Environment variables are expanded |:set_env|. |
12785 | 5753 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
|
5754 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
|
5755 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
|
5756 security reasons. |
b390f5003e2f
patch 8.0.1182: cannot see or change mzscheme dll name
Christian Brabandt <cb@256bit.org>
parents:
12559
diff
changeset
|
5757 |
b390f5003e2f
patch 8.0.1182: cannot see or change mzscheme dll name
Christian Brabandt <cb@256bit.org>
parents:
12559
diff
changeset
|
5758 *'mzschemegcdll'* |
b390f5003e2f
patch 8.0.1182: cannot see or change mzscheme dll name
Christian Brabandt <cb@256bit.org>
parents:
12559
diff
changeset
|
5759 '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
|
5760 global |
b390f5003e2f
patch 8.0.1182: cannot see or change mzscheme dll name
Christian Brabandt <cb@256bit.org>
parents:
12559
diff
changeset
|
5761 {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
|
5762 feature} |
b390f5003e2f
patch 8.0.1182: cannot see or change mzscheme dll name
Christian Brabandt <cb@256bit.org>
parents:
12559
diff
changeset
|
5763 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
|
5764 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
|
5765 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
|
5766 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
|
5767 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
|
5768 security reasons. |
b390f5003e2f
patch 8.0.1182: cannot see or change mzscheme dll name
Christian Brabandt <cb@256bit.org>
parents:
12559
diff
changeset
|
5769 |
14 | 5770 *'mzquantum'* *'mzq'* |
5771 'mzquantum' 'mzq' number (default 100) | |
5772 global | |
5773 {not available when compiled without the |+mzscheme| | |
5774 feature} | |
5775 The number of milliseconds between polls for MzScheme threads. | |
5776 Negative or zero value means no thread scheduling. | |
11160 | 5777 NOTE: This option is set to the Vim default value when 'compatible' |
5778 is reset. | |
14 | 5779 |
7 | 5780 *'nrformats'* *'nf'* |
9669
284b4eb307fc
commit https://github.com/vim/vim/commit/8c08b5b569e2a9e9f63dea514591ecfa2d3bb392
Christian Brabandt <cb@256bit.org>
parents:
9665
diff
changeset
|
5781 '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
|
5782 set to "bin,hex" in |defaults.vim|) |
7 | 5783 local to buffer |
5784 This defines what bases Vim will consider for numbers when using the | |
5785 CTRL-A and CTRL-X commands for adding to and subtracting from a number | |
5786 respectively; see |CTRL-A| for more info on these commands. | |
625 | 5787 alpha If included, single alphabetical characters will be |
7 | 5788 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
|
5789 letter index a), b), etc. *octal-nrformats* |
625 | 5790 octal If included, numbers that start with a zero will be considered |
7 | 5791 to be octal. Example: Using CTRL-A on "007" results in "010". |
625 | 5792 hex If included, numbers starting with "0x" or "0X" will be |
7 | 5793 considered to be hexadecimal. Example: Using CTRL-X on |
5794 "0x100" results in "0x0ff". | |
7528
53163e4d9e4f
commit https://github.com/vim/vim/commit/25e4fcde767084d1a79e0926bc301c92987c0cce
Christian Brabandt <cb@256bit.org>
parents:
7477
diff
changeset
|
5795 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
|
5796 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
|
5797 "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
|
5798 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
|
5799 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
|
5800 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
|
5801 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
|
5802 (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
|
5803 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
|
5804 (without "unsigned" it would become "9-2019"). |
20753 | 5805 Using CTRL-X on "0" or CTRL-A on "18446744073709551615" |
5806 (2^64 - 1) has no effect, overflow is prevented. | |
7 | 5807 Numbers which simply begin with a digit in the range 1-9 are always |
5808 considered decimal. This also happens for numbers that are not | |
5809 recognized as octal or hex. | |
5810 | |
5811 *'number'* *'nu'* *'nonumber'* *'nonu'* | |
5812 'number' 'nu' boolean (default off) | |
5813 local to window | |
5814 Print the line number in front of each line. When the 'n' option is | |
5815 excluded from 'cpoptions' a wrapped line will not use the column of | |
5816 line numbers (this is the default when 'compatible' isn't set). | |
13 | 5817 The 'numberwidth' option can be used to set the room used for the line |
5818 number. | |
7 | 5819 When a long, wrapped line doesn't start with the first character, '-' |
5820 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
|
5821 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
|
5822 |:sign-define| "numhl" argument. |
4780 | 5823 *number_relativenumber* |
5824 The 'relativenumber' option changes the displayed number to be | |
5825 relative to the cursor. Together with 'number' there are these | |
5826 four combinations (cursor in line 3): | |
5827 | |
8629
54ac275e3fc4
commit https://github.com/vim/vim/commit/3848e00e0177abdb31bc600234967863ec487233
Christian Brabandt <cb@256bit.org>
parents:
8560
diff
changeset
|
5828 'nonu' 'nu' 'nonu' 'nu' |
4780 | 5829 'nornu' 'nornu' 'rnu' 'rnu' |
5830 | |
5831 |apple | 1 apple | 2 apple | 2 apple | |
5832 |pear | 2 pear | 1 pear | 1 pear | |
5833 |nobody | 3 nobody | 0 nobody |3 nobody | |
5834 |there | 4 there | 1 there | 1 there | |
7 | 5835 |
13 | 5836 *'numberwidth'* *'nuw'* |
5837 'numberwidth' 'nuw' number (Vim default: 4 Vi default: 8) | |
5838 local to window | |
14 | 5839 {only available when compiled with the |+linebreak| |
5840 feature} | |
13 | 5841 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
|
5842 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
|
5843 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
|
5844 the text, there is one less character for the number itself. |
13 | 5845 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
|
5846 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
|
5847 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
|
5848 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
|
5849 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
|
5850 The minimum value is 1, the maximum value is 20. |
11160 | 5851 NOTE: This option is set to the Vi default value when 'compatible' is |
5852 set and to the Vim default value when 'compatible' is reset. | |
13 | 5853 |
523 | 5854 *'omnifunc'* *'ofu'* |
5855 'omnifunc' 'ofu' string (default: empty) | |
502 | 5856 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
|
5857 {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
|
5858 feature} |
623 | 5859 This option specifies a function to be used for Insert mode omni |
5860 completion with CTRL-X CTRL-O. |i_CTRL-X_CTRL-O| | |
648 | 5861 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
|
5862 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
|
5863 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
|
5864 more information. |
1004 | 5865 This option is usually set by a filetype plugin: |
859 | 5866 |:filetype-plugin-on| |
3682 | 5867 This option cannot be set from a |modeline| or in the |sandbox|, for |
5868 security reasons. | |
502 | 5869 |
5870 | |
1152 | 5871 *'opendevice'* *'odev'* *'noopendevice'* *'noodev'* |
1004 | 5872 'opendevice' 'odev' boolean (default off) |
5873 global | |
27321 | 5874 {only for MS-Windows} *E796* |
1004 | 5875 Enable reading and writing from devices. This may get Vim stuck on a |
5876 device that can be opened but doesn't actually do the I/O. Therefore | |
5877 it is off by default. | |
5878 Note that on MS-Windows editing "aux.h", "lpt1.txt" and the like also | |
5879 result in editing a device. | |
5880 | |
5881 | |
593 | 5882 *'operatorfunc'* *'opfunc'* |
5883 'operatorfunc' 'opfunc' string (default: empty) | |
5884 global | |
5885 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
|
5886 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
|
5887 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
|
5888 |option-value-function| for more information. |
593 | 5889 |
5890 This option cannot be set from a |modeline| or in the |sandbox|, for | |
5891 security reasons. | |
5892 | |
5893 | |
2908 | 5894 *'osfiletype'* *'oft'* |
5895 'osfiletype' 'oft' string (default: "") | |
7 | 5896 local to buffer |
2908 | 5897 This option was supported on RISC OS, which has been removed. |
5898 | |
7 | 5899 |
8182
95d59081580f
commit https://github.com/vim/vim/commit/f6fee0e2d4341c0c2f5339c1268e5877fafd07cf
Christian Brabandt <cb@256bit.org>
parents:
8148
diff
changeset
|
5900 *'packpath'* *'pp'* |
95d59081580f
commit https://github.com/vim/vim/commit/f6fee0e2d4341c0c2f5339c1268e5877fafd07cf
Christian Brabandt <cb@256bit.org>
parents:
8148
diff
changeset
|
5901 'packpath' 'pp' string (default: see 'runtimepath') |
95d59081580f
commit https://github.com/vim/vim/commit/f6fee0e2d4341c0c2f5339c1268e5877fafd07cf
Christian Brabandt <cb@256bit.org>
parents:
8148
diff
changeset
|
5902 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
|
5903 |
95d59081580f
commit https://github.com/vim/vim/commit/f6fee0e2d4341c0c2f5339c1268e5877fafd07cf
Christian Brabandt <cb@256bit.org>
parents:
8148
diff
changeset
|
5904 |
7 | 5905 *'paragraphs'* *'para'* |
1564 | 5906 'paragraphs' 'para' string (default "IPLPPPQPP TPHPLIPpLpItpplpipbp") |
7 | 5907 global |
5908 Specifies the nroff macros that separate paragraphs. These are pairs | |
5909 of two letters (see |object-motions|). | |
5910 | |
5911 *'paste'* *'nopaste'* | |
5912 'paste' boolean (default off) | |
5913 global | |
10 | 5914 Put Vim in Paste mode. This is useful if you want to cut or copy |
5915 some text from one window and paste it in Vim. This will avoid | |
7 | 5916 unexpected effects. |
5917 Setting this option is useful when using Vim in a terminal, where Vim | |
10 | 5918 cannot distinguish between typed text and pasted text. In the GUI, Vim |
7 | 5919 knows about pasting and will mostly do the right thing without 'paste' |
5920 being set. The same is true for a terminal where Vim handles the | |
5921 mouse clicks itself. | |
148 | 5922 This option is reset when starting the GUI. Thus if you set it in |
5923 your .vimrc it will work in a terminal, but not in the GUI. Setting | |
5924 'paste' in the GUI has side effects: e.g., the Paste toolbar button | |
5925 will no longer work in Insert mode, because it uses a mapping. | |
7 | 5926 When the 'paste' option is switched on (also when it was already on): |
5927 - mapping in Insert mode and Command-line mode is disabled | |
5928 - abbreviations are disabled | |
5929 - 'autoindent' is reset | |
7147
c590de398af9
commit https://github.com/vim/vim/commit/ca63501fbcd1cf9c8aa9ff12c093c95b62a89ed7
Christian Brabandt <cb@256bit.org>
parents:
7080
diff
changeset
|
5930 - 'expandtab' is reset |
25056 | 5931 - 'hkmap' is reset |
7 | 5932 - 'revins' is reset |
5933 - 'ruler' is reset | |
5934 - 'showmatch' is reset | |
7147
c590de398af9
commit https://github.com/vim/vim/commit/ca63501fbcd1cf9c8aa9ff12c093c95b62a89ed7
Christian Brabandt <cb@256bit.org>
parents:
7080
diff
changeset
|
5935 - 'smarttab' is reset |
c590de398af9
commit https://github.com/vim/vim/commit/ca63501fbcd1cf9c8aa9ff12c093c95b62a89ed7
Christian Brabandt <cb@256bit.org>
parents:
7080
diff
changeset
|
5936 - 'softtabstop' is set to 0 |
c590de398af9
commit https://github.com/vim/vim/commit/ca63501fbcd1cf9c8aa9ff12c093c95b62a89ed7
Christian Brabandt <cb@256bit.org>
parents:
7080
diff
changeset
|
5937 - 'textwidth' is set to 0 |
c590de398af9
commit https://github.com/vim/vim/commit/ca63501fbcd1cf9c8aa9ff12c093c95b62a89ed7
Christian Brabandt <cb@256bit.org>
parents:
7080
diff
changeset
|
5938 - 'wrapmargin' is set to 0 |
25056 | 5939 - 'varsofttabstop' is made empty |
7 | 5940 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
|
5941 - 'cindent' |
25056 | 5942 - '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
|
5943 - 'indentexpr' |
7 | 5944 - 'lisp' |
25056 | 5945 - 'smartindent' |
7 | 5946 NOTE: When you start editing another file while the 'paste' option is |
5947 on, settings from the modelines or autocommands may change the | |
5948 settings again, causing trouble when pasting text. You might want to | |
5949 set the 'paste' option again. | |
5950 When the 'paste' option is reset the mentioned options are restored to | |
5951 the value before the moment 'paste' was switched from off to on. | |
5952 Resetting 'paste' before ever setting it does not have any effect. | |
5953 Since mapping doesn't work while 'paste' is active, you need to use | |
5954 the 'pastetoggle' option to toggle the 'paste' option with some key. | |
5955 | |
5956 *'pastetoggle'* *'pt'* | |
5957 'pastetoggle' 'pt' string (default "") | |
5958 global | |
5959 When non-empty, specifies the key sequence that toggles the 'paste' | |
5960 option. This is like specifying a mapping: > | |
5961 :map {keys} :set invpaste<CR> | |
5962 < Where {keys} is the value of 'pastetoggle'. | |
5963 The difference is that it will work even when 'paste' is set. | |
5964 'pastetoggle' works in Insert mode and Normal mode, but not in | |
5965 Command-line mode. | |
5966 Mappings are checked first, thus overrule 'pastetoggle'. However, | |
5967 when 'paste' is on mappings are ignored in Insert mode, thus you can do | |
5968 this: > | |
5969 :map <F10> :set paste<CR> | |
5970 :map <F11> :set nopaste<CR> | |
5971 :imap <F10> <C-O>:set paste<CR> | |
5972 :imap <F11> <nop> | |
5973 :set pastetoggle=<F11> | |
5974 < This will make <F10> start paste mode and <F11> stop paste mode. | |
5975 Note that typing <F10> in paste mode inserts "<F10>", since in paste | |
5976 mode everything is inserted literally, except the 'pastetoggle' key | |
5977 sequence. | |
1621 | 5978 When the value has several bytes 'ttimeoutlen' applies. |
7 | 5979 |
5980 *'pex'* *'patchexpr'* | |
5981 'patchexpr' 'pex' string (default "") | |
5982 global | |
5983 {not available when compiled without the |+diff| | |
5984 feature} | |
5985 Expression which is evaluated to apply a patch to a file and generate | |
10 | 5986 the resulting new version of the file. See |diff-patchexpr|. |
7 | 5987 |
6091
7090d7f160f7
Update runtime files. Add vroom file support.
Bram Moolenaar <bram@vim.org>
parents:
6032
diff
changeset
|
5988 *'patchmode'* *'pm'* *E205* *E206* |
7 | 5989 'patchmode' 'pm' string (default "") |
5990 global | |
5991 When non-empty the oldest version of a file is kept. This can be used | |
5992 to keep the original version of a file if you are changing files in a | |
5993 source distribution. Only the first time that a file is written a | |
5994 copy of the original file will be kept. The name of the copy is the | |
5995 name of the original file with the string in the 'patchmode' option | |
5996 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
|
5997 ".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
|
5998 (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
|
5999 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
|
6000 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
|
6001 empty file is created. |
7 | 6002 When the 'backupskip' pattern matches, a patchmode file is not made. |
6003 Using 'patchmode' for compressed files appends the extension at the | |
6004 end (e.g., "file.gz.orig"), thus the resulting name isn't always | |
6005 recognized as a compressed file. | |
36 | 6006 Only normal file name characters can be used, "/\*?[|<>" are illegal. |
7 | 6007 |
3224 | 6008 *'path'* *'pa'* *E343* *E345* *E347* *E854* |
7 | 6009 'path' 'pa' string (default on Unix: ".,/usr/include,," |
6010 other systems: ".,,") | |
6011 global or local to buffer |global-local| | |
6012 This is a list of directories which will be searched when using the | |
1668 | 6013 |gf|, [f, ]f, ^Wf, |:find|, |:sfind|, |:tabfind| and other commands, |
6014 provided that the file being searched for has a relative path (not | |
6015 starting with "/", "./" or "../"). The directories in the 'path' | |
6016 option may be relative or absolute. | |
7 | 6017 - Use commas to separate directory names: > |
6018 :set path=.,/usr/local/include,/usr/include | |
6019 < - Spaces can also be used to separate directory names (for backwards | |
6020 compatibility with version 3.0). To have a space in a directory | |
6021 name, precede it with an extra backslash, and escape the space: > | |
6022 :set path=.,/dir/with\\\ space | |
6023 < - To include a comma in a directory name precede it with an extra | |
6024 backslash: > | |
6025 :set path=.,/dir/with\\,comma | |
6026 < - To search relative to the directory of the current file, use: > | |
6027 :set path=. | |
6028 < - To search in the current directory use an empty string between two | |
6029 commas: > | |
6030 :set path=,, | |
6031 < - A directory name may end in a ':' or '/'. | |
6032 - Environment variables are expanded |:set_env|. | |
6033 - When using |netrw.vim| URLs can be used. For example, adding | |
6034 "http://www.vim.org" will make ":find index.html" work. | |
1668 | 6035 - Search upwards and downwards in a directory tree using "*", "**" and |
6036 ";". See |file-searching| for info and syntax. | |
7 | 6037 - Careful with '\' characters, type two to get one in the option: > |
6038 :set path=.,c:\\include | |
6039 < Or just use '/' instead: > | |
6040 :set path=.,c:/include | |
6041 < Don't forget "." or files won't even be found in the same directory as | |
6042 the file! | |
10 | 6043 The maximum length is limited. How much depends on the system, mostly |
7 | 6044 it is something like 256 or 1024 characters. |
6045 You can check if all the include files are found, using the value of | |
6046 'path', see |:checkpath|. | |
6047 The use of |:set+=| and |:set-=| is preferred when adding or removing | |
6048 directories from the list. This avoids problems when a future version | |
6049 uses another default. To remove the current directory use: > | |
6050 :set path-= | |
6051 < To add the current directory use: > | |
6052 :set path+= | |
6053 < To use an environment variable, you probably need to replace the | |
6054 separator. Here is an example to append $INCL, in which directory | |
6055 names are separated with a semi-colon: > | |
27903 | 6056 :let &path = &path .. "," .. substitute($INCL, ';', ',', 'g') |
7 | 6057 < Replace the ';' with a ':' or whatever separator is used. Note that |
6058 this doesn't work when $INCL contains a comma or white space. | |
6059 | |
12499 | 6060 *'perldll'* |
6061 'perldll' string (default depends on the build) | |
6062 global | |
6063 {only available when compiled with the |+perl/dyn| | |
6064 feature} | |
6065 Specifies the name of the Perl shared library. The default is | |
6066 DYNAMIC_PERL_DLL, which was specified at compile time. | |
6067 Environment variables are expanded |:set_env|. | |
6068 This option cannot be set from a |modeline| or in the |sandbox|, for | |
6069 security reasons. | |
6070 | |
7 | 6071 *'preserveindent'* *'pi'* *'nopreserveindent'* *'nopi'* |
6072 'preserveindent' 'pi' boolean (default off) | |
6073 local to buffer | |
6074 When changing the indent of the current line, preserve as much of the | |
6075 indent structure as possible. Normally the indent is replaced by a | |
6076 series of tabs followed by spaces as required (unless |'expandtab'| is | |
6077 enabled, in which case only spaces are used). Enabling this option | |
6078 means the indent will preserve as many existing characters as possible | |
6079 for indenting, and only add additional tabs or spaces as required. | |
1621 | 6080 'expandtab' does not apply to the preserved white space, a Tab remains |
6081 a Tab. | |
7 | 6082 NOTE: When using ">>" multiple times the resulting indent is a mix of |
6083 tabs and spaces. You might not like this. | |
11160 | 6084 NOTE: This option is reset when 'compatible' is set. |
7 | 6085 Also see 'copyindent'. |
6086 Use |:retab| to clean up white space. | |
6087 | |
6088 *'previewheight'* *'pvh'* | |
6089 'previewheight' 'pvh' number (default 12) | |
6090 global | |
17771
4bd21046902b
patch 8.1.1882: cannot specify properties of the info popup window
Bram Moolenaar <Bram@vim.org>
parents:
17767
diff
changeset
|
6091 {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
|
6092 feature} |
7 | 6093 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
|
6094 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
|
6095 '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
|
6096 |
ce35cdbe9f74
patch 8.1.1714: cannot preview a file in a popup window
Bram Moolenaar <Bram@vim.org>
parents:
17372
diff
changeset
|
6097 *'previewpopup'* *'pvp'* |
ce35cdbe9f74
patch 8.1.1714: cannot preview a file in a popup window
Bram Moolenaar <Bram@vim.org>
parents:
17372
diff
changeset
|
6098 '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
|
6099 global |
17771
4bd21046902b
patch 8.1.1882: cannot specify properties of the info popup window
Bram Moolenaar <Bram@vim.org>
parents:
17767
diff
changeset
|
6100 {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
|
6101 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
|
6102 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
|
6103 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
|
6104 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
|
6105 'completeopt' for that. |
7 | 6106 |
6107 *'previewwindow'* *'nopreviewwindow'* | |
6108 *'pvw'* *'nopvw'* *E590* | |
6109 'previewwindow' 'pvw' boolean (default off) | |
6110 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
|
6111 {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
|
6112 feature} |
10 | 6113 Identifies the preview window. Only one window can have this option |
7 | 6114 set. It's normally not set directly, but by using one of the commands |
6115 |:ptag|, |:pedit|, etc. | |
6116 | |
6117 *'printdevice'* *'pdev'* | |
6118 'printdevice' 'pdev' string (default empty) | |
6119 global | |
6120 {only available when compiled with the |+printer| | |
6121 feature} | |
15 | 6122 The name of the printer to be used for |:hardcopy|. |
6123 See |pdev-option|. | |
36 | 6124 This option cannot be set from a |modeline| or in the |sandbox|, for |
6125 security reasons. | |
15 | 6126 |
6127 *'printencoding'* *'penc'* | |
14864 | 6128 'printencoding' 'penc' string (default empty, except for some systems) |
7 | 6129 global |
6130 {only available when compiled with the |+printer| | |
6131 and |+postscript| features} | |
15 | 6132 Sets the character encoding used when printing. |
6133 See |penc-option|. | |
7 | 6134 |
6135 *'printexpr'* *'pexpr'* | |
14864 | 6136 'printexpr' 'pexpr' string (default: see below) |
7 | 6137 global |
6138 {only available when compiled with the |+printer| | |
6139 and |+postscript| features} | |
15 | 6140 Expression used to print the PostScript produced with |:hardcopy|. |
6141 See |pexpr-option|. | |
10449
222b1432814e
commit https://github.com/vim/vim/commit/5162822914372fc916a93f85848c0c82209e7cec
Christian Brabandt <cb@256bit.org>
parents:
10272
diff
changeset
|
6142 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
|
6143 security reasons. |
15 | 6144 |
6145 *'printfont'* *'pfn'* | |
7 | 6146 'printfont' 'pfn' string (default "courier") |
6147 global | |
6148 {only available when compiled with the |+printer| | |
6149 feature} | |
15 | 6150 The name of the font that will be used for |:hardcopy|. |
6151 See |pfn-option|. | |
7 | 6152 |
6153 *'printheader'* *'pheader'* | |
6154 'printheader' 'pheader' string (default "%<%f%h%m%=Page %N") | |
6155 global | |
6156 {only available when compiled with the |+printer| | |
6157 feature} | |
15 | 6158 The format of the header produced in |:hardcopy| output. |
6159 See |pheader-option|. | |
6160 | |
6161 *'printmbcharset'* *'pmbcs'* | |
6162 'printmbcharset' 'pmbcs' string (default "") | |
6163 global | |
15878 | 6164 {only available when compiled with the |+printer| |
6165 and |+postscript| features} | |
15 | 6166 The CJK character set to be used for CJK output from |:hardcopy|. |
6167 See |pmbcs-option|. | |
6168 | |
6169 *'printmbfont'* *'pmbfn'* | |
6170 'printmbfont' 'pmbfn' string (default "") | |
6171 global | |
15878 | 6172 {only available when compiled with the |+printer| |
6173 and |+postscript| features} | |
15 | 6174 List of font names to be used for CJK output from |:hardcopy|. |
6175 See |pmbfn-option|. | |
7 | 6176 |
6177 *'printoptions'* *'popt'* | |
6178 'printoptions' 'popt' string (default "") | |
6179 global | |
6180 {only available when compiled with |+printer| feature} | |
15 | 6181 List of items that control the format of the output of |:hardcopy|. |
6182 See |popt-option|. | |
6183 | |
168 | 6184 *'prompt'* *'noprompt'* |
6185 'prompt' boolean (default on) | |
6186 global | |
6187 When on a ":" prompt is used in Ex mode. | |
6188 | |
766 | 6189 *'pumheight'* *'ph'* |
6190 'pumheight' 'ph' number (default 0) | |
6191 global | |
853 | 6192 Determines the maximum number of items to show in the popup menu for |
6193 Insert mode completion. When zero as much space as available is used. | |
766 | 6194 |ins-completion-menu|. |
6195 | |
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
|
6196 *'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
|
6197 '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
|
6198 global |
13341
acd7eaa13d2b
Updated runtime files.
Christian Brabandt <cb@256bit.org>
parents:
13314
diff
changeset
|
6199 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
|
6200 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
|
6201 |
7228
873eae260c97
commit https://github.com/vim/vim/commit/b4ff518d95aa57c2f8c0568c915035bef849581b
Christian Brabandt <cb@256bit.org>
parents:
7218
diff
changeset
|
6202 *'pythondll'* |
8629
54ac275e3fc4
commit https://github.com/vim/vim/commit/3848e00e0177abdb31bc600234967863ec487233
Christian Brabandt <cb@256bit.org>
parents:
8560
diff
changeset
|
6203 '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
|
6204 global |
7228
873eae260c97
commit https://github.com/vim/vim/commit/b4ff518d95aa57c2f8c0568c915035bef849581b
Christian Brabandt <cb@256bit.org>
parents:
7218
diff
changeset
|
6205 {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
|
6206 feature} |
7528
53163e4d9e4f
commit https://github.com/vim/vim/commit/25e4fcde767084d1a79e0926bc301c92987c0cce
Christian Brabandt <cb@256bit.org>
parents:
7477
diff
changeset
|
6207 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
|
6208 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
|
6209 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
|
6210 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
|
6211 security reasons. |
873eae260c97
commit https://github.com/vim/vim/commit/b4ff518d95aa57c2f8c0568c915035bef849581b
Christian Brabandt <cb@256bit.org>
parents:
7218
diff
changeset
|
6212 |
13154
53cc7ea77c54
patch 8.0.1451: difficult to set the python home directories properly
Christian Brabandt <cb@256bit.org>
parents:
13150
diff
changeset
|
6213 *'pythonhome'* |
53cc7ea77c54
patch 8.0.1451: difficult to set the python home directories properly
Christian Brabandt <cb@256bit.org>
parents:
13150
diff
changeset
|
6214 '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
|
6215 global |
53cc7ea77c54
patch 8.0.1451: difficult to set the python home directories properly
Christian Brabandt <cb@256bit.org>
parents:
13150
diff
changeset
|
6216 {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
|
6217 feature} |
53cc7ea77c54
patch 8.0.1451: difficult to set the python home directories properly
Christian Brabandt <cb@256bit.org>
parents:
13150
diff
changeset
|
6218 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
|
6219 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
|
6220 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
|
6221 home directory. |
53cc7ea77c54
patch 8.0.1451: difficult to set the python home directories properly
Christian Brabandt <cb@256bit.org>
parents:
13150
diff
changeset
|
6222 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
|
6223 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
|
6224 security reasons. |
53cc7ea77c54
patch 8.0.1451: difficult to set the python home directories properly
Christian Brabandt <cb@256bit.org>
parents:
13150
diff
changeset
|
6225 |
7218
36dc8df8560f
commit https://github.com/vim/vim/commit/0796c0625fa4b9eb2f47fe8c976b78523924e1fb
Christian Brabandt <cb@256bit.org>
parents:
7196
diff
changeset
|
6226 *'pythonthreedll'* |
7528
53163e4d9e4f
commit https://github.com/vim/vim/commit/25e4fcde767084d1a79e0926bc301c92987c0cce
Christian Brabandt <cb@256bit.org>
parents:
7477
diff
changeset
|
6227 '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
|
6228 global |
7196
42717d048817
commit https://github.com/vim/vim/commit/d94464ee294a351ce7b6ba18e8bd3f24f1bef920
Christian Brabandt <cb@256bit.org>
parents:
7147
diff
changeset
|
6229 {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
|
6230 feature} |
7528
53163e4d9e4f
commit https://github.com/vim/vim/commit/25e4fcde767084d1a79e0926bc301c92987c0cce
Christian Brabandt <cb@256bit.org>
parents:
7477
diff
changeset
|
6231 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
|
6232 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
|
6233 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
|
6234 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
|
6235 security reasons. |
42717d048817
commit https://github.com/vim/vim/commit/d94464ee294a351ce7b6ba18e8bd3f24f1bef920
Christian Brabandt <cb@256bit.org>
parents:
7147
diff
changeset
|
6236 |
13154
53cc7ea77c54
patch 8.0.1451: difficult to set the python home directories properly
Christian Brabandt <cb@256bit.org>
parents:
13150
diff
changeset
|
6237 *'pythonthreehome'* |
53cc7ea77c54
patch 8.0.1451: difficult to set the python home directories properly
Christian Brabandt <cb@256bit.org>
parents:
13150
diff
changeset
|
6238 '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
|
6239 global |
53cc7ea77c54
patch 8.0.1451: difficult to set the python home directories properly
Christian Brabandt <cb@256bit.org>
parents:
13150
diff
changeset
|
6240 {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
|
6241 feature} |
53cc7ea77c54
patch 8.0.1451: difficult to set the python home directories properly
Christian Brabandt <cb@256bit.org>
parents:
13150
diff
changeset
|
6242 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
|
6243 '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
|
6244 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
|
6245 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
|
6246 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
|
6247 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
|
6248 security reasons. |
53cc7ea77c54
patch 8.0.1451: difficult to set the python home directories properly
Christian Brabandt <cb@256bit.org>
parents:
13150
diff
changeset
|
6249 |
10722
7598ce51bf2a
patch 8.0.0251: not easy to select Python 2 or 3
Christian Brabandt <cb@256bit.org>
parents:
10617
diff
changeset
|
6250 *'pyxversion'* *'pyx'* |
7598ce51bf2a
patch 8.0.0251: not easy to select Python 2 or 3
Christian Brabandt <cb@256bit.org>
parents:
10617
diff
changeset
|
6251 '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
|
6252 global |
7598ce51bf2a
patch 8.0.0251: not easy to select Python 2 or 3
Christian Brabandt <cb@256bit.org>
parents:
10617
diff
changeset
|
6253 {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
|
6254 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
|
6255 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
|
6256 |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
|
6257 |
7598ce51bf2a
patch 8.0.0251: not easy to select Python 2 or 3
Christian Brabandt <cb@256bit.org>
parents:
10617
diff
changeset
|
6258 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
|
6259 |+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
|
6260 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
|
6261 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
|
6262 |
7598ce51bf2a
patch 8.0.0251: not easy to select Python 2 or 3
Christian Brabandt <cb@256bit.org>
parents:
10617
diff
changeset
|
6263 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
|
6264 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
|
6265 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
|
6266 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
|
6267 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
|
6268 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
|
6269 |
7598ce51bf2a
patch 8.0.0251: not easy to select Python 2 or 3
Christian Brabandt <cb@256bit.org>
parents:
10617
diff
changeset
|
6270 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
|
6271 '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
|
6272 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
|
6273 |
7598ce51bf2a
patch 8.0.0251: not easy to select Python 2 or 3
Christian Brabandt <cb@256bit.org>
parents:
10617
diff
changeset
|
6274 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
|
6275 security reasons. |
7598ce51bf2a
patch 8.0.0251: not easy to select Python 2 or 3
Christian Brabandt <cb@256bit.org>
parents:
10617
diff
changeset
|
6276 |
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
|
6277 *'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
|
6278 '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
|
6279 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
|
6280 {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
|
6281 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
|
6282 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
|
6283 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
|
6284 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
|
6285 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
|
6286 |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
|
6287 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
|
6288 |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
|
6289 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
|
6290 |
d6827bd31d1d
patch 8.2.0869: it is not possible to customize the quickfix window contents
Bram Moolenaar <Bram@vim.org>
parents:
20613
diff
changeset
|
6291 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
|
6292 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
|
6293 |
140 | 6294 *'quoteescape'* *'qe'* |
12 | 6295 'quoteescape' 'qe' string (default "\") |
6296 local to buffer | |
6297 The characters that are used to escape quotes in a string. Used for | |
6298 objects like a', a" and a` |a'|. | |
6299 When one of the characters in this option is found inside a string, | |
6300 the following character will be skipped. The default value makes the | |
6301 text "foo\"bar\\" considered to be one string. | |
6302 | |
7 | 6303 *'readonly'* *'ro'* *'noreadonly'* *'noro'* |
6304 'readonly' 'ro' boolean (default off) | |
6305 local to buffer | |
6306 If on, writes fail unless you use a '!'. Protects you from | |
6307 accidentally overwriting a file. Default on when Vim is started | |
6308 in read-only mode ("vim -R") or when the executable is called "view". | |
164 | 6309 When using ":w!" the 'readonly' option is reset for the current |
6310 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
|
6311 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
|
6312 newly edited buffer. |
10617 | 6313 See 'modifiable' for disallowing changes to the buffer. |
7 | 6314 |
1521 | 6315 *'redrawtime'* *'rdt'* |
6316 'redrawtime' 'rdt' number (default 2000) | |
6317 global | |
6318 {only available when compiled with the |+reltime| | |
6319 feature} | |
6320 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
|
6321 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
|
6322 highlighting. |
1521 | 6323 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
|
6324 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
|
6325 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
|
6326 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
|
6327 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
|
6328 pattern. |
1521 | 6329 |
4681
2eb30f341e8d
Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents:
4502
diff
changeset
|
6330 *'regexpengine'* *'re'* |
4502
605c9ce57ec3
Updated runtime files, language files and translations.
Bram Moolenaar <bram@vim.org>
parents:
4358
diff
changeset
|
6331 'regexpengine' 're' number (default 0) |
605c9ce57ec3
Updated runtime files, language files and translations.
Bram Moolenaar <bram@vim.org>
parents:
4358
diff
changeset
|
6332 global |
605c9ce57ec3
Updated runtime files, language files and translations.
Bram Moolenaar <bram@vim.org>
parents:
4358
diff
changeset
|
6333 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
|
6334 The possible values are: |
605c9ce57ec3
Updated runtime files, language files and translations.
Bram Moolenaar <bram@vim.org>
parents:
4358
diff
changeset
|
6335 0 automatic selection |
605c9ce57ec3
Updated runtime files, language files and translations.
Bram Moolenaar <bram@vim.org>
parents:
4358
diff
changeset
|
6336 1 old engine |
605c9ce57ec3
Updated runtime files, language files and translations.
Bram Moolenaar <bram@vim.org>
parents:
4358
diff
changeset
|
6337 2 NFA engine |
605c9ce57ec3
Updated runtime files, language files and translations.
Bram Moolenaar <bram@vim.org>
parents:
4358
diff
changeset
|
6338 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
|
6339 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
|
6340 for debugging the regexp engine. |
6328 | 6341 Using automatic selection enables Vim to switch the engine, if the |
6342 default engine becomes too costly. E.g., when the NFA engine uses too | |
6343 many states. This should prevent Vim from hanging on a combination of | |
6344 a complex pattern with long text. | |
4502
605c9ce57ec3
Updated runtime files, language files and translations.
Bram Moolenaar <bram@vim.org>
parents:
4358
diff
changeset
|
6345 |
2178
c6f1aa1e9f32
Add 'relativenumber' patch from Markus Heidelberg.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
6346 *'relativenumber'* *'rnu'* *'norelativenumber'* *'nornu'* |
c6f1aa1e9f32
Add 'relativenumber' patch from Markus Heidelberg.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
6347 'relativenumber' 'rnu' boolean (default off) |
c6f1aa1e9f32
Add 'relativenumber' patch from Markus Heidelberg.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
6348 local to window |
c6f1aa1e9f32
Add 'relativenumber' patch from Markus Heidelberg.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
6349 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
|
6350 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
|
6351 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
|
6352 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
|
6353 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
|
6354 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
|
6355 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
|
6356 'compatible' isn't set). |
c6f1aa1e9f32
Add 'relativenumber' patch from Markus Heidelberg.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
6357 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
|
6358 number. |
c6f1aa1e9f32
Add 'relativenumber' patch from Markus Heidelberg.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
6359 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
|
6360 characters are put before the number. |
3445 | 6361 See |hl-LineNr| and |hl-CursorLineNr| for the highlighting used for |
6362 the number. | |
13341
acd7eaa13d2b
Updated runtime files.
Christian Brabandt <cb@256bit.org>
parents:
13314
diff
changeset
|
6363 |
4780 | 6364 The number in front of the cursor line also depends on the value of |
6365 'number', see |number_relativenumber| for all combinations of the two | |
6366 options. | |
2178
c6f1aa1e9f32
Add 'relativenumber' patch from Markus Heidelberg.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
6367 |
7 | 6368 *'remap'* *'noremap'* |
6369 'remap' boolean (default on) | |
6370 global | |
6371 Allows for mappings to work recursively. If you do not want this for | |
6372 a single entry, use the :noremap[!] command. | |
717 | 6373 NOTE: To avoid portability problems with Vim scripts, always keep |
6374 this option at the default "on". Only switch it off when working with | |
6375 old Vi scripts. | |
7 | 6376 |
6110 | 6377 *'renderoptions'* *'rop'* |
6378 'renderoptions' 'rop' string (default: empty) | |
6379 global | |
6380 {only available when compiled with GUI and DIRECTX on | |
6381 MS-Windows} | |
6382 Select a text renderer and set its options. The options depend on the | |
6383 renderer. | |
6384 | |
6385 Syntax: > | |
6386 set rop=type:{renderer}(,{name}:{value})* | |
6387 < | |
6388 Currently, only one optional renderer is available. | |
6389 | |
6390 render behavior ~ | |
6391 directx Vim will draw text using DirectX (DirectWrite). It makes | |
6392 drawn glyphs more beautiful than default GDI. | |
6393 It requires 'encoding' is "utf-8", and only works on | |
6394 MS-Windows Vista or newer version. | |
6395 | |
6396 Options: | |
6397 name meaning type value ~ | |
6398 gamma gamma float 1.0 - 2.2 (maybe) | |
6399 contrast enhancedContrast float (unknown) | |
6400 level clearTypeLevel float (unknown) | |
6401 geom pixelGeometry int 0 - 2 (see below) | |
6402 renmode renderingMode int 0 - 6 (see below) | |
6403 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
|
6404 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
|
6405 |
18e6f4addce9
patch 8.0.1369: MS-Windows: drawing underline slow, mFallbackDC not updated
Christian Brabandt <cb@256bit.org>
parents:
12971
diff
changeset
|
6406 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
|
6407 https://msdn.microsoft.com/en-us/library/dd368190.aspx |
6110 | 6408 |
6409 For geom: structure of a device pixel. | |
6410 0 - DWRITE_PIXEL_GEOMETRY_FLAT | |
6411 1 - DWRITE_PIXEL_GEOMETRY_RGB | |
6412 2 - DWRITE_PIXEL_GEOMETRY_BGR | |
6413 | |
6414 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
|
6415 https://msdn.microsoft.com/en-us/library/dd368114.aspx |
6110 | 6416 |
6417 For renmode: method of rendering glyphs. | |
6418 0 - DWRITE_RENDERING_MODE_DEFAULT | |
6419 1 - DWRITE_RENDERING_MODE_ALIASED | |
6420 2 - DWRITE_RENDERING_MODE_GDI_CLASSIC | |
6421 3 - DWRITE_RENDERING_MODE_GDI_NATURAL | |
6422 4 - DWRITE_RENDERING_MODE_NATURAL | |
6423 5 - DWRITE_RENDERING_MODE_NATURAL_SYMMETRIC | |
6424 6 - DWRITE_RENDERING_MODE_OUTLINE | |
6425 | |
6426 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
|
6427 https://msdn.microsoft.com/en-us/library/dd368118.aspx |
6110 | 6428 |
6429 For taamode: antialiasing mode used for drawing text. | |
6430 0 - D2D1_TEXT_ANTIALIAS_MODE_DEFAULT | |
6431 1 - D2D1_TEXT_ANTIALIAS_MODE_CLEARTYPE | |
6432 2 - D2D1_TEXT_ANTIALIAS_MODE_GRAYSCALE | |
6433 3 - D2D1_TEXT_ANTIALIAS_MODE_ALIASED | |
6434 | |
6435 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
|
6436 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
|
6437 |
13150
808625d4b71b
patch 8.0.1449: slow redrawing with DirectX
Christian Brabandt <cb@256bit.org>
parents:
13100
diff
changeset
|
6438 For scrlines: |
808625d4b71b
patch 8.0.1449: slow redrawing with DirectX
Christian Brabandt <cb@256bit.org>
parents:
13100
diff
changeset
|
6439 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
|
6440 is now deprecated. If specified, it is simply ignored. |
6110 | 6441 |
6442 Example: > | |
6443 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
|
6444 set gfn=Ricty_Diminished:h12 |
6110 | 6445 set rop=type:directx |
6446 < | |
12934
2ebc3df65ca2
patch 8.0.1343: MS-Windows: does not show colored emojis
Christian Brabandt <cb@256bit.org>
parents:
12930
diff
changeset
|
6447 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
|
6448 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
|
6449 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
|
6450 |
2ebc3df65ca2
patch 8.0.1343: MS-Windows: does not show colored emojis
Christian Brabandt <cb@256bit.org>
parents:
12930
diff
changeset
|
6451 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
|
6452 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
|
6453 |
12986
18e6f4addce9
patch 8.0.1369: MS-Windows: drawing underline slow, mFallbackDC not updated
Christian Brabandt <cb@256bit.org>
parents:
12971
diff
changeset
|
6454 - '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
|
6455 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
|
6456 bitmap glyphs). |
2ebc3df65ca2
patch 8.0.1343: MS-Windows: does not show colored emojis
Christian Brabandt <cb@256bit.org>
parents:
12930
diff
changeset
|
6457 - '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
|
6458 |
2ebc3df65ca2
patch 8.0.1343: MS-Windows: does not show colored emojis
Christian Brabandt <cb@256bit.org>
parents:
12930
diff
changeset
|
6459 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
|
6460 (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
|
6461 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
|
6462 |
2ebc3df65ca2
patch 8.0.1343: MS-Windows: does not show colored emojis
Christian Brabandt <cb@256bit.org>
parents:
12930
diff
changeset
|
6463 - 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
|
6464 be used. |
2ebc3df65ca2
patch 8.0.1343: MS-Windows: does not show colored emojis
Christian Brabandt <cb@256bit.org>
parents:
12930
diff
changeset
|
6465 - 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
|
6466 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
|
6467 will be used. |
2ebc3df65ca2
patch 8.0.1343: MS-Windows: does not show colored emojis
Christian Brabandt <cb@256bit.org>
parents:
12930
diff
changeset
|
6468 - 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
|
6469 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
|
6470 cell. |
6110 | 6471 |
6472 Other render types are currently not supported. | |
6473 | |
7 | 6474 *'report'* |
6475 'report' number (default 2) | |
6476 global | |
6477 Threshold for reporting number of lines changed. When the number of | |
6478 changed lines is more than 'report' a message will be given for most | |
6479 ":" commands. If you want it always, set 'report' to 0. | |
6480 For the ":substitute" command the number of substitutions is used | |
6481 instead of the number of lines. | |
6482 | |
6483 *'restorescreen'* *'rs'* *'norestorescreen'* *'nors'* | |
6484 'restorescreen' 'rs' boolean (default on) | |
6485 global | |
19116 | 6486 {only in MS-Windows console version} |
7 | 6487 When set, the screen contents is restored when exiting Vim. This also |
6488 happens when executing external commands. | |
6489 | |
6490 For non-Windows Vim: You can set or reset the 't_ti' and 't_te' | |
6491 options in your .vimrc. To disable restoring: | |
6492 set t_ti= t_te= | |
6493 To enable restoring (for an xterm): | |
6494 set t_ti=^[7^[[r^[[?47h t_te=^[[?47l^[8 | |
6495 (Where ^[ is an <Esc>, type CTRL-V <Esc> to insert it) | |
6496 | |
6497 *'revins'* *'ri'* *'norevins'* *'nori'* | |
6498 'revins' 'ri' boolean (default off) | |
6499 global | |
6500 {only available when compiled with the |+rightleft| | |
6501 feature} | |
6502 Inserting characters in Insert mode will work backwards. See "typing | |
6503 backwards" |ins-reverse|. This option can be toggled with the CTRL-_ | |
6504 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
|
6505 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
|
6506 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
|
6507 reset. |
7 | 6508 |
6509 *'rightleft'* *'rl'* *'norightleft'* *'norl'* | |
6510 'rightleft' 'rl' boolean (default off) | |
6511 local to window | |
6512 {only available when compiled with the |+rightleft| | |
6513 feature} | |
6514 When on, display orientation becomes right-to-left, i.e., characters | |
6515 that are stored in the file appear from the right to the left. | |
6516 Using this option, it is possible to edit files for languages that | |
6517 are written from the right to the left such as Hebrew and Arabic. | |
6518 This option is per window, so it is possible to edit mixed files | |
6519 simultaneously, or to view the same file in both ways (this is | |
6520 useful whenever you have a mixed text file with both right-to-left | |
6521 and left-to-right strings so that both sets are displayed properly | |
6522 in different windows). Also see |rileft.txt|. | |
6523 | |
2341 | 6524 *'rightleftcmd'* *'rlc'* |
7 | 6525 'rightleftcmd' 'rlc' string (default "search") |
6526 local to window | |
6527 {only available when compiled with the |+rightleft| | |
6528 feature} | |
6529 Each word in this option enables the command line editing to work in | |
6530 right-to-left mode for a group of commands: | |
6531 | |
6532 search "/" and "?" commands | |
6533 | |
6534 This is useful for languages such as Hebrew, Arabic and Farsi. | |
6535 The 'rightleft' option must be set for 'rightleftcmd' to take effect. | |
6536 | |
7196
42717d048817
commit https://github.com/vim/vim/commit/d94464ee294a351ce7b6ba18e8bd3f24f1bef920
Christian Brabandt <cb@256bit.org>
parents:
7147
diff
changeset
|
6537 *'rubydll'* |
8629
54ac275e3fc4
commit https://github.com/vim/vim/commit/3848e00e0177abdb31bc600234967863ec487233
Christian Brabandt <cb@256bit.org>
parents:
8560
diff
changeset
|
6538 '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
|
6539 global |
7196
42717d048817
commit https://github.com/vim/vim/commit/d94464ee294a351ce7b6ba18e8bd3f24f1bef920
Christian Brabandt <cb@256bit.org>
parents:
7147
diff
changeset
|
6540 {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
|
6541 feature} |
7528
53163e4d9e4f
commit https://github.com/vim/vim/commit/25e4fcde767084d1a79e0926bc301c92987c0cce
Christian Brabandt <cb@256bit.org>
parents:
7477
diff
changeset
|
6542 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
|
6543 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
|
6544 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
|
6545 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
|
6546 security reasons. |
42717d048817
commit https://github.com/vim/vim/commit/d94464ee294a351ce7b6ba18e8bd3f24f1bef920
Christian Brabandt <cb@256bit.org>
parents:
7147
diff
changeset
|
6547 |
7 | 6548 *'ruler'* *'ru'* *'noruler'* *'noru'* |
9669
284b4eb307fc
commit https://github.com/vim/vim/commit/8c08b5b569e2a9e9f63dea514591ecfa2d3bb392
Christian Brabandt <cb@256bit.org>
parents:
9665
diff
changeset
|
6549 'ruler' 'ru' boolean (default off, set in |defaults.vim|) |
7 | 6550 global |
6551 Show the line and column number of the cursor position, separated by a | |
10 | 6552 comma. When there is room, the relative position of the displayed |
7 | 6553 text in the file is shown on the far right: |
6554 Top first line is visible | |
6555 Bot last line is visible | |
6556 All first and last line are visible | |
6557 45% relative position in the file | |
6558 If 'rulerformat' is set, it will determine the contents of the ruler. | |
10 | 6559 Each window has its own ruler. If a window has a status line, the |
30005
bb0e525e1393
patch 9.0.0340: the 'cmdheight' zero support causes too much trouble
Bram Moolenaar <Bram@vim.org>
parents:
29900
diff
changeset
|
6560 ruler is shown there. Otherwise it is shown in the last line of the |
bb0e525e1393
patch 9.0.0340: the 'cmdheight' zero support causes too much trouble
Bram Moolenaar <Bram@vim.org>
parents:
29900
diff
changeset
|
6561 screen. If the statusline is given by 'statusline' (i.e. not empty), |
bb0e525e1393
patch 9.0.0340: the 'cmdheight' zero support causes too much trouble
Bram Moolenaar <Bram@vim.org>
parents:
29900
diff
changeset
|
6562 this option takes precedence over 'ruler' and 'rulerformat'. |
7 | 6563 If the number of characters displayed is different from the number of |
21991 | 6564 bytes in the text (e.g., for a TAB or a multibyte character), both |
7 | 6565 the text column (byte number) and the screen column are shown, |
6566 separated with a dash. | |
6567 For an empty line "0-1" is shown. | |
6568 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
|
6569 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
|
6570 reset. |
7 | 6571 If you don't want to see the ruler all the time but want to know where |
6572 you are, use "g CTRL-G" |g_CTRL-G|. | |
6573 NOTE: This option is reset when 'compatible' is set. | |
6574 | |
6575 *'rulerformat'* *'ruf'* | |
6576 'rulerformat' 'ruf' string (default empty) | |
6577 global | |
6578 {not available when compiled without the |+statusline| | |
6579 feature} | |
6580 When this option is not empty, it determines the content of the ruler | |
6581 string, as displayed for the 'ruler' option. | |
692 | 6582 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
|
6583 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
|
6584 |
7 | 6585 The default ruler width is 17 characters. To make the ruler 15 |
6586 characters wide, put "%15(" at the start and "%)" at the end. | |
6587 Example: > | |
6588 :set rulerformat=%15(%c%V\ %p%%%) | |
6589 < | |
6590 *'runtimepath'* *'rtp'* *vimfiles* | |
6591 'runtimepath' 'rtp' string (default: | |
23931 | 6592 Unix: "$HOME/.vim, |
7 | 6593 $VIM/vimfiles, |
6594 $VIMRUNTIME, | |
6595 $VIM/vimfiles/after, | |
6596 $HOME/.vim/after" | |
6597 Amiga: "home:vimfiles, | |
6598 $VIM/vimfiles, | |
6599 $VIMRUNTIME, | |
6600 $VIM/vimfiles/after, | |
6601 home:vimfiles/after" | |
23931 | 6602 MS-Windows: "$HOME/vimfiles, |
7 | 6603 $VIM/vimfiles, |
6604 $VIMRUNTIME, | |
6605 $VIM/vimfiles/after, | |
6606 $HOME/vimfiles/after" | |
21825 | 6607 macOS: "$VIM:vimfiles, |
7 | 6608 $VIMRUNTIME, |
6609 $VIM:vimfiles:after" | |
19526
22f0dda71638
patch 8.2.0320: no Haiku support
Bram Moolenaar <Bram@vim.org>
parents:
19404
diff
changeset
|
6610 Haiku: "$BE_USER_SETTINGS/vim, |
22f0dda71638
patch 8.2.0320: no Haiku support
Bram Moolenaar <Bram@vim.org>
parents:
19404
diff
changeset
|
6611 $VIM/vimfiles, |
22f0dda71638
patch 8.2.0320: no Haiku support
Bram Moolenaar <Bram@vim.org>
parents:
19404
diff
changeset
|
6612 $VIMRUNTIME, |
22f0dda71638
patch 8.2.0320: no Haiku support
Bram Moolenaar <Bram@vim.org>
parents:
19404
diff
changeset
|
6613 $VIM/vimfiles/after, |
23931 | 6614 $BE_USER_SETTINGS/vim/after" |
6615 VMS: "sys$login:vimfiles, | |
7 | 6616 $VIM/vimfiles, |
6617 $VIMRUNTIME, | |
6618 $VIM/vimfiles/after, | |
233 | 6619 sys$login:vimfiles/after") |
7 | 6620 global |
6621 This is a list of directories which will be searched for runtime | |
6622 files: | |
6623 filetype.vim filetypes by file name |new-filetype| | |
6624 scripts.vim filetypes by file contents |new-filetype-scripts| | |
164 | 6625 autoload/ automatically loaded scripts |autoload-functions| |
7 | 6626 colors/ color scheme files |:colorscheme| |
6627 compiler/ compiler files |:compiler| | |
6628 doc/ documentation |write-local-help| | |
6629 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
|
6630 import/ files that are found by `:import` |
7 | 6631 indent/ indent scripts |indent-expression| |
6632 keymap/ key mapping files |mbyte-keymap| | |
6633 lang/ menu translations |:menutrans| | |
6634 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
|
6635 pack/ packages |:packadd| |
7 | 6636 plugin/ plugin scripts |write-plugin| |
6637 print/ files for printing |postscript-print-encoding| | |
650 | 6638 spell/ spell checking files |spell| |
7 | 6639 syntax/ syntax files |mysyntaxfile| |
6640 tutor/ files for vimtutor |tutor| | |
6641 | |
6642 And any other file searched for with the |:runtime| command. | |
6643 | |
6644 The defaults for most systems are setup to search five locations: | |
6645 1. In your home directory, for your personal preferences. | |
6646 2. In a system-wide Vim directory, for preferences from the system | |
6647 administrator. | |
6648 3. In $VIMRUNTIME, for files distributed with Vim. | |
6649 *after-directory* | |
6650 4. In the "after" directory in the system-wide Vim directory. This is | |
6651 for the system administrator to overrule or add to the distributed | |
6652 defaults (rarely needed) | |
6653 5. In the "after" directory in your home directory. This is for | |
6654 personal preferences to overrule or add to the distributed defaults | |
6655 or system-wide settings (rarely needed). | |
6656 | |
10211
b7da8d4c594c
commit https://github.com/vim/vim/commit/d07969093a9b3051511c478d71c36de6fc33c0d6
Christian Brabandt <cb@256bit.org>
parents:
10198
diff
changeset
|
6657 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
|
6658 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
|
6659 string. |
9116
bc38030aec7d
commit https://github.com/vim/vim/commit/26852128a2b713ef49341a0c18daba928444e7eb
Christian Brabandt <cb@256bit.org>
parents:
9098
diff
changeset
|
6660 |
7 | 6661 Note that, unlike 'path', no wildcards like "**" are allowed. Normal |
6662 wildcards are allowed, but can significantly slow down searching for | |
10 | 6663 runtime files. For speed, use as few items as possible and avoid |
7 | 6664 wildcards. |
6665 See |:runtime|. | |
6666 Example: > | |
6667 :set runtimepath=~/vimruntime,/mygroup/vim,$VIMRUNTIME | |
6668 < This will use the directory "~/vimruntime" first (containing your | |
6669 personal Vim runtime files), then "/mygroup/vim" (shared between a | |
6670 group of people) and finally "$VIMRUNTIME" (the distributed runtime | |
6671 files). | |
6672 You probably should always include $VIMRUNTIME somewhere, to use the | |
6673 distributed runtime files. You can put a directory before $VIMRUNTIME | |
6674 to find files which replace a distributed runtime files. You can put | |
6675 a directory after $VIMRUNTIME to find files which add to distributed | |
6676 runtime files. | |
13437 | 6677 When Vim is started with |--clean| the home directory entries are not |
6678 included. | |
7 | 6679 This option cannot be set from a |modeline| or in the |sandbox|, for |
6680 security reasons. | |
6681 | |
6682 *'scroll'* *'scr'* | |
6683 'scroll' 'scr' number (default: half the window height) | |
6684 local to window | |
6685 Number of lines to scroll with CTRL-U and CTRL-D commands. Will be | |
6686 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
|
6687 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
|
6688 '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
|
6689 If you give a count to the CTRL-U or CTRL-D command it will |
10 | 6690 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
|
6691 height with ":set scroll=0". |
7 | 6692 |
6693 *'scrollbind'* *'scb'* *'noscrollbind'* *'noscb'* | |
6694 'scrollbind' 'scb' boolean (default off) | |
6695 local to window | |
6696 See also |scroll-binding|. When this option is set, the current | |
6697 window scrolls as other scrollbind windows (windows that also have | |
6698 this option set) scroll. This option is useful for viewing the | |
6699 differences between two versions of a file, see 'diff'. | |
6700 See |'scrollopt'| for options that determine how this option should be | |
6701 interpreted. | |
6702 This option is mostly reset when splitting a window to edit another | |
6703 file. This means that ":split | edit file" results in two windows | |
6704 with scroll-binding, but ":split file" does not. | |
6705 | |
18526
334b1f897f3a
patch 8.1.2257: MS-Windows GUI: scroll wheel always uses current window
Bram Moolenaar <Bram@vim.org>
parents:
18489
diff
changeset
|
6706 *'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
|
6707 '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
|
6708 global |
334b1f897f3a
patch 8.1.2257: MS-Windows GUI: scroll wheel always uses current window
Bram Moolenaar <Bram@vim.org>
parents:
18489
diff
changeset
|
6709 {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
|
6710 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
|
6711 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
|
6712 window is scrolled. |
18594 | 6713 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
|
6714 |
7 | 6715 *'scrolljump'* *'sj'* |
6716 'scrolljump' 'sj' number (default 1) | |
6717 global | |
6718 Minimal number of lines to scroll when the cursor gets off the | |
6719 screen (e.g., with "j"). Not used for scroll commands (e.g., CTRL-E, | |
6720 CTRL-D). Useful if your terminal scrolls very slowly. | |
532 | 6721 When set to a negative number from -1 to -100 this is used as the |
6722 percentage of the window height. Thus -50 scrolls half the window | |
6723 height. | |
7 | 6724 NOTE: This option is set to 1 when 'compatible' is set. |
6725 | |
6726 *'scrolloff'* *'so'* | |
10218
584c835a2de1
commit https://github.com/vim/vim/commit/50ba526fbf3e9e5e0e6b0b3086a4d5df581ebc7e
Christian Brabandt <cb@256bit.org>
parents:
10211
diff
changeset
|
6727 '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
|
6728 global or local to window |global-local| |
7 | 6729 Minimal number of screen lines to keep above and below the cursor. |
6730 This will make some context visible around where you are working. If | |
6731 you set it to a very large value (999) the cursor line will always be | |
6732 in the middle of the window (except at the start or end of the file or | |
6733 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
|
6734 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
|
6735 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
|
6736 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
|
6737 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
|
6738 < For scrolling horizontally see 'sidescrolloff'. |
7 | 6739 NOTE: This option is set to 0 when 'compatible' is set. |
6740 | |
6741 *'scrollopt'* *'sbo'* | |
6742 'scrollopt' 'sbo' string (default "ver,jump") | |
6743 global | |
6744 This is a comma-separated list of words that specifies how | |
236 | 6745 'scrollbind' windows should behave. 'sbo' stands for ScrollBind |
6746 Options. | |
7 | 6747 The following words are available: |
6748 ver Bind vertical scrolling for 'scrollbind' windows | |
6749 hor Bind horizontal scrolling for 'scrollbind' windows | |
6750 jump Applies to the offset between two windows for vertical | |
6751 scrolling. This offset is the difference in the first | |
6752 displayed line of the bound windows. When moving | |
6753 around in a window, another 'scrollbind' window may | |
6754 reach a position before the start or after the end of | |
6755 the buffer. The offset is not changed though, when | |
6756 moving back the 'scrollbind' window will try to scroll | |
6757 to the desired position when possible. | |
6758 When now making that window the current one, two | |
6759 things can be done with the relative offset: | |
6760 1. When "jump" is not included, the relative offset is | |
6761 adjusted for the scroll position in the new current | |
6762 window. When going back to the other window, the | |
1152 | 6763 new relative offset will be used. |
7 | 6764 2. When "jump" is included, the other windows are |
6765 scrolled to keep the same relative offset. When | |
6766 going back to the other window, it still uses the | |
6767 same relative offset. | |
6768 Also see |scroll-binding|. | |
819 | 6769 When 'diff' mode is active there always is vertical scroll binding, |
6770 even when "ver" isn't there. | |
7 | 6771 |
6772 *'sections'* *'sect'* | |
6773 'sections' 'sect' string (default "SHNHH HUnhsh") | |
6774 global | |
6775 Specifies the nroff macros that separate sections. These are pairs of | |
6776 two letters (See |object-motions|). The default makes a section start | |
6777 at the nroff macros ".SH", ".NH", ".H", ".HU", ".nh" and ".sh". | |
6778 | |
6779 *'secure'* *'nosecure'* *E523* | |
6780 'secure' boolean (default off) | |
6781 global | |
6782 When on, ":autocmd", shell and write commands are not allowed in | |
6783 ".vimrc" and ".exrc" in the current directory and map commands are | |
6784 displayed. Switch it off only if you know that you will not run into | |
6785 problems, or when the 'exrc' option is off. On Unix this option is | |
6786 only used if the ".vimrc" or ".exrc" is not owned by you. This can be | |
10 | 6787 dangerous if the systems allows users to do a "chown". You better set |
7 | 6788 'secure' at the end of your ~/.vimrc then. |
6789 This option cannot be set from a |modeline| or in the |sandbox|, for | |
6790 security reasons. | |
6791 | |
6792 *'selection'* *'sel'* | |
6793 'selection' 'sel' string (default "inclusive") | |
6794 global | |
6795 This option defines the behavior of the selection. It is only used | |
6796 in Visual and Select mode. | |
6797 Possible values: | |
6798 value past line inclusive ~ | |
6799 old no yes | |
6800 inclusive yes yes | |
6801 exclusive yes no | |
6802 "past line" means that the cursor is allowed to be positioned one | |
6803 character past the line. | |
6804 "inclusive" means that the last character of the selection is included | |
6805 in an operation. For example, when "x" is used to delete the | |
6806 selection. | |
9975
03fa8a51e9dc
commit https://github.com/vim/vim/commit/e4a3bcf28d92d0bde9ca227ccb40d401038185e5
Christian Brabandt <cb@256bit.org>
parents:
9913
diff
changeset
|
6807 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
|
6808 the end of line the line break still isn't included. |
7 | 6809 Note that when "exclusive" is used and selecting from the end |
6810 backwards, you cannot include the last character of a line, when | |
6811 starting in Normal mode and 'virtualedit' empty. | |
6812 | |
6813 The 'selection' option is set by the |:behave| command. | |
6814 | |
6815 *'selectmode'* *'slm'* | |
6816 'selectmode' 'slm' string (default "") | |
6817 global | |
28379 | 6818 This is a comma-separated list of words, which specifies when to start |
7 | 6819 Select mode instead of Visual mode, when a selection is started. |
6820 Possible values: | |
6821 mouse when using the mouse | |
6822 key when using shifted special keys | |
6823 cmd when using "v", "V" or CTRL-V | |
6824 See |Select-mode|. | |
6825 The 'selectmode' option is set by the |:behave| command. | |
6826 | |
6827 *'sessionoptions'* *'ssop'* | |
6828 'sessionoptions' 'ssop' string (default: "blank,buffers,curdir,folds, | |
13437 | 6829 help,options,tabpages,winsize,terminal") |
7 | 6830 global |
2570
71b56b4e7785
Make the references to features in the help more consistent. (Sylvain Hitier)
Bram Moolenaar <bram@vim.org>
parents:
2561
diff
changeset
|
6831 {not available when compiled without the |+mksession| |
7 | 6832 feature} |
6833 Changes the effect of the |:mksession| command. It is a comma | |
6834 separated list of words. Each word enables saving and restoring | |
6835 something: | |
6836 word save and restore ~ | |
6837 blank empty windows | |
6838 buffers hidden and unloaded buffers, not just those in windows | |
6839 curdir the current directory | |
6840 folds manually created folds, opened/closed folds and local | |
6841 fold options | |
6842 globals global variables that start with an uppercase letter | |
75 | 6843 and contain at least one lowercase letter. Only |
6844 String and Number types are stored. | |
7 | 6845 help the help window |
6846 localoptions options and mappings local to a window or buffer (not | |
6847 global values for local options) | |
6848 options all options and mappings (also global values for local | |
6849 options) | |
24476
e79d1475fc89
patch 8.2.2778: problem restoring 'packpath' in session
Bram Moolenaar <Bram@vim.org>
parents:
24468
diff
changeset
|
6850 skiprtp exclude 'runtimepath' and 'packpath' from the options |
7 | 6851 resize size of the Vim window: 'lines' and 'columns' |
6852 sesdir the directory in which the session file is located | |
6853 will become the current directory (useful with | |
6854 projects accessed over a network from different | |
6855 systems) | |
6856 slash backslashes in file names replaced with forward | |
6857 slashes | |
827 | 6858 tabpages all tab pages; without this only the current tab page |
6859 is restored, so that you can make a session for each | |
6860 tab page separately | |
14519 | 6861 terminal include terminal windows where the command can be |
6862 restored | |
7 | 6863 unix with Unix end-of-line format (single <NL>), even when |
6864 on Windows or DOS | |
6865 winpos position of the whole Vim window | |
6866 winsize window sizes | |
6867 | |
6868 Don't include both "curdir" and "sesdir". | |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
6869 When neither "curdir" nor "sesdir" is included, file names are stored |
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
6870 with absolute paths. |
27036 | 6871 If you leave out "options" many things won't work well after restoring |
6872 the session. | |
7 | 6873 "slash" and "unix" are useful on Windows when sharing session files |
6874 with Unix. The Unix version of Vim cannot source dos format scripts, | |
6875 but the Windows version of Vim can source unix format scripts. | |
6876 | |
6877 *'shell'* *'sh'* *E91* | |
18928 | 6878 'shell' 'sh' string (default $SHELL or "sh", Win32: "cmd.exe") |
7 | 6879 global |
6880 Name of the shell to use for ! and :! commands. When changing the | |
6881 value also check these options: 'shelltype', 'shellpipe', 'shellslash' | |
6882 'shellredir', 'shellquote', 'shellxquote' and 'shellcmdflag'. | |
10 | 6883 It is allowed to give an argument to the command, e.g. "csh -f". |
7 | 6884 See |option-backslash| about including spaces and backslashes. |
6885 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
|
6886 |
27537 | 6887 In |restricted-mode| shell commands will not be possible. This mode |
6888 is used if the value of $SHELL ends in "false" or "nologin". | |
6889 | |
18489 | 6890 If the name of the shell contains a space, you need to enclose it in |
18594 | 6891 quotes and escape the space. Example with quotes: > |
7 | 6892 :set shell=\"c:\program\ files\unix\sh.exe\"\ -f |
6893 < Note the backslash before each quote (to avoid starting a comment) and | |
10 | 6894 each space (to avoid ending the option value). Also note that the |
7 | 6895 "-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
|
6896 name. Vim automagically recognizes the backslashes that are path |
7 | 6897 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
|
6898 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
|
6899 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
|
6900 :set shell=/bin/with\\\ space/sh |
14519 | 6901 < 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
|
6902 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
|
6903 |
7 | 6904 Under MS-Windows, when the executable ends in ".com" it must be |
6905 included. Thus setting the shell to "command.com" or "4dos.com" | |
6906 works, but "command" and "4dos" do not work for all commands (e.g., | |
6907 filtering). | |
6908 For unknown reasons, when using "4dos.com" the current directory is | |
6909 changed to "C:\". To avoid this set 'shell' like this: > | |
6910 :set shell=command.com\ /c\ 4dos | |
6911 < This option cannot be set from a |modeline| or in the |sandbox|, for | |
6912 security reasons. | |
6913 | |
6914 *'shellcmdflag'* *'shcf'* | |
3356 | 6915 '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
|
6916 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
|
6917 "-Command", or when it does not contain "sh" |
18972 | 6918 somewhere: "/c") |
7 | 6919 global |
6920 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
|
6921 "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
|
6922 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
|
6923 to reduce the need to set this option by the user. |
3082 | 6924 On Unix it can have more than one flag. Each white space separated |
6925 part is passed as an argument to the shell command. | |
6926 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
|
6927 Also see |dos-shell| and |dos-powershell| for MS-Windows. |
7 | 6928 This option cannot be set from a |modeline| or in the |sandbox|, for |
6929 security reasons. | |
6930 | |
6931 *'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
|
6932 '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
|
6933 "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
|
6934 "2>&1 | Out-File -Encoding default") |
7 | 6935 global |
6936 {not available when compiled without the |+quickfix| | |
6937 feature} | |
6938 String to be used to put the output of the ":make" command in the | |
10 | 6939 error file. See also |:make_makeprg|. See |option-backslash| about |
7 | 6940 including spaces and backslashes. |
6941 The name of the temporary file can be represented by "%s" if necessary | |
6942 (the file name is appended automatically if no %s appears in the value | |
6943 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
|
6944 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
|
6945 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
|
6946 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
|
6947 to the screen. |
22171 | 6948 For Unix the default is "| tee". The stdout of the compiler is saved |
7 | 6949 in a file and echoed to the screen. If the 'shell' option is "csh" or |
6950 "tcsh" after initializations, the default becomes "|& tee". If the | |
18456 | 6951 '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
|
6952 "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
|
6953 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
|
6954 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
|
6955 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
|
6956 becomes ">%s 2>&1" and the output is not echoed to the screen. |
7 | 6957 The initialization of this option is done after reading the ".vimrc" |
6958 and the other initializations, so that when the 'shell' option is set | |
6959 there, the 'shellpipe' option changes automatically, unless it was | |
6960 explicitly set before. | |
6961 When 'shellpipe' is set to an empty string, no redirection of the | |
6962 ":make" output will be done. This is useful if you use a 'makeprg' | |
6963 that writes to 'makeef' by itself. If you want no piping, but do | |
6964 want to include the 'makeef', set 'shellpipe' to a single space. | |
6965 Don't forget to precede the space with a backslash: ":set sp=\ ". | |
6966 In the future pipes may be used for filtering and this option will | |
6967 become obsolete (at least for Unix). | |
6968 This option cannot be set from a |modeline| or in the |sandbox|, for | |
6969 security reasons. | |
6970 | |
6971 *'shellquote'* *'shq'* | |
25084
beff72446e2e
patch 8.2.3079: Powershell core not supported by default
Bram Moolenaar <Bram@vim.org>
parents:
25068
diff
changeset
|
6972 'shellquote' 'shq' string (default: "") |
7 | 6973 global |
6974 Quoting character(s), put around the command passed to the shell, for | |
6975 the "!" and ":!" commands. The redirection is kept outside of the | |
6976 quoting. See 'shellxquote' to include the redirection. It's | |
6977 probably not useful to set both options. | |
6978 This is an empty string by default. Only known to be useful for | |
18972 | 6979 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
|
6980 Shell or bash, where it should be "\"". See |dos-shell|. |
7 | 6981 This option cannot be set from a |modeline| or in the |sandbox|, for |
6982 security reasons. | |
6983 | |
6984 *'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
|
6985 '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
|
6986 "2>&1 | Out-File -Encoding default") |
7 | 6987 global |
6988 String to be used to put the output of a filter command in a temporary | |
6989 file. See also |:!|. See |option-backslash| about including spaces | |
6990 and backslashes. | |
6991 The name of the temporary file can be represented by "%s" if necessary | |
6992 (the file name is appended automatically if no %s appears in the value | |
6993 of this option). | |
18456 | 6994 The default is ">". For Unix, if the 'shell' option is "csh" or |
6995 "tcsh" during initializations, the default becomes ">&". If the | |
18719 | 6996 '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
|
6997 "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
|
6998 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
|
6999 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
|
7000 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
|
7001 "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
|
7002 same names with ".exe" appended are checked for. |
7 | 7003 The initialization of this option is done after reading the ".vimrc" |
7004 and the other initializations, so that when the 'shell' option is set | |
7005 there, the 'shellredir' option changes automatically unless it was | |
7006 explicitly set before. | |
7007 In the future pipes may be used for filtering and this option will | |
7008 become obsolete (at least for Unix). | |
7009 This option cannot be set from a |modeline| or in the |sandbox|, for | |
7010 security reasons. | |
7011 | |
7012 *'shellslash'* *'ssl'* *'noshellslash'* *'nossl'* | |
7013 'shellslash' 'ssl' boolean (default off) | |
7014 global | |
18912
ccd16426a1f9
patch 8.2.0017: OS/2 and MS-DOS are still mentioned
Bram Moolenaar <Bram@vim.org>
parents:
18879
diff
changeset
|
7015 {only for MS-Windows} |
7 | 7016 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
|
7017 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
|
7018 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
|
7019 changed to forward slashes by Vim. |
7 | 7020 Note that setting or resetting this option has no effect for some |
7021 existing file names, thus this option needs to be set before opening | |
7022 any file for best results. This might change in the future. | |
7023 'shellslash' only works when a backslash can be used as a path | |
7024 separator. To test if this is so use: > | |
7025 if exists('+shellslash') | |
17543
77c3f6428b6c
patch 8.1.1769: 'shellslash' is also used for completion
Bram Moolenaar <Bram@vim.org>
parents:
17433
diff
changeset
|
7026 < Also see 'completeslash'. |
77c3f6428b6c
patch 8.1.1769: 'shellslash' is also used for completion
Bram Moolenaar <Bram@vim.org>
parents:
17433
diff
changeset
|
7027 |
168 | 7028 *'shelltemp'* *'stmp'* *'noshelltemp'* *'nostmp'* |
7029 'shelltemp' 'stmp' boolean (Vi default off, Vim default on) | |
7030 global | |
7031 When on, use temp files for shell commands. When off use a pipe. | |
7032 When using a pipe is not possible temp files are used anyway. | |
2965 | 7033 Currently a pipe is only supported on Unix and MS-Windows 2K and |
7034 later. You can check it with: > | |
168 | 7035 :if has("filterpipe") |
7036 < The advantage of using a pipe is that nobody can read the temp file | |
7037 and the 'shell' command does not need to support redirection. | |
7038 The advantage of using a temp file is that the file type and encoding | |
7039 can be detected. | |
7040 The |FilterReadPre|, |FilterReadPost| and |FilterWritePre|, | |
7041 |FilterWritePost| autocommands event are not triggered when | |
7042 'shelltemp' is off. | |
9533
9f921133ee90
commit https://github.com/vim/vim/commit/269f595f9eef584937e7eae70fde68cdd7da5bcf
Christian Brabandt <cb@256bit.org>
parents:
9464
diff
changeset
|
7043 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
|
7044 temp files. |
11160 | 7045 NOTE: This option is set to the Vim default value when 'compatible' |
7046 is reset. | |
168 | 7047 |
7 | 7048 *'shelltype'* *'st'* |
7049 'shelltype' 'st' number (default 0) | |
7050 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
|
7051 {only for the Amiga} |
7 | 7052 On the Amiga this option influences the way how the commands work |
7053 which use a shell. | |
7054 0 and 1: always use the shell | |
7055 2 and 3: use the shell only to filter lines | |
7056 4 and 5: use shell only for ':sh' command | |
7057 When not using the shell, the command is executed directly. | |
7058 | |
7059 0 and 2: use "shell 'shellcmdflag' cmd" to start external commands | |
7060 1 and 3: use "shell cmd" to start external commands | |
7061 | |
3371 | 7062 *'shellxescape'* *'sxe'* |
7063 'shellxescape' 'sxe' string (default: ""; | |
18972 | 7064 for MS-Windows: "\"&|<>()@^") |
3371 | 7065 global |
7066 When 'shellxquote' is set to "(" then the characters listed in this | |
7067 option will be escaped with a '^' character. This makes it possible | |
7068 to execute most external commands with cmd.exe. | |
7069 | |
7 | 7070 *'shellxquote'* *'sxq'* |
7071 'shellxquote' 'sxq' string (default: ""; | |
3359 | 7072 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
|
7073 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
|
7074 powershell.exe: "\"" |
3359 | 7075 for Win32, when 'shell' contains "sh" |
7076 somewhere: "\"" | |
7 | 7077 for Unix, when using system(): "\"") |
7078 global | |
7079 Quoting character(s), put around the command passed to the shell, for | |
7080 the "!" and ":!" commands. Includes the redirection. See | |
7081 'shellquote' to exclude the redirection. It's probably not useful | |
7082 to set both options. | |
3359 | 7083 When the value is '(' then ')' is appended. When the value is '"(' |
7084 then ')"' is appended. | |
7085 When the value is '(' then also see 'shellxescape'. | |
3352 | 7086 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
|
7087 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
|
7088 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
|
7089 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
|
7090 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
|
7091 '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
|
7092 |dos-shell|. |
7 | 7093 This option cannot be set from a |modeline| or in the |sandbox|, for |
7094 security reasons. | |
7095 | |
7096 *'shiftround'* *'sr'* *'noshiftround'* *'nosr'* | |
7097 'shiftround' 'sr' boolean (default off) | |
7098 global | |
7099 Round indent to multiple of 'shiftwidth'. Applies to > and < | |
7100 commands. CTRL-T and CTRL-D in Insert mode always round the indent to | |
7101 a multiple of 'shiftwidth' (this is Vi compatible). | |
7102 NOTE: This option is reset when 'compatible' is set. | |
7103 | |
7104 *'shiftwidth'* *'sw'* | |
7105 'shiftwidth' 'sw' number (default 8) | |
7106 local to buffer | |
10 | 7107 Number of spaces to use for each step of (auto)indent. Used for |
7 | 7108 |'cindent'|, |>>|, |<<|, etc. |
3893 | 7109 When zero the 'ts' value will be used. Use the |shiftwidth()| |
7110 function to get the effective shiftwidth value. | |
7 | 7111 |
7112 *'shortmess'* *'shm'* | |
16533
5e25171e0e75
patch 8.1.1270: cannot see current match position
Bram Moolenaar <Bram@vim.org>
parents:
16447
diff
changeset
|
7113 '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
|
7114 POSIX default: "AS") |
7 | 7115 global |
7116 This option helps to avoid all the |hit-enter| prompts caused by file | |
7117 messages, for example with CTRL-G, and to avoid some other messages. | |
7118 It is a list of flags: | |
7119 flag meaning when present ~ | |
7120 f use "(3 of 5)" instead of "(file 3 of 5)" | |
7121 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
|
7122 l use "999L, 888B" instead of "999 lines, 888 bytes" |
7 | 7123 m use "[+]" instead of "[Modified]" |
7124 n use "[New]" instead of "[New File]" | |
7125 r use "[RO]" instead of "[readonly]" | |
7126 w use "[w]" instead of "written" for file write message | |
7127 and "[a]" instead of "appended" for ':w >> file' command | |
7128 x use "[dos]" instead of "[dos format]", "[unix]" instead of | |
7129 "[unix format]" and "[mac]" instead of "[mac format]". | |
7130 a all of the above abbreviations | |
7131 | |
7132 o overwrite message for writing a file with subsequent message | |
7133 for reading a file (useful for ":wn" or when 'autowrite' on) | |
7134 O message for reading a file overwrites any previous message. | |
7135 Also for quickfix message (e.g., ":cn"). | |
7136 s don't give "search hit BOTTOM, continuing at TOP" or "search | |
16610 | 7137 hit TOP, continuing at BOTTOM" messages; when using the search |
7138 count do not show "W" after the count message (see S below) | |
7 | 7139 t truncate file message at the start if it is too long to fit |
7140 on the command-line, "<" will appear in the left most column. | |
7141 Ignored in Ex mode. | |
7142 T truncate other messages in the middle if they are too long to | |
233 | 7143 fit on the command line. "..." will appear in the middle. |
7 | 7144 Ignored in Ex mode. |
7145 W don't give "written" or "[w]" when writing a file | |
7146 A don't give the "ATTENTION" message when an existing swap file | |
7147 is found. | |
7148 I don't give the intro message when starting Vim |:intro|. | |
5946 | 7149 c don't give |ins-completion-menu| messages. For example, |
7150 "-- XXX completion (YYY)", "match 1 of 2", "The only match", | |
7151 "Pattern not found", "Back at original", etc. | |
30807
442a574ffae3
patch 9.0.0738: cannot suppress completion "scanning" messages
Bram Moolenaar <Bram@vim.org>
parents:
30643
diff
changeset
|
7152 C don't give messages while scanning for ins-completion items, |
442a574ffae3
patch 9.0.0738: cannot suppress completion "scanning" messages
Bram Moolenaar <Bram@vim.org>
parents:
30643
diff
changeset
|
7153 for instance "scanning tags" |
8560
f3c636c673f7
commit https://github.com/vim/vim/commit/426dd0219512af5f4abeb0901b533159253ffba3
Christian Brabandt <cb@256bit.org>
parents:
8497
diff
changeset
|
7154 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
|
7155 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
|
7156 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
|
7157 from autocommands |
16533
5e25171e0e75
patch 8.1.1270: cannot see current match position
Bram Moolenaar <Bram@vim.org>
parents:
16447
diff
changeset
|
7158 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
|
7159 "[1/5]" |
7 | 7160 |
7161 This gives you the opportunity to avoid that a change between buffers | |
7162 requires you to hit <Enter>, but still gives as useful a message as | |
7163 possible for the space available. To get the whole message that you | |
7164 would have got with 'shm' empty, use ":file!" | |
7165 Useful values: | |
7166 shm= No abbreviation of message. | |
7167 shm=a Abbreviation, but no loss of information. | |
7168 shm=at Abbreviation, and truncate message when necessary. | |
7169 | |
7170 NOTE: This option is set to the Vi default value when 'compatible' is | |
7171 set and to the Vim default value when 'compatible' is reset. | |
7172 | |
7173 *'shortname'* *'sn'* *'noshortname'* *'nosn'* | |
7174 'shortname' 'sn' boolean (default off) | |
7175 local to buffer | |
7176 Filenames are assumed to be 8 characters plus one extension of 3 | |
7177 characters. Multiple dots in file names are not allowed. When this | |
7178 option is on, dots in file names are replaced with underscores when | |
18972 | 7179 adding an extension (".~" or ".swp"). This option is useful |
7 | 7180 when editing files on an MS-DOS compatible filesystem, e.g., messydos |
19163 | 7181 or crossdos. |
7 | 7182 |
7183 *'showbreak'* *'sbr'* *E595* | |
7184 '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
|
7185 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
|
7186 {not available when compiled without the |+linebreak| |
7 | 7187 feature} |
7188 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
|
7189 values are "> " or "+++ ": > |
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
7190 :set showbreak=>\ |
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
7191 < 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
|
7192 this: > |
2314
233eb4412f5d
Added 'colorcolumn' option. Partly by Gregor Uhlenheuer.
Bram Moolenaar <bram@vim.org>
parents:
2302
diff
changeset
|
7193 :let &showbreak = '+++ ' |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
7194 < Only printable single-cell characters are allowed, excluding <Tab> and |
7 | 7195 comma (in a future version the comma might be used to separate the |
7196 part that is shown at the end and at the start of a line). | |
7197 The characters are highlighted according to the '@' flag in | |
7198 'highlight'. | |
7199 Note that tabs after the showbreak will be displayed differently. | |
7200 If you want the 'showbreak' to appear in between line numbers, add the | |
7201 "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
|
7202 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
|
7203 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
|
7204 :setlocal showbreak=NONE |
8b0114ffde2b
patch 8.1.2281: 'showbreak' cannot be set for one window
Bram Moolenaar <Bram@vim.org>
parents:
18526
diff
changeset
|
7205 < |
7 | 7206 *'showcmd'* *'sc'* *'noshowcmd'* *'nosc'* |
9669
284b4eb307fc
commit https://github.com/vim/vim/commit/8c08b5b569e2a9e9f63dea514591ecfa2d3bb392
Christian Brabandt <cb@256bit.org>
parents:
9665
diff
changeset
|
7207 '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
|
7208 Vi default: off, set in |defaults.vim|) |
7 | 7209 global |
1152 | 7210 Show (partial) command in the last line of the screen. Set this |
7211 option off if your terminal is slow. | |
7 | 7212 In Visual mode the size of the selected area is shown: |
7213 - 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
|
7214 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
|
7215 means two characters and six bytes. |
7 | 7216 - When selecting more than one line, the number of lines. |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
7217 - When selecting a block, the size in screen characters: |
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
7218 {lines}x{columns}. |
7 | 7219 NOTE: This option is set to the Vi default value when 'compatible' is |
7220 set and to the Vim default value when 'compatible' is reset. | |
7221 | |
7222 *'showfulltag'* *'sft'* *'noshowfulltag'* *'nosft'* | |
7223 'showfulltag' 'sft' boolean (default off) | |
7224 global | |
7225 When completing a word in insert mode (see |ins-completion|) from the | |
7226 tags file, show both the tag name and a tidied-up form of the search | |
10 | 7227 pattern (if there is one) as possible matches. Thus, if you have |
7 | 7228 matched a C function, you can see a template for what arguments are |
7229 required (coding style permitting). | |
1621 | 7230 Note that this doesn't work well together with having "longest" in |
7231 'completeopt', because the completion from the search pattern may not | |
7232 match the typed text. | |
7 | 7233 |
7234 *'showmatch'* *'sm'* *'noshowmatch'* *'nosm'* | |
7235 'showmatch' 'sm' boolean (default off) | |
7236 global | |
7237 When a bracket is inserted, briefly jump to the matching one. The | |
7238 jump is only done if the match can be seen on the screen. The time to | |
7239 show the match can be set with 'matchtime'. | |
7240 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
|
7241 seen or not). |
c590de398af9
commit https://github.com/vim/vim/commit/ca63501fbcd1cf9c8aa9ff12c093c95b62a89ed7
Christian Brabandt <cb@256bit.org>
parents:
7080
diff
changeset
|
7242 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
|
7243 reset. |
7 | 7244 When the 'm' flag is not included in 'cpoptions', typing a character |
7245 will immediately move the cursor back to where it belongs. | |
7246 See the "sm" field in 'guicursor' for setting the cursor shape and | |
7247 blinking when showing the match. | |
7248 The 'matchpairs' option can be used to specify the characters to show | |
7249 matches for. 'rightleft' and 'revins' are used to look for opposite | |
7250 matches. | |
699 | 7251 Also see the matchparen plugin for highlighting the match when moving |
7252 around |pi_paren.txt|. | |
7253 Note: Use of the short form is rated PG. | |
7 | 7254 |
7255 *'showmode'* *'smd'* *'noshowmode'* *'nosmd'* | |
7256 'showmode' 'smd' boolean (Vim default: on, Vi default: off) | |
7257 global | |
7258 If in Insert, Replace or Visual mode put a message on the last line. | |
7259 Use the 'M' flag in 'highlight' to set the type of highlighting for | |
7260 this message. | |
10 | 7261 When |XIM| may be used the message will include "XIM". But this |
7 | 7262 doesn't mean XIM is really active, especially when 'imactivatekey' is |
7263 not set. | |
7264 NOTE: This option is set to the Vi default value when 'compatible' is | |
7265 set and to the Vim default value when 'compatible' is reset. | |
7266 | |
677 | 7267 *'showtabline'* *'stal'* |
7268 'showtabline' 'stal' number (default 1) | |
7269 global | |
7270 The value of this option specifies when the line with tab page labels | |
7271 will be displayed: | |
7272 0: never | |
7273 1: only if there are at least two tab pages | |
7274 2: always | |
7275 This is both for the GUI and non-GUI implementation of the tab pages | |
7276 line. | |
7277 See |tab-page| for more information about tab pages. | |
7278 | |
7 | 7279 *'sidescroll'* *'ss'* |
7280 'sidescroll' 'ss' number (default 0) | |
7281 global | |
7282 The minimal number of columns to scroll horizontally. Used only when | |
7283 the 'wrap' option is off and the cursor is moved off of the screen. | |
7284 When it is zero the cursor will be put in the middle of the screen. | |
7285 When using a slow terminal set it to a large number or 0. When using | |
7286 a fast terminal use a small number or 1. Not used for "zh" and "zl" | |
7287 commands. | |
7288 | |
7289 *'sidescrolloff'* *'siso'* | |
7290 '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
|
7291 global or local to window |global-local| |
7 | 7292 The minimal number of screen columns to keep to the left and to the |
534 | 7293 right of the cursor if 'nowrap' is set. Setting this option to a |
7294 value greater than 0 while having |'sidescroll'| also at a non-zero | |
7295 value makes some context visible in the line you are scrolling in | |
7296 horizontally (except at beginning of the line). Setting this option | |
7297 to a large value (like 999) has the effect of keeping the cursor | |
7298 horizontally centered in the window, as long as one does not come too | |
7299 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
|
7300 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
|
7301 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
|
7302 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
|
7303 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
|
7304 < NOTE: This option is set to 0 when 'compatible' is set. |
7 | 7305 |
7306 Example: Try this together with 'sidescroll' and 'listchars' as | |
7307 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
|
7308 onto the "extends" character: > |
7 | 7309 |
7310 :set nowrap sidescroll=1 listchars=extends:>,precedes:< | |
7311 :set sidescrolloff=1 | |
9852
4eea48b76d03
commit https://github.com/vim/vim/commit/95ec9d6a6ab3117d60ff638670a803d43974ba51
Christian Brabandt <cb@256bit.org>
parents:
9737
diff
changeset
|
7312 < |
4eea48b76d03
commit https://github.com/vim/vim/commit/95ec9d6a6ab3117d60ff638670a803d43974ba51
Christian Brabandt <cb@256bit.org>
parents:
9737
diff
changeset
|
7313 *'signcolumn'* *'scl'* |
4eea48b76d03
commit https://github.com/vim/vim/commit/95ec9d6a6ab3117d60ff638670a803d43974ba51
Christian Brabandt <cb@256bit.org>
parents:
9737
diff
changeset
|
7314 'signcolumn' 'scl' string (default "auto") |
4eea48b76d03
commit https://github.com/vim/vim/commit/95ec9d6a6ab3117d60ff638670a803d43974ba51
Christian Brabandt <cb@256bit.org>
parents:
9737
diff
changeset
|
7315 local to window |
4eea48b76d03
commit https://github.com/vim/vim/commit/95ec9d6a6ab3117d60ff638670a803d43974ba51
Christian Brabandt <cb@256bit.org>
parents:
9737
diff
changeset
|
7316 {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
|
7317 feature} |
9860
9eaf8ef656e9
commit https://github.com/vim/vim/commit/0952131376a517fc12dc5ae908a97018b4ee23f0
Christian Brabandt <cb@256bit.org>
parents:
9852
diff
changeset
|
7318 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
|
7319 "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
|
7320 "no" never |
9eaf8ef656e9
commit https://github.com/vim/vim/commit/0952131376a517fc12dc5ae908a97018b4ee23f0
Christian Brabandt <cb@256bit.org>
parents:
9852
diff
changeset
|
7321 "yes" always |
17129
4fb68abc770f
patch 8.1.1564: sign column takes up space
Bram Moolenaar <Bram@vim.org>
parents:
16808
diff
changeset
|
7322 "number" display signs in the 'number' column. If the number |
17161 | 7323 column is not present, then behaves like "auto". |
7 | 7324 |
7325 | |
7326 *'smartcase'* *'scs'* *'nosmartcase'* *'noscs'* | |
7327 'smartcase' 'scs' boolean (default off) | |
7328 global | |
7329 Override the 'ignorecase' option if the search pattern contains upper | |
7330 case characters. Only used when the search pattern is typed and | |
7331 'ignorecase' option is on. Used for the commands "/", "?", "n", "N", | |
3557 | 7332 ":g" and ":s". Not used for "*", "#", "gd", tag search, etc. After |
7 | 7333 "*" and "#" you can make 'smartcase' used by doing a "/" command, |
7334 recalling the search pattern from history and hitting <Enter>. | |
7335 NOTE: This option is reset when 'compatible' is set. | |
7336 | |
7337 *'smartindent'* *'si'* *'nosmartindent'* *'nosi'* | |
7338 'smartindent' 'si' boolean (default off) | |
7339 local to buffer | |
7340 Do smart autoindenting when starting a new line. Works for C-like | |
7341 programs, but can also be used for other languages. 'cindent' does | |
7342 something like this, works better in most cases, but is more strict, | |
2662 | 7343 see |C-indenting|. When 'cindent' is on or 'indentexpr' is set, |
2642 | 7344 setting 'si' has no effect. 'indentexpr' is a more advanced |
7345 alternative. | |
7 | 7346 Normally 'autoindent' should also be on when using 'smartindent'. |
7347 An indent is automatically inserted: | |
7348 - After a line ending in '{'. | |
7349 - After a line starting with a keyword from 'cinwords'. | |
7350 - Before a line starting with '}' (only with the "O" command). | |
7351 When typing '}' as the first character in a new line, that line is | |
7352 given the same indent as the matching '{'. | |
7353 When typing '#' as the first character in a new line, the indent for | |
7354 that line is removed, the '#' is put in the first column. The indent | |
10 | 7355 is restored for the next line. If you don't want this, use this |
7 | 7356 mapping: ":inoremap # X^H#", where ^H is entered with CTRL-V CTRL-H. |
7357 When using the ">>" command, lines starting with '#' are not shifted | |
7358 right. | |
11160 | 7359 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
|
7360 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
|
7361 reset. |
7 | 7362 |
7363 *'smarttab'* *'sta'* *'nosmarttab'* *'nosta'* | |
7364 'smarttab' 'sta' boolean (default off) | |
7365 global | |
7366 When on, a <Tab> in front of a line inserts blanks according to | |
648 | 7367 'shiftwidth'. 'tabstop' or 'softtabstop' is used in other places. A |
7368 <BS> will delete a 'shiftwidth' worth of space at the start of the | |
7369 line. | |
650 | 7370 When off, a <Tab> always inserts blanks according to 'tabstop' or |
648 | 7371 'softtabstop'. 'shiftwidth' is only used for shifting text left or |
7372 right |shift-left-right|. | |
1263 | 7373 What gets inserted (a <Tab> or spaces) depends on the 'expandtab' |
7 | 7374 option. Also see |ins-expandtab|. When 'expandtab' is not set, the |
11 | 7375 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
|
7376 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
|
7377 reset. |
7 | 7378 NOTE: This option is reset when 'compatible' is set. |
7379 | |
30610
6c6ac189a05f
patch 9.0.0640: cannot scroll by screen line if a line wraps
Bram Moolenaar <Bram@vim.org>
parents:
30598
diff
changeset
|
7380 *'smoothscroll'* *'sms'* *'nosmoothscroll'* *'nosms'* |
6c6ac189a05f
patch 9.0.0640: cannot scroll by screen line if a line wraps
Bram Moolenaar <Bram@vim.org>
parents:
30598
diff
changeset
|
7381 'smoothscroll' 'sms' boolean (default off) |
6c6ac189a05f
patch 9.0.0640: cannot scroll by screen line if a line wraps
Bram Moolenaar <Bram@vim.org>
parents:
30598
diff
changeset
|
7382 local to window |
6c6ac189a05f
patch 9.0.0640: cannot scroll by screen line if a line wraps
Bram Moolenaar <Bram@vim.org>
parents:
30598
diff
changeset
|
7383 Scrolling works with screen lines. When 'wrap' is set and the first |
6c6ac189a05f
patch 9.0.0640: cannot scroll by screen line if a line wraps
Bram Moolenaar <Bram@vim.org>
parents:
30598
diff
changeset
|
7384 line in the window wraps part of it may not be visible, as if it is |
30634 | 7385 above the window. "<<<" is displayed at the start of the first line, |
7386 highlighted with |hl-NonText|. | |
7387 NOTE: only partly implemented, currently works with CTRL-E, CTRL-Y | |
7388 and scrolling with the mouse. | |
30610
6c6ac189a05f
patch 9.0.0640: cannot scroll by screen line if a line wraps
Bram Moolenaar <Bram@vim.org>
parents:
30598
diff
changeset
|
7389 |
7 | 7390 *'softtabstop'* *'sts'* |
7391 'softtabstop' 'sts' number (default 0) | |
7392 local to buffer | |
7393 Number of spaces that a <Tab> counts for while performing editing | |
7394 operations, like inserting a <Tab> or using <BS>. It "feels" like | |
7395 <Tab>s are being inserted, while in fact a mix of spaces and <Tab>s is | |
7396 used. This is useful to keep the 'ts' setting at its standard value | |
7397 of 8, while being able to edit like it is set to 'sts'. However, | |
7398 commands like "x" still work on the actual characters. | |
7399 When 'sts' is zero, this feature is off. | |
3893 | 7400 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
|
7401 '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
|
7402 when 'paste' is reset. |
7 | 7403 See also |ins-expandtab|. When 'expandtab' is not set, the number of |
7404 spaces is minimized by using <Tab>s. | |
7405 The 'L' flag in 'cpoptions' changes how tabs are used when 'list' is | |
7406 set. | |
7407 NOTE: This option is set to 0 when 'compatible' is set. | |
7408 | |
14175
2ad722003b36
patch 8.1.0105: all tab stops are the same
Christian Brabandt <cb@256bit.org>
parents:
14019
diff
changeset
|
7409 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
|
7410 '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
|
7411 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
|
7412 |
221 | 7413 *'spell'* *'nospell'* |
7414 'spell' boolean (default off) | |
7415 local to window | |
7416 {not available when compiled without the |+syntax| | |
7417 feature} | |
7418 When on spell checking will be done. See |spell|. | |
236 | 7419 The languages are specified with 'spelllang'. |
221 | 7420 |
386 | 7421 *'spellcapcheck'* *'spc'* |
389 | 7422 'spellcapcheck' 'spc' string (default "[.?!]\_[\])'" \t]\+") |
386 | 7423 local to buffer |
7424 {not available when compiled without the |+syntax| | |
7425 feature} | |
7426 Pattern to locate the end of a sentence. The following word will be | |
7427 checked to start with a capital letter. If not then it is highlighted | |
484 | 7428 with SpellCap |hl-SpellCap| (unless the word is also badly spelled). |
386 | 7429 When this check is not wanted make this option empty. |
7430 Only used when 'spell' is set. | |
389 | 7431 Be careful with special characters, see |option-backslash| about |
7432 including spaces and backslashes. | |
480 | 7433 To set this option automatically depending on the language, see |
7434 |set-spc-auto|. | |
386 | 7435 |
314 | 7436 *'spellfile'* *'spf'* |
7437 'spellfile' 'spf' string (default empty) | |
7438 local to buffer | |
7439 {not available when compiled without the |+syntax| | |
7440 feature} | |
7441 Name of the word list file where words are added for the |zg| and |zw| | |
401 | 7442 commands. It must end in ".{encoding}.add". You need to include the |
7443 path, otherwise the file is placed in the current directory. | |
29659 | 7444 The path may include characters from 'isfname', space, comma and '@'. |
386 | 7445 *E765* |
28379 | 7446 It may also be a comma-separated list of names. A count before the |
386 | 7447 |zg| and |zw| commands can be used to access each. This allows using |
7448 a personal word list file and a project word list file. | |
314 | 7449 When a word is added while this option is empty Vim will set it for |
819 | 7450 you: Using the first directory in 'runtimepath' that is writable. If |
7451 there is no "spell" directory yet it will be created. For the file | |
7452 name the first language name that appears in 'spelllang' is used, | |
353 | 7453 ignoring the region. |
7454 The resulting ".spl" file will be used for spell checking, it does not | |
7455 have to appear in 'spelllang'. | |
7456 Normally one file is used for all regions, but you can add the region | |
7457 name if you want to. However, it will then only be used when | |
7458 'spellfile' is set to it, for entries in 'spelllang' only files | |
7459 without region name will be found. | |
336 | 7460 This option cannot be set from a |modeline| or in the |sandbox|, for |
7461 security reasons. | |
314 | 7462 |
221 | 7463 *'spelllang'* *'spl'* |
314 | 7464 'spelllang' 'spl' string (default "en") |
221 | 7465 local to buffer |
7466 {not available when compiled without the |+syntax| | |
7467 feature} | |
28379 | 7468 A comma-separated list of word list names. When the 'spell' option is |
353 | 7469 on spellchecking will be done for these languages. Example: > |
7470 set spelllang=en_us,nl,medical | |
7471 < This means US English, Dutch and medical words are recognized. Words | |
7472 that are not recognized will be highlighted. | |
16380 | 7473 The word list name must consist of alphanumeric characters, a dash or |
7474 an underscore. It should not include a comma or dot. Using a dash is | |
353 | 7475 recommended to separate the two letter language name from a |
7476 specification. Thus "en-rare" is used for rare English words. | |
7477 A region name must come last and have the form "_xx", where "xx" is | |
7478 the two-letter, lower case region name. You can use more than one | |
7479 region by listing them: "en_us,en_ca" supports both US and Canadian | |
7480 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
|
7481 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
|
7482 en_ca, en_gb and en_us). |
5477 | 7483 If the name "cjk" is included East Asian characters are excluded from |
7484 spell checking. This is useful when editing text that also has Asian | |
7485 words. | |
25773 | 7486 Note that the "medical" dictionary does not exist, it is just an |
7487 example of a longer name. | |
484 | 7488 *E757* |
419 | 7489 As a special case the name of a .spl file can be given as-is. The |
7490 first "_xx" in the name is removed and used as the region name | |
7491 (_xx is an underscore, two letters and followed by a non-letter). | |
7492 This is mainly for testing purposes. You must make sure the correct | |
7493 encoding is used, Vim doesn't check it. | |
236 | 7494 When 'encoding' is set the word lists are reloaded. Thus it's a good |
419 | 7495 idea to set 'spelllang' after setting 'encoding' to avoid loading the |
7496 files twice. | |
353 | 7497 How the related spell files are found is explained here: |spell-load|. |
221 | 7498 |
653 | 7499 If the |spellfile.vim| plugin is active and you use a language name |
7500 for which Vim cannot find the .spl file in 'runtimepath' the plugin | |
7501 will ask you if you want to download the file. | |
7502 | |
480 | 7503 After this option has been set successfully, Vim will source the files |
7504 "spell/LANG.vim" in 'runtimepath'. "LANG" is the value of 'spelllang' | |
15068 | 7505 up to the first character that is not an ASCII letter or number and |
7506 not a dash. Also see |set-spc-auto|. | |
480 | 7507 |
20802
ed00f0fbdaef
patch 8.2.0953: spell checking doesn't work for CamelCased words
Bram Moolenaar <Bram@vim.org>
parents:
20758
diff
changeset
|
7508 *'spelloptions'* *'spo'* |
ed00f0fbdaef
patch 8.2.0953: spell checking doesn't work for CamelCased words
Bram Moolenaar <Bram@vim.org>
parents:
20758
diff
changeset
|
7509 '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
|
7510 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
|
7511 {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
|
7512 feature} |
28379 | 7513 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
|
7514 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
|
7515 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
|
7516 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
|
7517 start of a new word. |
480 | 7518 |
344 | 7519 *'spellsuggest'* *'sps'* |
7520 'spellsuggest' 'sps' string (default "best") | |
7521 global | |
7522 {not available when compiled without the |+syntax| | |
7523 feature} | |
593 | 7524 Methods used for spelling suggestions. Both for the |z=| command and |
374 | 7525 the |spellsuggest()| function. This is a comma-separated list of |
7526 items: | |
7527 | |
7528 best Internal method that works best for English. Finds | |
7529 changes like "fast" and uses a bit of sound-a-like | |
7530 scoring to improve the ordering. | |
7531 | |
7532 double Internal method that uses two methods and mixes the | |
7533 results. The first method is "fast", the other method | |
344 | 7534 computes how much the suggestion sounds like the bad |
374 | 7535 word. That only works when the language specifies |
7536 sound folding. Can be slow and doesn't always give | |
7537 better results. | |
7538 | |
7539 fast Internal method that only checks for simple changes: | |
7540 character inserts/deletes/swaps. Works well for | |
7541 simple typing mistakes. | |
7542 | |
593 | 7543 {number} The maximum number of suggestions listed for |z=|. |
484 | 7544 Not used for |spellsuggest()|. The number of |
7545 suggestions is never more than the value of 'lines' | |
7546 minus two. | |
7547 | |
27441
674240fcf6de
patch 8.2.4249: the timeout limit for spell suggestions is always 5000
Bram Moolenaar <Bram@vim.org>
parents:
27321
diff
changeset
|
7548 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
|
7549 {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
|
7550 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
|
7551 negative there is no limit. {only works when built |
29290 | 7552 with the |+reltime| feature} |
27441
674240fcf6de
patch 8.2.4249: the timeout limit for spell suggestions is always 5000
Bram Moolenaar <Bram@vim.org>
parents:
27321
diff
changeset
|
7553 |
374 | 7554 file:{filename} Read file {filename}, which must have two columns, |
7555 separated by a slash. The first column contains the | |
7556 bad word, the second column the suggested good word. | |
7557 Example: | |
7558 theribal/terrible ~ | |
7559 Use this for common mistakes that do not appear at the | |
7560 top of the suggestion list with the internal methods. | |
7561 Lines without a slash are ignored, use this for | |
7562 comments. | |
5862 | 7563 The word in the second column must be correct, |
7564 otherwise it will not be used. Add the word to an | |
7565 ".add" file if it is currently flagged as a spelling | |
7566 mistake. | |
374 | 7567 The file is used for all languages. |
7568 | |
7569 expr:{expr} Evaluate expression {expr}. Use a function to avoid | |
30598
37aa9fd2ed72
patch 9.0.0634: evaluating "expr" options has more overhead than needed
Bram Moolenaar <Bram@vim.org>
parents:
30547
diff
changeset
|
7570 trouble with spaces. Best is to call a function |
37aa9fd2ed72
patch 9.0.0634: evaluating "expr" options has more overhead than needed
Bram Moolenaar <Bram@vim.org>
parents:
30547
diff
changeset
|
7571 without arguments, see |expr-option-function|. |
37aa9fd2ed72
patch 9.0.0634: evaluating "expr" options has more overhead than needed
Bram Moolenaar <Bram@vim.org>
parents:
30547
diff
changeset
|
7572 |v:val| holds the badly spelled word. The expression |
37aa9fd2ed72
patch 9.0.0634: evaluating "expr" options has more overhead than needed
Bram Moolenaar <Bram@vim.org>
parents:
30547
diff
changeset
|
7573 must evaluate to a List of Lists, each with a |
37aa9fd2ed72
patch 9.0.0634: evaluating "expr" options has more overhead than needed
Bram Moolenaar <Bram@vim.org>
parents:
30547
diff
changeset
|
7574 suggestion and a score. |
374 | 7575 Example: |
11062 | 7576 [['the', 33], ['that', 44]] ~ |
593 | 7577 Set 'verbose' and use |z=| to see the scores that the |
374 | 7578 internal methods use. A lower score is better. |
7579 This may invoke |spellsuggest()| if you temporarily | |
7580 set 'spellsuggest' to exclude the "expr:" part. | |
7581 Errors are silently ignored, unless you set the | |
7582 'verbose' option to a non-zero value. | |
7583 | |
7584 Only one of "best", "double" or "fast" may be used. The others may | |
7585 appear several times in any order. Example: > | |
7586 :set sps=file:~/.vim/sugg,best,expr:MySuggest() | |
7587 < | |
7588 This option cannot be set from a |modeline| or in the |sandbox|, for | |
7589 security reasons. | |
344 | 7590 |
7591 | |
7 | 7592 *'splitbelow'* *'sb'* *'nosplitbelow'* *'nosb'* |
7593 'splitbelow' 'sb' boolean (default off) | |
7594 global | |
7595 When on, splitting a window will put the new window below the current | |
7596 one. |:split| | |
7597 | |
30875 | 7598 *'splitkeep'* *'spk'* |
30624
f2f35161d75a
patch 9.0.0647: the 'splitscroll' option is not a good name
Bram Moolenaar <Bram@vim.org>
parents:
30610
diff
changeset
|
7599 'splitkeep' 'spk' string (default "cursor") |
f2f35161d75a
patch 9.0.0647: the 'splitscroll' option is not a good name
Bram Moolenaar <Bram@vim.org>
parents:
30610
diff
changeset
|
7600 global |
f2f35161d75a
patch 9.0.0647: the 'splitscroll' option is not a good name
Bram Moolenaar <Bram@vim.org>
parents:
30610
diff
changeset
|
7601 The value of this option determines the scroll behavior when opening, |
f2f35161d75a
patch 9.0.0647: the 'splitscroll' option is not a good name
Bram Moolenaar <Bram@vim.org>
parents:
30610
diff
changeset
|
7602 closing or resizing horizontal splits. |
f2f35161d75a
patch 9.0.0647: the 'splitscroll' option is not a good name
Bram Moolenaar <Bram@vim.org>
parents:
30610
diff
changeset
|
7603 |
f2f35161d75a
patch 9.0.0647: the 'splitscroll' option is not a good name
Bram Moolenaar <Bram@vim.org>
parents:
30610
diff
changeset
|
7604 Possible values are: |
f2f35161d75a
patch 9.0.0647: the 'splitscroll' option is not a good name
Bram Moolenaar <Bram@vim.org>
parents:
30610
diff
changeset
|
7605 cursor Keep the same relative cursor position. |
f2f35161d75a
patch 9.0.0647: the 'splitscroll' option is not a good name
Bram Moolenaar <Bram@vim.org>
parents:
30610
diff
changeset
|
7606 screen Keep the text on the same screen line. |
f2f35161d75a
patch 9.0.0647: the 'splitscroll' option is not a good name
Bram Moolenaar <Bram@vim.org>
parents:
30610
diff
changeset
|
7607 topline Keep the topline the same. |
f2f35161d75a
patch 9.0.0647: the 'splitscroll' option is not a good name
Bram Moolenaar <Bram@vim.org>
parents:
30610
diff
changeset
|
7608 |
f2f35161d75a
patch 9.0.0647: the 'splitscroll' option is not a good name
Bram Moolenaar <Bram@vim.org>
parents:
30610
diff
changeset
|
7609 For the "screen" and "topline" values, the cursor position will be |
f2f35161d75a
patch 9.0.0647: the 'splitscroll' option is not a good name
Bram Moolenaar <Bram@vim.org>
parents:
30610
diff
changeset
|
7610 changed when necessary. In this case, the jumplist will be populated |
f2f35161d75a
patch 9.0.0647: the 'splitscroll' option is not a good name
Bram Moolenaar <Bram@vim.org>
parents:
30610
diff
changeset
|
7611 with the previous cursor position. For "screen", the text cannot always |
30875 | 7612 be kept on the same screen line when 'wrap' is enabled. |
30624
f2f35161d75a
patch 9.0.0647: the 'splitscroll' option is not a good name
Bram Moolenaar <Bram@vim.org>
parents:
30610
diff
changeset
|
7613 |
7 | 7614 *'splitright'* *'spr'* *'nosplitright'* *'nospr'* |
7615 'splitright' 'spr' boolean (default off) | |
7616 global | |
7617 When on, splitting a window will put the new window right of the | |
7618 current one. |:vsplit| | |
7619 | |
7620 *'startofline'* *'sol'* *'nostartofline'* *'nosol'* | |
7621 'startofline' 'sol' boolean (default on) | |
7622 global | |
7623 When "on" the commands listed below move the cursor to the first | |
11 | 7624 non-blank of the line. When off the cursor is kept in the same column |
10 | 7625 (if possible). This applies to the commands: CTRL-D, CTRL-U, CTRL-B, |
11 | 7626 CTRL-F, "G", "H", "M", "L", gg, and to the commands "d", "<<" and ">>" |
7 | 7627 with a linewise operator, with "%" with a count and to buffer changing |
7628 commands (CTRL-^, :bnext, :bNext, etc.). Also for an Ex command that | |
7629 only has a line number, e.g., ":25" or ":+". | |
7630 In case of buffer changing commands the cursor is placed at the column | |
7631 where it was the last time the buffer was edited. | |
7632 NOTE: This option is set when 'compatible' is set. | |
7633 | |
2709 | 7634 *'statusline'* *'stl'* *E540* *E542* |
7 | 7635 'statusline' 'stl' string (default empty) |
40 | 7636 global or local to window |global-local| |
7 | 7637 {not available when compiled without the |+statusline| |
7638 feature} | |
27804 | 7639 When non-empty, this option determines the content of the status line. |
7 | 7640 Also see |status-line|. |
7641 | |
7642 The option consists of printf style '%' items interspersed with | |
7643 normal text. Each status line item is of the form: | |
7644 %-0{minwid}.{maxwid}{item} | |
7876
93f747af7b58
commit https://github.com/vim/vim/commit/5e9b2fa9bb0e6061cf18457c173cd141a5dc9c92
Christian Brabandt <cb@256bit.org>
parents:
7687
diff
changeset
|
7645 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
|
7646 be given as "%%". |
7 | 7647 |
680 | 7648 When the option starts with "%!" then it is used as an expression, |
7649 evaluated and the result is used as the option value. Example: > | |
7650 :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
|
7651 < 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
|
7652 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
|
7653 The result can contain %{} items that will be evaluated too. |
3445 | 7654 Note that the "%!" expression is evaluated in the context of the |
7655 current window and buffer, while %{} items are evaluated in the | |
7656 context of the window that the statusline belongs to. | |
680 | 7657 |
7658 When there is error while evaluating the option then it will be made | |
7659 empty to avoid further errors. Otherwise screen updating would loop. | |
7660 | |
7 | 7661 Note that the only effect of 'ruler' when this option is set (and |
7662 'laststatus' is 2) is controlling the output of |CTRL-G|. | |
7663 | |
7664 field meaning ~ | |
233 | 7665 - Left justify the item. The default is right justified |
7 | 7666 when minwid is larger than the length of the item. |
233 | 7667 0 Leading zeroes in numeric items. Overridden by '-'. |
7 | 7668 minwid Minimum width of the item, padding as set by '-' & '0'. |
7669 Value must be 50 or less. | |
10 | 7670 maxwid Maximum width of the item. Truncation occurs with a '<' |
7 | 7671 on the left for text items. Numeric items will be |
7672 shifted down to maxwid-2 digits followed by '>'number | |
7673 where number is the amount of missing digits, much like | |
7674 an exponential notation. | |
7675 item A one letter code as described below. | |
7676 | |
7677 Following is a description of the possible statusline items. The | |
7678 second character in "item" is the type: | |
7679 N for number | |
7680 S for string | |
7681 F for flags as described below | |
7682 - not applicable | |
7683 | |
7684 item meaning ~ | |
1152 | 7685 f S Path to the file in the buffer, as typed or relative to current |
7686 directory. | |
7 | 7687 F S Full path to the file in the buffer. |
7688 t S File name (tail) of file in the buffer. | |
1698 | 7689 m F Modified flag, text is "[+]"; "[-]" if 'modifiable' is off. |
7 | 7690 M F Modified flag, text is ",+" or ",-". |
1698 | 7691 r F Readonly flag, text is "[RO]". |
7 | 7692 R F Readonly flag, text is ",RO". |
1698 | 7693 h F Help buffer flag, text is "[help]". |
7 | 7694 H F Help buffer flag, text is ",HLP". |
1698 | 7695 w F Preview window flag, text is "[Preview]". |
7 | 7696 W F Preview window flag, text is ",PRV". |
1698 | 7697 y F Type of file in the buffer, e.g., "[vim]". See 'filetype'. |
7 | 7698 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
|
7699 q S "[Quickfix List]", "[Location List]" or empty. |
7 | 7700 k S Value of "b:keymap_name" or 'keymap' when |:lmap| mappings are |
7701 being used: "<keymap>" | |
7702 n N Buffer number. | |
2709 | 7703 b N Value of character under cursor. |
7 | 7704 B N As above, in hexadecimal. |
7705 o N Byte number in file of byte under cursor, first byte is 1. | |
7706 Mnemonic: Offset from start of file (with one added) | |
7707 {not available when compiled without |+byte_offset| feature} | |
7708 O N As above, in hexadecimal. | |
233 | 7709 N N Printer page number. (Only works in the 'printheader' option.) |
7 | 7710 l N Line number. |
7711 L N Number of lines in buffer. | |
22328 | 7712 c N Column number (byte index). |
7713 v N Virtual column number (screen column). | |
10 | 7714 V N Virtual column number as -{num}. Not displayed if equal to 'c'. |
7 | 7715 p N Percentage through file in lines as in |CTRL-G|. |
7716 P S Percentage through file of displayed window. This is like the | |
5055 | 7717 percentage described for 'ruler'. Always 3 in length, unless |
7718 translated. | |
233 | 7719 a S Argument list status as in default title. ({current} of {max}) |
7 | 7720 Empty if the argument file count is zero or one. |
680 | 7721 { 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
|
7722 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
|
7723 expression cannot contain a '}' character, call a function to |
18719 | 7724 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
|
7725 {% - 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
|
7726 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
|
7727 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
|
7728 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
|
7729 expression is denoted by %}. |
25973 | 7730 For example: > |
24630
4cf4d7a71fac
patch 8.2.2854: custom statusline cannot contain % items
Bram Moolenaar <Bram@vim.org>
parents:
24600
diff
changeset
|
7731 func! Stl_filename() abort |
4cf4d7a71fac
patch 8.2.2854: custom statusline cannot contain % items
Bram Moolenaar <Bram@vim.org>
parents:
24600
diff
changeset
|
7732 return "%t" |
4cf4d7a71fac
patch 8.2.2854: custom statusline cannot contain % items
Bram Moolenaar <Bram@vim.org>
parents:
24600
diff
changeset
|
7733 endfunc |
4cf4d7a71fac
patch 8.2.2854: custom statusline cannot contain % items
Bram Moolenaar <Bram@vim.org>
parents:
24600
diff
changeset
|
7734 < `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
|
7735 `stl=%{%Stl_filename()%}` results in `"Name of current file"` |
25973 | 7736 %} - End of `{%` expression |
7 | 7737 ( - Start of item group. Can be used for setting the width and |
7738 alignment of a section. Must be followed by %) somewhere. | |
7739 ) - End of item group. No width fields allowed. | |
681 | 7740 T N For 'tabline': start of tab page N label. Use %T after the last |
7741 label. This information is used for mouse clicks. | |
7742 X N For 'tabline': start of close tab N label. Use %X after the | |
7743 label, e.g.: %3Xclose%X. Use %999X for a "close current tab" | |
7744 mark. This information is used for mouse clicks. | |
7 | 7745 < - Where to truncate line if too long. Default is at the start. |
7746 No width fields allowed. | |
7747 = - Separation point between left and right aligned items. | |
7748 No width fields allowed. | |
680 | 7749 # - Set highlight group. The name must follow and then a # again. |
7750 Thus use %#HLname# for highlight group HLname. The same | |
7751 highlighting is used, also for the statusline of non-current | |
7752 windows. | |
7 | 7753 * - Set highlight group to User{N}, where {N} is taken from the |
233 | 7754 minwid field, e.g. %1*. Restore normal highlight with %* or %0*. |
7 | 7755 The difference between User{N} and StatusLine will be applied |
7756 to StatusLineNC for the statusline of non-current windows. | |
7757 The number N must be between 1 and 9. See |hl-User1..9| | |
7758 | |
1698 | 7759 When displaying a flag, Vim removes the leading comma, if any, when |
7760 that flag comes right after plaintext. This will make a nice display | |
7761 when flags are used like in the examples below. | |
7 | 7762 |
233 | 7763 When all items in a group becomes an empty string (i.e. flags that are |
7 | 7764 not set) and a minwid is not set for the group, the whole group will |
7765 become empty. This will make a group like the following disappear | |
7766 completely from the statusline when none of the flags are set. > | |
7767 :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
|
7768 < 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
|
7769 line is displayed. |
18719 | 7770 *stl-%{* *g:actual_curbuf* *g:actual_curwin* |
19163 | 7771 While evaluating %{} the current buffer and current window will be set |
7772 temporarily to that of the window (and buffer) whose statusline is | |
18719 | 7773 currently being drawn. The expression will evaluate in this context. |
7774 The variable "g:actual_curbuf" is set to the `bufnr()` number of the | |
7775 real current buffer and "g:actual_curwin" to the |window-ID| of the | |
7776 real current window. These values are strings. | |
634 | 7777 |
3682 | 7778 The 'statusline' option will be evaluated in the |sandbox| if set from |
7779 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
|
7780 This option cannot be set in a modeline when 'modelineexpr' is off. |
634 | 7781 |
7782 It is not allowed to change text or jump to another window while | |
7783 evaluating 'statusline' |textlock|. | |
7 | 7784 |
7785 If the statusline is not updated when you want it (e.g., after setting | |
7786 a variable that's used in an expression), you can force an update by | |
29066 | 7787 using `:redrawstatus`. |
7788 | |
7789 A result of all digits is regarded a number for display purposes. | |
7 | 7790 Otherwise the result is taken as flag text and applied to the rules |
7791 described above. | |
7792 | |
199 | 7793 Watch out for errors in expressions. They may render Vim unusable! |
7 | 7794 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
|
7795 edit your .vimrc or whatever with "vim --clean" to get it right. |
7 | 7796 |
7797 Examples: | |
7798 Emulate standard status line with 'ruler' set > | |
7799 :set statusline=%<%f\ %h%m%r%=%-14.(%l,%c%V%)\ %P | |
7800 < Similar, but add ASCII value of char under the cursor (like "ga") > | |
7801 :set statusline=%<%f%h%m%r%=%b\ 0x%B\ \ %l,%c%V\ %P | |
7802 < Display byte count and byte value, modified flag in red. > | |
7803 :set statusline=%<%f%=\ [%1*%M%*%n%R%H]\ %-19(%3l,%02c%03V%)%O'%02b' | |
7804 :hi User1 term=inverse,bold cterm=inverse,bold ctermfg=red | |
7805 < Display a ,GZ flag if a compressed file is loaded > | |
7806 :set statusline=...%r%{VarExists('b:gzflag','\ [GZ]')}%h... | |
7807 < In the |:autocmd|'s: > | |
7808 :let b:gzflag = 1 | |
7809 < And: > | |
7810 :unlet b:gzflag | |
7811 < And define this function: > | |
7812 :function VarExists(var, val) | |
7813 : if exists(a:var) | return a:val | else | return '' | endif | |
7814 :endfunction | |
7815 < | |
7816 *'suffixes'* *'su'* | |
7817 'suffixes' 'su' string (default ".bak,~,.o,.h,.info,.swp,.obj") | |
7818 global | |
7819 Files with these suffixes get a lower priority when multiple files | |
7820 match a wildcard. See |suffixes|. Commas can be used to separate the | |
10 | 7821 suffixes. Spaces after the comma are ignored. A dot is also seen as |
7822 the start of a suffix. To avoid a dot or comma being recognized as a | |
7 | 7823 separator, precede it with a backslash (see |option-backslash| about |
7824 including spaces and backslashes). | |
7825 See 'wildignore' for completely ignoring files. | |
7826 The use of |:set+=| and |:set-=| is preferred when adding or removing | |
7827 suffixes from the list. This avoids problems when a future version | |
7828 uses another default. | |
7829 | |
7830 *'suffixesadd'* *'sua'* | |
7831 'suffixesadd' 'sua' string (default "") | |
7832 local to buffer | |
28379 | 7833 Comma-separated list of suffixes, which are used when searching for a |
7 | 7834 file for the "gf", "[I", etc. commands. Example: > |
7835 :set suffixesadd=.java | |
7836 < | |
7837 *'swapfile'* *'swf'* *'noswapfile'* *'noswf'* | |
7838 'swapfile' 'swf' boolean (default on) | |
7839 local to buffer | |
10 | 7840 Use a swapfile for the buffer. This option can be reset when a |
7 | 7841 swapfile is not wanted for a specific buffer. For example, with |
7842 confidential information that even root must not be able to access. | |
7843 Careful: All text will be in memory: | |
7844 - Don't use this for big files. | |
7845 - Recovery will be impossible! | |
7846 A swapfile will only be present when |'updatecount'| is non-zero and | |
7847 'swapfile' is set. | |
7848 When 'swapfile' is reset, the swap file for the current buffer is | |
7849 immediately deleted. When 'swapfile' is set, and 'updatecount' is | |
7850 non-zero, a swap file is immediately created. | |
7851 Also see |swap-file| and |'swapsync'|. | |
5763 | 7852 If you want to open a new buffer without creating a swap file for it, |
7853 use the |:noswapfile| modifier. | |
13341
acd7eaa13d2b
Updated runtime files.
Christian Brabandt <cb@256bit.org>
parents:
13314
diff
changeset
|
7854 See 'directory' for where the swap file is created. |
7 | 7855 |
7856 This option is used together with 'bufhidden' and 'buftype' to | |
7857 specify special kinds of buffers. See |special-buffers|. | |
7858 | |
7859 *'swapsync'* *'sws'* | |
7860 'swapsync' 'sws' string (default "fsync") | |
7861 global | |
7862 When this option is not empty a swap file is synced to disk after | |
10 | 7863 writing to it. This takes some time, especially on busy unix systems. |
7 | 7864 When this option is empty parts of the swap file may be in memory and |
7865 not written to disk. When the system crashes you may lose more work. | |
7866 On Unix the system does a sync now and then without Vim asking for it, | |
7867 so the disadvantage of setting this option off is small. On some | |
7868 systems the swap file will not be written at all. For a unix system | |
7869 setting it to "sync" will use the sync() call instead of the default | |
7870 fsync(), which may work better on some systems. | |
36 | 7871 The 'fsync' option is used for the actual file. |
7 | 7872 |
7873 *'switchbuf'* *'swb'* | |
7874 'switchbuf' 'swb' string (default "") | |
7875 global | |
7876 This option controls the behavior when switching between buffers. | |
24751 | 7877 Mostly for |quickfix| commands some values are also used for other |
7878 commands, as mentioned below. | |
28379 | 7879 Possible values (comma-separated list): |
7 | 7880 useopen If included, jump to the first open window that |
7881 contains the specified buffer (if there is one). | |
7882 Otherwise: Do not examine other windows. | |
7883 This setting is checked with |quickfix| commands, when | |
7884 jumping to errors (":cc", ":cn", "cp", etc.). It is | |
7885 also used in all buffer related split commands, for | |
7886 example ":sbuffer", ":sbnext", or ":sbrewind". | |
825 | 7887 usetab Like "useopen", but also consider windows in other tab |
856 | 7888 pages. |
7 | 7889 split If included, split the current window before loading |
3153 | 7890 a buffer for a |quickfix| command that display errors. |
16086 | 7891 Otherwise: do not split, use current window (when used |
7892 in the quickfix window: the previously used window or | |
7893 split if there is no other window). | |
6843 | 7894 vsplit Just like "split" but split vertically. |
1621 | 7895 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
|
7896 "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
|
7897 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
|
7898 jumping to errors with |quickfix| commands. |
7 | 7899 |
410 | 7900 *'synmaxcol'* *'smc'* |
7901 'synmaxcol' 'smc' number (default 3000) | |
7902 local to buffer | |
7903 {not available when compiled without the |+syntax| | |
7904 feature} | |
419 | 7905 Maximum column in which to search for syntax items. In long lines the |
7906 text after this column is not highlighted and following lines may not | |
7907 be highlighted correctly, because the syntax state is cleared. | |
410 | 7908 This helps to avoid very slow redrawing for an XML file that is one |
7909 long line. | |
7910 Set to zero to remove the limit. | |
7911 | |
7 | 7912 *'syntax'* *'syn'* |
7913 'syntax' 'syn' string (default empty) | |
7914 local to buffer | |
7915 {not available when compiled without the |+syntax| | |
7916 feature} | |
7917 When this option is set, the syntax with this name is loaded, unless | |
7918 syntax highlighting has been switched off with ":syntax off". | |
7919 Otherwise this option does not always reflect the current syntax (the | |
7920 b:current_syntax variable does). | |
7921 This option is most useful in a modeline, for a file which syntax is | |
782 | 7922 not automatically recognized. Example, in an IDL file: |
7923 /* vim: set syntax=idl : */ ~ | |
7924 When a dot appears in the value then this separates two filetype | |
7925 names. Example: | |
7926 /* vim: set syntax=c.doxygen : */ ~ | |
7927 This will use the "c" syntax first, then the "doxygen" syntax. | |
7928 Note that the second one must be prepared to be loaded as an addition, | |
7929 otherwise it will be skipped. More than one dot may appear. | |
7930 To switch off syntax highlighting for the current file, use: > | |
7 | 7931 :set syntax=OFF |
7932 < To switch syntax highlighting on according to the current value of the | |
7933 'filetype' option: > | |
7934 :set syntax=ON | |
7935 < What actually happens when setting the 'syntax' option is that the | |
7936 Syntax autocommand event is triggered with the value as argument. | |
7937 This option is not copied to another buffer, independent of the 's' or | |
7938 'S' flag in 'cpoptions'. | |
36 | 7939 Only normal file name characters can be used, "/\*?[|<>" are illegal. |
7 | 7940 |
699 | 7941 *'tabline'* *'tal'* |
677 | 7942 'tabline' 'tal' string (default empty) |
674 | 7943 global |
27804 | 7944 When non-empty, this option determines the content of the tab pages |
677 | 7945 line at the top of the Vim window. When empty Vim will use a default |
681 | 7946 tab pages line. See |setting-tabline| for more info. |
677 | 7947 |
7948 The tab pages line only appears as specified with the 'showtabline' | |
688 | 7949 option and only when there is no GUI tab line. When 'e' is in |
7950 '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
|
7951 instead. Note that the two tab pages lines are very different. |
677 | 7952 |
7953 The value is evaluated like with 'statusline'. You can use | |
7954 |tabpagenr()|, |tabpagewinnr()| and |tabpagebuflist()| to figure out | |
681 | 7955 the text to be displayed. Use "%1T" for the first label, "%2T" for |
7956 the second one, etc. Use "%X" items for closing labels. | |
677 | 7957 |
15396
325e4a8ba1b6
patch 8.1.0706: tabline is not always redrawn
Bram Moolenaar <Bram@vim.org>
parents:
15281
diff
changeset
|
7958 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
|
7959 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
|
7960 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
|
7961 |
677 | 7962 Keep in mind that only one of the tab pages is the current one, others |
7963 are invisible and you can't jump to their windows. | |
7964 | |
674 | 7965 |
699 | 7966 *'tabpagemax'* *'tpm'* |
7967 'tabpagemax' 'tpm' number (default 10) | |
7968 global | |
7969 Maximum number of tab pages to be opened by the |-p| command line | |
7970 argument or the ":tab all" command. |tabpage| | |
7971 | |
7972 | |
7973 *'tabstop'* *'ts'* | |
7 | 7974 'tabstop' 'ts' number (default 8) |
7975 local to buffer | |
7976 Number of spaces that a <Tab> in the file counts for. Also see | |
27459 | 7977 the |:retab| command, and the 'softtabstop' option. |
7 | 7978 |
7979 Note: Setting 'tabstop' to any other value than 8 can make your file | |
27459 | 7980 appear wrong in many places, e.g., when printing it. |
7981 The value must be more than 0 and less than 10000. | |
7 | 7982 |
7983 There are four main ways to use tabs in Vim: | |
7984 1. Always keep 'tabstop' at 8, set 'softtabstop' and 'shiftwidth' to 4 | |
7985 (or 3 or whatever you prefer) and use 'noexpandtab'. Then Vim | |
1263 | 7986 will use a mix of tabs and spaces, but typing <Tab> and <BS> will |
7 | 7987 behave like a tab appears every 4 (or 3) characters. |
7988 2. Set 'tabstop' and 'shiftwidth' to whatever you prefer and use | |
7989 'expandtab'. This way you will always insert spaces. The | |
7990 formatting will never be messed up when 'tabstop' is changed. | |
7991 3. Set 'tabstop' and 'shiftwidth' to whatever you prefer and use a | |
10 | 7992 |modeline| to set these values when editing the file again. Only |
7 | 7993 works when using Vim to edit the file. |
7994 4. Always set 'tabstop' and 'shiftwidth' to the same value, and | |
7995 'noexpandtab'. This should then work (for initial indents only) | |
7996 for any tabstop setting that people use. It might be nice to have | |
7997 tabs after the first non-blank inserted as spaces if you do this | |
7998 though. Otherwise aligned comments will be wrong when 'tabstop' is | |
7999 changed. | |
8000 | |
14175
2ad722003b36
patch 8.1.0105: all tab stops are the same
Christian Brabandt <cb@256bit.org>
parents:
14019
diff
changeset
|
8001 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
|
8002 '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
|
8003 than an empty string. |
2ad722003b36
patch 8.1.0105: all tab stops are the same
Christian Brabandt <cb@256bit.org>
parents:
14019
diff
changeset
|
8004 |
7 | 8005 *'tagbsearch'* *'tbs'* *'notagbsearch'* *'notbs'* |
8006 'tagbsearch' 'tbs' boolean (default on) | |
8007 global | |
8008 When searching for a tag (e.g., for the |:ta| command), Vim can either | |
10 | 8009 use a binary search or a linear search in a tags file. Binary |
7 | 8010 searching makes searching for a tag a LOT faster, but a linear search |
8011 will find more tags if the tags file wasn't properly sorted. | |
8012 Vim normally assumes that your tags files are sorted, or indicate that | |
8013 they are not sorted. Only when this is not the case does the | |
8014 'tagbsearch' option need to be switched off. | |
8015 | |
8016 When 'tagbsearch' is on, binary searching is first used in the tags | |
10 | 8017 files. In certain situations, Vim will do a linear search instead for |
7 | 8018 certain files, or retry all files with a linear search. When |
8019 'tagbsearch' is off, only a linear search is done. | |
8020 | |
8021 Linear searching is done anyway, for one file, when Vim finds a line | |
8022 at the start of the file indicating that it's not sorted: > | |
1621 | 8023 !_TAG_FILE_SORTED 0 /some comment/ |
7 | 8024 < [The whitespace before and after the '0' must be a single <Tab>] |
8025 | |
8026 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
|
8027 files listed in 'tags', and case is ignored or a pattern is used |
7 | 8028 instead of a normal tag name, a retry is done with a linear search. |
8029 Tags in unsorted tags files, and matches with different case will only | |
8030 be found in the retry. | |
8031 | |
22 | 8032 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
|
8033 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
|
8034 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
|
8035 sorted with the -f switch to "sort" in most unices, as in the command: |
28141 | 8036 "sort -f -o tags tags". For Universal ctags and Exuberant ctags |
8037 version 5.x or higher (at least 5.5) the --sort=foldcase switch can be | |
8038 used for this as well. Note that case must be folded to uppercase for | |
8039 this to work. | |
7266
6ba7182fb7bd
commit https://github.com/vim/vim/commit/0f6562e9036f889185dff49a75c7fc5ffb28b307
Christian Brabandt <cb@256bit.org>
parents:
7245
diff
changeset
|
8040 |
6ba7182fb7bd
commit https://github.com/vim/vim/commit/0f6562e9036f889185dff49a75c7fc5ffb28b307
Christian Brabandt <cb@256bit.org>
parents:
7245
diff
changeset
|
8041 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
|
8042 '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
|
8043 "ignore". |
9913
bb00c661b3a4
commit https://github.com/vim/vim/commit/66e29d7112e437b2b50efe1f82c7e892736d23e4
Christian Brabandt <cb@256bit.org>
parents:
9887
diff
changeset
|
8044 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
|
8045 '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
|
8046 characters. |
7 | 8047 |
8048 When 'tagbsearch' is off, tags searching is slower when a full match | |
8049 exists, but faster when no full match exists. Tags in unsorted tags | |
8050 files may only be found with 'tagbsearch' off. | |
8051 When the tags file is not sorted, or sorted in a wrong way (not on | |
8052 ASCII byte value), 'tagbsearch' should be off, or the line given above | |
8053 must be included in the tags file. | |
8054 This option doesn't affect commands that find all matching tags (e.g., | |
8055 command-line completion and ":help"). | |
8056 | |
7266
6ba7182fb7bd
commit https://github.com/vim/vim/commit/0f6562e9036f889185dff49a75c7fc5ffb28b307
Christian Brabandt <cb@256bit.org>
parents:
7245
diff
changeset
|
8057 *'tagcase'* *'tc'* |
6ba7182fb7bd
commit https://github.com/vim/vim/commit/0f6562e9036f889185dff49a75c7fc5ffb28b307
Christian Brabandt <cb@256bit.org>
parents:
7245
diff
changeset
|
8058 'tagcase' 'tc' string (default "followic") |
6ba7182fb7bd
commit https://github.com/vim/vim/commit/0f6562e9036f889185dff49a75c7fc5ffb28b307
Christian Brabandt <cb@256bit.org>
parents:
7245
diff
changeset
|
8059 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
|
8060 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
|
8061 file: |
6ba7182fb7bd
commit https://github.com/vim/vim/commit/0f6562e9036f889185dff49a75c7fc5ffb28b307
Christian Brabandt <cb@256bit.org>
parents:
7245
diff
changeset
|
8062 followic Follow the 'ignorecase' option |
9913
bb00c661b3a4
commit https://github.com/vim/vim/commit/66e29d7112e437b2b50efe1f82c7e892736d23e4
Christian Brabandt <cb@256bit.org>
parents:
9887
diff
changeset
|
8063 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
|
8064 ignore Ignore case |
6ba7182fb7bd
commit https://github.com/vim/vim/commit/0f6562e9036f889185dff49a75c7fc5ffb28b307
Christian Brabandt <cb@256bit.org>
parents:
7245
diff
changeset
|
8065 match Match case |
9913
bb00c661b3a4
commit https://github.com/vim/vim/commit/66e29d7112e437b2b50efe1f82c7e892736d23e4
Christian Brabandt <cb@256bit.org>
parents:
9887
diff
changeset
|
8066 smart Ignore case unless an upper case letter is used |
11160 | 8067 NOTE: This option is set to the Vi default value when 'compatible' is |
8068 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
|
8069 |
16447
54ffc82f38a8
patch 8.1.1228: not possible to process tags with a function
Bram Moolenaar <Bram@vim.org>
parents:
16443
diff
changeset
|
8070 *'tagfunc'* *'tfu'* |
54ffc82f38a8
patch 8.1.1228: not possible to process tags with a function
Bram Moolenaar <Bram@vim.org>
parents:
16443
diff
changeset
|
8071 '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
|
8072 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
|
8073 {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
|
8074 feature} |
54ffc82f38a8
patch 8.1.1228: not possible to process tags with a function
Bram Moolenaar <Bram@vim.org>
parents:
16443
diff
changeset
|
8075 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
|
8076 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
|
8077 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
|
8078 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
|
8079 |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
|
8080 information. |
16447
54ffc82f38a8
patch 8.1.1228: not possible to process tags with a function
Bram Moolenaar <Bram@vim.org>
parents:
16443
diff
changeset
|
8081 |
7 | 8082 *'taglength'* *'tl'* |
8083 'taglength' 'tl' number (default 0) | |
8084 global | |
8085 If non-zero, tags are significant up to this number of characters. | |
8086 | |
8087 *'tagrelative'* *'tr'* *'notagrelative'* *'notr'* | |
8088 'tagrelative' 'tr' boolean (Vim default: on, Vi default: off) | |
8089 global | |
824 | 8090 If on and using a tags file in another directory, file names in that |
8091 tags file are relative to the directory where the tags file is. | |
7 | 8092 NOTE: This option is set to the Vi default value when 'compatible' is |
8093 set and to the Vim default value when 'compatible' is reset. | |
8094 | |
8095 *'tags'* *'tag'* *E433* | |
8096 'tags' 'tag' string (default "./tags,tags", when compiled with | |
8097 |+emacs_tags|: "./tags,./TAGS,tags,TAGS") | |
8098 global or local to buffer |global-local| | |
8099 Filenames for the tag command, separated by spaces or commas. To | |
8100 include a space or comma in a file name, precede it with a backslash | |
8101 (see |option-backslash| about including spaces and backslashes). | |
8102 When a file name starts with "./", the '.' is replaced with the path | |
8103 of the current file. But only when the 'd' flag is not included in | |
8104 'cpoptions'. Environment variables are expanded |:set_env|. Also see | |
8105 |tags-option|. | |
8106 "*", "**" 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
|
8107 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
|
8108 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
|
8109 contain wildcards, it is used as-is. E.g., "/lib/**/tags?" will find |
29863
62350f19d4ed
patch 9.0.0270: some values of 'path' and 'tags' invalid in the tiny version
Bram Moolenaar <Bram@vim.org>
parents:
29853
diff
changeset
|
8110 files called "tags?". |
515 | 8111 The |tagfiles()| function can be used to get a list of the file names |
8112 actually used. | |
7 | 8113 If Vim was compiled with the |+emacs_tags| feature, Emacs-style tag |
8114 files are also supported. They are automatically recognized. The | |
8115 default value becomes "./tags,./TAGS,tags,TAGS", unless case | |
8116 differences are ignored (MS-Windows). |emacs-tags| | |
8117 The use of |:set+=| and |:set-=| is preferred when adding or removing | |
8118 file names from the list. This avoids problems when a future version | |
8119 uses another default. | |
8120 | |
8121 *'tagstack'* *'tgst'* *'notagstack'* *'notgst'* | |
8122 'tagstack' 'tgst' boolean (default on) | |
8123 global | |
8124 When on, the |tagstack| is used normally. When off, a ":tag" or | |
8125 ":tselect" command with an argument will not push the tag onto the | |
8126 tagstack. A following ":tag" without an argument, a ":pop" command or | |
8127 any other command that uses the tagstack will use the unmodified | |
8128 tagstack, but does change the pointer to the active entry. | |
8129 Resetting this option is useful when using a ":tag" command in a | |
8130 mapping which should not change the tagstack. | |
8131 | |
7538
c9fc24b76293
commit https://github.com/vim/vim/commit/8a5115cf18751022387af2085f374d38c60dde83
Christian Brabandt <cb@256bit.org>
parents:
7528
diff
changeset
|
8132 *'tcldll'* |
8629
54ac275e3fc4
commit https://github.com/vim/vim/commit/3848e00e0177abdb31bc600234967863ec487233
Christian Brabandt <cb@256bit.org>
parents:
8560
diff
changeset
|
8133 '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
|
8134 global |
c9fc24b76293
commit https://github.com/vim/vim/commit/8a5115cf18751022387af2085f374d38c60dde83
Christian Brabandt <cb@256bit.org>
parents:
7528
diff
changeset
|
8135 {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
|
8136 feature} |
c9fc24b76293
commit https://github.com/vim/vim/commit/8a5115cf18751022387af2085f374d38c60dde83
Christian Brabandt <cb@256bit.org>
parents:
7528
diff
changeset
|
8137 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
|
8138 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
|
8139 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
|
8140 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
|
8141 security reasons. |
c9fc24b76293
commit https://github.com/vim/vim/commit/8a5115cf18751022387af2085f374d38c60dde83
Christian Brabandt <cb@256bit.org>
parents:
7528
diff
changeset
|
8142 |
7 | 8143 *'term'* *E529* *E530* *E531* |
8144 'term' string (default is $TERM, if that fails: | |
8145 in the GUI: "builtin_gui" | |
8146 on Amiga: "amiga" | |
19526
22f0dda71638
patch 8.2.0320: no Haiku support
Bram Moolenaar <Bram@vim.org>
parents:
19404
diff
changeset
|
8147 on Haiku: "xterm" |
7 | 8148 on Mac: "mac-ansi" |
8149 on Unix: "ansi" | |
8150 on VMS: "ansi" | |
8151 on Win 32: "win32") | |
8152 global | |
8153 Name of the terminal. Used for choosing the terminal control | |
8154 characters. Environment variables are expanded |:set_env|. | |
8155 For example: > | |
8156 :set term=$TERM | |
8157 < See |termcap|. | |
8158 | |
8159 *'termbidi'* *'tbidi'* | |
8160 *'notermbidi'* *'notbidi'* | |
8161 'termbidi' 'tbidi' boolean (default off, on for "mlterm") | |
8162 global | |
8163 {only available when compiled with the |+arabic| | |
8164 feature} | |
8165 The terminal is in charge of Bi-directionality of text (as specified | |
8166 by Unicode). The terminal is also expected to do the required shaping | |
8167 that some languages (such as Arabic) require. | |
8168 Setting this option implies that 'rightleft' will not be set when | |
8169 'arabic' is set and the value of 'arabicshape' will be ignored. | |
8170 Note that setting 'termbidi' has the immediate effect that | |
8171 'arabicshape' is ignored, but 'rightleft' isn't changed automatically. | |
8172 This option is reset when the GUI is started. | |
8173 For further details see |arabic.txt|. | |
8174 | |
8175 *'termencoding'* *'tenc'* | |
21825 | 8176 'termencoding' 'tenc' string (default ""; with GTK+ GUI: "utf-8") |
7 | 8177 global |
8178 Encoding used for the terminal. This specifies what character | |
8179 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
|
8180 the GUI it only applies to the keyboard ('encoding' is used for the |
21825 | 8181 display). |
19027
d72b30bf3a80
patch 8.2.0074: Python 3 unicode test someitmes fails
Bram Moolenaar <Bram@vim.org>
parents:
18972
diff
changeset
|
8182 *E617* *E950* |
10895
c391bfbdb452
Updated runtime files.
Christian Brabandt <cb@256bit.org>
parents:
10734
diff
changeset
|
8183 Note: This does not apply to the GTK+ GUI. After the GUI has been |
7 | 8184 successfully initialized, 'termencoding' is forcibly set to "utf-8". |
8185 Any attempts to set a different value will be rejected, and an error | |
8186 message is shown. | |
7080
1a34f5272977
commit https://github.com/vim/vim/commit/ac360bf2ca293735fc7c6654dc2b3066f4c62488
Christian Brabandt <cb@256bit.org>
parents:
7051
diff
changeset
|
8187 For the Win32 GUI and console versions 'termencoding' is not used, |
7 | 8188 because the Win32 system always passes Unicode characters. |
8189 When empty, the same encoding is used as for the 'encoding' option. | |
8190 This is the normal value. | |
8191 Not all combinations for 'termencoding' and 'encoding' are valid. See | |
8192 |encoding-table|. | |
8193 The value for this option must be supported by internal conversions or | |
8194 iconv(). When this is not possible no conversion will be done and you | |
8195 will probably experience problems with non-ASCII characters. | |
8196 Example: You are working with the locale set to euc-jp (Japanese) and | |
8197 want to edit a UTF-8 file: > | |
8198 :let &termencoding = &encoding | |
8199 :set encoding=utf-8 | |
8200 < You need to do this when your system has no locale support for UTF-8. | |
8201 | |
13314
65c3e8259124
patch 8.0.1531: cannot use 24 bit colors in MS-Windows console
Christian Brabandt <cb@256bit.org>
parents:
13234
diff
changeset
|
8202 *'termguicolors'* *'tgc'* *E954* |
9027
773d627cac0b
commit https://github.com/vim/vim/commit/61be73bb0f965a895bfb064ea3e55476ac175162
Christian Brabandt <cb@256bit.org>
parents:
8969
diff
changeset
|
8203 'termguicolors' 'tgc' boolean (default off) |
773d627cac0b
commit https://github.com/vim/vim/commit/61be73bb0f965a895bfb064ea3e55476ac175162
Christian Brabandt <cb@256bit.org>
parents:
8969
diff
changeset
|
8204 global |
773d627cac0b
commit https://github.com/vim/vim/commit/61be73bb0f965a895bfb064ea3e55476ac175162
Christian Brabandt <cb@256bit.org>
parents:
8969
diff
changeset
|
8205 {not available when compiled without the |
773d627cac0b
commit https://github.com/vim/vim/commit/61be73bb0f965a895bfb064ea3e55476ac175162
Christian Brabandt <cb@256bit.org>
parents:
8969
diff
changeset
|
8206 |+termguicolors| feature} |
773d627cac0b
commit https://github.com/vim/vim/commit/61be73bb0f965a895bfb064ea3e55476ac175162
Christian Brabandt <cb@256bit.org>
parents:
8969
diff
changeset
|
8207 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
|
8208 the terminal (thus using 24-bit color). |
13341
acd7eaa13d2b
Updated runtime files.
Christian Brabandt <cb@256bit.org>
parents:
13314
diff
changeset
|
8209 |
13314
65c3e8259124
patch 8.0.1531: cannot use 24 bit colors in MS-Windows console
Christian Brabandt <cb@256bit.org>
parents:
13234
diff
changeset
|
8210 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
|
8211 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
|
8212 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
|
8213 |
65c3e8259124
patch 8.0.1531: cannot use 24 bit colors in MS-Windows console
Christian Brabandt <cb@256bit.org>
parents:
13234
diff
changeset
|
8214 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
|
8215 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
|
8216 if has('vcon') |
13341
acd7eaa13d2b
Updated runtime files.
Christian Brabandt <cb@256bit.org>
parents:
13314
diff
changeset
|
8217 < This requires Vim to be built with the |+vtp| feature. |
acd7eaa13d2b
Updated runtime files.
Christian Brabandt <cb@256bit.org>
parents:
13314
diff
changeset
|
8218 |
11473 | 8219 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
|
8220 |
b01bca69b1d5
patch 8.2.4906: MS-Windows: cannot use transparent background
Bram Moolenaar <Bram@vim.org>
parents:
28716
diff
changeset
|
8221 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
|
8222 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
|
8223 '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
|
8224 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
|
8225 :hi Normal guibg=NONE |
b01bca69b1d5
patch 8.2.4906: MS-Windows: cannot use transparent background
Bram Moolenaar <Bram@vim.org>
parents:
28716
diff
changeset
|
8226 < |
11160 | 8227 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
|
8228 |
13735 | 8229 *'termwinkey'* *'twk'* |
8230 'termwinkey' 'twk' string (default "") | |
11659
49c12c93abf3
Updated runtime files and translations.
Christian Brabandt <cb@256bit.org>
parents:
11529
diff
changeset
|
8231 local to window |
11914 | 8232 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
|
8233 are sent to the job running in the window. |
11914 | 8234 The <> notation can be used, e.g.: > |
13735 | 8235 :set termwinkey=<C-L> |
11914 | 8236 < The string must be one key stroke but can be multiple bytes. |
8237 When not set CTRL-W is used, so that CTRL-W : gets you to the command | |
13735 | 8238 line. If 'termwinkey' is set to CTRL-L then CTRL-L : gets you to the |
11914 | 8239 command line. |
11659
49c12c93abf3
Updated runtime files and translations.
Christian Brabandt <cb@256bit.org>
parents:
11529
diff
changeset
|
8240 |
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
|
8241 *'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
|
8242 '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
|
8243 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
|
8244 {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
|
8245 |+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
|
8246 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
|
8247 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
|
8248 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
|
8249 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
|
8250 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
|
8251 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
|
8252 |
13735 | 8253 *'termwinsize'* *'tws'* |
8254 'termwinsize' 'tws' string (default "") | |
11659
49c12c93abf3
Updated runtime files and translations.
Christian Brabandt <cb@256bit.org>
parents:
11529
diff
changeset
|
8255 local to window |
22171 | 8256 Size used when opening the |terminal| window. Format: |
8257 {rows}x{columns} or {rows}*{columns}. | |
11659
49c12c93abf3
Updated runtime files and translations.
Christian Brabandt <cb@256bit.org>
parents:
11529
diff
changeset
|
8258 - 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
|
8259 - 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
|
8260 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
|
8261 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
|
8262 - 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
|
8263 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
|
8264 columns. |
b28d679b1843
patch 8.0.1722: cannot specify a minimal size for a terminal window
Christian Brabandt <cb@256bit.org>
parents:
13680
diff
changeset
|
8265 - 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
|
8266 - 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
|
8267 - Using "0x0" or "0*0" is the same as empty. |
22171 | 8268 - Can be overruled in the |term_start()| options with "term_rows" and |
8269 "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
|
8270 |
b28d679b1843
patch 8.0.1722: cannot specify a minimal size for a terminal window
Christian Brabandt <cb@256bit.org>
parents:
13680
diff
changeset
|
8271 Examples: |
b28d679b1843
patch 8.0.1722: cannot specify a minimal size for a terminal window
Christian Brabandt <cb@256bit.org>
parents:
13680
diff
changeset
|
8272 "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
|
8273 "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
|
8274 "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
|
8275 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
|
8276 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
|
8277 adjusted to that size, if possible. |
11659
49c12c93abf3
Updated runtime files and translations.
Christian Brabandt <cb@256bit.org>
parents:
11529
diff
changeset
|
8278 |
15746
c017195b121b
patch 8.1.0880: MS-Windows: inconsistent selection of winpty/conpty
Bram Moolenaar <Bram@vim.org>
parents:
15729
diff
changeset
|
8279 *'termwintype'* *'twt'* |
c017195b121b
patch 8.1.0880: MS-Windows: inconsistent selection of winpty/conpty
Bram Moolenaar <Bram@vim.org>
parents:
15729
diff
changeset
|
8280 '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
|
8281 global |
c017195b121b
patch 8.1.0880: MS-Windows: inconsistent selection of winpty/conpty
Bram Moolenaar <Bram@vim.org>
parents:
15729
diff
changeset
|
8282 {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
|
8283 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
|
8284 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
|
8285 window. |
c017195b121b
patch 8.1.0880: MS-Windows: inconsistent selection of winpty/conpty
Bram Moolenaar <Bram@vim.org>
parents:
15729
diff
changeset
|
8286 |
c017195b121b
patch 8.1.0880: MS-Windows: inconsistent selection of winpty/conpty
Bram Moolenaar <Bram@vim.org>
parents:
15729
diff
changeset
|
8287 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
|
8288 "" 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
|
8289 "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
|
8290 "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
|
8291 |
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
|
8292 |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
|
8293 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
|
8294 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
|
8295 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
|
8296 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
|
8297 |
7 | 8298 *'terse'* *'noterse'* |
8299 'terse' boolean (default off) | |
8300 global | |
8301 When set: Add 's' flag to 'shortmess' option (this makes the message | |
8302 for a search that hits the start or end of the file not being | |
8303 displayed). When reset: Remove 's' flag from 'shortmess' option. {Vi | |
8304 shortens a lot of messages} | |
8305 | |
8306 *'textauto'* *'ta'* *'notextauto'* *'nota'* | |
8307 'textauto' 'ta' boolean (Vim default: on, Vi default: off) | |
8308 global | |
8309 This option is obsolete. Use 'fileformats'. | |
8310 For backwards compatibility, when 'textauto' is set, 'fileformats' is | |
8311 set to the default value for the current system. When 'textauto' is | |
8312 reset, 'fileformats' is made empty. | |
8313 NOTE: This option is set to the Vi default value when 'compatible' is | |
8314 set and to the Vim default value when 'compatible' is reset. | |
8315 | |
8316 *'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
|
8317 'textmode' 'tx' boolean (Win32: default on, |
7 | 8318 others: default off) |
8319 local to buffer | |
8320 This option is obsolete. Use 'fileformat'. | |
8321 For backwards compatibility, when 'textmode' is set, 'fileformat' is | |
8322 set to "dos". When 'textmode' is reset, 'fileformat' is set to | |
8323 "unix". | |
8324 | |
8325 *'textwidth'* *'tw'* | |
8326 'textwidth' 'tw' number (default 0) | |
8327 local to buffer | |
8328 Maximum width of text that is being inserted. A longer line will be | |
8329 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
|
8330 this. |
c590de398af9
commit https://github.com/vim/vim/commit/ca63501fbcd1cf9c8aa9ff12c093c95b62a89ed7
Christian Brabandt <cb@256bit.org>
parents:
7080
diff
changeset
|
8331 '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
|
8332 when 'paste' is reset. |
c590de398af9
commit https://github.com/vim/vim/commit/ca63501fbcd1cf9c8aa9ff12c093c95b62a89ed7
Christian Brabandt <cb@256bit.org>
parents:
7080
diff
changeset
|
8333 When 'textwidth' is zero, 'wrapmargin' may be used. See also |
7 | 8334 'formatoptions' and |ins-textwidth|. |
838 | 8335 When 'formatexpr' is set it will be used to break the line. |
7 | 8336 NOTE: This option is set to 0 when 'compatible' is set. |
8337 | |
8338 *'thesaurus'* *'tsr'* | |
8339 'thesaurus' 'tsr' string (default "") | |
8340 global or local to buffer |global-local| | |
8341 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
|
8342 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
|
8343 |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
|
8344 |
ac330e2fecc4
patch 8.2.3528: 'thesaurus' and 'thesaurusfunc' do not have the same scope
Bram Moolenaar <Bram@vim.org>
parents:
25982
diff
changeset
|
8345 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
|
8346 buffer or globally. |
15033 | 8347 |
10 | 8348 To include a comma in a file name precede it with a backslash. Spaces |
7 | 8349 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
|
8350 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
|
8351 |: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
|
8352 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
|
8353 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
|
8354 reasons. |
7 | 8355 |
27036 | 8356 *'thesaurusfunc'* *'tsrfu'* |
25974
416237f1de22
patch 8.2.3520: cannot define a function for thesaurus completion
Bram Moolenaar <Bram@vim.org>
parents:
25973
diff
changeset
|
8357 '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
|
8358 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
|
8359 {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
|
8360 feature} |
416237f1de22
patch 8.2.3520: cannot define a function for thesaurus completion
Bram Moolenaar <Bram@vim.org>
parents:
25973
diff
changeset
|
8361 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
|
8362 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
|
8363 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
|
8364 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
|
8365 |
25974
416237f1de22
patch 8.2.3520: cannot define a function for thesaurus completion
Bram Moolenaar <Bram@vim.org>
parents:
25973
diff
changeset
|
8366 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
|
8367 security reasons. |
416237f1de22
patch 8.2.3520: cannot define a function for thesaurus completion
Bram Moolenaar <Bram@vim.org>
parents:
25973
diff
changeset
|
8368 |
7 | 8369 *'tildeop'* *'top'* *'notildeop'* *'notop'* |
8370 'tildeop' 'top' boolean (default off) | |
8371 global | |
8372 When on: The tilde command "~" behaves like an operator. | |
8373 NOTE: This option is reset when 'compatible' is set. | |
8374 | |
8375 *'timeout'* *'to'* *'notimeout'* *'noto'* | |
8376 'timeout' 'to' boolean (default on) | |
8377 global | |
8378 *'ttimeout'* *'nottimeout'* | |
11400
0f8713fe20dc
Updated runtime files.
Christian Brabandt <cb@256bit.org>
parents:
11262
diff
changeset
|
8379 'ttimeout' boolean (default off, set in |defaults.vim|) |
7 | 8380 global |
8381 These two options together determine the behavior when part of a | |
8382 mapped key sequence or keyboard code has been received: | |
8383 | |
8384 'timeout' 'ttimeout' action ~ | |
8385 off off do not time out | |
8386 on on or off time out on :mappings and key codes | |
8387 off on time out on key codes | |
8388 | |
8389 If both options are off, Vim will wait until either the complete | |
8390 mapping or key sequence has been received, or it is clear that there | |
8391 is no mapping or key sequence for the received characters. For | |
8392 example: if you have mapped "vl" and Vim has received 'v', the next | |
8393 character is needed to see if the 'v' is followed by an 'l'. | |
8394 When one of the options is on, Vim will wait for about 1 second for | |
8395 the next character to arrive. After that the already received | |
8396 characters are interpreted as single characters. The waiting time can | |
8397 be changed with the 'timeoutlen' option. | |
8398 On slow terminals or very busy systems timing out may cause | |
8399 malfunctioning cursor keys. If both options are off, Vim waits | |
8400 forever after an entered <Esc> if there are key codes that start | |
8401 with <Esc>. You will have to type <Esc> twice. If you do not have | |
8402 problems with key codes, but would like to have :mapped key | |
8403 sequences not timing out in 1 second, set the 'ttimeout' option and | |
8404 reset the 'timeout' option. | |
8405 | |
8406 NOTE: 'ttimeout' is reset when 'compatible' is set. | |
8407 | |
8408 *'timeoutlen'* *'tm'* | |
8409 'timeoutlen' 'tm' number (default 1000) | |
8410 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
|
8411 |
7 | 8412 *'ttimeoutlen'* *'ttm'* |
11400
0f8713fe20dc
Updated runtime files.
Christian Brabandt <cb@256bit.org>
parents:
11262
diff
changeset
|
8413 'ttimeoutlen' 'ttm' number (default -1, set to 100 in |defaults.vim|) |
7 | 8414 global |
8415 The time in milliseconds that is waited for a key code or mapped key | |
8416 sequence to complete. Also used for CTRL-\ CTRL-N and CTRL-\ CTRL-G | |
8417 when part of a command has been typed. | |
8418 Normally only 'timeoutlen' is used and 'ttimeoutlen' is -1. When a | |
8419 different timeout value for key codes is desired set 'ttimeoutlen' to | |
8420 a non-negative number. | |
8421 | |
8422 ttimeoutlen mapping delay key code delay ~ | |
8423 < 0 'timeoutlen' 'timeoutlen' | |
8424 >= 0 'timeoutlen' 'ttimeoutlen' | |
8425 | |
8426 The timeout only happens when the 'timeout' and 'ttimeout' options | |
8427 tell so. A useful setting would be > | |
8428 :set timeout timeoutlen=3000 ttimeoutlen=100 | |
8429 < (time out on mapping after three seconds, time out on key codes after | |
8430 a tenth of a second). | |
8431 | |
8432 *'title'* *'notitle'* | |
8433 'title' boolean (default off, on when title can be restored) | |
8434 global | |
8435 When on, the title of the window will be set to the value of | |
8436 'titlestring' (if it is not empty), or to: | |
8437 filename [+=-] (path) - VIM | |
8438 Where: | |
8439 filename the name of the file being edited | |
8440 - indicates the file cannot be modified, 'ma' off | |
8441 + indicates the file was modified | |
8442 = indicates the file is read-only | |
8443 =+ indicates the file is read-only and modified | |
8444 (path) is the path of the file being edited | |
8445 - VIM the server name |v:servername| or "VIM" | |
8446 Only works if the terminal supports setting window titles | |
8447 (currently Amiga console, Win32 console, all GUI versions and | |
19968 | 8448 terminals with a non-empty 't_ts' option - these are Unix xterm and |
7 | 8449 iris-ansi by default, where 't_ts' is taken from the builtin termcap). |
8450 *X11* | |
8451 When Vim was compiled with HAVE_X11 defined, the original title will | |
8452 be restored if possible. The output of ":version" will include "+X11" | |
8453 when HAVE_X11 was defined, otherwise it will be "-X11". This also | |
8454 works for the icon name |'icon'|. | |
8455 But: When Vim was started with the |-X| argument, restoring the title | |
8456 will not work (except in the GUI). | |
8457 If the title cannot be restored, it is set to the value of 'titleold'. | |
8458 You might want to restore the title outside of Vim then. | |
8459 When using an xterm from a remote machine you can use this command: | |
8460 rsh machine_name xterm -display $DISPLAY & | |
8461 then the WINDOWID environment variable should be inherited and the | |
8462 title of the window should change back to what it should be after | |
8463 exiting Vim. | |
8464 | |
8465 *'titlelen'* | |
8466 'titlelen' number (default 85) | |
8467 global | |
8468 Gives the percentage of 'columns' to use for the length of the window | |
10 | 8469 title. When the title is longer, only the end of the path name is |
8470 shown. A '<' character before the path name is used to indicate this. | |
7 | 8471 Using a percentage makes this adapt to the width of the window. But |
8472 it won't work perfectly, because the actual number of characters | |
8473 available also depends on the font used and other things in the title | |
8474 bar. When 'titlelen' is zero the full path is used. Otherwise, | |
8475 values from 1 to 30000 percent can be used. | |
8476 'titlelen' is also used for the 'titlestring' option. | |
8477 | |
8478 *'titleold'* | |
8479 'titleold' string (default "Thanks for flying Vim") | |
8480 global | |
8481 This option will be used for the window title when exiting Vim if the | |
8482 original title cannot be restored. Only happens if 'title' is on or | |
8483 'titlestring' is not empty. | |
36 | 8484 This option cannot be set from a |modeline| or in the |sandbox|, for |
8485 security reasons. | |
7 | 8486 *'titlestring'* |
8487 'titlestring' string (default "") | |
8488 global | |
8489 When this option is not empty, it will be used for the title of the | |
8490 window. This happens only when the 'title' option is on. | |
8491 Only works if the terminal supports setting window titles (currently | |
8492 Amiga console, Win32 console, all GUI versions and terminals with a | |
8493 non-empty 't_ts' option). | |
8494 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
|
8495 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
|
8496 |
7 | 8497 When this option contains printf-style '%' items, they will be |
8498 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
|
8499 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
|
8500 |
7 | 8501 Example: > |
27903 | 8502 :auto BufEnter * let &titlestring = hostname() .. "/" .. expand("%:p") |
7 | 8503 :set title titlestring=%<%F%=%l/%L-%P titlelen=70 |
8504 < The value of 'titlelen' is used to align items in the middle or right | |
8505 of the available space. | |
8506 Some people prefer to have the file name first: > | |
8507 :set titlestring=%t%(\ %M%)%(\ (%{expand(\"%:~:.:h\")})%)%(\ %a%) | |
8508 < Note the use of "%{ }" and an expression to get the path of the file, | |
10 | 8509 without the file name. The "%( %)" constructs are used to add a |
7 | 8510 separating space only when needed. |
8511 NOTE: Use of special characters in 'titlestring' may cause the display | |
8512 to be garbled (e.g., when it contains a CR or NL character). | |
8513 {not available when compiled without the |+statusline| feature} | |
8514 | |
8515 *'toolbar'* *'tb'* | |
8516 'toolbar' 'tb' string (default "icons,tooltips") | |
8517 global | |
28379 | 8518 {only for |+GUI_GTK|, |+GUI_Motif| and |+GUI_Photon|} |
10 | 8519 The contents of this option controls various toolbar settings. The |
7 | 8520 possible values are: |
8521 icons Toolbar buttons are shown with icons. | |
8522 text Toolbar buttons shown with text. | |
8523 horiz Icon and text of a toolbar button are | |
10 | 8524 horizontally arranged. {only in GTK+ 2 GUI} |
7 | 8525 tooltips Tooltips are active for toolbar buttons. |
8526 Tooltips refer to the popup help text which appears after the mouse | |
8527 cursor is placed over a toolbar button for a brief moment. | |
8528 | |
8529 If you want the toolbar to be shown with icons as well as text, do the | |
8530 following: > | |
8531 :set tb=icons,text | |
28379 | 8532 < Motif cannot display icons and text at the same time. They |
7 | 8533 will show icons if both are requested. |
8534 | |
8535 If none of the strings specified in 'toolbar' are valid or if | |
8536 'toolbar' is empty, this option is ignored. If you want to disable | |
8537 the toolbar, you need to set the 'guioptions' option. For example: > | |
8538 :set guioptions-=T | |
8539 < Also see |gui-toolbar|. | |
8540 | |
8541 *'toolbariconsize'* *'tbis'* | |
8542 'toolbariconsize' 'tbis' string (default "small") | |
8543 global | |
10895
c391bfbdb452
Updated runtime files.
Christian Brabandt <cb@256bit.org>
parents:
10734
diff
changeset
|
8544 {only in the GTK+ GUI} |
7 | 8545 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
|
8546 tiny Use tiny icons. |
da01d5da2cfa
commit https://github.com/vim/vim/commit/77cdfd10382e01cc51f4ba1a9177032351843151
Christian Brabandt <cb@256bit.org>
parents:
8246
diff
changeset
|
8547 small Use small icons (default). |
da01d5da2cfa
commit https://github.com/vim/vim/commit/77cdfd10382e01cc51f4ba1a9177032351843151
Christian Brabandt <cb@256bit.org>
parents:
8246
diff
changeset
|
8548 medium Use medium-sized icons. |
da01d5da2cfa
commit https://github.com/vim/vim/commit/77cdfd10382e01cc51f4ba1a9177032351843151
Christian Brabandt <cb@256bit.org>
parents:
8246
diff
changeset
|
8549 large Use large icons. |
da01d5da2cfa
commit https://github.com/vim/vim/commit/77cdfd10382e01cc51f4ba1a9177032351843151
Christian Brabandt <cb@256bit.org>
parents:
8246
diff
changeset
|
8550 huge Use even larger icons. |
da01d5da2cfa
commit https://github.com/vim/vim/commit/77cdfd10382e01cc51f4ba1a9177032351843151
Christian Brabandt <cb@256bit.org>
parents:
8246
diff
changeset
|
8551 giant Use very big icons. |
7 | 8552 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
|
8553 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
|
8554 large=24x24, medium=24x24, small=20x20 and tiny=16x16. |
7 | 8555 |
8556 If 'toolbariconsize' is empty, the global default size as determined | |
8557 by user preferences or the current theme is used. | |
8558 | |
8559 *'ttybuiltin'* *'tbi'* *'nottybuiltin'* *'notbi'* | |
8560 'ttybuiltin' 'tbi' boolean (default on) | |
8561 global | |
8562 When on, the builtin termcaps are searched before the external ones. | |
8563 When off the builtin termcaps are searched after the external ones. | |
8564 When this option is changed, you should set the 'term' option next for | |
8565 the change to take effect, for example: > | |
8566 :set notbi term=$TERM | |
8567 < See also |termcap|. | |
8568 Rationale: The default for this option is "on", because the builtin | |
8569 termcap entries are generally better (many systems contain faulty | |
8570 xterm entries...). | |
8571 | |
8572 *'ttyfast'* *'tf'* *'nottyfast'* *'notf'* | |
31229
5b71c3884a2a
patch 9.0.0948: 'ttyfast' is set for arbitrary terminals
Bram Moolenaar <Bram@vim.org>
parents:
31200
diff
changeset
|
8573 'ttyfast' 'tf' boolean (default on) |
7 | 8574 global |
8575 Indicates a fast terminal connection. More characters will be sent to | |
8576 the screen for redrawing, instead of using insert/delete line | |
8577 commands. Improves smoothness of redrawing when there are multiple | |
8578 windows and the terminal does not support a scrolling region. | |
8579 Also enables the extra writing of characters at the end of each screen | |
8580 line for lines that wrap. This helps when using copy/paste with the | |
8581 mouse in an xterm and other terminals. | |
8582 | |
31229
5b71c3884a2a
patch 9.0.0948: 'ttyfast' is set for arbitrary terminals
Bram Moolenaar <Bram@vim.org>
parents:
31200
diff
changeset
|
8583 The default used to be set only for some terminal names, but these |
5b71c3884a2a
patch 9.0.0948: 'ttyfast' is set for arbitrary terminals
Bram Moolenaar <Bram@vim.org>
parents:
31200
diff
changeset
|
8584 days nearly all terminals are fast, therefore the default is now "on". |
5b71c3884a2a
patch 9.0.0948: 'ttyfast' is set for arbitrary terminals
Bram Moolenaar <Bram@vim.org>
parents:
31200
diff
changeset
|
8585 If you have a slow connection you may want to set this option off, |
5b71c3884a2a
patch 9.0.0948: 'ttyfast' is set for arbitrary terminals
Bram Moolenaar <Bram@vim.org>
parents:
31200
diff
changeset
|
8586 e.g. depending on the host name: > |
5b71c3884a2a
patch 9.0.0948: 'ttyfast' is set for arbitrary terminals
Bram Moolenaar <Bram@vim.org>
parents:
31200
diff
changeset
|
8587 if hostname() =~ 'faraway' |
5b71c3884a2a
patch 9.0.0948: 'ttyfast' is set for arbitrary terminals
Bram Moolenaar <Bram@vim.org>
parents:
31200
diff
changeset
|
8588 set nottyfast |
5b71c3884a2a
patch 9.0.0948: 'ttyfast' is set for arbitrary terminals
Bram Moolenaar <Bram@vim.org>
parents:
31200
diff
changeset
|
8589 endif |
5b71c3884a2a
patch 9.0.0948: 'ttyfast' is set for arbitrary terminals
Bram Moolenaar <Bram@vim.org>
parents:
31200
diff
changeset
|
8590 < |
7 | 8591 *'ttymouse'* *'ttym'* |
8592 'ttymouse' 'ttym' string (default depends on 'term') | |
8593 global | |
8594 {only in Unix and VMS, doesn't work in the GUI; not | |
8595 available when compiled without |+mouse|} | |
8596 Name of the terminal type for which mouse codes are to be recognized. | |
1213 | 8597 Currently these strings are valid: |
7 | 8598 *xterm-mouse* |
8599 xterm xterm-like mouse handling. The mouse generates | |
8600 "<Esc>[Mscr", where "scr" is three bytes: | |
8601 "s" = button state | |
8602 "c" = column plus 33 | |
8603 "r" = row plus 33 | |
5908 | 8604 This only works up to 223 columns! See "dec", |
8605 "urxvt", and "sgr" for solutions. | |
7 | 8606 xterm2 Works like "xterm", but with the xterm reporting the |
8607 mouse position while the mouse is dragged. This works | |
8608 much faster and more precise. Your xterm must at | |
180 | 8609 least at patchlevel 88 / XFree 3.3.3 for this to |
7 | 8610 work. See below for how Vim detects this |
8611 automatically. | |
8612 *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
|
8613 netterm NetTerm mouse handling. A left mouse click generates |
7 | 8614 "<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
|
8615 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
|
8616 supported. |
7 | 8617 *dec-mouse* |
8618 dec DEC terminal mouse handling. The mouse generates a | |
8619 rather complex sequence, starting with "<Esc>[". | |
189 | 8620 This is also available for an Xterm, if it was |
8621 configured with "--enable-dec-locator". | |
7 | 8622 *jsbterm-mouse* |
8623 jsbterm JSB term mouse handling. | |
8624 *pterm-mouse* | |
8625 pterm QNX pterm mouse handling. | |
3224 | 8626 *urxvt-mouse* |
8627 urxvt Mouse handling for the urxvt (rxvt-unicode) terminal. | |
5908 | 8628 The mouse works only if the terminal supports this |
8629 encoding style, but it does not have 223 columns limit | |
8630 unlike "xterm" or "xterm2". | |
3750 | 8631 *sgr-mouse* |
8632 sgr Mouse handling for the terminal that emits SGR-styled | |
5908 | 8633 mouse reporting. The mouse works even in columns |
8634 beyond 223. This option is backward compatible with | |
8635 "xterm2" because it can also decode "xterm2" style | |
8636 mouse codes. | |
7 | 8637 |
8638 The mouse handling must be enabled at compile time |+mouse_xterm| | |
5908 | 8639 |+mouse_dec| |+mouse_netterm| |+mouse_jsbterm| |+mouse_urxvt| |
8640 |+mouse_sgr|. | |
7 | 8641 Only "xterm"(2) is really recognized. NetTerm mouse codes are always |
8642 recognized, if enabled at compile time. DEC terminal mouse codes | |
8643 are recognized if enabled at compile time, and 'ttymouse' is not | |
5908 | 8644 "xterm", "xterm2", "urxvt" or "sgr" (because dec mouse codes conflict |
8645 with them). | |
7 | 8646 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
|
8647 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
|
8648 "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
|
8649 already. |
5908 | 8650 Additionally, if vim is compiled with the |+termresponse| feature and |
8651 |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
|
8652 number, more intelligent detection is done. |
7 | 8653 The "xterm2" value will be set if the xterm version is reported to be |
15131 | 8654 from 95 to 276. The "sgr" value will be set if Vim detects Mac |
8655 Terminal.app, iTerm2 or mintty, and when the xterm version is 277 or | |
8656 higher. | |
5908 | 8657 If you do not want 'ttymouse' to be set to "xterm2" or "sgr" |
8658 automatically, set t_RV to an empty string: > | |
7 | 8659 :set t_RV= |
8660 < | |
8661 *'ttyscroll'* *'tsl'* | |
8662 'ttyscroll' 'tsl' number (default 999) | |
8663 global | |
8664 Maximum number of lines to scroll the screen. If there are more lines | |
8665 to scroll the window is redrawn. For terminals where scrolling is | |
8666 very slow and redrawing is not slow this can be set to a small number, | |
8667 e.g., 3, to speed up displaying. | |
8668 | |
8669 *'ttytype'* *'tty'* | |
8670 'ttytype' 'tty' string (default from $TERM) | |
8671 global | |
8672 Alias for 'term', see above. | |
8673 | |
2214
f8222d1f9a73
Included patch for persistent undo. Lots of changes and added test.
Bram Moolenaar <bram@vim.org>
parents:
2209
diff
changeset
|
8674 *'undodir'* *'udir'* |
f8222d1f9a73
Included patch for persistent undo. Lots of changes and added test.
Bram Moolenaar <bram@vim.org>
parents:
2209
diff
changeset
|
8675 '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
|
8676 global |
2570
71b56b4e7785
Make the references to features in the help more consistent. (Sylvain Hitier)
Bram Moolenaar <bram@vim.org>
parents:
2561
diff
changeset
|
8677 {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
|
8678 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
|
8679 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
|
8680 "." 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
|
8681 "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
|
8682 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
|
8683 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
|
8684 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
|
8685 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
|
8686 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
|
8687 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
|
8688 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
|
8689 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
|
8690 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
|
8691 security reasons. |
2214
f8222d1f9a73
Included patch for persistent undo. Lots of changes and added test.
Bram Moolenaar <bram@vim.org>
parents:
2209
diff
changeset
|
8692 |
4681
2eb30f341e8d
Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents:
4502
diff
changeset
|
8693 *'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
|
8694 '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
|
8695 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
|
8696 {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
|
8697 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
|
8698 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
|
8699 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
|
8700 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
|
8701 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
|
8702 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
|
8703 before a reload to be saved for undo. |
3920 | 8704 When 'undofile' is turned off the undo file is NOT deleted. |
11160 | 8705 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
|
8706 |
7 | 8707 *'undolevels'* *'ul'* |
19116 | 8708 'undolevels' 'ul' number (default 100, 1000 for Unix, VMS and Win32) |
5446 | 8709 global or local to buffer |global-local| |
7 | 8710 Maximum number of changes that can be undone. Since undo information |
18186 | 8711 is kept in memory, higher numbers will cause more memory to be used. |
8712 Nevertheless, a single change can already use a large amount of memory. | |
7 | 8713 Set to 0 for Vi compatibility: One level of undo and "u" undoes |
8714 itself: > | |
8715 set ul=0 | |
8716 < But you can also get Vi compatibility by including the 'u' flag in | |
8717 '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
|
8718 Also see |undo-two-ways|. |
5446 | 8719 Set to -1 for no undo at all. You might want to do this only for the |
8720 current buffer: > | |
8721 setlocal ul=-1 | |
7 | 8722 < This helps when you run out of memory for a single change. |
6336 | 8723 |
8724 The local value is set to -123456 when the global value is to be used. | |
8725 | |
2249
6d3d35ff2c2b
Use full path in undofile(). Updated docs.
Bram Moolenaar <bram@vim.org>
parents:
2240
diff
changeset
|
8726 Also see |clear-undo|. |
7 | 8727 |
2394
a3aca345aafa
Add the 'undoreload' option to be able to undo a file reload.
Bram Moolenaar <bram@vim.org>
parents:
2382
diff
changeset
|
8728 *'undoreload'* *'ur'* |
a3aca345aafa
Add the 'undoreload' option to be able to undo a file reload.
Bram Moolenaar <bram@vim.org>
parents:
2382
diff
changeset
|
8729 '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
|
8730 global |
a3aca345aafa
Add the 'undoreload' option to be able to undo a file reload.
Bram Moolenaar <bram@vim.org>
parents:
2382
diff
changeset
|
8731 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
|
8732 ":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
|
8733 Vim. |FileChangedShell| |
12559 | 8734 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
|
8735 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
|
8736 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
|
8737 |
a3aca345aafa
Add the 'undoreload' option to be able to undo a file reload.
Bram Moolenaar <bram@vim.org>
parents:
2382
diff
changeset
|
8738 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
|
8739 |
a3aca345aafa
Add the 'undoreload' option to be able to undo a file reload.
Bram Moolenaar <bram@vim.org>
parents:
2382
diff
changeset
|
8740 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
|
8741 this option to a lower value if you run out of memory. |
7 | 8742 |
8743 *'updatecount'* *'uc'* | |
8744 'updatecount' 'uc' number (default: 200) | |
8745 global | |
8746 After typing this many characters the swap file will be written to | |
8747 disk. When zero, no swap file will be created at all (see chapter on | |
8748 recovery |crash-recovery|). 'updatecount' is set to zero by starting | |
8749 Vim with the "-n" option, see |startup|. When editing in readonly | |
8750 mode this option will be initialized to 10000. | |
8751 The swapfile can be disabled per buffer with |'swapfile'|. | |
8752 When 'updatecount' is set from zero to non-zero, swap files are | |
8753 created for all buffers that have 'swapfile' set. When 'updatecount' | |
8754 is set to zero, existing swap files are not deleted. | |
8755 Also see |'swapsync'|. | |
8756 This option has no meaning in buffers where |'buftype'| is "nofile" | |
8757 or "nowrite". | |
8758 | |
8759 *'updatetime'* *'ut'* | |
8760 'updatetime' 'ut' number (default 4000) | |
8761 global | |
8762 If this many milliseconds nothing is typed the swap file will be | |
8763 written to disk (see |crash-recovery|). Also used for the | |
8764 |CursorHold| autocommand event. | |
8765 | |
14175
2ad722003b36
patch 8.1.0105: all tab stops are the same
Christian Brabandt <cb@256bit.org>
parents:
14019
diff
changeset
|
8766 *'varsofttabstop'* *'vsts'* |
2ad722003b36
patch 8.1.0105: all tab stops are the same
Christian Brabandt <cb@256bit.org>
parents:
14019
diff
changeset
|
8767 'varsofttabstop' 'vsts' string (default "") |
2ad722003b36
patch 8.1.0105: all tab stops are the same
Christian Brabandt <cb@256bit.org>
parents:
14019
diff
changeset
|
8768 local to buffer |
2ad722003b36
patch 8.1.0105: all tab stops are the same
Christian Brabandt <cb@256bit.org>
parents:
14019
diff
changeset
|
8769 {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
|
8770 feature} |
2ad722003b36
patch 8.1.0105: all tab stops are the same
Christian Brabandt <cb@256bit.org>
parents:
14019
diff
changeset
|
8771 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
|
8772 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
|
8773 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
|
8774 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
|
8775 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
|
8776 |
2ad722003b36
patch 8.1.0105: all tab stops are the same
Christian Brabandt <cb@256bit.org>
parents:
14019
diff
changeset
|
8777 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
|
8778 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
|
8779 to use the following: > |
2ad722003b36
patch 8.1.0105: all tab stops are the same
Christian Brabandt <cb@256bit.org>
parents:
14019
diff
changeset
|
8780 :set varsofttabstop=8,32,8 |
14249
4543777545a3
Updated runtime and language files.
Christian Brabandt <cb@256bit.org>
parents:
14175
diff
changeset
|
8781 < 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
|
8782 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
|
8783 |
2ad722003b36
patch 8.1.0105: all tab stops are the same
Christian Brabandt <cb@256bit.org>
parents:
14019
diff
changeset
|
8784 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
|
8785 'varsofttabstop' is set. |
2ad722003b36
patch 8.1.0105: all tab stops are the same
Christian Brabandt <cb@256bit.org>
parents:
14019
diff
changeset
|
8786 |
2ad722003b36
patch 8.1.0105: all tab stops are the same
Christian Brabandt <cb@256bit.org>
parents:
14019
diff
changeset
|
8787 *'vartabstop'* *'vts'* |
2ad722003b36
patch 8.1.0105: all tab stops are the same
Christian Brabandt <cb@256bit.org>
parents:
14019
diff
changeset
|
8788 'vartabstop' 'vts' string (default "") |
2ad722003b36
patch 8.1.0105: all tab stops are the same
Christian Brabandt <cb@256bit.org>
parents:
14019
diff
changeset
|
8789 local to buffer |
2ad722003b36
patch 8.1.0105: all tab stops are the same
Christian Brabandt <cb@256bit.org>
parents:
14019
diff
changeset
|
8790 {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
|
8791 feature} |
2ad722003b36
patch 8.1.0105: all tab stops are the same
Christian Brabandt <cb@256bit.org>
parents:
14019
diff
changeset
|
8792 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
|
8793 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
|
8794 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
|
8795 :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
|
8796 < 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
|
8797 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
|
8798 |
2ad722003b36
patch 8.1.0105: all tab stops are the same
Christian Brabandt <cb@256bit.org>
parents:
14019
diff
changeset
|
8799 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
|
8800 is set. |
2ad722003b36
patch 8.1.0105: all tab stops are the same
Christian Brabandt <cb@256bit.org>
parents:
14019
diff
changeset
|
8801 |
7 | 8802 *'verbose'* *'vbs'* |
8803 'verbose' 'vbs' number (default 0) | |
8804 global | |
8805 When bigger than zero, Vim will give messages about what it is doing. | |
8806 Currently, these messages are given: | |
8807 >= 1 When the viminfo file is read or written. | |
8808 >= 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
|
8809 >= 4 Shell commands. |
712 | 8810 >= 5 Every searched tags file and include file. |
7 | 8811 >= 8 Files for which a group of autocommands is executed. |
8812 >= 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
|
8813 >= 11 Finding items in a path |
7 | 8814 >= 12 Every executed function. |
8815 >= 13 When an exception is thrown, caught, finished, or discarded. | |
8816 >= 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
|
8817 >= 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
|
8818 characters). |
21676 | 8819 >= 16 Every executed Ex command. |
7 | 8820 |
8821 This option can also be set with the "-V" argument. See |-V|. | |
8822 This option is also set by the |:verbose| command. | |
8823 | |
293 | 8824 When the 'verbosefile' option is set then the verbose messages are not |
8825 displayed. | |
8826 | |
8827 *'verbosefile'* *'vfile'* | |
8828 'verbosefile' 'vfile' string (default empty) | |
8829 global | |
8830 When not empty all messages are written in a file with this name. | |
8831 When the file exists messages are appended. | |
8832 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
|
8833 empty. Writes are buffered, thus may not show up for some time. |
293 | 8834 Setting 'verbosefile' to a new value is like making it empty first. |
8835 The difference with |:redir| is that verbose messages are not | |
8836 displayed when 'verbosefile' is set. | |
8837 | |
7 | 8838 *'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
|
8839 'viewdir' 'vdir' string (default for Amiga and Win32: |
7 | 8840 "$VIM/vimfiles/view", |
8841 for Unix: "~/.vim/view", | |
21825 | 8842 for macOS: "$VIM:vimfiles:view" |
18972 | 8843 for VMS: "sys$login:vimfiles/view") |
7 | 8844 global |
2570
71b56b4e7785
Make the references to features in the help more consistent. (Sylvain Hitier)
Bram Moolenaar <bram@vim.org>
parents:
2561
diff
changeset
|
8845 {not available when compiled without the |+mksession| |
7 | 8846 feature} |
8847 Name of the directory where to store files for |:mkview|. | |
8848 This option cannot be set from a |modeline| or in the |sandbox|, for | |
8849 security reasons. | |
8850 | |
8851 *'viewoptions'* *'vop'* | |
12824
79a754456110
patch 8.0.1289: mkview always includes the local directory
Christian Brabandt <cb@256bit.org>
parents:
12802
diff
changeset
|
8852 'viewoptions' 'vop' string (default: "folds,options,cursor,curdir") |
7 | 8853 global |
2570
71b56b4e7785
Make the references to features in the help more consistent. (Sylvain Hitier)
Bram Moolenaar <bram@vim.org>
parents:
2561
diff
changeset
|
8854 {not available when compiled without the |+mksession| |
7 | 8855 feature} |
28379 | 8856 Changes the effect of the |:mkview| command. It is a comma-separated |
10 | 8857 list of words. Each word enables saving and restoring something: |
7 | 8858 word save and restore ~ |
8859 cursor cursor position in file and in window | |
8860 folds manually created folds, opened/closed folds and local | |
8861 fold options | |
8862 options options and mappings local to a window or buffer (not | |
8863 global values for local options) | |
6213 | 8864 localoptions same as "options" |
7 | 8865 slash backslashes in file names replaced with forward |
8866 slashes | |
8867 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
|
8868 on MS-Windows |
12824
79a754456110
patch 8.0.1289: mkview always includes the local directory
Christian Brabandt <cb@256bit.org>
parents:
12802
diff
changeset
|
8869 curdir the window-local directory, if set with `:lcd` |
7 | 8870 |
18912
ccd16426a1f9
patch 8.2.0017: OS/2 and MS-DOS are still mentioned
Bram Moolenaar <Bram@vim.org>
parents:
18879
diff
changeset
|
8871 "slash" and "unix" are useful on MS-Windows when sharing view files |
7 | 8872 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
|
8873 but the MS-Windows version of Vim can source unix format scripts. |
7 | 8874 |
8875 *'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
|
8876 '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
|
8877 MS-Windows: '100,<50,s10,h,rA:,rB:, |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
8878 for Amiga: '100,<50,s10,h,rdf0:,rdf1:,rdf2: |
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
8879 for others: '100,<50,s10,h) |
7 | 8880 global |
2570
71b56b4e7785
Make the references to features in the help more consistent. (Sylvain Hitier)
Bram Moolenaar <bram@vim.org>
parents:
2561
diff
changeset
|
8881 {not available when compiled without the |+viminfo| |
7 | 8882 feature} |
8883 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
|
8884 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
|
8885 "NONE". |
28379 | 8886 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
|
8887 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
|
8888 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
|
8889 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
|
8890 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
|
8891 identifying characters and the effect of their value. |
7 | 8892 CHAR VALUE ~ |
3224 | 8893 *viminfo-!* |
7 | 8894 ! When included, save and restore global variables that start |
8895 with an uppercase letter, and don't contain a lowercase | |
8896 letter. Thus "KEEPTHIS and "K_L_M" are stored, but "KeepThis" | |
2607 | 8897 and "_K_L_M" are not. Nested List and Dict items may not be |
2642 | 8898 read back correctly, you end up with an empty item. |
3224 | 8899 *viminfo-quote* |
7 | 8900 " Maximum number of lines saved for each register. Old name of |
8901 the '<' item, with the disadvantage that you need to put a | |
8902 backslash before the ", otherwise it will be recognized as the | |
8903 start of a comment! | |
3224 | 8904 *viminfo-%* |
7 | 8905 % When included, save and restore the buffer list. If Vim is |
8906 started with a file name argument, the buffer list is not | |
8907 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
|
8908 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
|
8909 ('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
|
8910 removable media (|viminfo-r|) are not saved. |
23 | 8911 When followed by a number, the number specifies the maximum |
8912 number of buffers that are stored. Without a number all | |
8913 buffers are stored. | |
3224 | 8914 *viminfo-'* |
7 | 8915 ' Maximum number of previously edited files for which the marks |
8916 are remembered. This parameter must always be included when | |
8917 'viminfo' is non-empty. | |
8918 Including this item also means that the |jumplist| and the | |
8919 |changelist| are stored in the viminfo file. | |
3224 | 8920 *viminfo-/* |
7 | 8921 / Maximum number of items in the search pattern history to be |
10 | 8922 saved. If non-zero, then the previous search and substitute |
7 | 8923 patterns are also saved. When not included, the value of |
8924 'history' is used. | |
3224 | 8925 *viminfo-:* |
7 | 8926 : Maximum number of items in the command-line history to be |
10 | 8927 saved. When not included, the value of 'history' is used. |
3224 | 8928 *viminfo-<* |
7 | 8929 < Maximum number of lines saved for each register. If zero then |
8930 registers are not saved. When not included, all lines are | |
8931 saved. '"' is the old name for this item. | |
8932 Also see the 's' item below: limit specified in Kbyte. | |
3224 | 8933 *viminfo-@* |
7 | 8934 @ Maximum number of items in the input-line history to be |
10 | 8935 saved. When not included, the value of 'history' is used. |
3224 | 8936 *viminfo-c* |
7 | 8937 c When included, convert the text in the viminfo file from the |
8938 'encoding' used when writing the file to the current | |
233 | 8939 'encoding'. See |viminfo-encoding|. |
3224 | 8940 *viminfo-f* |
7 | 8941 f Whether file marks need to be stored. If zero, file marks ('0 |
8942 to '9, 'A to 'Z) are not stored. When not present or when | |
10 | 8943 non-zero, they are all stored. '0 is used for the current |
7 | 8944 cursor position (when exiting or when doing ":wviminfo"). |
3224 | 8945 *viminfo-h* |
7 | 8946 h Disable the effect of 'hlsearch' when loading the viminfo |
8947 file. When not included, it depends on whether ":nohlsearch" | |
8948 has been used since the last search command. | |
3224 | 8949 *viminfo-n* |
7 | 8950 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
|
8951 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
|
8952 '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
|
8953 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
|
8954 expanded when opening the file, not when setting the option. |
3224 | 8955 *viminfo-r* |
7 | 8956 r Removable media. The argument is a string (up to the next |
8957 ','). This parameter can be given several times. Each | |
8958 specifies the start of a path for which no marks will be | |
18972 | 8959 stored. This is to avoid removable media. For MS-Windows you |
7 | 8960 could use "ra:,rb:", for Amiga "rdf0:,rdf1:,rdf2:". You can |
8961 also use it for temp files, e.g., for Unix: "r/tmp". Case is | |
8962 ignored. Maximum length of each 'r' argument is 50 | |
8963 characters. | |
3224 | 8964 *viminfo-s* |
7 | 8965 s Maximum size of an item in Kbyte. If zero then registers are |
8966 not saved. Currently only applies to registers. The default | |
8967 "s10" will exclude registers with more than 10 Kbyte of text. | |
8968 Also see the '<' item above: line count limit. | |
8969 | |
8970 Example: > | |
8971 :set viminfo='50,<1000,s100,:0,n~/vim/viminfo | |
8972 < | |
8973 '50 Marks will be remembered for the last 50 files you | |
8974 edited. | |
8975 <1000 Contents of registers (up to 1000 lines each) will be | |
8976 remembered. | |
8977 s100 Registers with more than 100 Kbyte text are skipped. | |
8978 :0 Command-line history will not be saved. | |
8979 n~/vim/viminfo The name of the file to use is "~/vim/viminfo". | |
8980 no / Since '/' is not specified, the default will be used, | |
8981 that is, save all of the search history, and also the | |
8982 previous search and substitute patterns. | |
8983 no % The buffer list will not be saved nor read back. | |
8984 no h 'hlsearch' highlighting will be restored. | |
8985 | |
8986 When setting 'viminfo' from an empty value you can use |:rviminfo| to | |
8987 load the contents of the file, this is not done automatically. | |
8988 | |
8989 This option cannot be set from a |modeline| or in the |sandbox|, for | |
8990 security reasons. | |
11160 | 8991 NOTE: This option is set to the Vim default value when 'compatible' |
8992 is reset. | |
7 | 8993 |
11666
5cd9ba96561d
patch 8.0.0716: not easy to start Vim cleanly
Christian Brabandt <cb@256bit.org>
parents:
11659
diff
changeset
|
8994 *'viminfofile'* *'vif'* |
5cd9ba96561d
patch 8.0.0716: not easy to start Vim cleanly
Christian Brabandt <cb@256bit.org>
parents:
11659
diff
changeset
|
8995 'viminfofile' 'vif' string (default: "") |
5cd9ba96561d
patch 8.0.0716: not easy to start Vim cleanly
Christian Brabandt <cb@256bit.org>
parents:
11659
diff
changeset
|
8996 global |
5cd9ba96561d
patch 8.0.0716: not easy to start Vim cleanly
Christian Brabandt <cb@256bit.org>
parents:
11659
diff
changeset
|
8997 {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
|
8998 feature} |
5cd9ba96561d
patch 8.0.0716: not easy to start Vim cleanly
Christian Brabandt <cb@256bit.org>
parents:
11659
diff
changeset
|
8999 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
|
9000 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
|
9001 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
|
9002 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
|
9003 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
|
9004 security reasons. |
11666
5cd9ba96561d
patch 8.0.0716: not easy to start Vim cleanly
Christian Brabandt <cb@256bit.org>
parents:
11659
diff
changeset
|
9005 |
7 | 9006 *'virtualedit'* *'ve'* |
9007 '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
|
9008 global or local to window |global-local| |
28379 | 9009 A comma-separated list of these words: |
7 | 9010 block Allow virtual editing in Visual block mode. |
9011 insert Allow virtual editing in Insert mode. | |
9012 all Allow virtual editing in all modes. | |
772 | 9013 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
|
9014 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
|
9015 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
|
9016 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
|
9017 NONE Alternative spelling of "none". |
782 | 9018 |
7 | 9019 Virtual editing means that the cursor can be positioned where there is |
1263 | 9020 no actual character. This can be halfway into a tab or beyond the end |
7 | 9021 of the line. Useful for selecting a rectangle in Visual mode and |
9022 editing a table. | |
772 | 9023 "onemore" is not the same, it will only allow moving the cursor just |
9024 after the last character of the line. This makes some commands more | |
9025 consistent. Previously the cursor was always past the end of the line | |
9026 if the line was empty. But it is far from Vi compatible. It may also | |
782 | 9027 break some plugins or Vim scripts. For example because |l| can move |
9028 the cursor after the last character. Use with care! | |
5220 | 9029 Using the `$` command will move to the last character in the line, not |
782 | 9030 past it. This may actually move the cursor to the left! |
5220 | 9031 The `g$` command will move to the end of the screen line. |
772 | 9032 It doesn't make sense to combine "all" with "onemore", but you will |
9033 not get a warning for it. | |
25402 | 9034 When combined with other words, "none" is ignored. |
11160 | 9035 NOTE: This option is set to "" when 'compatible' is set. |
7 | 9036 |
9037 *'visualbell'* *'vb'* *'novisualbell'* *'novb'* *beep* | |
9038 'visualbell' 'vb' boolean (default off) | |
9039 global | |
11659
49c12c93abf3
Updated runtime files and translations.
Christian Brabandt <cb@256bit.org>
parents:
11529
diff
changeset
|
9040 Use a visual bell instead of beeping. The terminal code to display the |
7 | 9041 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
|
9042 use: > |
49c12c93abf3
Updated runtime files and translations.
Christian Brabandt <cb@256bit.org>
parents:
11529
diff
changeset
|
9043 :set vb t_vb= |
49c12c93abf3
Updated runtime files and translations.
Christian Brabandt <cb@256bit.org>
parents:
11529
diff
changeset
|
9044 < 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
|
9045 :set vb t_vb=[?5h$<100>[?5l |
49c12c93abf3
Updated runtime files and translations.
Christian Brabandt <cb@256bit.org>
parents:
11529
diff
changeset
|
9046 < 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
|
9047 to get a shorter or longer flash. |
49c12c93abf3
Updated runtime files and translations.
Christian Brabandt <cb@256bit.org>
parents:
11529
diff
changeset
|
9048 |
49c12c93abf3
Updated runtime files and translations.
Christian Brabandt <cb@256bit.org>
parents:
11529
diff
changeset
|
9049 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
|
9050 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
|
9051 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
|
9052 set. |
49c12c93abf3
Updated runtime files and translations.
Christian Brabandt <cb@256bit.org>
parents:
11529
diff
changeset
|
9053 |
7 | 9054 In the GUI, 't_vb' defaults to "<Esc>|f", which inverts the display |
9055 for 20 msec. If you want to use a different time, use "<Esc>|40f", | |
9056 where 40 is the time in msec. | |
11659
49c12c93abf3
Updated runtime files and translations.
Christian Brabandt <cb@256bit.org>
parents:
11529
diff
changeset
|
9057 |
49c12c93abf3
Updated runtime files and translations.
Christian Brabandt <cb@256bit.org>
parents:
11529
diff
changeset
|
9058 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
|
9059 might want to set it again in your |gvimrc|. |
49c12c93abf3
Updated runtime files and translations.
Christian Brabandt <cb@256bit.org>
parents:
11529
diff
changeset
|
9060 |
7 | 9061 Does not work on the Amiga, you always get a screen flash. |
9062 Also see 'errorbells'. | |
9063 | |
9064 *'warn'* *'nowarn'* | |
9065 'warn' boolean (default on) | |
9066 global | |
9067 Give a warning message when a shell command is used while the buffer | |
9068 has been changed. | |
9069 | |
9070 *'weirdinvert'* *'wiv'* *'noweirdinvert'* *'nowiv'* | |
9071 'weirdinvert' 'wiv' boolean (default off) | |
9072 global | |
667 | 9073 This option has the same effect as the 't_xs' terminal option. |
7 | 9074 It is provided for backwards compatibility with version 4.x. |
9075 Setting 'weirdinvert' has the effect of making 't_xs' non-empty, and | |
9076 vice versa. Has no effect when the GUI is running. | |
9077 | |
9078 *'whichwrap'* *'ww'* | |
9079 'whichwrap' 'ww' string (Vim default: "b,s", Vi default: "") | |
9080 global | |
9081 Allow specified keys that move the cursor left/right to move to the | |
9082 previous/next line when the cursor is on the first/last character in | |
9083 the line. Concatenate characters to allow this for these keys: | |
9084 char key mode ~ | |
9085 b <BS> Normal and Visual | |
9086 s <Space> Normal and Visual | |
712 | 9087 h "h" Normal and Visual (not recommended) |
9088 l "l" Normal and Visual (not recommended) | |
7 | 9089 < <Left> Normal and Visual |
9090 > <Right> Normal and Visual | |
9091 ~ "~" Normal | |
9092 [ <Left> Insert and Replace | |
9093 ] <Right> Insert and Replace | |
9094 For example: > | |
9095 :set ww=<,>,[,] | |
9096 < allows wrap only when cursor keys are used. | |
9097 When the movement keys are used in combination with a delete or change | |
9098 operator, the <EOL> also counts for a character. This makes "3h" | |
9099 different from "3dh" when the cursor crosses the end of a line. This | |
9100 is also true for "x" and "X", because they do the same as "dl" and | |
9101 "dh". If you use this, you may also want to use the mapping | |
9102 ":map <BS> X" to make backspace delete the character in front of the | |
9103 cursor. | |
714 | 9104 When 'l' is included and it is used after an operator at the end of a |
18130 | 9105 line (not an empty line) then it will not move to the next line. This |
9106 makes "dl", "cl", "yl" etc. work normally. | |
7 | 9107 NOTE: This option is set to the Vi default value when 'compatible' is |
9108 set and to the Vim default value when 'compatible' is reset. | |
9109 | |
9110 *'wildchar'* *'wc'* | |
9111 'wildchar' 'wc' number (Vim default: <Tab>, Vi default: CTRL-E) | |
9112 global | |
9113 Character you have to type to start wildcard expansion in the | |
9114 command-line, as specified with 'wildmode'. | |
1621 | 9115 More info here: |cmdline-completion|. |
7 | 9116 The character is not recognized when used inside a macro. See |
9117 'wildcharm' for that. | |
25836 | 9118 Some keys will not work, such as CTRL-C, <CR> and Enter. |
7 | 9119 Although 'wc' is a number option, you can set it to a special key: > |
25836 | 9120 :set wc=<Tab> |
7 | 9121 < NOTE: This option is set to the Vi default value when 'compatible' is |
9122 set and to the Vim default value when 'compatible' is reset. | |
9123 | |
9124 *'wildcharm'* *'wcm'* | |
9125 'wildcharm' 'wcm' number (default: none (0)) | |
9126 global | |
9127 'wildcharm' works exactly like 'wildchar', except that it is | |
233 | 9128 recognized when used inside a macro. You can find "spare" command-line |
9129 keys suitable for this option by looking at |ex-edit-index|. Normally | |
7 | 9130 you'll never actually type 'wildcharm', just use it in mappings that |
9131 automatically invoke completion mode, e.g.: > | |
9132 :set wcm=<C-Z> | |
1621 | 9133 :cnoremap ss so $vim/sessions/*.vim<C-Z> |
7 | 9134 < Then after typing :ss you can use CTRL-P & CTRL-N. |
9135 | |
9136 *'wildignore'* *'wig'* | |
9137 'wildignore' 'wig' string (default "") | |
9138 global | |
9139 A list of file patterns. A file that matches with one of these | |
3682 | 9140 patterns is ignored when expanding |wildcards|, completing file or |
9141 directory names, and influences the result of |expand()|, |glob()| and | |
9142 |globpath()| unless a flag is passed to disable this. | |
7 | 9143 The pattern is used like with |:autocmd|, see |autocmd-patterns|. |
9144 Also see 'suffixes'. | |
9145 Example: > | |
9146 :set wildignore=*.o,*.obj | |
9147 < The use of |:set+=| and |:set-=| is preferred when adding or removing | |
9148 a pattern from the list. This avoids problems when a future version | |
9149 uses another default. | |
9150 | |
2652 | 9151 |
2662 | 9152 *'wildignorecase'* *'wic'* *'nowildignorecase'* *'nowic'* |
2652 | 9153 'wildignorecase' 'wic' boolean (default off) |
9154 global | |
9155 When set case is ignored when completing file names and directories. | |
4242 | 9156 Has no effect when 'fileignorecase' is set. |
2652 | 9157 Does not apply when the shell is used to expand wildcards, which |
9158 happens when there are special characters. | |
9159 | |
9160 | |
7 | 9161 *'wildmenu'* *'wmnu'* *'nowildmenu'* *'nowmnu'* |
9669
284b4eb307fc
commit https://github.com/vim/vim/commit/8c08b5b569e2a9e9f63dea514591ecfa2d3bb392
Christian Brabandt <cb@256bit.org>
parents:
9665
diff
changeset
|
9162 'wildmenu' 'wmnu' boolean (default off, set in |defaults.vim|) |
7 | 9163 global |
9164 When 'wildmenu' is on, command-line completion operates in an enhanced | |
9165 mode. On pressing 'wildchar' (usually <Tab>) to invoke completion, | |
29881
0cc9a3001717
patch 9.0.0279: the tiny version has the popup menu but not 'wildmenu'
Bram Moolenaar <Bram@vim.org>
parents:
29879
diff
changeset
|
9166 the possible matches are shown. |
0cc9a3001717
patch 9.0.0279: the tiny version has the popup menu but not 'wildmenu'
Bram Moolenaar <Bram@vim.org>
parents:
29879
diff
changeset
|
9167 When 'wildoptions' contains "pum", then the completion matches are |
0cc9a3001717
patch 9.0.0279: the tiny version has the popup menu but not 'wildmenu'
Bram Moolenaar <Bram@vim.org>
parents:
29879
diff
changeset
|
9168 shown in a popup menu. Otherwise they are displayed just above the |
0cc9a3001717
patch 9.0.0279: the tiny version has the popup menu but not 'wildmenu'
Bram Moolenaar <Bram@vim.org>
parents:
29879
diff
changeset
|
9169 command line, with the first match highlighted (overwriting the status |
0cc9a3001717
patch 9.0.0279: the tiny version has the popup menu but not 'wildmenu'
Bram Moolenaar <Bram@vim.org>
parents:
29879
diff
changeset
|
9170 line, if there is one). |
27597
4eb2bf8b2f27
patch 8.2.4325: 'wildmenu' only shows few matches
Bram Moolenaar <Bram@vim.org>
parents:
27537
diff
changeset
|
9171 Keys that show the previous/next match, such as <Tab> or |
7 | 9172 CTRL-P/CTRL-N, cause the highlight to move to the appropriate match. |
9173 When 'wildmode' is used, "wildmenu" mode is used where "full" is | |
9174 specified. "longest" and "list" do not start "wildmenu" mode. | |
4159 | 9175 You can check the current mode with |wildmenumode()|. |
7 | 9176 If there are more matches than can fit in the line, a ">" is shown on |
9177 the right and/or a "<" is shown on the left. The status line scrolls | |
9178 as needed. | |
9179 The "wildmenu" mode is abandoned when a key is hit that is not used | |
9180 for selecting a completion. | |
27597
4eb2bf8b2f27
patch 8.2.4325: 'wildmenu' only shows few matches
Bram Moolenaar <Bram@vim.org>
parents:
27537
diff
changeset
|
9181 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
|
9182 following keys have special meanings: |
7 | 9183 |
9184 <Left> <Right> - select previous/next match (like CTRL-P/CTRL-N) | |
9185 <Down> - in filename/menu name completion: move into a | |
9186 subdirectory or submenu. | |
9187 <CR> - in menu completion, when the cursor is just after a | |
9188 dot: move into a submenu. | |
9189 <Up> - in filename/menu name completion: move up into | |
9190 parent directory or parent menu. | |
9191 | |
27597
4eb2bf8b2f27
patch 8.2.4325: 'wildmenu' only shows few matches
Bram Moolenaar <Bram@vim.org>
parents:
27537
diff
changeset
|
9192 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
|
9193 keys have special meanings: |
4eb2bf8b2f27
patch 8.2.4325: 'wildmenu' only shows few matches
Bram Moolenaar <Bram@vim.org>
parents:
27537
diff
changeset
|
9194 <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
|
9195 <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
|
9196 parent directory or parent menu. |
4eb2bf8b2f27
patch 8.2.4325: 'wildmenu' only shows few matches
Bram Moolenaar <Bram@vim.org>
parents:
27537
diff
changeset
|
9197 <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
|
9198 subdirectory or submenu. |
4eb2bf8b2f27
patch 8.2.4325: 'wildmenu' only shows few matches
Bram Moolenaar <Bram@vim.org>
parents:
27537
diff
changeset
|
9199 <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
|
9200 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
|
9201 selecting a match. |
4eb2bf8b2f27
patch 8.2.4325: 'wildmenu' only shows few matches
Bram Moolenaar <Bram@vim.org>
parents:
27537
diff
changeset
|
9202 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
|
9203 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
|
9204 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
|
9205 completion. |
4eb2bf8b2f27
patch 8.2.4325: 'wildmenu' only shows few matches
Bram Moolenaar <Bram@vim.org>
parents:
27537
diff
changeset
|
9206 |
7 | 9207 This makes the menus accessible from the console |console-menus|. |
9208 | |
9209 If you prefer the <Left> and <Right> keys to move the cursor instead | |
9210 of selecting a different match, use this: > | |
9211 :cnoremap <Left> <Space><BS><Left> | |
9212 :cnoremap <Right> <Space><BS><Right> | |
9213 < | |
9214 The "WildMenu" highlighting is used for displaying the current match | |
9215 |hl-WildMenu|. | |
9216 | |
9217 *'wildmode'* *'wim'* | |
9218 'wildmode' 'wim' string (Vim default: "full") | |
9219 global | |
9220 Completion mode that is used for the character specified with | |
28379 | 9221 'wildchar'. It is a comma-separated list of up to four parts. Each |
1152 | 9222 part specifies what to do for each consecutive use of 'wildchar'. The |
7 | 9223 first part specifies the behavior for the first use of 'wildchar', |
9224 The second part for the second use, etc. | |
24387 | 9225 |
9226 Each part consists of a colon separated list consisting of the | |
9227 following possible values: | |
7 | 9228 "" Complete only the first match. |
9229 "full" Complete the next full match. After the last match, | |
9230 the original string is used and then the first match | |
24387 | 9231 again. Will also start 'wildmenu' if it is enabled. |
7 | 9232 "longest" Complete till longest common string. If this doesn't |
9233 result in a longer string, use the next part. | |
24387 | 9234 "list" When more than one match, list all matches. |
9235 "lastused" When completing buffer names and more than one buffer | |
9236 matches, sort buffers by time last used (other than | |
9237 the current buffer). | |
9238 When there is only a single match, it is fully completed in all cases. | |
9239 | |
9240 Examples of useful colon-separated values: | |
7 | 9241 "longest:full" Like "longest", but also start 'wildmenu' if it is |
24387 | 9242 enabled. Will not complete to the next full match. |
7 | 9243 "list:full" When more than one match, list all matches and |
9244 complete first match. | |
9245 "list:longest" When more than one match, list all matches and | |
9246 complete till longest common string. | |
24387 | 9247 "list:lastused" When more than one buffer matches, list all matches |
9248 and sort buffers by time last used (other than the | |
9249 current buffer). | |
7 | 9250 |
9251 Examples: > | |
9252 :set wildmode=full | |
233 | 9253 < Complete first full match, next match, etc. (the default) > |
7 | 9254 :set wildmode=longest,full |
9255 < Complete longest common string, then each full match > | |
9256 :set wildmode=list:full | |
9257 < List all matches and complete each full match > | |
9258 :set wildmode=list,full | |
9259 < List all matches without completing, then each full match > | |
9260 :set wildmode=longest,list | |
9261 < Complete longest common string, then list alternatives. | |
1621 | 9262 More info here: |cmdline-completion|. |
7 | 9263 |
40 | 9264 *'wildoptions'* *'wop'* |
9265 'wildoptions' 'wop' string (default "") | |
9266 global | |
27597
4eb2bf8b2f27
patch 8.2.4325: 'wildmenu' only shows few matches
Bram Moolenaar <Bram@vim.org>
parents:
27537
diff
changeset
|
9267 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
|
9268 The following values are supported: |
28010 | 9269 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
|
9270 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
|
9271 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
|
9272 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
|
9273 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
|
9274 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
|
9275 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
|
9276 instead wildcard expansion is used. |
29290 | 9277 pum Display the completion matches using the popup menu |
27597
4eb2bf8b2f27
patch 8.2.4325: 'wildmenu' only shows few matches
Bram Moolenaar <Bram@vim.org>
parents:
27537
diff
changeset
|
9278 in the same style as the |ins-completion-menu|. |
40 | 9279 tagfile When using CTRL-D to list matching tags, the kind of |
856 | 9280 tag and the file of the tag is listed. Only one match |
40 | 9281 is displayed per line. Often used tag kinds are: |
9282 d #define | |
9283 f function | |
9284 | |
7 | 9285 *'winaltkeys'* *'wak'* |
9286 'winaltkeys' 'wak' string (default "menu") | |
9287 global | |
9288 {only used in Win32, Motif, GTK and Photon GUI} | |
9289 Some GUI versions allow the access to menu entries by using the ALT | |
9290 key in combination with a character that appears underlined in the | |
9291 menu. This conflicts with the use of the ALT key for mappings and | |
9292 entering special characters. This option tells what to do: | |
9293 no Don't use ALT keys for menus. ALT key combinations can be | |
9294 mapped, but there is no automatic handling. This can then be | |
9295 done with the |:simalt| command. | |
9296 yes ALT key handling is done by the windowing system. ALT key | |
9297 combinations cannot be mapped. | |
9298 menu Using ALT in combination with a character that is a menu | |
10 | 9299 shortcut key, will be handled by the windowing system. Other |
7 | 9300 keys can be mapped. |
9301 If the menu is disabled by excluding 'm' from 'guioptions', the ALT | |
9302 key is never used for the menu. | |
36 | 9303 This option is not used for <F10>; on Win32 and with GTK <F10> will |
9304 select the menu, unless it has been mapped. | |
7 | 9305 |
16778
eda4d65f232c
patch 8.1.1391: no popup window support
Bram Moolenaar <Bram@vim.org>
parents:
16740
diff
changeset
|
9306 *'wincolor'* *'wcr'* |
eda4d65f232c
patch 8.1.1391: no popup window support
Bram Moolenaar <Bram@vim.org>
parents:
16740
diff
changeset
|
9307 'wincolor' 'wcr' string (default empty) |
eda4d65f232c
patch 8.1.1391: no popup window support
Bram Moolenaar <Bram@vim.org>
parents:
16740
diff
changeset
|
9308 local to window |
eda4d65f232c
patch 8.1.1391: no popup window support
Bram Moolenaar <Bram@vim.org>
parents:
16740
diff
changeset
|
9309 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
|
9310 color |hl-Normal|. |
eda4d65f232c
patch 8.1.1391: no popup window support
Bram Moolenaar <Bram@vim.org>
parents:
16740
diff
changeset
|
9311 |
164 | 9312 *'window'* *'wi'* |
9313 'window' 'wi' number (default screen height - 1) | |
9314 global | |
24278 | 9315 Window height used for |CTRL-F| and |CTRL-B| when there is only one |
9316 window and the value is smaller than 'lines' minus one. The screen | |
9317 will scroll 'window' minus two lines, with a minimum of one. | |
164 | 9318 When 'window' is equal to 'lines' minus one CTRL-F and CTRL-B scroll |
9319 in a much smarter way, taking care of wrapping lines. | |
9320 When resizing the Vim window, the value is smaller than 1 or more than | |
9321 or equal to 'lines' it will be set to 'lines' minus 1. | |
24278 | 9322 Note: Do not confuse this with the height of the Vim window, use |
9323 'lines' for that. | |
164 | 9324 |
7 | 9325 *'winheight'* *'wh'* *E591* |
9326 'winheight' 'wh' number (default 1) | |
9327 global | |
9328 Minimal number of lines for the current window. This is not a hard | |
10 | 9329 minimum, Vim will use fewer lines if there is not enough room. If the |
1621 | 9330 focus goes to a window that is smaller, its size is increased, at the |
9331 cost of the height of other windows. | |
9332 Set 'winheight' to a small number for normal editing. | |
9333 Set it to 999 to make the current window fill most of the screen. | |
9334 Other windows will be only 'winminheight' high. This has the drawback | |
9335 that ":all" will create only two windows. To avoid "vim -o 1 2 3 4" | |
9336 to create only two windows, set the option after startup is done, | |
9337 using the |VimEnter| event: > | |
9338 au VimEnter * set winheight=999 | |
9339 < Minimum value is 1. | |
9340 The height is not adjusted after one of the commands that change the | |
7 | 9341 height of the current window. |
9342 'winheight' applies to the current window. Use 'winminheight' to set | |
9343 the minimal height for other windows. | |
9344 | |
9345 *'winfixheight'* *'wfh'* *'nowinfixheight'* *'nowfh'* | |
9346 'winfixheight' 'wfh' boolean (default off) | |
9347 local to window | |
9348 Keep the window height when windows are opened or closed and | |
1152 | 9349 'equalalways' is set. Also for |CTRL-W_=|. Set by default for the |
9350 |preview-window| and |quickfix-window|. | |
7 | 9351 The height may be changed anyway when running out of room. |
9352 | |
782 | 9353 *'winfixwidth'* *'wfw'* *'nowinfixwidth'* *'nowfw'* |
9354 'winfixwidth' 'wfw' boolean (default off) | |
9355 local to window | |
9356 Keep the window width when windows are opened or closed and | |
1152 | 9357 'equalalways' is set. Also for |CTRL-W_=|. |
782 | 9358 The width may be changed anyway when running out of room. |
9359 | |
7 | 9360 *'winminheight'* *'wmh'* |
9361 'winminheight' 'wmh' number (default 1) | |
9362 global | |
9363 The minimal height of a window, when it's not the current window. | |
9364 This is a hard minimum, windows will never become smaller. | |
9365 When set to zero, windows may be "squashed" to zero lines (i.e. just a | |
9366 status bar) if necessary. They will return to at least one line when | |
9367 they become active (since the cursor has to have somewhere to go.) | |
9368 Use 'winheight' to set the minimal height of the current window. | |
9369 This option is only checked when making a window smaller. Don't use a | |
9370 large number, it will cause errors when opening more than a few | |
9371 windows. A value of 0 to 3 is reasonable. | |
9372 | |
9373 *'winminwidth'* *'wmw'* | |
9374 'winminwidth' 'wmw' number (default 1) | |
9375 global | |
9376 The minimal width of a window, when it's not the current window. | |
9377 This is a hard minimum, windows will never become smaller. | |
9378 When set to zero, windows may be "squashed" to zero columns (i.e. just | |
9379 a vertical separator) if necessary. They will return to at least one | |
9380 line when they become active (since the cursor has to have somewhere | |
9381 to go.) | |
9382 Use 'winwidth' to set the minimal width of the current window. | |
9383 This option is only checked when making a window smaller. Don't use a | |
9384 large number, it will cause errors when opening more than a few | |
9385 windows. A value of 0 to 12 is reasonable. | |
9386 | |
12138
bee3751f3d4e
patch 8.0.0949: winpty.dll name is fixed
Christian Brabandt <cb@256bit.org>
parents:
11914
diff
changeset
|
9387 *'winptydll'* |
bee3751f3d4e
patch 8.0.0949: winpty.dll name is fixed
Christian Brabandt <cb@256bit.org>
parents:
11914
diff
changeset
|
9388 '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
|
9389 global |
bee3751f3d4e
patch 8.0.0949: winpty.dll name is fixed
Christian Brabandt <cb@256bit.org>
parents:
11914
diff
changeset
|
9390 {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
|
9391 feature on MS-Windows} |
bee3751f3d4e
patch 8.0.0949: winpty.dll name is fixed
Christian Brabandt <cb@256bit.org>
parents:
11914
diff
changeset
|
9392 Specifies the name of the winpty shared library, used for the |
21676 | 9393 |:terminal| command. The default depends on whether Vim was built as a |
12254 | 9394 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
|
9395 a fallback. |
bee3751f3d4e
patch 8.0.0949: winpty.dll name is fixed
Christian Brabandt <cb@256bit.org>
parents:
11914
diff
changeset
|
9396 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
|
9397 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
|
9398 security reasons. |
bee3751f3d4e
patch 8.0.0949: winpty.dll name is fixed
Christian Brabandt <cb@256bit.org>
parents:
11914
diff
changeset
|
9399 |
7 | 9400 *'winwidth'* *'wiw'* *E592* |
9401 'winwidth' 'wiw' number (default 20) | |
9402 global | |
9403 Minimal number of columns for the current window. This is not a hard | |
9404 minimum, Vim will use fewer columns if there is not enough room. If | |
9405 the current window is smaller, its size is increased, at the cost of | |
9406 the width of other windows. Set it to 999 to make the current window | |
9407 always fill the screen. Set it to a small number for normal editing. | |
9408 The width is not adjusted after one of the commands to change the | |
9409 width of the current window. | |
9410 'winwidth' applies to the current window. Use 'winminwidth' to set | |
9411 the minimal width for other windows. | |
9412 | |
9413 *'wrap'* *'nowrap'* | |
9414 'wrap' boolean (default on) | |
9415 local to window | |
9416 This option changes how text is displayed. It doesn't change the text | |
9417 in the buffer, see 'textwidth' for that. | |
9418 When on, lines longer than the width of the window will wrap and | |
10 | 9419 displaying continues on the next line. When off lines will not wrap |
9420 and only part of long lines will be displayed. When the cursor is | |
7 | 9421 moved to a part that is not shown, the screen will scroll |
9422 horizontally. | |
9423 The line will be broken in the middle of a word if necessary. See | |
9424 'linebreak' to get the break at a word boundary. | |
9425 To make scrolling horizontally a bit more useful, try this: > | |
9426 :set sidescroll=5 | |
9427 :set listchars+=precedes:<,extends:> | |
9428 < See 'sidescroll', 'listchars' and |wrap-off|. | |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
9429 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
|
9430 on. |
7 | 9431 |
9432 *'wrapmargin'* *'wm'* | |
9433 'wrapmargin' 'wm' number (default 0) | |
9434 local to buffer | |
9435 Number of characters from the right window border where wrapping | |
9436 starts. When typing text beyond this limit, an <EOL> will be inserted | |
9437 and inserting continues on the next line. | |
9438 Options that add a margin, such as 'number' and 'foldcolumn', cause | |
9439 the text width to be further reduced. This is Vi compatible. | |
9440 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
|
9441 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
|
9442 is reset. |
16610 | 9443 See also 'formatoptions' and |ins-textwidth|. |
7 | 9444 |
9445 *'wrapscan'* *'ws'* *'nowrapscan'* *'nows'* | |
9446 'wrapscan' 'ws' boolean (default on) *E384* *E385* | |
9447 global | |
500 | 9448 Searches wrap around the end of the file. Also applies to |]s| and |
9449 |[s|, searching for spelling mistakes. | |
7 | 9450 |
9451 *'write'* *'nowrite'* | |
9452 'write' boolean (default on) | |
9453 global | |
9454 Allows writing files. When not set, writing a file is not allowed. | |
9455 Can be used for a view-only mode, where modifications to the text are | |
10 | 9456 still allowed. Can be reset with the |-m| or |-M| command line |
7 | 9457 argument. Filtering text is still possible, even though this requires |
9458 writing a temporary file. | |
9459 | |
9460 *'writeany'* *'wa'* *'nowriteany'* *'nowa'* | |
9461 'writeany' 'wa' boolean (default off) | |
9462 global | |
9463 Allows writing to any file with no need for "!" override. | |
9464 | |
9465 *'writebackup'* *'wb'* *'nowritebackup'* *'nowb'* | |
9466 'writebackup' 'wb' boolean (default on with |+writebackup| feature, off | |
9467 otherwise) | |
9468 global | |
9469 Make a backup before overwriting a file. The backup is removed after | |
9470 the file was successfully written, unless the 'backup' option is | |
3513 | 9471 also on. |
9472 WARNING: Switching this option off means that when Vim fails to write | |
9473 your buffer correctly and then, for whatever reason, Vim exits, you | |
9474 lose both the original file and what you were writing. Only reset | |
9475 this option if your file system is almost full and it makes the write | |
9476 fail (and make sure not to exit Vim until the write was successful). | |
9477 See |backup-table| for another explanation. | |
7 | 9478 When the 'backupskip' pattern matches, a backup is not made anyway. |
18719 | 9479 Depending on 'backupcopy' the backup is a new file or the original |
9480 file renamed (and a new file is written). | |
7 | 9481 NOTE: This option is set to the default value when 'compatible' is |
9482 set. | |
9483 | |
9484 *'writedelay'* *'wd'* | |
9485 'writedelay' 'wd' number (default 0) | |
9486 global | |
9344
33c1b85d408c
commit https://github.com/vim/vim/commit/802a0d902fca423acb15f835d7b09183883d79a0
Christian Brabandt <cb@256bit.org>
parents:
9286
diff
changeset
|
9487 The number of milliseconds to wait for each character sent to the |
7 | 9488 screen. When non-zero, characters are sent to the terminal one by |
18972 | 9489 one. For debugging purposes. |
7 | 9490 |
26670
a77b661439f9
patch 8.2.3864: cannot disable requesting key codes from xterm
Bram Moolenaar <Bram@vim.org>
parents:
26508
diff
changeset
|
9491 *'xtermcodes'* *'noxtermcodes'* |
a77b661439f9
patch 8.2.3864: cannot disable requesting key codes from xterm
Bram Moolenaar <Bram@vim.org>
parents:
26508
diff
changeset
|
9492 '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
|
9493 global |
a77b661439f9
patch 8.2.3864: cannot disable requesting key codes from xterm
Bram Moolenaar <Bram@vim.org>
parents:
26508
diff
changeset
|
9494 When detecting xterm patchlevel 141 or higher with the termresponse |
26708 | 9495 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
|
9496 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
|
9497 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
|
9498 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
|
9499 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
|
9500 display. |
a77b661439f9
patch 8.2.3864: cannot disable requesting key codes from xterm
Bram Moolenaar <Bram@vim.org>
parents:
26508
diff
changeset
|
9501 |
a77b661439f9
patch 8.2.3864: cannot disable requesting key codes from xterm
Bram Moolenaar <Bram@vim.org>
parents:
26508
diff
changeset
|
9502 |
14421 | 9503 vim:tw=78:ts=8:noet:ft=help:norl: |