Mercurial > vim
annotate runtime/doc/options.txt @ 16654:7d54a66c95d7 v8.1.1329
patch 8.1.1329: plans for popup window support are spread out
commit https://github.com/vim/vim/commit/957f85d54ebd5a3bd0d930de9603190f0876f977
Author: Bram Moolenaar <Bram@vim.org>
Date: Sun May 12 21:43:48 2019 +0200
patch 8.1.1329: plans for popup window support are spread out
Problem: Plans for popup window support are spread out.
Solution: Add a first version of the popup window help.
author | Bram Moolenaar <Bram@vim.org> |
---|---|
date | Sun, 12 May 2019 21:45:05 +0200 |
parents | 1eaf34420bb3 |
children | e55c26aaf484 |
rev | line source |
---|---|
16610 | 1 *options.txt* For Vim version 8.1. Last change: 2019 May 08 |
7 | 2 |
3 | |
4 VIM REFERENCE MANUAL by Bram Moolenaar | |
5 | |
6 | |
7 Options *options* | |
8 | |
9 1. Setting options |set-option| | |
10 2. Automatically setting options |auto-setting| | |
11 3. Options summary |option-summary| | |
12 | |
10244
876fbdd84e52
commit https://github.com/vim/vim/commit/2ec618c9feac4573b154510236ad8121c77d0eca
Christian Brabandt <cb@256bit.org>
parents:
10218
diff
changeset
|
13 For an overview of options see quickref.txt |option-list|. |
7 | 14 |
15 Vim has a number of internal variables and switches which can be set to | |
16 achieve special effects. These options come in three forms: | |
17 boolean can only be on or off *boolean* *toggle* | |
18 number has a numeric value | |
19 string has a string value | |
20 | |
21 ============================================================================== | |
523 | 22 1. Setting options *set-option* *E764* |
7 | 23 |
24 *:se* *:set* | |
25 :se[t] Show all options that differ from their default value. | |
26 | |
27 :se[t] all Show all but terminal options. | |
28 | |
29 :se[t] termcap Show all terminal options. Note that in the GUI the | |
30 key codes are not shown, because they are generated | |
31 internally and can't be changed. Changing the terminal | |
32 codes in the GUI is not useful either... | |
33 | |
34 *E518* *E519* | |
35 :se[t] {option}? Show value of {option}. | |
36 | |
37 :se[t] {option} Toggle option: set, switch it on. | |
38 Number option: show value. | |
39 String option: show value. | |
40 | |
41 :se[t] no{option} Toggle option: Reset, switch it off. | |
42 | |
2152 | 43 *:set-!* *:set-inv* |
7 | 44 :se[t] {option}! or |
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
|
45 :se[t] inv{option} Toggle option: Invert value. |
7 | 46 |
47 *:set-default* *:set-&* *:set-&vi* *:set-&vim* | |
48 :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
|
49 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
|
50 :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
|
51 :se[t] {option}&vim Reset option to its Vim default value. |
7 | 52 |
13341
acd7eaa13d2b
Updated runtime files.
Christian Brabandt <cb@256bit.org>
parents:
13314
diff
changeset
|
53 :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
|
54 these options are not changed: |
eff26a8620ce
commit https://github.com/vim/vim/commit/88774fdd23f08355297bb8cda78856859051d3c7
Christian Brabandt <cb@256bit.org>
parents:
6949
diff
changeset
|
55 all terminal options, starting with t_ |
eff26a8620ce
commit https://github.com/vim/vim/commit/88774fdd23f08355297bb8cda78856859051d3c7
Christian Brabandt <cb@256bit.org>
parents:
6949
diff
changeset
|
56 'columns' |
eff26a8620ce
commit https://github.com/vim/vim/commit/88774fdd23f08355297bb8cda78856859051d3c7
Christian Brabandt <cb@256bit.org>
parents:
6949
diff
changeset
|
57 'cryptmethod' |
eff26a8620ce
commit https://github.com/vim/vim/commit/88774fdd23f08355297bb8cda78856859051d3c7
Christian Brabandt <cb@256bit.org>
parents:
6949
diff
changeset
|
58 'encoding' |
eff26a8620ce
commit https://github.com/vim/vim/commit/88774fdd23f08355297bb8cda78856859051d3c7
Christian Brabandt <cb@256bit.org>
parents:
6949
diff
changeset
|
59 'key' |
eff26a8620ce
commit https://github.com/vim/vim/commit/88774fdd23f08355297bb8cda78856859051d3c7
Christian Brabandt <cb@256bit.org>
parents:
6949
diff
changeset
|
60 'lines' |
eff26a8620ce
commit https://github.com/vim/vim/commit/88774fdd23f08355297bb8cda78856859051d3c7
Christian Brabandt <cb@256bit.org>
parents:
6949
diff
changeset
|
61 'term' |
eff26a8620ce
commit https://github.com/vim/vim/commit/88774fdd23f08355297bb8cda78856859051d3c7
Christian Brabandt <cb@256bit.org>
parents:
6949
diff
changeset
|
62 'ttymouse' |
eff26a8620ce
commit https://github.com/vim/vim/commit/88774fdd23f08355297bb8cda78856859051d3c7
Christian Brabandt <cb@256bit.org>
parents:
6949
diff
changeset
|
63 'ttytype' |
eff26a8620ce
commit https://github.com/vim/vim/commit/88774fdd23f08355297bb8cda78856859051d3c7
Christian Brabandt <cb@256bit.org>
parents:
6949
diff
changeset
|
64 Warning: This may have a lot of side effects. |
7 | 65 |
66 *:set-args* *E487* *E521* | |
67 :se[t] {option}={value} or | |
68 :se[t] {option}:{value} | |
69 Set string or number option to {value}. | |
70 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
|
71 hex (preceded with 0x) or octal (preceded with '0'). |
7 | 72 The old value can be inserted by typing 'wildchar' (by |
73 default this is a <Tab> or CTRL-E if 'compatible' is | |
74 set). See |cmdline-completion|. | |
75 White space between {option} and '=' is allowed and | |
76 will be ignored. White space between '=' and {value} | |
77 is not allowed. | |
78 See |option-backslash| for using white space and | |
79 backslashes in {value}. | |
80 | |
81 :se[t] {option}+={value} *:set+=* | |
82 Add the {value} to a number option, or append the | |
83 {value} to a string option. When the option is a | |
84 comma separated list, a comma is added, unless the | |
85 value was empty. | |
86 If the option is a list of flags, superfluous flags | |
557 | 87 are removed. When adding a flag that was already |
88 present the option value doesn't change. | |
809 | 89 Also see |:set-args| above. |
7 | 90 |
91 :se[t] {option}^={value} *:set^=* | |
92 Multiply the {value} to a number option, or prepend | |
93 the {value} to a string option. When the option is a | |
94 comma separated list, a comma is added, unless the | |
95 value was empty. | |
96 Also see |:set-args| above. | |
97 | |
98 :se[t] {option}-={value} *:set-=* | |
99 Subtract the {value} from a number option, or remove | |
100 the {value} from a string option, if it is there. | |
101 If the {value} is not found in a string option, there | |
102 is no error or warning. When the option is a comma | |
103 separated list, a comma is deleted, unless the option | |
104 becomes empty. | |
105 When the option is a list of flags, {value} must be | |
106 exactly as they appear in the option. Remove flags | |
107 one by one to avoid problems. | |
108 Also see |:set-args| above. | |
109 | |
110 The {option} arguments to ":set" may be repeated. For example: > | |
111 :set ai nosi sw=3 ts=3 | |
112 If you make an error in one of the arguments, an error message will be given | |
113 and the following arguments will be ignored. | |
114 | |
115 *:set-verbose* | |
116 When 'verbose' is non-zero, displaying an option value will also tell where it | |
117 was last set. Example: > | |
118 :verbose set shiftwidth cindent? | |
14864 | 119 < shiftwidth=4 ~ |
120 Last set from modeline line 1 ~ | |
121 cindent ~ | |
122 Last set from /usr/local/share/vim/vim60/ftplugin/c.vim line 30 ~ | |
1621 | 123 This is only done when specific option values are requested, not for ":verbose |
124 set all" or ":verbose set" without an argument. | |
125 When the option was set by hand there is no "Last set" message. | |
7 | 126 When the option was set while executing a function, user command or |
127 autocommand, the script in which it was defined is reported. | |
128 Note that an option may also have been set as a side effect of setting | |
129 'compatible'. | |
1621 | 130 A few special texts: |
14864 | 131 Last set from modeline line 1 ~ |
1621 | 132 Option was set in a |modeline|. |
133 Last set from --cmd argument ~ | |
134 Option was set with command line argument |--cmd| or +. | |
135 Last set from -c argument ~ | |
136 Option was set with command line argument |-c|, +, |-S| or | |
137 |-q|. | |
138 Last set from environment variable ~ | |
139 Option was set from an environment variable, $VIMINIT, | |
140 $GVIMINIT or $EXINIT. | |
141 Last set from error handler ~ | |
142 Option was cleared when evaluating it resulted in an error. | |
143 | |
2570
71b56b4e7785
Make the references to features in the help more consistent. (Sylvain Hitier)
Bram Moolenaar <bram@vim.org>
parents:
2561
diff
changeset
|
144 {not available when compiled without the |+eval| feature} |
7 | 145 |
146 *:set-termcap* *E522* | |
667 | 147 For {option} the form "t_xx" may be used to set a terminal option. This will |
7 | 148 override the value from the termcap. You can then use it in a mapping. If |
149 the "xx" part contains special characters, use the <t_xx> form: > | |
150 :set <t_#4>=^[Ot | |
151 This can also be used to translate a special code for a normal key. For | |
152 example, if Alt-b produces <Esc>b, use this: > | |
153 :set <M-b>=^[b | |
154 (the ^[ is a real <Esc> here, use CTRL-V <Esc> to enter it) | |
155 The advantage over a mapping is that it works in all situations. | |
156 | |
2726 | 157 You can define any key codes, e.g.: > |
158 :set t_xy=^[foo; | |
159 There is no warning for using a name that isn't recognized. You can map these | |
160 codes as you like: > | |
161 :map <t_xy> something | |
162 < *E846* | |
163 When a key code is not set, it's like it does not exist. Trying to get its | |
164 value will result in an error: > | |
165 :set t_kb= | |
166 :set t_kb | |
167 E846: Key code not set: t_kb | |
168 | |
36 | 169 The t_xx options cannot be set from a |modeline| or in the |sandbox|, for |
170 security reasons. | |
171 | |
7 | 172 The listing from ":set" looks different from Vi. Long string options are put |
10 | 173 at the end of the list. The number of options is quite large. The output of |
7 | 174 "set all" probably does not fit on the screen, causing Vim to give the |
175 |more-prompt|. | |
176 | |
177 *option-backslash* | |
178 To include white space in a string option value it has to be preceded with a | |
179 backslash. To include a backslash you have to use two. Effectively this | |
180 means that the number of backslashes in an option value is halved (rounded | |
181 down). | |
182 A few examples: > | |
183 :set tags=tags\ /usr/tags results in "tags /usr/tags" | |
184 :set tags=tags\\,file results in "tags\,file" | |
185 :set tags=tags\\\ file results in "tags\ file" | |
186 | |
10 | 187 The "|" character separates a ":set" command from a following command. To |
188 include the "|" in the option value, use "\|" instead. This example sets the | |
7 | 189 'titlestring' option to "hi|there": > |
190 :set titlestring=hi\|there | |
191 This sets the 'titlestring' option to "hi" and 'iconstring' to "there": > | |
192 :set titlestring=hi|set iconstring=there | |
193 | |
642 | 194 Similarly, the double quote character starts a comment. To include the '"' in |
195 the option value, use '\"' instead. This example sets the 'titlestring' | |
196 option to 'hi "there"': > | |
197 :set titlestring=hi\ \"there\" | |
198 | |
10 | 199 For MS-DOS and WIN32 backslashes in file names are mostly not removed. More |
7 | 200 precise: For options that expect a file name (those where environment |
201 variables are expanded) a backslash before a normal file name character is not | |
202 removed. But a backslash before a special character (space, backslash, comma, | |
203 etc.) is used like explained above. | |
204 There is one special situation, when the value starts with "\\": > | |
205 :set dir=\\machine\path results in "\\machine\path" | |
206 :set dir=\\\\machine\\path results in "\\machine\path" | |
207 :set dir=\\path\\file results in "\\path\file" (wrong!) | |
208 For the first one the start is kept, but for the second one the backslashes | |
209 are halved. This makes sure it works both when you expect backslashes to be | |
10 | 210 halved and when you expect the backslashes to be kept. The third gives a |
7 | 211 result which is probably not what you want. Avoid it. |
212 | |
213 *add-option-flags* *remove-option-flags* | |
214 *E539* *E550* *E551* *E552* | |
215 Some options are a list of flags. When you want to add a flag to such an | |
216 option, without changing the existing ones, you can do it like this: > | |
217 :set guioptions+=a | |
218 Remove a flag from an option like this: > | |
219 :set guioptions-=a | |
220 This removes the 'a' flag from 'guioptions'. | |
10 | 221 Note that you should add or remove one flag at a time. If 'guioptions' has |
7 | 222 the value "ab", using "set guioptions-=ba" won't work, because the string "ba" |
223 doesn't appear. | |
224 | |
225 *:set_env* *expand-env* *expand-environment-var* | |
22 | 226 Environment variables in specific string options will be expanded. If the |
7 | 227 environment variable exists the '$' and the following environment variable |
228 name is replaced with its value. If it does not exist the '$' and the name | |
229 are not modified. Any non-id character (not a letter, digit or '_') may | |
230 follow the environment variable name. That character and what follows is | |
231 appended to the value of the environment variable. Examples: > | |
232 :set term=$TERM.new | |
233 :set path=/usr/$INCLUDE,$HOME/include,. | |
234 When adding or removing a string from an option with ":set opt-=val" or ":set | |
235 opt+=val" the expansion is done before the adding or removing. | |
236 | |
237 | |
238 Handling of local options *local-options* | |
239 | |
240 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
|
241 has its own copy of this option, thus each can have its own value. This |
7 | 242 allows you to set 'list' in one window but not in another. And set |
243 'shiftwidth' to 3 in one buffer and 4 in another. | |
244 | |
245 The following explains what happens to these local options in specific | |
246 situations. You don't really need to know all of this, since Vim mostly uses | |
247 the option values you would expect. Unfortunately, doing what the user | |
248 expects is a bit complicated... | |
249 | |
250 When splitting a window, the local options are copied to the new window. Thus | |
251 right after the split the contents of the two windows look the same. | |
252 | |
253 When editing a new buffer, its local option values must be initialized. Since | |
254 the local options of the current buffer might be specifically for that buffer, | |
255 these are not used. Instead, for each buffer-local option there also is a | |
256 global value, which is used for new buffers. With ":set" both the local and | |
257 global value is changed. With "setlocal" only the local value is changed, | |
258 thus this value is not used when editing a new buffer. | |
259 | |
9852
4eea48b76d03
commit https://github.com/vim/vim/commit/95ec9d6a6ab3117d60ff638670a803d43974ba51
Christian Brabandt <cb@256bit.org>
parents:
9737
diff
changeset
|
260 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
|
261 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
|
262 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
|
263 last closed window where the buffer was edited last are used. |
7 | 264 |
265 It's possible to set a local window option specifically for a type of buffer. | |
266 When you edit another buffer in the same window, you don't want to keep | |
267 using these local window options. Therefore Vim keeps a global value of the | |
268 local window options, which is used when editing another buffer. Each window | |
269 has its own copy of these values. Thus these are local to the window, but | |
270 global to all buffers in the window. With this you can do: > | |
271 :e one | |
272 :set list | |
273 :e two | |
274 Now the 'list' option will also be set in "two", since with the ":set list" | |
275 command you have also set the global value. > | |
276 :set nolist | |
277 :e one | |
278 :setlocal list | |
279 :e two | |
280 Now the 'list' option is not set, because ":set nolist" resets the global | |
281 value, ":setlocal list" only changes the local value and ":e two" gets the | |
282 global value. Note that if you do this next: > | |
283 :e one | |
4358 | 284 You will get back the 'list' value as it was the last time you edited "one". |
285 The options local to a window are remembered for each buffer. This also | |
286 happens when the buffer is not loaded, but they are lost when the buffer is | |
287 wiped out |:bwipe|. | |
7 | 288 |
289 *:setl* *:setlocal* | |
290 :setl[ocal] ... Like ":set" but set only the value local to the | |
291 current buffer or window. Not all options have a | |
292 local value. If the option does not have a local | |
293 value the global value is set. | |
2413 | 294 With the "all" argument: display local values for all |
295 local options. | |
296 Without argument: Display local values for all local | |
297 options which are different from the default. | |
7 | 298 When displaying a specific local option, show the |
1621 | 299 local value. For a global/local boolean option, when |
300 the global value is being used, "--" is displayed | |
301 before the option name. | |
302 For a global option the global value is | |
7 | 303 shown (but that might change in the future). |
304 | |
809 | 305 :setl[ocal] {option}< Set the local value of {option} to its global value by |
306 copying the value. | |
307 | |
3281 | 308 :se[t] {option}< For |global-local| options: Remove the local value of |
309 {option}, so that the global value will be used. | |
7 | 310 |
311 *:setg* *:setglobal* | |
312 :setg[lobal] ... Like ":set" but set only the global value for a local | |
313 option without changing the local value. | |
314 When displaying an option, the global value is shown. | |
2413 | 315 With the "all" argument: display global values for all |
316 local options. | |
317 Without argument: display global values for all local | |
318 options which are different from the default. | |
7 | 319 |
320 For buffer-local and window-local options: | |
321 Command global value local value ~ | |
322 :set option=value set set | |
323 :setlocal option=value - set | |
324 :setglobal option=value set - | |
325 :set option? - display | |
326 :setlocal option? - display | |
327 :setglobal option? display - | |
328 | |
329 | |
330 Global options with a local value *global-local* | |
331 | |
40 | 332 Options are global when you mostly use one value for all buffers and windows. |
333 For some global options it's useful to sometimes have a different local value. | |
334 You can set the local value with ":setlocal". That buffer or window will then | |
335 use the local value, while other buffers and windows continue using the global | |
336 value. | |
7 | 337 |
338 For example, you have two windows, both on C source code. They use the global | |
339 'makeprg' option. If you do this in one of the two windows: > | |
340 :set makeprg=gmake | |
341 then the other window will switch to the same value. There is no need to set | |
342 the 'makeprg' option in the other C source window too. | |
343 However, if you start editing a Perl file in a new window, you want to use | |
1152 | 344 another 'makeprg' for it, without changing the value used for the C source |
10 | 345 files. You use this command: > |
7 | 346 :setlocal makeprg=perlmake |
347 You can switch back to using the global value by making the local value empty: > | |
348 :setlocal makeprg= | |
15729 | 349 This only works for a string option. For a number or boolean option you need |
350 to use the "<" flag, like this: > | |
7 | 351 :setlocal autoread< |
15729 | 352 Note that for non-boolean and non-number options using "<" copies the global |
353 value to the local value, it doesn't switch back to using the global value | |
354 (that matters when the global value changes later). You can also use: > | |
809 | 355 :set path< |
356 This will make the local value of 'path' empty, so that the global value is | |
357 used. Thus it does the same as: > | |
358 :setlocal path= | |
7 | 359 Note: In the future more global options can be made global-local. Using |
360 ":setlocal" on a global option might work differently then. | |
361 | |
362 | |
363 Setting the filetype | |
364 | |
11473 | 365 :setf[iletype] [FALLBACK] {filetype} *:setf* *:setfiletype* |
7 | 366 Set the 'filetype' option to {filetype}, but only if |
367 not done yet in a sequence of (nested) autocommands. | |
368 This is short for: > | |
369 :if !did_filetype() | |
370 : setlocal filetype={filetype} | |
371 :endif | |
372 < This command is used in a filetype.vim file to avoid | |
373 setting the 'filetype' option twice, causing different | |
374 settings and syntax files to be loaded. | |
11473 | 375 |
376 When the optional FALLBACK argument is present, a | |
377 later :setfiletype command will override the | |
16023 | 378 'filetype'. This is to be used for filetype |
379 detections that are just a guess. |did_filetype()| | |
380 will return false after this command. | |
11473 | 381 |
2698
b6471224d2af
Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents:
2681
diff
changeset
|
382 *option-window* *optwin* |
7 | 383 :bro[wse] se[t] *:set-browse* *:browse-set* *:opt* *:options* |
384 :opt[ions] Open a window for viewing and setting all options. | |
385 Options are grouped by function. | |
386 Offers short help for each option. Hit <CR> on the | |
387 short help to open a help window with more help for | |
388 the option. | |
389 Modify the value of the option and hit <CR> on the | |
390 "set" line to set the new value. For window and | |
391 buffer specific options, the last accessed window is | |
392 used to set the option value in, unless this is a help | |
393 window, in which case the window below help window is | |
394 used (skipping the option-window). | |
13437 | 395 {not available when compiled without the |+eval| |
396 feature} | |
7 | 397 |
398 *$HOME* | |
399 Using "~" is like using "$HOME", but it is only recognized at the start of an | |
400 option and after a space or comma. | |
401 | |
402 On Unix systems "~user" can be used too. It is replaced by the home directory | |
403 of user "user". Example: > | |
404 :set path=~mool/include,/usr/include,. | |
405 | |
406 On Unix systems the form "${HOME}" can be used too. The name between {} can | |
407 contain non-id characters then. Note that if you want to use this for the | |
408 "gf" command, you need to add the '{' and '}' characters to 'isfname'. | |
409 | |
12254 | 410 NOTE: expanding environment variables and "~/" is only done with the ":set" |
411 command, not when assigning a value to an option with ":let". | |
412 | |
413 *$HOME-windows* | |
3224 | 414 On MS-Windows, if $HOME is not defined as an environment variable, then |
415 at runtime Vim will set it to the expansion of $HOMEDRIVE$HOMEPATH. | |
12499 | 416 If $HOMEDRIVE is not set then $USERPROFILE is used. |
417 | |
418 This expanded value is not exported to the environment, this matters when | |
419 running an external command: > | |
420 :echo system('set | findstr ^HOME=') | |
421 and > | |
422 :echo luaeval('os.getenv("HOME")') | |
423 should echo nothing (an empty string) despite exists('$HOME') being true. | |
424 When setting $HOME to a non-empty string it will be exported to the | |
425 subprocesses. | |
3224 | 426 |
7 | 427 |
428 Note the maximum length of an expanded option is limited. How much depends on | |
429 the system, mostly it is something like 256 or 1024 characters. | |
430 | |
431 *:fix* *:fixdel* | |
432 :fix[del] Set the value of 't_kD': | |
433 't_kb' is 't_kD' becomes ~ | |
434 CTRL-? CTRL-H | |
435 not CTRL-? CTRL-? | |
436 | |
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
|
437 (CTRL-? is 0177 octal, 0x7f hex) |
7 | 438 |
439 If your delete key terminal code is wrong, but the | |
440 code for backspace is alright, you can put this in | |
441 your .vimrc: > | |
442 :fixdel | |
443 < This works no matter what the actual code for | |
444 backspace is. | |
445 | |
446 If the backspace key terminal code is wrong you can | |
447 use this: > | |
448 :if &term == "termname" | |
449 : set t_kb=^V<BS> | |
450 : fixdel | |
451 :endif | |
452 < Where "^V" is CTRL-V and "<BS>" is the backspace key | |
10 | 453 (don't type four characters!). Replace "termname" |
7 | 454 with your terminal name. |
455 | |
456 If your <Delete> key sends a strange key sequence (not | |
457 CTRL-? or CTRL-H) you cannot use ":fixdel". Then use: > | |
458 :if &term == "termname" | |
459 : set t_kD=^V<Delete> | |
460 :endif | |
461 < Where "^V" is CTRL-V and "<Delete>" is the delete key | |
462 (don't type eight characters!). Replace "termname" | |
463 with your terminal name. | |
464 | |
465 *Linux-backspace* | |
466 Note about Linux: By default the backspace key | |
467 produces CTRL-?, which is wrong. You can fix it by | |
468 putting this line in your rc.local: > | |
469 echo "keycode 14 = BackSpace" | loadkeys | |
470 < | |
471 *NetBSD-backspace* | |
472 Note about NetBSD: If your backspace doesn't produce | |
473 the right code, try this: > | |
474 xmodmap -e "keycode 22 = BackSpace" | |
475 < If this works, add this in your .Xmodmap file: > | |
476 keysym 22 = BackSpace | |
477 < You need to restart for this to take effect. | |
478 | |
479 ============================================================================== | |
480 2. Automatically setting options *auto-setting* | |
481 | |
482 Besides changing options with the ":set" command, there are three alternatives | |
483 to set options automatically for one or more files: | |
484 | |
485 1. When starting Vim initializations are read from various places. See | |
486 |initialization|. Most of them are performed for all editing sessions, | |
487 and some of them depend on the directory where Vim is started. | |
488 You can create an initialization file with |:mkvimrc|, |:mkview| and | |
489 |:mksession|. | |
490 2. If you start editing a new file, the automatic commands are executed. | |
491 This can be used to set options for files matching a particular pattern and | |
492 many other things. See |autocommand|. | |
493 3. If you start editing a new file, and the 'modeline' option is on, a | |
494 number of lines at the beginning and end of the file are checked for | |
495 modelines. This is explained here. | |
496 | |
497 *modeline* *vim:* *vi:* *ex:* *E520* | |
498 There are two forms of modelines. The first form: | |
5055 | 499 [text]{white}{vi:|vim:|ex:}[white]{options} |
5024
7a2ffd685c0e
Update runtime files. Remove duplicate tags in help.
Bram Moolenaar <bram@vim.org>
parents:
5008
diff
changeset
|
500 |
7a2ffd685c0e
Update runtime files. Remove duplicate tags in help.
Bram Moolenaar <bram@vim.org>
parents:
5008
diff
changeset
|
501 [text] any text or empty |
7a2ffd685c0e
Update runtime files. Remove duplicate tags in help.
Bram Moolenaar <bram@vim.org>
parents:
5008
diff
changeset
|
502 {white} at least one blank character (<Space> or <Tab>) |
5055 | 503 {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
|
504 [white] optional white space |
7a2ffd685c0e
Update runtime files. Remove duplicate tags in help.
Bram Moolenaar <bram@vim.org>
parents:
5008
diff
changeset
|
505 {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
|
506 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
|
507 for a ":set" command (can be empty) |
7 | 508 |
5055 | 509 Examples: |
782 | 510 vi:noai:sw=3 ts=6 ~ |
5055 | 511 vim: tw=77 ~ |
7 | 512 |
513 The second form (this is compatible with some versions of Vi): | |
514 | |
5024
7a2ffd685c0e
Update runtime files. Remove duplicate tags in help.
Bram Moolenaar <bram@vim.org>
parents:
5008
diff
changeset
|
515 [text]{white}{vi:|vim:|Vim:|ex:}[white]se[t] {options}:[text] |
7a2ffd685c0e
Update runtime files. Remove duplicate tags in help.
Bram Moolenaar <bram@vim.org>
parents:
5008
diff
changeset
|
516 |
7a2ffd685c0e
Update runtime files. Remove duplicate tags in help.
Bram Moolenaar <bram@vim.org>
parents:
5008
diff
changeset
|
517 [text] any text or empty |
7a2ffd685c0e
Update runtime files. Remove duplicate tags in help.
Bram Moolenaar <bram@vim.org>
parents:
5008
diff
changeset
|
518 {white} at least one blank character (<Space> or <Tab>) |
7a2ffd685c0e
Update runtime files. Remove duplicate tags in help.
Bram Moolenaar <bram@vim.org>
parents:
5008
diff
changeset
|
519 {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
|
520 [white] optional white space |
5055 | 521 se[t] the string "set " or "se " (note the space); When |
522 "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
|
523 {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
|
524 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
|
525 : a colon |
7a2ffd685c0e
Update runtime files. Remove duplicate tags in help.
Bram Moolenaar <bram@vim.org>
parents:
5008
diff
changeset
|
526 [text] any text or empty |
7 | 527 |
5055 | 528 Examples: |
782 | 529 /* vim: set ai tw=75: */ ~ |
5055 | 530 /* Vim: set ai tw=75: */ ~ |
7 | 531 |
5024
7a2ffd685c0e
Update runtime files. Remove duplicate tags in help.
Bram Moolenaar <bram@vim.org>
parents:
5008
diff
changeset
|
532 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
|
533 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
|
534 "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
|
535 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
|
536 could be short for "example:"). |
7 | 537 |
538 *modeline-local* | |
539 The options are set like with ":setlocal": The new value only applies to the | |
11 | 540 buffer and window that contain the file. Although it's possible to set global |
541 options from a modeline, this is unusual. If you have two windows open and | |
542 the files in it set the same global option to a different value, the result | |
543 depends on which one was opened last. | |
7 | 544 |
23 | 545 When editing a file that was already loaded, only the window-local options |
546 from the modeline are used. Thus if you manually changed a buffer-local | |
547 option after opening the file, it won't be changed if you edit the same buffer | |
548 in another window. But window-local options will be set. | |
549 | |
7 | 550 *modeline-version* |
551 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
|
552 number can be specified where "vim:" or "Vim:" is used: |
7 | 553 vim{vers}: version {vers} or later |
554 vim<{vers}: version before {vers} | |
555 vim={vers}: version {vers} | |
556 vim>{vers}: version after {vers} | |
6647 | 557 {vers} is 700 for Vim 7.0 (hundred times the major version plus minor). |
558 For example, to use a modeline only for Vim 7.0: | |
559 /* vim700: set foldmethod=marker */ ~ | |
560 To use a modeline for Vim after version 7.2: | |
561 /* vim>702: set cole=2: */ ~ | |
7 | 562 There can be no blanks between "vim" and the ":". |
563 | |
564 | |
565 The number of lines that are checked can be set with the 'modelines' option. | |
566 If 'modeline' is off or 'modelines' is 0 no lines are checked. | |
567 | |
568 Note that for the first form all of the rest of the line is used, thus a line | |
782 | 569 like: |
570 /* vi:ts=4: */ ~ | |
571 will give an error message for the trailing "*/". This line is OK: | |
572 /* vi:set ts=4: */ ~ | |
7 | 573 |
574 If an error is detected the rest of the line is skipped. | |
575 | |
576 If you want to include a ':' in a set command precede it with a '\'. The | |
782 | 577 backslash in front of the ':' will be removed. Example: |
578 /* vi:set dir=c\:\tmp: */ ~ | |
7 | 579 This sets the 'dir' option to "c:\tmp". Only a single backslash before the |
580 ':' is removed. Thus to include "\:" you have to specify "\\:". | |
581 | |
582 No other commands than "set" are supported, for security reasons (somebody | |
1111 | 583 might create a Trojan horse text file with modelines). And not all options |
584 can be set. For some options a flag is set, so that when it's used the | |
1152 | 585 |sandbox| is effective. Still, there is always a small risk that a modeline |
1111 | 586 causes trouble. E.g., when some joker sets 'textwidth' to 5 all your lines |
587 are wrapped unexpectedly. So disable modelines before editing untrusted text. | |
588 The mail ftplugin does this, for example. | |
7 | 589 |
590 Hint: If you would like to do something else than setting an option, you could | |
591 define an autocommand that checks the file for a specific string. For | |
592 example: > | |
593 au BufReadPost * if getline(1) =~ "VAR" | call SetVar() | endif | |
594 And define a function SetVar() that does something with the line containing | |
595 "VAR". | |
596 | |
597 ============================================================================== | |
598 3. Options summary *option-summary* | |
599 | |
600 In the list below all the options are mentioned with their full name and with | |
601 an abbreviation if there is one. Both forms may be used. | |
602 | |
603 In this document when a boolean option is "set" that means that ":set option" | |
604 is entered. When an option is "reset", ":set nooption" is used. | |
605 | |
606 For some options there are two default values: The "Vim default", which is | |
607 used when 'compatible' is not set, and the "Vi default", which is used when | |
608 'compatible' is set. | |
609 | |
610 Most options are the same in all windows and buffers. There are a few that | |
10 | 611 are specific to how the text is presented in a window. These can be set to a |
7 | 612 different value in each window. For example the 'list' option can be set in |
613 one window and reset in another for the same text, giving both types of view | |
614 at the same time. There are a few options that are specific to a certain | |
615 file. These can have a different value for each file or buffer. For example | |
616 the 'textwidth' option can be 78 for a normal text file and 0 for a C | |
617 program. | |
618 | |
619 global one option for all buffers and windows | |
620 local to window each window has its own copy of this option | |
621 local to buffer each buffer has its own copy of this option | |
622 | |
623 When creating a new window the option values from the currently active window | |
624 are used as a default value for the window-specific options. For the | |
625 buffer-specific options this depends on the 's' and 'S' flags in the | |
626 'cpoptions' option. If 's' is included (which is the default) the values for | |
627 buffer options are copied from the currently active buffer when a buffer is | |
10 | 628 first entered. If 'S' is present the options are copied each time the buffer |
629 is entered, this is almost like having global options. If 's' and 'S' are not | |
7 | 630 present, the options are copied from the currently active buffer when the |
631 buffer is created. | |
632 | |
519 | 633 Hidden options *hidden-options* |
634 | |
635 Not all options are supported in all versions. This depends on the supported | |
636 features and sometimes on the system. A remark about this is in curly braces | |
637 below. When an option is not supported it may still be set without getting an | |
638 error, this is called a hidden option. You can't get the value of a hidden | |
639 option though, it is not stored. | |
640 | |
641 To test if option "foo" can be used with ":set" use something like this: > | |
642 if exists('&foo') | |
643 This also returns true for a hidden option. To test if option "foo" is really | |
644 supported use something like this: > | |
645 if exists('+foo') | |
646 < | |
7 | 647 *E355* |
648 A jump table for the options with a short description can be found at |Q_op|. | |
649 | |
650 *'aleph'* *'al'* *aleph* *Aleph* | |
651 'aleph' 'al' number (default 128 for MS-DOS, 224 otherwise) | |
652 global | |
653 {only available when compiled with the |+rightleft| | |
654 feature} | |
655 The ASCII code for the first letter of the Hebrew alphabet. The | |
656 routine that maps the keyboard in Hebrew mode, both in Insert mode | |
657 (when hkmap is set) and on the command-line (when hitting CTRL-_) | |
658 outputs the Hebrew characters in the range [aleph..aleph+26]. | |
659 aleph=128 applies to PC code, and aleph=224 applies to ISO 8859-8. | |
660 See |rileft.txt|. | |
661 | |
662 *'allowrevins'* *'ari'* *'noallowrevins'* *'noari'* | |
663 'allowrevins' 'ari' boolean (default off) | |
664 global | |
665 {only available when compiled with the |+rightleft| | |
666 feature} | |
667 Allow CTRL-_ in Insert and Command-line mode. This is default off, to | |
668 avoid that users that accidentally type CTRL-_ instead of SHIFT-_ get | |
669 into reverse Insert mode, and don't know how to get out. See | |
670 'revins'. | |
671 NOTE: This option is reset when 'compatible' is set. | |
672 | |
673 *'altkeymap'* *'akm'* *'noaltkeymap'* *'noakm'* | |
674 'altkeymap' 'akm' boolean (default off) | |
675 global | |
676 {only available when compiled with the |+farsi| | |
677 feature} | |
15850
a6ca8cf07a98
patch 8.1.0932: Farsi support is outdated and unused
Bram Moolenaar <Bram@vim.org>
parents:
15840
diff
changeset
|
678 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
|
679 |farsi.txt|. |
7 | 680 |
681 *'ambiwidth'* *'ambw'* | |
682 'ambiwidth' 'ambw' string (default: "single") | |
683 global | |
684 Only effective when 'encoding' is "utf-8" or another Unicode encoding. | |
685 Tells Vim what to do with characters with East Asian Width Class | |
686 Ambiguous (such as Euro, Registered Sign, Copyright Sign, Greek | |
687 letters, Cyrillic letters). | |
688 | |
689 There are currently two possible values: | |
233 | 690 "single": Use the same width as characters in US-ASCII. This is |
7 | 691 expected by most users. |
692 "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
|
693 *E834* *E835* |
c945fdb34ce3
Disallow setting 'ambiwidth' to "double" when 'listchars' or 'fillchars'
Bram Moolenaar <bram@vim.org>
parents:
2490
diff
changeset
|
694 The value "double" cannot be used if 'listchars' or 'fillchars' |
c945fdb34ce3
Disallow setting 'ambiwidth' to "double" when 'listchars' or 'fillchars'
Bram Moolenaar <bram@vim.org>
parents:
2490
diff
changeset
|
695 contains a character that would be double width. |
7 | 696 |
697 There are a number of CJK fonts for which the width of glyphs for | |
698 those characters are solely based on how many octets they take in | |
699 legacy/traditional CJK encodings. In those encodings, Euro, | |
700 Registered sign, Greek/Cyrillic letters are represented by two octets, | |
233 | 701 therefore those fonts have "wide" glyphs for them. This is also |
7 | 702 true of some line drawing characters used to make tables in text |
233 | 703 file. Therefore, when a CJK font is used for GUI Vim or |
7 | 704 Vim is running inside a terminal (emulators) that uses a CJK font |
705 (or Vim is run inside an xterm invoked with "-cjkwidth" option.), | |
706 this option should be set to "double" to match the width perceived | |
707 by Vim with the width of glyphs in the font. Perhaps it also has | |
708 to be set to "double" under CJK Windows 9x/ME or Windows 2k/XP | |
709 when the system locale is set to one of CJK locales. See Unicode | |
710 Standard Annex #11 (http://www.unicode.org/reports/tr11). | |
711 | |
4229 | 712 Vim may set this option automatically at startup time when Vim is |
713 compiled with the |+termresponse| feature and if |t_u7| is set to the | |
12499 | 714 escape sequence to request cursor position report. The response can |
715 be found in |v:termu7resp|. | |
4229 | 716 |
7 | 717 *'antialias'* *'anti'* *'noantialias'* *'noanti'* |
718 'antialias' 'anti' boolean (default: off) | |
719 global | |
720 {only available when compiled with GUI enabled | |
721 on Mac OS X} | |
722 This option only has an effect in the GUI version of Vim on Mac OS X | |
723 v10.2 or later. When on, Vim will use smooth ("antialiased") fonts, | |
724 which can be easier to read at certain sizes on certain displays. | |
725 Setting this option can sometimes cause problems if 'guifont' is set | |
726 to its default (empty string). | |
11160 | 727 NOTE: This option is reset when 'compatible' is set. |
7 | 728 |
729 *'autochdir'* *'acd'* *'noautochdir'* *'noacd'* | |
730 'autochdir' 'acd' boolean (default off) | |
731 global | |
2152 | 732 {only available when compiled with it, use |
733 exists("+autochdir") to check} | |
438 | 734 When on, Vim will change the current working directory whenever you |
735 open a file, switch buffers, delete a buffer or open/close a window. | |
736 It will change to the directory containing the file which was opened | |
737 or selected. | |
819 | 738 Note: When this option is on some plugins may not work. |
7 | 739 |
740 *'arabic'* *'arab'* *'noarabic'* *'noarab'* | |
741 'arabic' 'arab' boolean (default off) | |
742 local to window | |
743 {only available when compiled with the |+arabic| | |
744 feature} | |
745 This option can be set to start editing Arabic text. | |
746 Setting this option will: | |
747 - Set the 'rightleft' option, unless 'termbidi' is set. | |
748 - Set the 'arabicshape' option, unless 'termbidi' is set. | |
749 - Set the 'keymap' option to "arabic"; in Insert mode CTRL-^ toggles | |
750 between typing English and Arabic key mapping. | |
751 - Set the 'delcombine' option | |
752 Note that 'encoding' must be "utf-8" for working with Arabic text. | |
753 | |
754 Resetting this option will: | |
755 - Reset the 'rightleft' option. | |
756 - Disable the use of 'keymap' (without changing its value). | |
757 Note that 'arabicshape' and 'delcombine' are not reset (it is a global | |
3557 | 758 option). |
11160 | 759 NOTE: This option is reset when 'compatible' is set. |
7 | 760 Also see |arabic.txt|. |
761 | |
762 *'arabicshape'* *'arshape'* | |
763 *'noarabicshape'* *'noarshape'* | |
764 'arabicshape' 'arshape' boolean (default on) | |
765 global | |
766 {only available when compiled with the |+arabic| | |
767 feature} | |
768 When on and 'termbidi' is off, the required visual character | |
769 corrections that need to take place for displaying the Arabic language | |
3893 | 770 take effect. Shaping, in essence, gets enabled; the term is a broad |
7 | 771 one which encompasses: |
772 a) the changing/morphing of characters based on their location | |
773 within a word (initial, medial, final and stand-alone). | |
774 b) the enabling of the ability to compose characters | |
775 c) the enabling of the required combining of some characters | |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
776 When disabled the display shows each character's true stand-alone |
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
777 form. |
7 | 778 Arabic is a complex language which requires other settings, for |
779 further details see |arabic.txt|. | |
11160 | 780 NOTE: This option is set when 'compatible' is set. |
7 | 781 |
782 *'autoindent'* *'ai'* *'noautoindent'* *'noai'* | |
783 'autoindent' 'ai' boolean (default off) | |
784 local to buffer | |
785 Copy indent from current line when starting a new line (typing <CR> | |
786 in Insert mode or when using the "o" or "O" command). If you do not | |
787 type anything on the new line except <BS> or CTRL-D and then type | |
1152 | 788 <Esc>, CTRL-O or <CR>, the indent is deleted again. Moving the cursor |
789 to another line has the same effect, unless the 'I' flag is included | |
790 in 'cpoptions'. | |
10 | 791 When autoindent is on, formatting (with the "gq" command or when you |
792 reach 'textwidth' in Insert mode) uses the indentation of the first | |
793 line. | |
7 | 794 When 'smartindent' or 'cindent' is on the indent is changed in |
795 a different way. | |
7147
c590de398af9
commit https://github.com/vim/vim/commit/ca63501fbcd1cf9c8aa9ff12c093c95b62a89ed7
Christian Brabandt <cb@256bit.org>
parents:
7080
diff
changeset
|
796 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
|
797 restored when 'paste' is reset. |
7 | 798 |
799 *'autoread'* *'ar'* *'noautoread'* *'noar'* | |
800 'autoread' 'ar' boolean (default off) | |
801 global or local to buffer |global-local| | |
802 When a file has been detected to have been changed outside of Vim and | |
803 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
|
804 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
|
805 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
|
806 |timestamp| |
7 | 807 If this option has a local value, use this command to switch back to |
808 using the global value: > | |
809 :set autoread< | |
810 < | |
811 *'autowrite'* *'aw'* *'noautowrite'* *'noaw'* | |
812 'autowrite' 'aw' boolean (default off) | |
813 global | |
814 Write the contents of the file, if it has been modified, on each | |
815 :next, :rewind, :last, :first, :previous, :stop, :suspend, :tag, :!, | |
864 | 816 :make, CTRL-] and CTRL-^ command; and when a :buffer, CTRL-O, CTRL-I, |
7 | 817 '{A-Z0-9}, or `{A-Z0-9} command takes one to another file. |
818 Note that for some commands the 'autowrite' option is not used, see | |
819 'autowriteall' for that. | |
14695 | 820 Some buffers will not be written, specifically when 'buftype' is |
14668 | 821 "nowrite", "nofile", "terminal" or "prompt". |
7 | 822 |
823 *'autowriteall'* *'awa'* *'noautowriteall'* *'noawa'* | |
824 'autowriteall' 'awa' boolean (default off) | |
825 global | |
826 Like 'autowrite', but also used for commands ":edit", ":enew", ":quit", | |
827 ":qall", ":exit", ":xit", ":recover" and closing the Vim window. | |
828 Setting this option also implies that Vim behaves like 'autowrite' has | |
829 been set. | |
830 | |
831 *'background'* *'bg'* | |
2826 | 832 'background' 'bg' string (default "dark" or "light", see below) |
7 | 833 global |
834 When set to "dark", Vim will try to use colors that look good on a | |
835 dark background. When set to "light", Vim will try to use colors that | |
836 look good on a light background. Any other value is illegal. | |
837 Vim tries to set the default value according to the terminal used. | |
838 This will not always be correct. | |
839 Setting this option does not change the background color, it tells Vim | |
840 what the background color looks like. For changing the background | |
841 color, see |:hi-normal|. | |
842 | |
843 When 'background' is set Vim will adjust the default color groups for | |
10 | 844 the new value. But the colors used for syntax highlighting will not |
1621 | 845 change. *g:colors_name* |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
846 When a color scheme is loaded (the "g:colors_name" variable is set) |
7 | 847 setting 'background' will cause the color scheme to be reloaded. If |
848 the color scheme adjusts to the value of 'background' this will work. | |
849 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
|
850 be undone. First delete the "g:colors_name" variable when needed. |
7 | 851 |
852 When setting 'background' to the default value with: > | |
853 :set background& | |
854 < Vim will guess the value. In the GUI this should work correctly, | |
855 in other cases Vim might not be able to guess the right value. | |
856 | |
12499 | 857 When the |t_RB| option is set, Vim will use it to request the background |
11442 | 858 color from the terminal. If the returned RGB value is dark/light and |
859 'background' is not dark/light, 'background' will be set and the | |
860 screen is redrawn. This may have side effects, make t_BG empty in | |
12499 | 861 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
|
862 be found in |v:termrbgresp|. |
11442 | 863 |
7 | 864 When starting the GUI, the default value for 'background' will be |
865 "light". When the value is not set in the .gvimrc, and Vim detects | |
866 that the background is actually quite dark, 'background' is set to | |
867 "dark". But this happens only AFTER the .gvimrc file has been read | |
868 (because the window needs to be opened to find the actual background | |
869 color). To get around this, force the GUI window to be opened by | |
870 putting a ":gui" command in the .gvimrc file, before where the value | |
871 of 'background' is used (e.g., before ":syntax on"). | |
2826 | 872 |
873 For MS-DOS, Windows and OS/2 the default is "dark". | |
874 For other systems "dark" is used when 'term' is "linux", | |
875 "screen.linux", "cygwin" or "putty", or $COLORFGBG suggests a dark | |
876 background. Otherwise the default is "light". | |
877 | |
12254 | 878 The |:terminal| command and the |term_start()| function use the |
879 'background' value to decide whether the terminal window will start | |
880 with a white or black background. | |
881 | |
7 | 882 Normally this option would be set in the .vimrc file. Possibly |
883 depending on the terminal name. Example: > | |
884 :if &term == "pcterm" | |
885 : set background=dark | |
886 :endif | |
887 < When this option is set, the default settings for the highlight groups | |
888 will change. To use other settings, place ":highlight" commands AFTER | |
889 the setting of the 'background' option. | |
890 This option is also used in the "$VIMRUNTIME/syntax/syntax.vim" file | |
891 to select the colors for syntax highlighting. After changing this | |
892 option, you must load syntax.vim again to see the result. This can be | |
893 done with ":syntax on". | |
894 | |
895 *'backspace'* *'bs'* | |
9669
284b4eb307fc
commit https://github.com/vim/vim/commit/8c08b5b569e2a9e9f63dea514591ecfa2d3bb392
Christian Brabandt <cb@256bit.org>
parents:
9665
diff
changeset
|
896 '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
|
897 in |defaults.vim|) |
7 | 898 global |
899 Influences the working of <BS>, <Del>, CTRL-W and CTRL-U in Insert | |
900 mode. This is a list of items, separated by commas. Each item allows | |
901 a way to backspace over something: | |
902 value effect ~ | |
903 indent allow backspacing over autoindent | |
904 eol allow backspacing over line breaks (join lines) | |
905 start allow backspacing over the start of insert; CTRL-W and CTRL-U | |
906 stop once at the start of insert. | |
907 | |
908 When the value is empty, Vi compatible backspacing is used. | |
909 | |
910 For backwards compatibility with version 5.4 and earlier: | |
911 value effect ~ | |
912 0 same as ":set backspace=" (Vi compatible) | |
913 1 same as ":set backspace=indent,eol" | |
914 2 same as ":set backspace=indent,eol,start" | |
915 | |
916 See |:fixdel| if your <BS> or <Del> key does not do what you want. | |
917 NOTE: This option is set to "" when 'compatible' is set. | |
918 | |
919 *'backup'* *'bk'* *'nobackup'* *'nobk'* | |
920 'backup' 'bk' boolean (default off) | |
921 global | |
922 Make a backup before overwriting a file. Leave it around after the | |
923 file has been successfully written. If you do not want to keep the | |
924 backup file, but you do want a backup while the file is being | |
925 written, reset this option and set the 'writebackup' option (this is | |
926 the default). If you do not want a backup file at all reset both | |
10 | 927 options (use this if your file system is almost full). See the |
7 | 928 |backup-table| for more explanations. |
929 When the 'backupskip' pattern matches, a backup is not made anyway. | |
930 When 'patchmode' is set, the backup may be renamed to become the | |
931 oldest version of a file. | |
932 NOTE: This option is reset when 'compatible' is set. | |
933 | |
934 *'backupcopy'* *'bkc'* | |
935 'backupcopy' 'bkc' string (Vi default for Unix: "yes", otherwise: "auto") | |
6243 | 936 global or local to buffer |global-local| |
7 | 937 When writing a file and a backup is made, this option tells how it's |
938 done. This is a comma separated list of words. | |
939 | |
940 The main values are: | |
941 "yes" make a copy of the file and overwrite the original one | |
942 "no" rename the file and write a new one | |
943 "auto" one of the previous, what works best | |
944 | |
945 Extra values that can be combined with the ones above are: | |
946 "breaksymlink" always break symlinks when writing | |
947 "breakhardlink" always break hardlinks when writing | |
948 | |
949 Making a copy and overwriting the original file: | |
950 - Takes extra time to copy the file. | |
951 + When the file has special attributes, is a (hard/symbolic) link or | |
952 has a resource fork, all this is preserved. | |
953 - When the file is a link the backup will have the name of the link, | |
954 not of the real file. | |
955 | |
956 Renaming the file and writing a new one: | |
957 + It's fast. | |
958 - Sometimes not all attributes of the file can be copied to the new | |
959 file. | |
960 - When the file is a link the new file will not be a link. | |
961 | |
962 The "auto" value is the middle way: When Vim sees that renaming file | |
963 is possible without side effects (the attributes can be passed on and | |
1152 | 964 the file is not a link) that is used. When problems are expected, a |
965 copy will be made. | |
7 | 966 |
967 The "breaksymlink" and "breakhardlink" values can be used in | |
968 combination with any of "yes", "no" and "auto". When included, they | |
969 force Vim to always break either symbolic or hard links by doing | |
970 exactly what the "no" option does, renaming the original file to | |
971 become the backup and writing a new file in its place. This can be | |
972 useful for example in source trees where all the files are symbolic or | |
973 hard links and any changes should stay in the local source tree, not | |
974 be propagated back to the original source. | |
975 *crontab* | |
976 One situation where "no" and "auto" will cause problems: A program | |
977 that opens a file, invokes Vim to edit that file, and then tests if | |
978 the open file was changed (through the file descriptor) will check the | |
10 | 979 backup file instead of the newly created file. "crontab -e" is an |
7 | 980 example. |
981 | |
982 When a copy is made, the original file is truncated and then filled | |
983 with the new text. This means that protection bits, owner and | |
984 symbolic links of the original file are unmodified. The backup file | |
10 | 985 however, is a new file, owned by the user who edited the file. The |
7 | 986 group of the backup is set to the group of the original file. If this |
987 fails, the protection bits for the group are made the same as for | |
988 others. | |
989 | |
990 When the file is renamed this is the other way around: The backup has | |
991 the same attributes of the original file, and the newly written file | |
992 is owned by the current user. When the file was a (hard/symbolic) | |
993 link, the new file will not! That's why the "auto" value doesn't | |
994 rename when the file is a link. The owner and group of the newly | |
995 written file will be set to the same ones as the original file, but | |
996 the system may refuse to do this. In that case the "auto" value will | |
997 again not rename the file. | |
998 | |
11160 | 999 NOTE: This option is set to the Vi default value when 'compatible' is |
1000 set and to the Vim default value when 'compatible' is reset. | |
1001 | |
7 | 1002 *'backupdir'* *'bdir'* |
1003 'backupdir' 'bdir' string (default for Amiga: ".,t:", | |
5555 | 1004 for MS-DOS and Win32: ".,$TEMP,c:/tmp,c:/temp" |
7 | 1005 for Unix: ".,~/tmp,~/") |
1006 global | |
1007 List of directories for the backup file, separated with commas. | |
1008 - 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
|
1009 where this is possible. The directory must exist, Vim will not |
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
1010 create it for you. |
8629
54ac275e3fc4
commit https://github.com/vim/vim/commit/3848e00e0177abdb31bc600234967863ec487233
Christian Brabandt <cb@256bit.org>
parents:
8560
diff
changeset
|
1011 - Empty means that no backup file will be created ('patchmode' is |
7 | 1012 impossible!). Writing may fail because of this. |
1013 - A directory "." means to put the backup file in the same directory | |
1014 as the edited file. | |
33 | 1015 - A directory starting with "./" (or ".\" for MS-DOS et al.) means to |
7 | 1016 put the backup file relative to where the edited file is. The |
1017 leading "." is replaced with the path name of the edited file. | |
1018 ("." inside a directory name has no special meaning). | |
1019 - Spaces after the comma are ignored, other spaces are considered part | |
1020 of the directory name. To have a space at the start of a directory | |
1021 name, precede it with a backslash. | |
1022 - To include a comma in a directory name precede it with a backslash. | |
1023 - 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
|
1024 - For Unix and Win32, if a directory ends in two path separators "//", |
15033 | 1025 the backup file name will be built from the complete path to the |
1026 file with all path separators changed to percent '%' signs. This | |
1027 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
|
1028 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
|
1029 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
|
1030 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
|
1031 use '//', instead of '\\'. |
7 | 1032 - Environment variables are expanded |:set_env|. |
1033 - Careful with '\' characters, type one before a space, type two to | |
1034 get one in the option (see |option-backslash|), for example: > | |
1035 :set bdir=c:\\tmp,\ dir\\,with\\,commas,\\\ dir\ with\ spaces | |
1036 < - For backwards compatibility with Vim version 3.0 a '>' at the start | |
1037 of the option is removed. | |
1038 See also 'backup' and 'writebackup' options. | |
1039 If you want to hide your backup files on Unix, consider this value: > | |
1040 :set backupdir=./.backup,~/.backup,.,/tmp | |
1041 < You must create a ".backup" directory in each directory and in your | |
1042 home directory for this to work properly. | |
1043 The use of |:set+=| and |:set-=| is preferred when adding or removing | |
1044 directories from the list. This avoids problems when a future version | |
1045 uses another default. | |
1046 This option cannot be set from a |modeline| or in the |sandbox|, for | |
1047 security reasons. | |
1048 | |
1049 *'backupext'* *'bex'* *E589* | |
1050 'backupext' 'bex' string (default "~", for VMS: "_") | |
1051 global | |
1052 String which is appended to a file name to make the name of the | |
1053 backup file. The default is quite unusual, because this avoids | |
1054 accidentally overwriting existing files with a backup file. You might | |
1055 prefer using ".bak", but make sure that you don't have files with | |
1056 ".bak" that you want to keep. | |
36 | 1057 Only normal file name characters can be used, "/\*?[|<>" are illegal. |
7 | 1058 |
26 | 1059 If you like to keep a lot of backups, you could use a BufWritePre |
1060 autocommand to change 'backupext' just before writing the file to | |
1061 include a timestamp. > | |
1062 :au BufWritePre * let &bex = '-' . strftime("%Y%b%d%X") . '~' | |
1063 < Use 'backupdir' to put the backup in a different directory. | |
1064 | |
7 | 1065 *'backupskip'* *'bsk'* |
13664
f64c5e636c9f
patch 8.0.1704: 'backupskip' default doesn't work for Mac
Christian Brabandt <cb@256bit.org>
parents:
13482
diff
changeset
|
1066 '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
|
1067 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
|
1068 Mac: "/private/tmp/*,$TMPDIR/*,$TMP/*,$TEMP/*") |
7 | 1069 global |
1070 {not available when compiled without the |+wildignore| | |
1071 feature} | |
1072 A list of file patterns. When one of the patterns matches with the | |
1073 name of the file which is written, no backup file is created. Both | |
1074 the specified file name and the full path name of the file are used. | |
1075 The pattern is used like with |:autocmd|, see |autocmd-patterns|. | |
1076 Watch out for special characters, see |option-backslash|. | |
1077 When $TMPDIR, $TMP or $TEMP is not defined, it is not used for the | |
233 | 1078 default value. "/tmp/*" is only used for Unix. |
1152 | 1079 |
3513 | 1080 WARNING: Not having a backup file means that when Vim fails to write |
1081 your buffer correctly and then, for whatever reason, Vim exits, you | |
1082 lose both the original file and what you were writing. Only disable | |
1083 backups if you don't care about losing the file. | |
1084 | |
1152 | 1085 Note that environment variables are not expanded. If you want to use |
1086 $HOME you must expand it explicitly, e.g.: > | |
8835
c1a5623cfc86
commit https://github.com/vim/vim/commit/7c1c6dbb6817640fd3956a0d5417da23fde336d8
Christian Brabandt <cb@256bit.org>
parents:
8748
diff
changeset
|
1087 :let &backupskip = escape(expand('$HOME'), '\') . '/tmp/*' |
1152 | 1088 |
1089 < Note that the default also makes sure that "crontab -e" works (when a | |
557 | 1090 backup would be made by renaming the original file crontab won't see |
1091 the newly created file). Also see 'backupcopy' and |crontab|. | |
7 | 1092 |
1093 *'balloondelay'* *'bdlay'* | |
1094 'balloondelay' 'bdlay' number (default: 600) | |
1095 global | |
1096 {only available when compiled with the |+balloon_eval| | |
1097 feature} | |
1098 Delay in milliseconds before a balloon may pop up. See |balloon-eval|. | |
1099 | |
1100 *'ballooneval'* *'beval'* *'noballooneval'* *'nobeval'* | |
1101 'ballooneval' 'beval' boolean (default off) | |
1102 global | |
1103 {only available when compiled with the |+balloon_eval| | |
189 | 1104 feature} |
12865
ebb4f6c93598
patch 8.0.1309: cannot use 'balloonexpr' in a terminal
Christian Brabandt <cb@256bit.org>
parents:
12826
diff
changeset
|
1105 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
|
1106 |
ebb4f6c93598
patch 8.0.1309: cannot use 'balloonexpr' in a terminal
Christian Brabandt <cb@256bit.org>
parents:
12826
diff
changeset
|
1107 *'balloonevalterm'* *'bevalterm'* *'noballoonevalterm'* |
ebb4f6c93598
patch 8.0.1309: cannot use 'balloonexpr' in a terminal
Christian Brabandt <cb@256bit.org>
parents:
12826
diff
changeset
|
1108 *'nobevalterm'* |
ebb4f6c93598
patch 8.0.1309: cannot use 'balloonexpr' in a terminal
Christian Brabandt <cb@256bit.org>
parents:
12826
diff
changeset
|
1109 '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
|
1110 global |
ebb4f6c93598
patch 8.0.1309: cannot use 'balloonexpr' in a terminal
Christian Brabandt <cb@256bit.org>
parents:
12826
diff
changeset
|
1111 {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
|
1112 |+balloon_eval_term| feature} |
ebb4f6c93598
patch 8.0.1309: cannot use 'balloonexpr' in a terminal
Christian Brabandt <cb@256bit.org>
parents:
12826
diff
changeset
|
1113 Switch on the |balloon-eval| functionality for the terminal. |
7 | 1114 |
189 | 1115 *'balloonexpr'* *'bexpr'* |
1116 'balloonexpr' 'bexpr' string (default "") | |
790 | 1117 global or local to buffer |global-local| |
189 | 1118 {only available when compiled with the |+balloon_eval| |
1119 feature} | |
782 | 1120 Expression for text to show in evaluation balloon. It is only used |
16610 | 1121 when 'ballooneval' or 'balloonevalterm' is on. These variables can be |
1122 used: | |
189 | 1123 |
1124 v:beval_bufnr number of the buffer in which balloon is going to show | |
1125 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
|
1126 v:beval_winid ID of the window |
189 | 1127 v:beval_lnum line number |
1128 v:beval_col column number (byte index) | |
1129 v:beval_text word under or after the mouse pointer | |
1130 | |
1131 The evaluation of the expression must not have side effects! | |
1132 Example: > | |
16610 | 1133 function MyBalloonExpr() |
435 | 1134 return 'Cursor is at line ' . v:beval_lnum . |
189 | 1135 \', column ' . v:beval_col . |
1136 \ ' of file ' . bufname(v:beval_bufnr) . | |
1137 \ ' on word "' . v:beval_text . '"' | |
1138 endfunction | |
1139 set bexpr=MyBalloonExpr() | |
1140 set ballooneval | |
1141 < | |
11062 | 1142 Also see |balloon_show()|, can be used if the content of the balloon |
1143 is to be fetched asynchronously. | |
1144 | |
189 | 1145 NOTE: The balloon is displayed only if the cursor is on a text |
1146 character. If the result of evaluating 'balloonexpr' is not empty, | |
1147 Vim does not try to send a message to an external debugger (Netbeans | |
1148 or Sun Workshop). | |
1149 | |
3682 | 1150 The expression will be evaluated in the |sandbox| when set from a |
1151 modeline, see |sandbox-option|. | |
634 | 1152 |
1153 It is not allowed to change text or jump to another window while | |
1154 evaluating 'balloonexpr' |textlock|. | |
1155 | |
446 | 1156 To check whether line breaks in the balloon text work use this check: > |
435 | 1157 if has("balloon_multiline") |
714 | 1158 < When they are supported "\n" characters will start a new line. If the |
1159 expression evaluates to a |List| this is equal to using each List item | |
1160 as a string and putting "\n" in between them. | |
11160 | 1161 NOTE: This option is set to "" when 'compatible' is set. |
714 | 1162 |
6949 | 1163 *'belloff'* *'bo'* |
1164 'belloff' 'bo' string (default "") | |
1165 global | |
1166 Specifies for which events the bell will not be rung. It is a comma | |
1167 separated list of items. For each item that is present, the bell | |
1168 will be silenced. This is most useful to specify specific events in | |
1169 insert mode to be silenced. | |
1170 | |
1171 item meaning when present ~ | |
1172 all All events. | |
1173 backspace When hitting <BS> or <Del> and deleting results in an | |
1174 error. | |
1175 cursor Fail to move around using the cursor keys or | |
1176 <PageUp>/<PageDown> in |Insert-mode|. | |
1177 complete Error occurred when using |i_CTRL-X_CTRL-K| or | |
1178 |i_CTRL-X_CTRL-T|. | |
1179 copy Cannot copy char from insert mode using |i_CTRL-Y| or | |
1180 |i_CTRL-E|. | |
1181 ctrlg Unknown Char after <C-G> in Insert mode. | |
1182 error Other Error occurred (e.g. try to join last line) | |
1183 (mostly used in |Normal-mode| or |Cmdline-mode|). | |
1184 esc hitting <Esc> in |Normal-mode|. | |
1185 ex In |Visual-mode|, hitting |Q| results in an error. | |
1186 hangul Error occurred when using hangul input. | |
1187 insertmode Pressing <Esc> in 'insertmode'. | |
1188 lang Calling the beep module for Lua/Mzscheme/TCL. | |
1189 mess No output available for |g<|. | |
1190 showmatch Error occurred for 'showmatch' function. | |
1191 operator Empty region error |cpo-E|. | |
1192 register Unknown register after <C-R> in |Insert-mode|. | |
1193 shell Bell from shell output |:!|. | |
1194 spell Error happened on spell suggest. | |
1195 wildmode More matches in |cmdline-completion| available | |
1196 (depends on the 'wildmode' setting). | |
1197 | |
11160 | 1198 This is most useful to fine tune when in Insert mode the bell should |
1199 be rung. For Normal mode and Ex commands, the bell is often rung to | |
6949 | 1200 indicate that an error occurred. It can be silenced by adding the |
1201 "error" keyword. | |
1202 | |
7 | 1203 *'binary'* *'bin'* *'nobinary'* *'nobin'* |
1204 'binary' 'bin' boolean (default off) | |
1205 local to buffer | |
1206 This option should be set before editing a binary file. You can also | |
1207 use the |-b| Vim argument. When this option is switched on a few | |
1208 options will be changed (also when it already was on): | |
1209 'textwidth' will be set to 0 | |
1210 'wrapmargin' will be set to 0 | |
1211 'modeline' will be off | |
1212 'expandtab' will be off | |
1213 Also, 'fileformat' and 'fileformats' options will not be used, the | |
1214 file is read and written like 'fileformat' was "unix" (a single <NL> | |
1215 separates lines). | |
1216 The 'fileencoding' and 'fileencodings' options will not be used, the | |
1217 file is read without conversion. | |
1218 NOTE: When you start editing a(nother) file while the 'bin' option is | |
1219 on, settings from autocommands may change the settings again (e.g., | |
1220 'textwidth'), causing trouble when editing. You might want to set | |
1221 'bin' again when the file has been loaded. | |
1222 The previous values of these options are remembered and restored when | |
1223 'bin' is switched from on to off. Each buffer has its own set of | |
1224 saved option values. | |
1225 To edit a file with 'binary' set you can use the |++bin| argument. | |
1226 This avoids you have to do ":set bin", which would have effect for all | |
1227 files you edit. | |
1228 When writing a file the <EOL> for the last line is only written if | |
1229 there was one in the original file (normally Vim appends an <EOL> to | |
1230 the last line if there is none; this would make the file longer). See | |
1231 the 'endofline' option. | |
1232 | |
1233 *'bioskey'* *'biosk'* *'nobioskey'* *'nobiosk'* | |
1234 'bioskey' 'biosk' boolean (default on) | |
1235 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
|
1236 {only for MS-DOS} |
8246
f16bfe02cef1
commit https://github.com/vim/vim/commit/f391327adbbffb11180cf6038a92af1ed144e907
Christian Brabandt <cb@256bit.org>
parents:
8182
diff
changeset
|
1237 This was for MS-DOS and is no longer supported. |
7 | 1238 |
1239 *'bomb'* *'nobomb'* | |
1240 'bomb' boolean (default off) | |
1241 local to buffer | |
1242 When writing a file and the following conditions are met, a BOM (Byte | |
1243 Order Mark) is prepended to the file: | |
1244 - this option is on | |
1245 - the 'binary' option is off | |
1246 - 'fileencoding' is "utf-8", "ucs-2", "ucs-4" or one of the little/big | |
1247 endian variants. | |
1248 Some applications use the BOM to recognize the encoding of the file. | |
1249 Often used for UCS-2 files on MS-Windows. For other applications it | |
1250 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
|
1251 appear halfway the resulting file. Gcc doesn't accept a BOM. |
7 | 1252 When Vim reads a file and 'fileencodings' starts with "ucs-bom", a |
1253 check for the presence of the BOM is done and 'bomb' set accordingly. | |
1254 Unless 'binary' is set, it is removed from the first line, so that you | |
1255 don't see it when editing. When you don't change the options, the BOM | |
1256 will be restored when writing the file. | |
1257 | |
1258 *'breakat'* *'brk'* | |
1259 'breakat' 'brk' string (default " ^I!@*-+;:,./?") | |
1260 global | |
2570
71b56b4e7785
Make the references to features in the help more consistent. (Sylvain Hitier)
Bram Moolenaar <bram@vim.org>
parents:
2561
diff
changeset
|
1261 {not available when compiled without the |+linebreak| |
7 | 1262 feature} |
1263 This option lets you choose which characters might cause a line | |
500 | 1264 break if 'linebreak' is on. Only works for ASCII and also for 8-bit |
1265 characters when 'encoding' is an 8-bit encoding. | |
7 | 1266 |
8835
c1a5623cfc86
commit https://github.com/vim/vim/commit/7c1c6dbb6817640fd3956a0d5417da23fde336d8
Christian Brabandt <cb@256bit.org>
parents:
8748
diff
changeset
|
1267 *'breakindent'* *'bri'* *'nobreakindent'* *'nobri'* |
6009 | 1268 'breakindent' 'bri' boolean (default off) |
1269 local to window | |
1270 {not available when compiled without the |+linebreak| | |
1271 feature} | |
1272 Every wrapped line will continue visually indented (same amount of | |
1273 space as the beginning of that line), thus preserving horizontal blocks | |
1274 of text. | |
11160 | 1275 NOTE: This option is reset when 'compatible' is set. |
6009 | 1276 |
1277 *'breakindentopt'* *'briopt'* | |
1278 'breakindentopt' 'briopt' string (default empty) | |
1279 local to window | |
1280 {not available when compiled without the |+linebreak| | |
1281 feature} | |
1282 Settings for 'breakindent'. It can consist of the following optional | |
6026 | 1283 items and must be separated by a comma: |
6009 | 1284 min:{n} Minimum text width that will be kept after |
1285 applying 'breakindent', even if the resulting | |
1286 text should normally be narrower. This prevents | |
1287 text indented almost to the right window border | |
1288 occupying lot of vertical space when broken. | |
6026 | 1289 shift:{n} After applying 'breakindent', the wrapped line's |
1290 beginning will be shifted by the given number of | |
1291 characters. It permits dynamic French paragraph | |
6009 | 1292 indentation (negative) or emphasizing the line |
1293 continuation (positive). | |
13341
acd7eaa13d2b
Updated runtime files.
Christian Brabandt <cb@256bit.org>
parents:
13314
diff
changeset
|
1294 sbr Display the 'showbreak' value before applying the |
6009 | 1295 additional indent. |
1296 The default value for min is 20 and shift is 0. | |
1297 | |
7 | 1298 *'browsedir'* *'bsdir'* |
29 | 1299 'browsedir' 'bsdir' string (default: "last") |
7 | 1300 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
|
1301 {only for Motif, Athena, GTK, Mac and Win32 GUI} |
7 | 1302 Which directory to use for the file browser: |
1621 | 1303 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
|
1304 file was opened or saved. |
7 | 1305 buffer Use the directory of the related buffer. |
1306 current Use the current directory. | |
1307 {path} Use the specified directory | |
1308 | |
1309 *'bufhidden'* *'bh'* | |
1310 'bufhidden' 'bh' string (default: "") | |
1311 local to buffer | |
1312 This option specifies what happens when a buffer is no longer | |
1313 displayed in a window: | |
1314 <empty> follow the global 'hidden' option | |
1315 hide hide the buffer (don't unload it), also when 'hidden' | |
1316 is not set | |
1317 unload unload the buffer, also when 'hidden' is set or using | |
1318 |:hide| | |
1319 delete delete the buffer from the buffer list, also when | |
1320 'hidden' is set or using |:hide|, like using | |
1321 |:bdelete| | |
1322 wipe wipe out the buffer from the buffer list, also when | |
1323 'hidden' is set or using |:hide|, like using | |
1324 |:bwipeout| | |
1325 | |
82 | 1326 CAREFUL: when "unload", "delete" or "wipe" is used changes in a buffer |
3224 | 1327 are lost without a warning. Also, these values may break autocommands |
1328 that switch between buffers temporarily. | |
7 | 1329 This option is used together with 'buftype' and 'swapfile' to specify |
1330 special kinds of buffers. See |special-buffers|. | |
1331 | |
1332 *'buflisted'* *'bl'* *'nobuflisted'* *'nobl'* *E85* | |
1333 'buflisted' 'bl' boolean (default: on) | |
1334 local to buffer | |
1335 When this option is set, the buffer shows up in the buffer list. If | |
1336 it is reset it is not used for ":bnext", "ls", the Buffers menu, etc. | |
1337 This option is reset by Vim for buffers that are only used to remember | |
1338 a file name or marks. Vim sets it when starting to edit a buffer. | |
1339 But not when moving to a buffer with ":buffer". | |
1340 | |
1341 *'buftype'* *'bt'* *E382* | |
1342 'buftype' 'bt' string (default: "") | |
1343 local to buffer | |
1344 The value of this option specifies the type of a buffer: | |
1345 <empty> normal buffer | |
1346 nofile buffer which is not related to a file and will not be | |
1347 written | |
1348 nowrite buffer which will not be written | |
17 | 1349 acwrite buffer which will always be written with BufWriteCmd |
13437 | 1350 autocommands. |
7 | 1351 quickfix quickfix buffer, contains list of errors |:cwindow| |
648 | 1352 or list of locations |:lwindow| |
7 | 1353 help help buffer (you are not supposed to set this |
1354 manually) | |
11757
74abb6c84984
patch 8.0.0761: options not set properly for a terminal buffer
Christian Brabandt <cb@256bit.org>
parents:
11666
diff
changeset
|
1355 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
|
1356 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
|
1357 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
|
1358 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
|
1359 {only when compiled with the |+channel| feature} |
7 | 1360 |
1361 This option is used together with 'bufhidden' and 'swapfile' to | |
1362 specify special kinds of buffers. See |special-buffers|. | |
1363 | |
1364 Be careful with changing this option, it can have many side effects! | |
1365 | |
648 | 1366 A "quickfix" buffer is only used for the error list and the location |
1367 list. This value is set by the |:cwindow| and |:lwindow| commands and | |
1368 you are not supposed to change it. | |
7 | 1369 |
1370 "nofile" and "nowrite" buffers are similar: | |
1371 both: The buffer is not to be written to disk, ":w" doesn't | |
1372 work (":w filename" does work though). | |
1373 both: The buffer is never considered to be |'modified'|. | |
1374 There is no warning when the changes will be lost, for | |
1375 example when you quit Vim. | |
1376 both: A swap file is only created when using too much memory | |
1377 (when 'swapfile' has been reset there is never a swap | |
1378 file). | |
1379 nofile only: The buffer name is fixed, it is not handled like a | |
1380 file name. It is not modified in response to a |:cd| | |
1381 command. | |
6647 | 1382 both: When using ":e bufname" and already editing "bufname" |
1383 the buffer is made empty and autocommands are | |
1384 triggered as usual for |:edit|. | |
17 | 1385 *E676* |
1386 "acwrite" implies that the buffer name is not related to a file, like | |
1387 "nofile", but it will be written. Thus, in contrast to "nofile" and | |
1388 "nowrite", ":w" does work and a modified buffer can't be abandoned | |
1389 without saving. For writing there must be matching |BufWriteCmd|, | |
1390 |FileWriteCmd| or |FileAppendCmd| autocommands. | |
7 | 1391 |
1392 *'casemap'* *'cmp'* | |
1393 'casemap' 'cmp' string (default: "internal,keepascii") | |
1394 global | |
1395 Specifies details about changing the case of letters. It may contain | |
1396 these words, separated by a comma: | |
1397 internal Use internal case mapping functions, the current | |
1398 locale does not change the case mapping. This only | |
493 | 1399 matters when 'encoding' is a Unicode encoding, |
1400 "latin1" or "iso-8859-15". When "internal" is | |
1401 omitted, the towupper() and towlower() system library | |
1402 functions are used when available. | |
7 | 1403 keepascii For the ASCII characters (0x00 to 0x7f) use the US |
1404 case mapping, the current locale is not effective. | |
1405 This probably only matters for Turkish. | |
1406 | |
1407 *'cdpath'* *'cd'* *E344* *E346* | |
1408 'cdpath' 'cd' string (default: equivalent to $CDPATH or ",,") | |
1409 global | |
1410 {not available when compiled without the | |
1411 |+file_in_path| feature} | |
1412 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
|
1413 |: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
|
1414 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
|
1415 "/", "./" or "../", the 'cdpath' option is not used then. |
7 | 1416 The 'cdpath' option's value has the same form and semantics as |
1417 |'path'|. Also see |file-searching|. | |
1418 The default value is taken from $CDPATH, with a "," prepended to look | |
1419 in the current directory first. | |
1420 If the default value taken from $CDPATH is not what you want, include | |
1421 a modified version of the following command in your vimrc file to | |
1422 override it: > | |
1423 :let &cdpath = ',' . substitute(substitute($CDPATH, '[, ]', '\\\0', 'g'), ':', ',', 'g') | |
1424 < This option cannot be set from a |modeline| or in the |sandbox|, for | |
1425 security reasons. | |
1426 (parts of 'cdpath' can be passed to the shell to expand file names). | |
1427 | |
1428 *'cedit'* | |
1429 'cedit' string (Vi default: "", Vim default: CTRL-F) | |
1430 global | |
1431 {not available when compiled without the |+vertsplit| | |
1432 feature} | |
1433 The key used in Command-line Mode to open the command-line window. | |
1434 The default is CTRL-F when 'compatible' is off. | |
1435 Only non-printable keys are allowed. | |
1436 The key can be specified as a single character, but it is difficult to | |
1437 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
|
1438 :exe "set cedit=\<C-Y>" |
619a98a67f67
commit https://github.com/vim/vim/commit/e18dbe865d190e74fb5d43ac8bc6ac22507d0223
Christian Brabandt <cb@256bit.org>
parents:
9344
diff
changeset
|
1439 :exe "set cedit=\<Esc>" |
7 | 1440 < |Nvi| also has this option, but it only uses the first character. |
1441 See |cmdwin|. | |
11160 | 1442 NOTE: This option is set to the Vim default value when 'compatible' |
1443 is reset. | |
7 | 1444 |
1445 *'charconvert'* *'ccv'* *E202* *E214* *E513* | |
1446 'charconvert' 'ccv' string (default "") | |
1447 global | |
15878 | 1448 {only available when compiled with the |+eval| feature} |
7 | 1449 An expression that is used for character encoding conversion. It is |
1450 evaluated when a file that is to be read or has been written has a | |
1451 different encoding from what is desired. | |
1452 'charconvert' is not used when the internal iconv() function is | |
1453 supported and is able to do the conversion. Using iconv() is | |
1454 preferred, because it is much faster. | |
1455 'charconvert' is not used when reading stdin |--|, because there is no | |
1456 file to convert from. You will have to save the text in a file first. | |
1457 The expression must return zero or an empty string for success, | |
1458 non-zero for failure. | |
1459 The possible encoding names encountered are in 'encoding'. | |
1460 Additionally, names given in 'fileencodings' and 'fileencoding' are | |
1461 used. | |
1462 Conversion between "latin1", "unicode", "ucs-2", "ucs-4" and "utf-8" | |
1463 is done internally by Vim, 'charconvert' is not used for this. | |
1464 'charconvert' is also used to convert the viminfo file, if the 'c' | |
1465 flag is present in 'viminfo'. Also used for Unicode conversion. | |
1466 Example: > | |
1467 set charconvert=CharConvert() | |
1468 fun CharConvert() | |
1469 system("recode " | |
1470 \ . v:charconvert_from . ".." . v:charconvert_to | |
1471 \ . " <" . v:fname_in . " >" v:fname_out) | |
1472 return v:shell_error | |
1473 endfun | |
1474 < The related Vim variables are: | |
1475 v:charconvert_from name of the current encoding | |
1476 v:charconvert_to name of the desired encoding | |
1477 v:fname_in name of the input file | |
1478 v:fname_out name of the output file | |
1479 Note that v:fname_in and v:fname_out will never be the same. | |
1480 Note that v:charconvert_from and v:charconvert_to may be different | |
1481 from 'encoding'. Vim internally uses UTF-8 instead of UCS-2 or UCS-4. | |
1482 Encryption is not done by Vim when using 'charconvert'. If you want | |
1483 to encrypt the file after conversion, 'charconvert' should take care | |
1484 of this. | |
1485 This option cannot be set from a |modeline| or in the |sandbox|, for | |
1486 security reasons. | |
1487 | |
1488 *'cindent'* *'cin'* *'nocindent'* *'nocin'* | |
1489 'cindent' 'cin' boolean (default off) | |
1490 local to buffer | |
1491 {not available when compiled without the |+cindent| | |
1492 feature} | |
1621 | 1493 Enables automatic C program indenting. See 'cinkeys' to set the keys |
7 | 1494 that trigger reindenting in insert mode and 'cinoptions' to set your |
1495 preferred indent style. | |
1496 If 'indentexpr' is not empty, it overrules 'cindent'. | |
1497 If 'lisp' is not on and both 'indentexpr' and 'equalprg' are empty, | |
1498 the "=" operator indents using this algorithm rather than calling an | |
1499 external program. | |
1500 See |C-indenting|. | |
1501 When you don't like the way 'cindent' works, try the 'smartindent' | |
1502 option or 'indentexpr'. | |
1503 This option is not used when 'paste' is set. | |
1504 NOTE: This option is reset when 'compatible' is set. | |
1505 | |
1506 *'cinkeys'* *'cink'* | |
15701
9cd11f6beb70
patch 8.1.0858: 'indentkeys' and 'cinkeys' defaults are different
Bram Moolenaar <Bram@vim.org>
parents:
15512
diff
changeset
|
1507 'cinkeys' 'cink' string (default "0{,0},0),0],:,0#,!^F,o,O,e") |
7 | 1508 local to buffer |
1509 {not available when compiled without the |+cindent| | |
1510 feature} | |
1511 A list of keys that, when typed in Insert mode, cause reindenting of | |
1512 the current line. Only used if 'cindent' is on and 'indentexpr' is | |
1513 empty. | |
1514 For the format of this option see |cinkeys-format|. | |
1515 See |C-indenting|. | |
1516 | |
1517 *'cinoptions'* *'cino'* | |
1518 'cinoptions' 'cino' string (default "") | |
1519 local to buffer | |
1520 {not available when compiled without the |+cindent| | |
1521 feature} | |
1522 The 'cinoptions' affect the way 'cindent' reindents lines in a C | |
1523 program. See |cinoptions-values| for the values of this option, and | |
1524 |C-indenting| for info on C indenting in general. | |
1525 | |
1526 | |
1527 *'cinwords'* *'cinw'* | |
1528 'cinwords' 'cinw' string (default "if,else,while,do,for,switch") | |
1529 local to buffer | |
1530 {not available when compiled without both the | |
1531 |+cindent| and the |+smartindent| features} | |
1532 These keywords start an extra indent in the next line when | |
1533 'smartindent' or 'cindent' is set. For 'cindent' this is only done at | |
1534 an appropriate place (inside {}). | |
1535 Note that 'ignorecase' isn't used for 'cinwords'. If case doesn't | |
1536 matter, include the keyword both the uppercase and lowercase: | |
1537 "if,If,IF". | |
1538 | |
1539 *'clipboard'* *'cb'* | |
1540 'clipboard' 'cb' string (default "autoselect,exclude:cons\|linux" | |
1541 for X-windows, "" otherwise) | |
1542 global | |
1543 {only in GUI versions or when the |+xterm_clipboard| | |
1544 feature is included} | |
1545 This option is a list of comma separated names. | |
1546 These names are recognized: | |
1547 | |
3674 | 1548 *clipboard-unnamed* |
7 | 1549 unnamed When included, Vim will use the clipboard register '*' |
1550 for all yank, delete, change and put operations which | |
1551 would normally go to the unnamed register. When a | |
1552 register is explicitly specified, it will always be | |
1553 used regardless of whether "unnamed" is in 'clipboard' | |
1554 or not. The clipboard register can always be | |
1555 explicitly accessed using the "* notation. Also see | |
1556 |gui-clipboard|. | |
1557 | |
3682 | 1558 *clipboard-unnamedplus* |
4119 | 1559 unnamedplus A variant of the "unnamed" flag which uses the |
1560 clipboard register '+' (|quoteplus|) instead of | |
1561 register '*' for all yank, delete, change and put | |
1562 operations which would normally go to the unnamed | |
1563 register. When "unnamed" is also included to the | |
1564 option, yank operations (but not delete, change or | |
1565 put) will additionally copy the text into register | |
1566 '*'. | |
2662 | 1567 Only available with the |+X11| feature. |
2654 | 1568 Availability can be checked with: > |
1569 if has('unnamedplus') | |
1570 < | |
3682 | 1571 *clipboard-autoselect* |
7 | 1572 autoselect Works like the 'a' flag in 'guioptions': If present, |
1573 then whenever Visual mode is started, or the Visual | |
1574 area extended, Vim tries to become the owner of the | |
1575 windowing system's global selection or put the | |
1576 selected text on the clipboard used by the selection | |
14999 | 1577 register "*. See |'go-a'| and |quotestar| for details. |
1578 When the GUI is active, the 'a' flag in 'guioptions' | |
1579 is used, when the GUI is not active, this "autoselect" | |
1580 flag is used. | |
7 | 1581 Also applies to the modeless selection. |
1582 | |
3674 | 1583 *clipboard-autoselectplus* |
1584 autoselectplus Like "autoselect" but using the + register instead of | |
1585 the * register. Compare to the 'P' flag in | |
1586 'guioptions'. | |
1587 | |
1588 *clipboard-autoselectml* | |
7 | 1589 autoselectml Like "autoselect", but for the modeless selection |
1590 only. Compare to the 'A' flag in 'guioptions'. | |
1591 | |
3674 | 1592 *clipboard-html* |
1904 | 1593 html When the clipboard contains HTML, use this when |
1594 pasting. When putting text on the clipboard, mark it | |
1595 as HTML. This works to copy rendered HTML from | |
1596 Firefox, paste it as raw HTML in Vim, select the HTML | |
1597 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
|
1598 You probably want to add this only temporarily, |
6b4879aea261
Add test for gettabvar() and settabvar().
Bram Moolenaar <bram@vim.org>
parents:
2220
diff
changeset
|
1599 possibly use BufEnter autocommands. |
1904 | 1600 Only supported for GTK version 2 and later. |
1601 | |
3674 | 1602 *clipboard-exclude* |
7 | 1603 exclude:{pattern} |
1604 Defines a pattern that is matched against the name of | |
1605 the terminal 'term'. If there is a match, no | |
1606 connection will be made to the X server. This is | |
1607 useful in this situation: | |
1608 - Running Vim in a console. | |
1609 - $DISPLAY is set to start applications on another | |
1610 display. | |
1611 - You do not want to connect to the X server in the | |
1612 console, but do want this in a terminal emulator. | |
1613 To never connect to the X server use: > | |
1614 exclude:.* | |
1615 < This has the same effect as using the |-X| argument. | |
1616 Note that when there is no connection to the X server | |
1617 the window title won't be restored and the clipboard | |
1618 cannot be accessed. | |
1619 The value of 'magic' is ignored, {pattern} is | |
1620 interpreted as if 'magic' was on. | |
1621 The rest of the option value will be used for | |
1622 {pattern}, this must be the last entry. | |
1623 | |
1624 *'cmdheight'* *'ch'* | |
1625 'cmdheight' 'ch' number (default 1) | |
1626 global | |
1627 Number of screen lines to use for the command-line. Helps avoiding | |
1628 |hit-enter| prompts. | |
824 | 1629 The value of this option is stored with the tab page, so that each tab |
1630 page can have a different value. | |
7 | 1631 |
1632 *'cmdwinheight'* *'cwh'* | |
1633 'cmdwinheight' 'cwh' number (default 7) | |
1634 global | |
1635 {not available when compiled without the |+vertsplit| | |
1636 feature} | |
1637 Number of screen lines to use for the command-line window. |cmdwin| | |
1638 | |
2608
7d8af31066c8
Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents:
2607
diff
changeset
|
1639 *'colorcolumn'* *'cc'* |
7d8af31066c8
Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents:
2607
diff
changeset
|
1640 'colorcolumn' 'cc' string (default "") |
7d8af31066c8
Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents:
2607
diff
changeset
|
1641 local to window |
7d8af31066c8
Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents:
2607
diff
changeset
|
1642 {not available when compiled without the |+syntax| |
7d8af31066c8
Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents:
2607
diff
changeset
|
1643 feature} |
7d8af31066c8
Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents:
2607
diff
changeset
|
1644 'colorcolumn' is a comma separated list of screen columns that are |
7d8af31066c8
Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents:
2607
diff
changeset
|
1645 highlighted with ColorColumn |hl-ColorColumn|. Useful to align |
7d8af31066c8
Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents:
2607
diff
changeset
|
1646 text. Will make screen redrawing slower. |
7d8af31066c8
Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents:
2607
diff
changeset
|
1647 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
|
1648 '+' or '-', which is added to or subtracted from 'textwidth'. > |
7d8af31066c8
Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents:
2607
diff
changeset
|
1649 |
7d8af31066c8
Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents:
2607
diff
changeset
|
1650 :set cc=+1 " highlight column after 'textwidth' |
7d8af31066c8
Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents:
2607
diff
changeset
|
1651 :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
|
1652 :hi ColorColumn ctermbg=lightgrey guibg=lightgrey |
7d8af31066c8
Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents:
2607
diff
changeset
|
1653 < |
7d8af31066c8
Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents:
2607
diff
changeset
|
1654 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
|
1655 A maximum of 256 columns are highlighted. |
7d8af31066c8
Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents:
2607
diff
changeset
|
1656 |
7 | 1657 *'columns'* *'co'* *E594* |
1658 'columns' 'co' number (default 80 or terminal width) | |
1659 global | |
1660 Number of columns of the screen. Normally this is set by the terminal | |
161 | 1661 initialization and does not have to be set by hand. Also see |
1662 |posix-screen-size|. | |
7 | 1663 When Vim is running in the GUI or in a resizable window, setting this |
1664 option will cause the window size to be changed. When you only want | |
1665 to use the size for the GUI, put the command in your |gvimrc| file. | |
1666 When you set this option and Vim is unable to change the physical | |
1152 | 1667 number of columns of the display, the display may be messed up. For |
1668 the GUI it is always possible and Vim limits the number of columns to | |
1669 what fits on the screen. You can use this command to get the widest | |
1670 window possible: > | |
1671 :set columns=9999 | |
1672 < Minimum value is 12, maximum value is 10000. | |
7 | 1673 |
1674 *'comments'* *'com'* *E524* *E525* | |
1675 'comments' 'com' string (default | |
1676 "s1:/*,mb:*,ex:*/,://,b:#,:%,:XCOMM,n:>,fb:-") | |
1677 local to buffer | |
1678 {not available when compiled without the |+comments| | |
1679 feature} | |
1680 A comma separated list of strings that can start a comment line. See | |
1681 |format-comments|. See |option-backslash| about using backslashes to | |
1682 insert a space. | |
1683 | |
1684 *'commentstring'* *'cms'* *E537* | |
1685 'commentstring' 'cms' string (default "/*%s*/") | |
1686 local to buffer | |
1687 {not available when compiled without the |+folding| | |
1688 feature} | |
1689 A template for a comment. The "%s" in the value is replaced with the | |
1690 comment text. Currently only used to add markers for folding, see | |
1691 |fold-marker|. | |
1692 | |
1693 *'compatible'* *'cp'* *'nocompatible'* *'nocp'* | |
819 | 1694 '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
|
1695 file is found, reset in |defaults.vim|) |
7 | 1696 global |
1697 This option has the effect of making Vim either more Vi-compatible, or | |
1698 make Vim behave in a more useful way. | |
11062 | 1699 |
7 | 1700 This is a special kind of option, because when it's set or reset, |
11062 | 1701 other options are also changed as a side effect. |
1702 NOTE: Setting or resetting this option can have a lot of unexpected | |
1703 effects: Mappings are interpreted in another way, undo behaves | |
1704 differently, etc. If you set this option in your vimrc file, you | |
1705 should probably put it at the very start. | |
1706 | |
7 | 1707 By default this option is on and the Vi defaults are used for the |
1708 options. This default was chosen for those people who want to use Vim | |
1709 just like Vi, and don't even (want to) know about the 'compatible' | |
1710 option. | |
819 | 1711 When a |vimrc| or |gvimrc| file is found while Vim is starting up, |
378 | 1712 this option is switched off, and all options that have not been |
1713 modified will be set to the Vim defaults. Effectively, this means | |
819 | 1714 that when a |vimrc| or |gvimrc| file exists, Vim will use the Vim |
378 | 1715 defaults, otherwise it will use the Vi defaults. (Note: This doesn't |
1152 | 1716 happen for the system-wide vimrc or gvimrc file, nor for a file given |
1717 with the |-u| argument). Also see |compatible-default| and | |
1718 |posix-compliance|. | |
7 | 1719 You can also set this option with the "-C" argument, and reset it with |
1720 "-N". See |-C| and |-N|. | |
11062 | 1721 See 'cpoptions' for more fine tuning of Vi compatibility. |
1722 | |
1723 When this option is set, numerous other options are set to make Vim as | |
1724 Vi-compatible as possible. When this option is unset, various options | |
1725 are set to make Vim more useful. The table below lists all the | |
1726 options affected. | |
1727 The {?} column indicates when the options are affected: | |
1728 + Means that the option is set to the value given in {set value} when | |
1729 'compatible' is set. | |
1730 & Means that the option is set to the value given in {set value} when | |
1731 'compatible' is set AND is set to its Vim default value when | |
1732 'compatible' is unset. | |
1733 - Means the option is NOT changed when setting 'compatible' but IS | |
1734 set to its Vim default when 'compatible' is unset. | |
1735 The {effect} column summarises the change when 'compatible' is set. | |
1736 | |
11160 | 1737 option ? set value effect ~ |
11062 | 1738 |
1739 'allowrevins' + off no CTRL-_ command | |
1740 'antialias' + off don't use antialiased fonts | |
1741 'arabic' + off reset arabic-related options | |
1742 'arabicshape' + on correct character shapes | |
1743 'backspace' + "" normal backspace | |
1744 'backup' + off no backup file | |
1745 'backupcopy' & Unix: "yes" backup file is a copy | |
1746 else: "auto" copy or rename backup file | |
1747 'balloonexpr' + "" text to show in evaluation balloon | |
1748 'breakindent' + off don't indent when wrapping lines | |
1749 'cedit' - {unchanged} {set vim default only on resetting 'cp'} | |
1750 'cindent' + off no C code indentation | |
1751 'compatible' - {unchanged} {set vim default only on resetting 'cp'} | |
1752 'copyindent' + off don't copy indent structure | |
1753 'cpoptions' & (all flags) Vi-compatible flags | |
1754 'cscopepathcomp'+ 0 don't show directories in tags list | |
13341
acd7eaa13d2b
Updated runtime files.
Christian Brabandt <cb@256bit.org>
parents:
13314
diff
changeset
|
1755 'cscoperelative'+ off don't use basename of path as prefix |
11062 | 1756 'cscopetag' + off don't use cscope for ":tag" |
11160 | 1757 'cscopetagorder'+ 0 see |cscopetagorder| |
11062 | 1758 'cscopeverbose' + off see |cscopeverbose| |
1759 'delcombine' + off unicode: delete whole char combination | |
1760 'digraph' + off no digraphs | |
1761 'esckeys' & off no <Esc>-keys in Insert mode | |
1762 'expandtab' + off tabs not expanded to spaces | |
1763 'fileformats' & "" no automatic file format detection, | |
7 | 1764 "dos,unix" except for DOS, Windows and OS/2 |
11062 | 1765 'formatexpr' + "" use 'formatprg' for auto-formatting |
1766 'formatoptions' & "vt" Vi compatible formatting | |
1767 'gdefault' + off no default 'g' flag for ":s" | |
1768 'history' & 0 no commandline history | |
1769 'hkmap' + off no Hebrew keyboard mapping | |
1770 'hkmapp' + off no phonetic Hebrew keyboard mapping | |
1771 'hlsearch' + off no highlighting of search matches | |
1772 'incsearch' + off no incremental searching | |
1773 'indentexpr' + "" no indenting by expression | |
1774 'insertmode' + off do not start in Insert mode | |
1775 'iskeyword' & "@,48-57,_" keywords contain alphanumeric | |
7 | 1776 characters and '_' |
11062 | 1777 'joinspaces' + on insert 2 spaces after period |
1778 'modeline' & off no modelines | |
1779 'more' & off no pauses in listings | |
1780 'mzquantum' - {unchanged} {set vim default only on resetting 'cp'} | |
1781 'numberwidth' & 8 min number of columns for line number | |
1782 'preserveindent'+ off don't preserve current indent structure | |
1783 when changing it | |
1784 'revins' + off no reverse insert | |
1785 'ruler' + off no ruler | |
1786 'scrolljump' + 1 no jump scroll | |
1787 'scrolloff' + 0 no scroll offset | |
1788 'shelltemp' - {unchanged} {set vim default only on resetting 'cp'} | |
1789 '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
|
1790 'shortmess' & "S" no shortening of messages |
11062 | 1791 'showcmd' & off command characters not shown |
1792 'showmode' & off current mode not shown | |
1793 'sidescrolloff' + 0 cursor moves to edge of screen in scroll | |
1794 'smartcase' + off no automatic ignore case switch | |
1795 'smartindent' + off no smart indentation | |
1796 'smarttab' + off no smart tab size | |
1797 'softtabstop' + 0 tabs are always 'tabstop' positions | |
1798 'startofline' + on goto startofline with some commands | |
1799 'tagcase' & "followic" 'ignorecase' when searching tags file | |
1800 'tagrelative' & off tag file names are not relative | |
1801 'termguicolors' + off don't use highlight-(guifg|guibg) | |
1802 'textauto' & off no automatic textmode detection | |
1803 'textwidth' + 0 no automatic line wrap | |
1804 'tildeop' + off tilde is not an operator | |
1805 'ttimeout' + off no terminal timeout | |
1806 'undofile' + off don't use an undo file | |
11160 | 1807 'viminfo' - {unchanged} {set Vim default only on resetting 'cp'} |
11062 | 1808 'virtualedit' + "" cursor can only be placed on characters |
1809 'whichwrap' & "" left-right movements don't wrap | |
1810 'wildchar' & CTRL-E only when the current value is <Tab> | |
7 | 1811 use CTRL-E for cmdline completion |
11062 | 1812 'writebackup' + on or off depends on the |+writebackup| feature |
7 | 1813 |
1814 *'complete'* *'cpt'* *E535* | |
1815 'complete' 'cpt' string (default: ".,w,b,u,t,i") | |
1816 local to buffer | |
1817 This option specifies how keyword completion |ins-completion| works | |
1818 when CTRL-P or CTRL-N are used. It is also used for whole-line | |
1819 completion |i_CTRL-X_CTRL-L|. It indicates the type of completion | |
1820 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
|
1821 . scan the current buffer ('wrapscan' is ignored) |
7 | 1822 w scan buffers from other windows |
1823 b scan other loaded buffers that are in the buffer list | |
1824 u scan the unloaded buffers that are in the buffer list | |
1825 U scan the buffers that are not in the buffer list | |
1826 k scan the files given with the 'dictionary' option | |
703 | 1827 kspell use the currently active spell checking |spell| |
7 | 1828 k{dict} scan the file {dict}. Several "k" flags can be given, |
1829 patterns are valid too. For example: > | |
1830 :set cpt=k/usr/dict/*,k~/spanish | |
1831 < s scan the files given with the 'thesaurus' option | |
1832 s{tsr} scan the file {tsr}. Several "s" flags can be given, patterns | |
1833 are valid too. | |
1834 i scan current and included files | |
1835 d scan current and included files for defined name or macro | |
1836 |i_CTRL-X_CTRL-D| | |
1837 ] tag completion | |
1838 t same as "]" | |
1839 | |
1840 Unloaded buffers are not loaded, thus their autocmds |:autocmd| are | |
1841 not executed, this may lead to unexpected completions from some files | |
1842 (gzipped files for example). Unloaded buffers are not scanned for | |
1843 whole-line completion. | |
1844 | |
1845 The default is ".,w,b,u,t,i", which means to scan: | |
1846 1. the current buffer | |
1847 2. buffers in other windows | |
1848 3. other loaded buffers | |
1849 4. unloaded buffers | |
1850 5. tags | |
1851 6. included files | |
1852 | |
1853 As you can see, CTRL-N and CTRL-P can be used to do any 'iskeyword'- | |
233 | 1854 based expansion (e.g., dictionary |i_CTRL-X_CTRL-K|, included patterns |
1855 |i_CTRL-X_CTRL-I|, tags |i_CTRL-X_CTRL-]| and normal expansions). | |
7 | 1856 |
12 | 1857 *'completefunc'* *'cfu'* |
1858 'completefunc' 'cfu' string (default: empty) | |
1859 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
|
1860 {not available when compiled without the |+eval| |
71b56b4e7785
Make the references to features in the help more consistent. (Sylvain Hitier)
Bram Moolenaar <bram@vim.org>
parents:
2561
diff
changeset
|
1861 or |+insert_expand| features} |
623 | 1862 This option specifies a function to be used for Insert mode completion |
1863 with CTRL-X CTRL-U. |i_CTRL-X_CTRL-U| | |
648 | 1864 See |complete-functions| for an explanation of how the function is |
1865 invoked and what it should return. | |
2642 | 1866 This option cannot be set from a |modeline| or in the |sandbox|, for |
1867 security reasons. | |
14 | 1868 |
540 | 1869 *'completeopt'* *'cot'* |
730 | 1870 'completeopt' 'cot' string (default: "menu,preview") |
540 | 1871 global |
766 | 1872 {not available when compiled without the |
1873 |+insert_expand| feature} | |
665 | 1874 A comma separated list of options for Insert mode completion |
1875 |ins-completion|. The supported values are: | |
540 | 1876 |
1877 menu Use a popup menu to show the possible completions. The | |
1878 menu is only shown when there is more than one match and | |
1879 sufficient colors are available. |ins-completion-menu| | |
1880 | |
707 | 1881 menuone Use the popup menu also when there is only one match. |
856 | 1882 Useful when there is additional information about the |
707 | 1883 match, e.g., what file it comes from. |
1884 | |
836 | 1885 longest Only insert the longest common text of the matches. If |
1886 the menu is displayed you can use CTRL-L to add more | |
1887 characters. Whether case is ignored depends on the kind | |
1888 of completion. For buffer text the 'ignorecase' option is | |
1889 used. | |
665 | 1890 |
730 | 1891 preview Show extra information about the currently selected |
1152 | 1892 completion in the preview window. Only works in |
1893 combination with "menu" or "menuone". | |
1894 | |
6911 | 1895 noinsert Do not insert any text for a match until the user selects |
1896 a match from the menu. Only works in combination with | |
1897 "menu" or "menuone". No effect if "longest" is present. | |
1898 | |
1899 noselect Do not select a match in the menu, force the user to | |
1900 select one from the menu. Only works in combination with | |
1901 "menu" or "menuone". | |
1902 | |
730 | 1903 |
2378
85b7dc8da5eb
Add the 'concealcursor' option to decide when the cursor line is to be
Bram Moolenaar <bram@vim.org>
parents:
2365
diff
changeset
|
1904 *'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
|
1905 '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
|
1906 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
|
1907 {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
|
1908 feature} |
85b7dc8da5eb
Add the 'concealcursor' option to decide when the cursor line is to be
Bram Moolenaar <bram@vim.org>
parents:
2365
diff
changeset
|
1909 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
|
1910 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
|
1911 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
|
1912 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
|
1913 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
|
1914 i Insert mode |
2382
3a5ededa240a
Add the 'c' flag to 'concealcursor'.
Bram Moolenaar <bram@vim.org>
parents:
2380
diff
changeset
|
1915 c Command line editing, for 'incsearch' |
3a5ededa240a
Add the 'c' flag to 'concealcursor'.
Bram Moolenaar <bram@vim.org>
parents:
2380
diff
changeset
|
1916 |
2400
e6f1424dd66a
Let 'v' flag in 'concealcursor' apply to all lines in the Visual area.
Bram Moolenaar <bram@vim.org>
parents:
2394
diff
changeset
|
1917 '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
|
1918 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
|
1919 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
|
1920 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
|
1921 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
|
1922 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
|
1923 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
|
1924 |
85b7dc8da5eb
Add the 'concealcursor' option to decide when the cursor line is to be
Bram Moolenaar <bram@vim.org>
parents:
2365
diff
changeset
|
1925 |
14864 | 1926 *'conceallevel'* *'cole'* |
1927 'conceallevel' 'cole' number (default 0) | |
2250
1bac28a53fae
Add the conceal patch from Vince Negri.
Bram Moolenaar <bram@vim.org>
parents:
2249
diff
changeset
|
1928 local to window |
1bac28a53fae
Add the conceal patch from Vince Negri.
Bram Moolenaar <bram@vim.org>
parents:
2249
diff
changeset
|
1929 {not available when compiled without the |+conceal| |
1bac28a53fae
Add the conceal patch from Vince Negri.
Bram Moolenaar <bram@vim.org>
parents:
2249
diff
changeset
|
1930 feature} |
2340
99c1eba60b2d
Make automatic prototype generation work with more interfaces.
Bram Moolenaar <bram@vim.org>
parents:
2337
diff
changeset
|
1931 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
|
1932 is shown: |
99c1eba60b2d
Make automatic prototype generation work with more interfaces.
Bram Moolenaar <bram@vim.org>
parents:
2337
diff
changeset
|
1933 |
99c1eba60b2d
Make automatic prototype generation work with more interfaces.
Bram Moolenaar <bram@vim.org>
parents:
2337
diff
changeset
|
1934 Value Effect ~ |
2250
1bac28a53fae
Add the conceal patch from Vince Negri.
Bram Moolenaar <bram@vim.org>
parents:
2249
diff
changeset
|
1935 0 Text is shown normally |
2426 | 1936 1 Each block of concealed text is replaced with one |
1937 character. If the syntax item does not have a custom | |
1938 replacement character defined (see |:syn-cchar|) the | |
1939 character defined in 'listchars' is used (default is a | |
1940 space). | |
1941 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
|
1942 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
|
1943 custom replacement character defined (see |
2426 | 1944 |: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
|
1945 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
|
1946 |
586a459f3980
Never hide text for conceal in cursor line. Do hide when there is
Bram Moolenaar <bram@vim.org>
parents:
2348
diff
changeset
|
1947 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
|
1948 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
|
1949 option. |
2250
1bac28a53fae
Add the conceal patch from Vince Negri.
Bram Moolenaar <bram@vim.org>
parents:
2249
diff
changeset
|
1950 |
7 | 1951 *'confirm'* *'cf'* *'noconfirm'* *'nocf'* |
1952 'confirm' 'cf' boolean (default off) | |
1953 global | |
1954 When 'confirm' is on, certain operations that would normally | |
1955 fail because of unsaved changes to a buffer, e.g. ":q" and ":e", | |
1956 instead raise a |dialog| asking if you wish to save the current | |
1957 file(s). You can still use a ! to unconditionally |abandon| a buffer. | |
1958 If 'confirm' is off you can still activate confirmation for one | |
1959 command only (this is most useful in mappings) with the |:confirm| | |
1960 command. | |
1961 Also see the |confirm()| function and the 'v' flag in 'guioptions'. | |
1962 | |
1963 *'conskey'* *'consk'* *'noconskey'* *'noconsk'* | |
1964 'conskey' 'consk' boolean (default off) | |
1965 global | |
8246
f16bfe02cef1
commit https://github.com/vim/vim/commit/f391327adbbffb11180cf6038a92af1ed144e907
Christian Brabandt <cb@256bit.org>
parents:
8182
diff
changeset
|
1966 This was for MS-DOS and is no longer supported. |
7 | 1967 |
1968 *'copyindent'* *'ci'* *'nocopyindent'* *'noci'* | |
1969 'copyindent' 'ci' boolean (default off) | |
1970 local to buffer | |
1971 Copy the structure of the existing lines indent when autoindenting a | |
1972 new line. Normally the new indent is reconstructed by a series of | |
1973 tabs followed by spaces as required (unless |'expandtab'| is enabled, | |
1974 in which case only spaces are used). Enabling this option makes the | |
1975 new line copy whatever characters were used for indenting on the | |
1621 | 1976 existing line. 'expandtab' has no effect on these characters, a Tab |
1977 remains a Tab. If the new indent is greater than on the existing | |
7 | 1978 line, the remaining space is filled in the normal manner. |
11160 | 1979 NOTE: This option is reset when 'compatible' is set. |
7 | 1980 Also see 'preserveindent'. |
1981 | |
8148
f5da459c5698
commit https://github.com/vim/vim/commit/e0fa3742ead676a3074a10edadbc955e1a89153d
Christian Brabandt <cb@256bit.org>
parents:
8061
diff
changeset
|
1982 *'cpoptions'* *'cpo'* *cpo* |
7 | 1983 'cpoptions' 'cpo' string (Vim default: "aABceFs", |
1984 Vi default: all flags) | |
1985 global | |
1986 A sequence of single character flags. When a character is present | |
5340 | 1987 this indicates Vi-compatible behavior. This is used for things where |
1988 not being Vi-compatible is mostly or sometimes preferred. | |
7 | 1989 'cpoptions' stands for "compatible-options". |
1990 Commas can be added for readability. | |
1991 To avoid problems with flags that are added in the future, use the | |
1992 "+=" and "-=" feature of ":set" |add-option-flags|. | |
1993 NOTE: This option is set to the Vi default value when 'compatible' is | |
1994 set and to the Vim default value when 'compatible' is reset. | |
164 | 1995 NOTE: This option is set to the POSIX default value at startup when |
1996 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
|
1997 variable exists |posix|. This means Vim tries to behave like the |
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
1998 POSIX specification. |
7 | 1999 |
2000 contains behavior ~ | |
2001 *cpo-a* | |
2002 a When included, a ":read" command with a file name | |
2003 argument will set the alternate file name for the | |
2004 current window. | |
2005 *cpo-A* | |
2006 A When included, a ":write" command with a file name | |
2007 argument will set the alternate file name for the | |
2008 current window. | |
2009 *cpo-b* | |
2010 b "\|" in a ":map" command is recognized as the end of | |
2011 the map command. The '\' is included in the mapping, | |
2012 the text after the '|' is interpreted as the next | |
2013 command. Use a CTRL-V instead of a backslash to | |
2014 include the '|' in the mapping. Applies to all | |
2015 mapping, abbreviation, menu and autocmd commands. | |
2016 See also |map_bar|. | |
2017 *cpo-B* | |
2018 B A backslash has no special meaning in mappings, | |
14372 | 2019 abbreviations, user commands and the "to" part of the |
2020 menu commands. Remove this flag to be able to use a | |
2021 backslash like a CTRL-V. For example, the command | |
2022 ":map X \<Esc>" results in X being mapped to: | |
7 | 2023 'B' included: "\^[" (^[ is a real <Esc>) |
2024 'B' excluded: "<Esc>" (5 characters) | |
2025 ('<' excluded in both cases) | |
2026 *cpo-c* | |
2027 c Searching continues at the end of any match at the | |
2028 cursor position, but not further than the start of the | |
2029 next line. When not present searching continues | |
2030 one character from the cursor position. With 'c' | |
2031 "abababababab" only gets three matches when repeating | |
2032 "/abab", without 'c' there are five matches. | |
2033 *cpo-C* | |
2034 C Do not concatenate sourced lines that start with a | |
2035 backslash. See |line-continuation|. | |
2036 *cpo-d* | |
2037 d Using "./" in the 'tags' option doesn't mean to use | |
2038 the tags file relative to the current file, but the | |
2039 tags file in the current directory. | |
2040 *cpo-D* | |
2041 D Can't use CTRL-K to enter a digraph after Normal mode | |
2042 commands with a character argument, like |r|, |f| and | |
2043 |t|. | |
2044 *cpo-e* | |
2045 e When executing a register with ":@r", always add a | |
2046 <CR> to the last line, also when the register is not | |
2047 linewise. If this flag is not present, the register | |
2048 is not linewise and the last line does not end in a | |
2049 <CR>, then the last line is put on the command-line | |
2050 and can be edited before hitting <CR>. | |
2051 *cpo-E* | |
2052 E It is an error when using "y", "d", "c", "g~", "gu" or | |
2053 "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
|
2054 at least one character is to be operated on. Example: |
7 | 2055 This makes "y0" fail in the first column. |
2056 *cpo-f* | |
2057 f When included, a ":read" command with a file name | |
2058 argument will set the file name for the current buffer, | |
2059 if the current buffer doesn't have a file name yet. | |
2060 *cpo-F* | |
2061 F When included, a ":write" command with a file name | |
2062 argument will set the file name for the current | |
2063 buffer, if the current buffer doesn't have a file name | |
590 | 2064 yet. Also see |cpo-P|. |
7 | 2065 *cpo-g* |
2066 g Goto line 1 when using ":edit" without argument. | |
164 | 2067 *cpo-H* |
2068 H When using "I" on a line with only blanks, insert | |
2069 before the last blank. Without this flag insert after | |
2070 the last blank. | |
7 | 2071 *cpo-i* |
2072 i When included, interrupting the reading of a file will | |
2073 leave it modified. | |
10 | 2074 *cpo-I* |
2075 I When moving the cursor up or down just after inserting | |
2076 indent for 'autoindent', do not delete the indent. | |
7 | 2077 *cpo-j* |
2078 j When joining lines, only add two spaces after a '.', | |
2079 not after '!' or '?'. Also see 'joinspaces'. | |
2080 *cpo-J* | |
2081 J A |sentence| has to be followed by two spaces after | |
233 | 2082 the '.', '!' or '?'. A <Tab> is not recognized as |
7 | 2083 white space. |
2084 *cpo-k* | |
2085 k Disable the recognition of raw key codes in | |
2086 mappings, abbreviations, and the "to" part of menu | |
2087 commands. For example, if <Key> sends ^[OA (where ^[ | |
2088 is <Esc>), the command ":map X ^[OA" results in X | |
2089 being mapped to: | |
2090 'k' included: "^[OA" (3 characters) | |
2091 'k' excluded: "<Key>" (one key code) | |
2092 Also see the '<' flag below. | |
2093 *cpo-K* | |
2094 K Don't wait for a key code to complete when it is | |
2095 halfway a mapping. This breaks mapping <F1><F1> when | |
2096 only part of the second <F1> has been read. It | |
2097 enables cancelling the mapping by typing <F1><Esc>. | |
2098 *cpo-l* | |
2099 l Backslash in a [] range in a search pattern is taken | |
168 | 2100 literally, only "\]", "\^", "\-" and "\\" are special. |
2101 See |/[]| | |
7 | 2102 'l' included: "/[ \t]" finds <Space>, '\' and 't' |
2103 'l' excluded: "/[ \t]" finds <Space> and <Tab> | |
168 | 2104 Also see |cpo-\|. |
7 | 2105 *cpo-L* |
2106 L When the 'list' option is set, 'wrapmargin', | |
2107 'textwidth', 'softtabstop' and Virtual Replace mode | |
2108 (see |gR|) count a <Tab> as two characters, instead of | |
2109 the normal behavior of a <Tab>. | |
2110 *cpo-m* | |
2111 m When included, a showmatch will always wait half a | |
2112 second. When not included, a showmatch will wait half | |
2113 a second or until a character is typed. |'showmatch'| | |
2114 *cpo-M* | |
2115 M When excluded, "%" matching will take backslashes into | |
2116 account. Thus in "( \( )" and "\( ( \)" the outer | |
2117 parenthesis match. When included "%" ignores | |
2118 backslashes, which is Vi compatible. | |
2119 *cpo-n* | |
2178
c6f1aa1e9f32
Add 'relativenumber' patch from Markus Heidelberg.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2120 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
|
2121 '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
|
2122 lines. |
7 | 2123 *cpo-o* |
2124 o Line offset to search command is not remembered for | |
2125 next search. | |
2126 *cpo-O* | |
2127 O Don't complain if a file is being overwritten, even | |
2128 when it didn't exist when editing it. This is a | |
2129 protection against a file unexpectedly created by | |
2130 someone else. Vi didn't complain about this. | |
2131 *cpo-p* | |
2132 p Vi compatible Lisp indenting. When not present, a | |
2133 slightly better algorithm is used. | |
590 | 2134 *cpo-P* |
2135 P When included, a ":write" command that appends to a | |
2136 file will set the file name for the current buffer, if | |
2137 the current buffer doesn't have a file name yet and | |
2138 the 'F' flag is also included |cpo-F|. | |
164 | 2139 *cpo-q* |
2140 q When joining multiple lines leave the cursor at the | |
2141 position where it would be when joining two lines. | |
7 | 2142 *cpo-r* |
2143 r Redo ("." command) uses "/" to repeat a search | |
2144 command, instead of the actually used search string. | |
2145 *cpo-R* | |
2146 R Remove marks from filtered lines. Without this flag | |
2147 marks are kept like |:keepmarks| was used. | |
2148 *cpo-s* | |
2149 s Set buffer options when entering the buffer for the | |
2150 first time. This is like it is in Vim version 3.0. | |
10 | 2151 And it is the default. If not present the options are |
7 | 2152 set when the buffer is created. |
2153 *cpo-S* | |
2154 S Set buffer options always when entering a buffer | |
2155 (except 'readonly', 'fileformat', 'filetype' and | |
2156 'syntax'). This is the (most) Vi compatible setting. | |
2157 The options are set to the values in the current | |
2158 buffer. When you change an option and go to another | |
2159 buffer, the value is copied. Effectively makes the | |
2160 buffer options global to all buffers. | |
2161 | |
2162 's' 'S' copy buffer options | |
2163 no no when buffer created | |
2164 yes no when buffer first entered (default) | |
2165 X yes each time when buffer entered (vi comp.) | |
2166 *cpo-t* | |
2167 t Search pattern for the tag command is remembered for | |
2168 "n" command. Otherwise Vim only puts the pattern in | |
2169 the history for search pattern, but doesn't change the | |
2170 last used search pattern. | |
2171 *cpo-u* | |
10 | 2172 u Undo is Vi compatible. See |undo-two-ways|. |
7 | 2173 *cpo-v* |
2174 v Backspaced characters remain visible on the screen in | |
2175 Insert mode. Without this flag the characters are | |
2176 erased from the screen right away. With this flag the | |
2177 screen newly typed text overwrites backspaced | |
2178 characters. | |
2179 *cpo-w* | |
2180 w When using "cw" on a blank character, only change one | |
2181 character and not all blanks until the start of the | |
2182 next word. | |
2183 *cpo-W* | |
2184 W Don't overwrite a readonly file. When omitted, ":w!" | |
2185 overwrites a readonly file, if possible. | |
2186 *cpo-x* | |
2187 x <Esc> on the command-line executes the command-line. | |
2188 The default in Vim is to abandon the command-line, | |
2189 because <Esc> normally aborts a command. |c_<Esc>| | |
164 | 2190 *cpo-X* |
2191 X When using a count with "R" the replaced text is | |
2192 deleted only once. Also when repeating "R" with "." | |
2193 and a count. | |
7 | 2194 *cpo-y* |
15512 | 2195 y A yank command can be redone with ".". Think twice if |
2196 you really want to use this, it may break some | |
2197 plugins, since most people expect "." to only repeat a | |
2198 change. | |
164 | 2199 *cpo-Z* |
2200 Z When using "w!" while the 'readonly' option is set, | |
2201 don't reset 'readonly'. | |
7 | 2202 *cpo-!* |
2203 ! When redoing a filter command, use the last used | |
2204 external command, whatever it was. Otherwise the last | |
2205 used -filter- command is used. | |
2206 *cpo-$* | |
2207 $ When making a change to one line, don't redisplay the | |
2208 line, but put a '$' at the end of the changed text. | |
2209 The changed text will be overwritten when you type the | |
2210 new text. The line is redisplayed if you type any | |
2211 command that moves the cursor from the insertion | |
2212 point. | |
2213 *cpo-%* | |
2214 % Vi-compatible matching is done for the "%" command. | |
2215 Does not recognize "#if", "#endif", etc. | |
2216 Does not recognize "/*" and "*/". | |
2217 Parens inside single and double quotes are also | |
2218 counted, causing a string that contains a paren to | |
2219 disturb the matching. For example, in a line like | |
2220 "if (strcmp("foo(", s))" the first paren does not | |
2221 match the last one. When this flag is not included, | |
2222 parens inside single and double quotes are treated | |
2223 specially. When matching a paren outside of quotes, | |
2224 everything inside quotes is ignored. When matching a | |
2225 paren inside quotes, it will find the matching one (if | |
10 | 2226 there is one). This works very well for C programs. |
36 | 2227 This flag is also used for other features, such as |
2228 C-indenting. | |
161 | 2229 *cpo--* |
2230 - When included, a vertical movement command fails when | |
632 | 2231 it would go above the first line or below the last |
2232 line. Without it the cursor moves to the first or | |
2233 last line, unless it already was in that line. | |
161 | 2234 Applies to the commands "-", "k", CTRL-P, "+", "j", |
632 | 2235 CTRL-N, CTRL-J and ":1234". |
39 | 2236 *cpo-+* |
2237 + When included, a ":write file" command will reset the | |
2238 'modified' flag of the buffer, even though the buffer | |
2239 itself may still be different from its file. | |
856 | 2240 *cpo-star* |
7 | 2241 * Use ":*" in the same way as ":@". When not included, |
2242 ":*" is an alias for ":'<,'>", select the Visual area. | |
2243 *cpo-<* | |
2244 < Disable the recognition of special key codes in |<>| | |
2245 form in mappings, abbreviations, and the "to" part of | |
10 | 2246 menu commands. For example, the command |
7 | 2247 ":map X <Tab>" results in X being mapped to: |
2248 '<' included: "<Tab>" (5 characters) | |
2249 '<' excluded: "^I" (^I is a real <Tab>) | |
2250 Also see the 'k' flag above. | |
164 | 2251 *cpo->* |
2252 > When appending to a register, put a line break before | |
2253 the appended text. | |
2925 | 2254 *cpo-;* |
2255 ; When using |,| or |;| to repeat the last |t| search | |
2256 and the cursor is right in front of the searched | |
2257 character, the cursor won't move. When not included, | |
2258 the cursor would skip over it and jump to the | |
3557 | 2259 following occurrence. |
164 | 2260 |
2261 POSIX flags. These are not included in the Vi default value, except | |
2262 when $VIM_POSIX was set on startup. |posix| | |
2263 | |
2264 contains behavior ~ | |
856 | 2265 *cpo-#* |
164 | 2266 # A count before "D", "o" and "O" has no effect. |
168 | 2267 *cpo-&* |
2268 & When ":preserve" was used keep the swap file when | |
2269 exiting normally while this buffer is still loaded. | |
2270 This flag is tested when exiting. | |
2271 *cpo-\* | |
2272 \ Backslash in a [] range in a search pattern is taken | |
2273 literally, only "\]" is special See |/[]| | |
488 | 2274 '\' included: "/[ \-]" finds <Space>, '\' and '-' |
2275 '\' excluded: "/[ \-]" finds <Space> and '-' | |
2276 Also see |cpo-l|. | |
168 | 2277 *cpo-/* |
2278 / When "%" is used as the replacement string in a |:s| | |
2279 command, use the previous replacement string. |:s%| | |
164 | 2280 *cpo-{* |
2281 { The |{| and |}| commands also stop at a "{" character | |
2282 at the start of a line. | |
168 | 2283 *cpo-.* |
2284 . The ":chdir" and ":cd" commands fail if the current | |
2285 buffer is modified, unless ! is used. Vim doesn't | |
2286 need this, since it remembers the full path of an | |
2287 opened file. | |
164 | 2288 *cpo-bar* |
2289 | The value of the $LINES and $COLUMNS environment | |
2290 variables overrule the terminal size values obtained | |
2291 with system specific functions. | |
2292 | |
7 | 2293 |
2180
f60a0c9cbe6c
Add the blowfish encryption patch from Mohsin Ahmed. Needs more work.
Bram Moolenaar <bram@vim.org>
parents:
2178
diff
changeset
|
2294 *'cryptmethod'* *'cm'* |
15192
690da0a83419
patch 8.1.0606: 'cryptmethod' defaults to a very old method
Bram Moolenaar <Bram@vim.org>
parents:
15131
diff
changeset
|
2295 '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
|
2296 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
|
2297 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
|
2298 *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
|
2299 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
|
2300 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
|
2301 *blowfish* |
6122 | 2302 blowfish Blowfish method. Medium strong encryption but it has |
2303 an implementation flaw. Requires Vim 7.3 or later, | |
2304 files can NOT be read by Vim 7.2 and older. This adds | |
2305 a "seed" to the file, every time you write the file | |
2306 the encrypted bytes will be different. | |
2307 *blowfish2* | |
2308 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
|
2309 Vim 7.4.401 or later, files can NOT be read by Vim 7.3 |
6122 | 2310 and older. This adds a "seed" to the file, every time |
2311 you write the file the encrypted bytes will be | |
2312 different. The whole undo file is encrypted, not just | |
2313 the pieces of text. | |
2204
c493d6bfde09
A few more changes for encryption. Add test that encrypted file can be read.
Bram Moolenaar <bram@vim.org>
parents:
2184
diff
changeset
|
2314 |
8748
b1a19a2f73f0
commit https://github.com/vim/vim/commit/4f3f668c8486444e53163c29d2fc79bf47eb3c82
Christian Brabandt <cb@256bit.org>
parents:
8629
diff
changeset
|
2315 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
|
2316 |
2180
f60a0c9cbe6c
Add the blowfish encryption patch from Mohsin Ahmed. Needs more work.
Bram Moolenaar <bram@vim.org>
parents:
2178
diff
changeset
|
2317 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
|
2318 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
|
2319 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
|
2320 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
|
2321 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
|
2322 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
|
2323 |
d8e4b27cef80
Change 'cryptmethod' from a number to a string option. Make it global-local.
Bram Moolenaar <bram@vim.org>
parents:
2350
diff
changeset
|
2324 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
|
2325 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
|
2326 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
|
2327 |
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
|
2328 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
|
2329 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
|
2330 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
|
2331 |
f60a0c9cbe6c
Add the blowfish encryption patch from Mohsin Ahmed. Needs more work.
Bram Moolenaar <bram@vim.org>
parents:
2178
diff
changeset
|
2332 |
7 | 2333 *'cscopepathcomp'* *'cspc'* |
2334 'cscopepathcomp' 'cspc' number (default 0) | |
2335 global | |
2336 {not available when compiled without the |+cscope| | |
2337 feature} | |
2338 Determines how many components of the path to show in a list of tags. | |
2339 See |cscopepathcomp|. | |
11160 | 2340 NOTE: This option is set to 0 when 'compatible' is set. |
7 | 2341 |
2342 *'cscopeprg'* *'csprg'* | |
2343 'cscopeprg' 'csprg' string (default "cscope") | |
2344 global | |
2345 {not available when compiled without the |+cscope| | |
2346 feature} | |
2347 Specifies the command to execute cscope. See |cscopeprg|. | |
2348 This option cannot be set from a |modeline| or in the |sandbox|, for | |
2349 security reasons. | |
2350 | |
2351 *'cscopequickfix'* *'csqf'* | |
2352 'cscopequickfix' 'csqf' string (default "") | |
2353 global | |
2354 {not available when compiled without the |+cscope| | |
2355 or |+quickfix| features} | |
2356 Specifies whether to use quickfix window to show cscope results. | |
2357 See |cscopequickfix|. | |
2358 | |
4869 | 2359 *'cscoperelative'* *'csre'* *'nocscoperelative'* *'nocsre'* |
2873 | 2360 'cscoperelative' 'csre' boolean (default off) |
2361 global | |
2362 {not available when compiled without the |+cscope| | |
2363 feature} | |
2364 In the absence of a prefix (-P) for cscope. setting this option enables | |
2365 to use the basename of cscope.out path as the prefix. | |
2366 See |cscoperelative|. | |
11160 | 2367 NOTE: This option is reset when 'compatible' is set. |
2873 | 2368 |
7 | 2369 *'cscopetag'* *'cst'* *'nocscopetag'* *'nocst'* |
2370 'cscopetag' 'cst' boolean (default off) | |
2371 global | |
2372 {not available when compiled without the |+cscope| | |
2373 feature} | |
2374 Use cscope for tag commands. See |cscope-options|. | |
2375 NOTE: This option is reset when 'compatible' is set. | |
2376 | |
2377 *'cscopetagorder'* *'csto'* | |
2378 'cscopetagorder' 'csto' number (default 0) | |
2379 global | |
2380 {not available when compiled without the |+cscope| | |
2381 feature} | |
2382 Determines the order in which ":cstag" performs a search. See | |
2383 |cscopetagorder|. | |
2384 NOTE: This option is set to 0 when 'compatible' is set. | |
2385 | |
2386 *'cscopeverbose'* *'csverb'* | |
2387 *'nocscopeverbose'* *'nocsverb'* | |
2388 'cscopeverbose' 'csverb' boolean (default off) | |
2389 global | |
2390 {not available when compiled without the |+cscope| | |
2391 feature} | |
2392 Give messages when adding a cscope database. See |cscopeverbose|. | |
2393 NOTE: This option is reset when 'compatible' is set. | |
2394 | |
2250
1bac28a53fae
Add the conceal patch from Vince Negri.
Bram Moolenaar <bram@vim.org>
parents:
2249
diff
changeset
|
2395 *'cursorbind'* *'crb'* *'nocursorbind'* *'nocrb'* |
1bac28a53fae
Add the conceal patch from Vince Negri.
Bram Moolenaar <bram@vim.org>
parents:
2249
diff
changeset
|
2396 'cursorbind' 'crb' boolean (default off) |
1bac28a53fae
Add the conceal patch from Vince Negri.
Bram Moolenaar <bram@vim.org>
parents:
2249
diff
changeset
|
2397 local to window |
1bac28a53fae
Add the conceal patch from Vince Negri.
Bram Moolenaar <bram@vim.org>
parents:
2249
diff
changeset
|
2398 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
|
2399 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
|
2400 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
|
2401 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
|
2402 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
|
2403 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
|
2404 taken into account. |
2250
1bac28a53fae
Add the conceal patch from Vince Negri.
Bram Moolenaar <bram@vim.org>
parents:
2249
diff
changeset
|
2405 |
743 | 2406 |
2407 *'cursorcolumn'* *'cuc'* *'nocursorcolumn'* *'nocuc'* | |
2408 'cursorcolumn' 'cuc' boolean (default off) | |
2409 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
|
2410 {not available when compiled without the |+syntax| |
743 | 2411 feature} |
2412 Highlight the screen column of the cursor with CursorColumn | |
2413 |hl-CursorColumn|. Useful to align text. Will make screen redrawing | |
2414 slower. | |
826 | 2415 If you only want the highlighting in the current window you can use |
2416 these autocommands: > | |
2417 au WinLeave * set nocursorline nocursorcolumn | |
2418 au WinEnter * set cursorline cursorcolumn | |
2419 < | |
743 | 2420 |
2421 *'cursorline'* *'cul'* *'nocursorline'* *'nocul'* | |
2422 'cursorline' 'cul' boolean (default off) | |
2423 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
|
2424 {not available when compiled without the |+syntax| |
743 | 2425 feature} |
2426 Highlight the screen line of the cursor with CursorLine | |
2427 |hl-CursorLine|. Useful to easily spot the cursor. Will make screen | |
2428 redrawing slower. | |
818 | 2429 When Visual mode is active the highlighting isn't used to make it |
825 | 2430 easier to see the selected text. |
743 | 2431 |
2432 | |
7 | 2433 *'debug'* |
2434 'debug' string (default "") | |
2435 global | |
839 | 2436 These values can be used: |
2437 msg Error messages that would otherwise be omitted will be given | |
2438 anyway. | |
2439 throw Error messages that would otherwise be omitted will be given | |
2440 anyway and also throw an exception and set |v:errmsg|. | |
2441 beep A message will be given when otherwise only a beep would be | |
2442 produced. | |
168 | 2443 The values can be combined, separated by a comma. |
839 | 2444 "msg" and "throw" are useful for debugging 'foldexpr', 'formatexpr' or |
2445 'indentexpr'. | |
7 | 2446 |
2447 *'define'* *'def'* | |
2448 'define' 'def' string (default "^\s*#\s*define") | |
2449 global or local to buffer |global-local| | |
10 | 2450 Pattern to be used to find a macro definition. It is a search |
7 | 2451 pattern, just like for the "/" command. This option is used for the |
2452 commands like "[i" and "[d" |include-search|. The 'isident' option is | |
2453 used to recognize the defined name after the match: | |
2454 {match with 'define'}{non-ID chars}{defined name}{non-ID char} | |
2455 See |option-backslash| about inserting backslashes to include a space | |
2456 or backslash. | |
2457 The default value is for C programs. For C++ this value would be | |
2458 useful, to include const type declarations: > | |
2459 ^\(#\s*define\|[a-z]*\s*const\s*[a-z]*\) | |
16086 | 2460 < You can also use "\ze" just before the name and continue the pattern |
2461 to check what is following. E.g. for Javascript, if a function is | |
2462 defined with "func_name = function(args)": > | |
2463 ^\s*\ze\i\+\s*=\s*function( | |
2464 < If the function is defined with "func_name : function() {...": > | |
2465 ^\s*\ze\i\+\s*[:]\s*(*function\s*( | |
7 | 2466 < When using the ":set" command, you need to double the backslashes! |
16086 | 2467 To avoid that use `:let` with a single quote string: > |
2468 let &l:define = '^\s*\ze\k\+\s*=\s*function(' | |
16380 | 2469 < |
7 | 2470 |
2471 *'delcombine'* *'deco'* *'nodelcombine'* *'nodeco'* | |
2472 'delcombine' 'deco' boolean (default off) | |
2473 global | |
2474 If editing Unicode and this option is set, backspace and Normal mode | |
2475 "x" delete each combining character on its own. When it is off (the | |
2476 default) the character along with its combining characters are | |
2477 deleted. | |
2478 Note: When 'delcombine' is set "xx" may work different from "2x"! | |
2479 | |
2480 This is useful for Arabic, Hebrew and many other languages where one | |
2481 may have combining characters overtop of base characters, and want | |
2482 to remove only the combining ones. | |
11160 | 2483 NOTE: This option is reset when 'compatible' is set. |
7 | 2484 |
2485 *'dictionary'* *'dict'* | |
2486 'dictionary' 'dict' string (default "") | |
2487 global or local to buffer |global-local| | |
2488 List of file names, separated by commas, that are used to lookup words | |
2489 for keyword completion commands |i_CTRL-X_CTRL-K|. Each file should | |
2490 contain a list of words. This can be one word per line, or several | |
2491 words per line, separated by non-keyword characters (white space is | |
2492 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
|
2493 |
741b1feeac9f
patch 8.0.1845: various comment updates needed, missing white space
Christian Brabandt <cb@256bit.org>
parents:
13818
diff
changeset
|
2494 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
|
2495 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
|
2496 '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
|
2497 |
10 | 2498 To include a comma in a file name precede it with a backslash. Spaces |
7 | 2499 after a comma are ignored, otherwise spaces are included in the file |
2500 name. See |option-backslash| about using backslashes. | |
99 | 2501 This has nothing to do with the |Dictionary| variable type. |
7 | 2502 Where to find a list of words? |
2503 - On FreeBSD, there is the file "/usr/share/dict/words". | |
2504 - In the Simtel archive, look in the "msdos/linguist" directory. | |
2505 - In "miscfiles" of the GNU collection. | |
2506 The use of |:set+=| and |:set-=| is preferred when adding or removing | |
2507 directories from the list. This avoids problems when a future version | |
2508 uses another default. | |
2509 Backticks cannot be used in this option for security reasons. | |
2510 | |
2511 *'diff'* *'nodiff'* | |
2512 'diff' boolean (default off) | |
2513 local to window | |
2514 {not available when compiled without the |+diff| | |
2515 feature} | |
2516 Join the current window in the group of windows that shows differences | |
10 | 2517 between files. See |vimdiff|. |
7 | 2518 |
2519 *'dex'* *'diffexpr'* | |
2520 'diffexpr' 'dex' string (default "") | |
2521 global | |
2522 {not available when compiled without the |+diff| | |
2523 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
|
2524 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
|
2525 or unified-style) from two versions of a file. See |diff-diffexpr|. |
7 | 2526 This option cannot be set from a |modeline| or in the |sandbox|, for |
2527 security reasons. | |
2528 | |
2529 *'dip'* *'diffopt'* | |
14702
daf8afe6279b
patch 8.1.0363: internal diff isn't used by default as advertised
Christian Brabandt <cb@256bit.org>
parents:
14696
diff
changeset
|
2530 'diffopt' 'dip' string (default "internal,filler") |
7 | 2531 global |
2532 {not available when compiled without the |+diff| | |
2533 feature} | |
10 | 2534 Option settings for diff mode. It can consist of the following items. |
7 | 2535 All are optional. Items must be separated by a comma. |
2536 | |
2537 filler Show filler lines, to keep the text | |
2538 synchronized with a window that has inserted | |
2539 lines at the same position. Mostly useful | |
2540 when windows are side-by-side and 'scrollbind' | |
2541 is set. | |
2542 | |
2543 context:{n} Use a context of {n} lines between a change | |
2544 and a fold that contains unchanged lines. | |
2545 When omitted a context of six lines is used. | |
15932 | 2546 When using zero the context is actually one, |
2547 since folds require a line in between, also | |
2548 for a deleted line. | |
7 | 2549 See |fold-diff|. |
2550 | |
14864 | 2551 iblank Ignore changes where lines are all blank. Adds |
2552 the "-B" flag to the "diff" command if | |
2553 'diffexpr' is empty. Check the documentation | |
2554 of the "diff" command for what this does | |
2555 exactly. | |
2556 NOTE: the diff windows will get out of sync, | |
2557 because no differences between blank lines are | |
2558 taken into account. | |
2559 | |
7 | 2560 icase Ignore changes in case of text. "a" and "A" |
2561 are considered the same. Adds the "-i" flag | |
2562 to the "diff" command if 'diffexpr' is empty. | |
2563 | |
2564 iwhite Ignore changes in amount of white space. Adds | |
2565 the "-b" flag to the "diff" command if | |
2566 'diffexpr' is empty. Check the documentation | |
2567 of the "diff" command for what this does | |
2568 exactly. It should ignore adding trailing | |
2569 white space, but not leading white space. | |
2570 | |
14864 | 2571 iwhiteall Ignore all white space changes. Adds |
2572 the "-w" flag to the "diff" command if | |
2573 'diffexpr' is empty. Check the documentation | |
2574 of the "diff" command for what this does | |
2575 exactly. | |
2576 | |
2577 iwhiteeol Ignore white space changes at end of line. | |
2578 Adds the "-Z" flag to the "diff" command if | |
2579 'diffexpr' is empty. Check the documentation | |
2580 of the "diff" command for what this does | |
2581 exactly. | |
2582 | |
766 | 2583 horizontal Start diff mode with horizontal splits (unless |
2584 explicitly specified otherwise). | |
2585 | |
2586 vertical Start diff mode with vertical splits (unless | |
2587 explicitly specified otherwise). | |
2588 | |
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
|
2589 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
|
2590 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
|
2591 |
766 | 2592 foldcolumn:{n} Set the 'foldcolumn' option to {n} when |
2593 starting diff mode. Without this 2 is used. | |
2594 | |
14696
195e8b1fcbbf
patch 8.1.0360: using an external diff program is slow and inflexible
Christian Brabandt <cb@256bit.org>
parents:
14695
diff
changeset
|
2595 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
|
2596 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
|
2597 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
|
2598 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
|
2599 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
|
2600 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
|
2601 |
195e8b1fcbbf
patch 8.1.0360: using an external diff program is slow and inflexible
Christian Brabandt <cb@256bit.org>
parents:
14695
diff
changeset
|
2602 indent-heuristic |
15033 | 2603 Use the indent heuristic for the internal |
2604 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
|
2605 |
195e8b1fcbbf
patch 8.1.0360: using an external diff program is slow and inflexible
Christian Brabandt <cb@256bit.org>
parents:
14695
diff
changeset
|
2606 algorithm:{text} Use the specified diff algorithm with the |
15033 | 2607 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
|
2608 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
|
2609 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
|
2610 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
|
2611 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
|
2612 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
|
2613 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
|
2614 |
7 | 2615 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
|
2616 :set diffopt=internal,filler,context:4 |
7 | 2617 :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
|
2618 :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
|
2619 :set diffopt-=internal " do NOT use the internal diff parser |
7 | 2620 < |
2621 *'digraph'* *'dg'* *'nodigraph'* *'nodg'* | |
2622 'digraph' 'dg' boolean (default off) | |
2623 global | |
2624 {not available when compiled without the |+digraphs| | |
2625 feature} | |
2626 Enable the entering of digraphs in Insert mode with {char1} <BS> | |
2627 {char2}. See |digraphs|. | |
2628 NOTE: This option is reset when 'compatible' is set. | |
2629 | |
2630 *'directory'* *'dir'* | |
2631 'directory' 'dir' string (default for Amiga: ".,t:", | |
5555 | 2632 for MS-DOS and Win32: ".,$TEMP,c:\tmp,c:\temp" |
7 | 2633 for Unix: ".,~/tmp,/var/tmp,/tmp") |
2634 global | |
2635 List of directory names for the swap file, separated with commas. | |
2636 - The swap file will be created in the first directory where this is | |
2637 possible. | |
2638 - Empty means that no swap file will be used (recovery is | |
2639 impossible!). | |
2640 - A directory "." means to put the swap file in the same directory as | |
2641 the edited file. On Unix, a dot is prepended to the file name, so | |
2642 it doesn't show in a directory listing. On MS-Windows the "hidden" | |
2643 attribute is set and a dot prepended if possible. | |
33 | 2644 - A directory starting with "./" (or ".\" for MS-DOS et al.) means to |
7 | 2645 put the swap file relative to where the edited file is. The leading |
2646 "." 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
|
2647 - 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
|
2648 the swap file name will be built from the complete path to the file |
dddba3937532
patch 8.1.0251: using full path is not supported for 'backupdir'
Christian Brabandt <cb@256bit.org>
parents:
14421
diff
changeset
|
2649 with all path separators substituted to percent '%' signs. This will |
dddba3937532
patch 8.1.0251: using full path is not supported for 'backupdir'
Christian Brabandt <cb@256bit.org>
parents:
14421
diff
changeset
|
2650 ensure file name uniqueness in the preserve directory. |
dddba3937532
patch 8.1.0251: using full path is not supported for 'backupdir'
Christian Brabandt <cb@256bit.org>
parents:
14421
diff
changeset
|
2651 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
|
2652 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
|
2653 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
|
2654 use '//', instead of '\\'. |
7 | 2655 - Spaces after the comma are ignored, other spaces are considered part |
2656 of the directory name. To have a space at the start of a directory | |
2657 name, precede it with a backslash. | |
2658 - To include a comma in a directory name precede it with a backslash. | |
2659 - A directory name may end in an ':' or '/'. | |
2660 - Environment variables are expanded |:set_env|. | |
2661 - Careful with '\' characters, type one before a space, type two to | |
2662 get one in the option (see |option-backslash|), for example: > | |
2663 :set dir=c:\\tmp,\ dir\\,with\\,commas,\\\ dir\ with\ spaces | |
2664 < - For backwards compatibility with Vim version 3.0 a '>' at the start | |
2665 of the option is removed. | |
2666 Using "." first in the list is recommended. This means that editing | |
2667 the same file twice will result in a warning. Using "/tmp" on Unix is | |
2668 discouraged: When the system crashes you lose the swap file. | |
2669 "/var/tmp" is often not cleared when rebooting, thus is a better | |
2670 choice than "/tmp". But it can contain a lot of files, your swap | |
2671 files get lost in the crowd. That is why a "tmp" directory in your | |
2672 home directory is tried first. | |
2673 The use of |:set+=| and |:set-=| is preferred when adding or removing | |
2674 directories from the list. This avoids problems when a future version | |
2675 uses another default. | |
2676 This option cannot be set from a |modeline| or in the |sandbox|, for | |
2677 security reasons. | |
2678 | |
2679 *'display'* *'dy'* | |
9737
35ce559b8553
commit https://github.com/vim/vim/commit/bc8801c9317eb721a2ee91322669f2dd5d136380
Christian Brabandt <cb@256bit.org>
parents:
9669
diff
changeset
|
2680 '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
|
2681 |defaults.vim|) |
7 | 2682 global |
2683 Change the way text is displayed. This is comma separated list of | |
2684 flags: | |
2685 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
|
2686 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
|
2687 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
|
2688 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
|
2689 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
|
2690 column of the last screen line. Overrules "lastline". |
7 | 2691 uhex Show unprintable characters hexadecimal as <xx> |
2692 instead of using ^C and ~C. | |
2693 | |
10211
b7da8d4c594c
commit https://github.com/vim/vim/commit/d07969093a9b3051511c478d71c36de6fc33c0d6
Christian Brabandt <cb@256bit.org>
parents:
10198
diff
changeset
|
2694 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
|
2695 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
|
2696 |
7 | 2697 *'eadirection'* *'ead'* |
2698 'eadirection' 'ead' string (default "both") | |
2699 global | |
2570
71b56b4e7785
Make the references to features in the help more consistent. (Sylvain Hitier)
Bram Moolenaar <bram@vim.org>
parents:
2561
diff
changeset
|
2700 {not available when compiled without the |+vertsplit| |
7 | 2701 feature} |
2702 Tells when the 'equalalways' option applies: | |
2703 ver vertically, width of windows is not affected | |
2704 hor horizontally, height of windows is not affected | |
2705 both width and height of windows is affected | |
2706 | |
2707 *'ed'* *'edcompatible'* *'noed'* *'noedcompatible'* | |
2708 'edcompatible' 'ed' boolean (default off) | |
2709 global | |
2710 Makes the 'g' and 'c' flags of the ":substitute" command to be | |
2711 toggled each time the flag is given. See |complex-change|. See | |
2712 also 'gdefault' option. | |
11442 | 2713 Switching this option on may break plugins! |
7 | 2714 |
8876
47f17f66da3d
commit https://github.com/vim/vim/commit/03413f44167c4b5cd0012def9bb331e2518c83cf
Christian Brabandt <cb@256bit.org>
parents:
8835
diff
changeset
|
2715 *'emoji'* *'emo'* *'noemoji'* *'noemo'* |
8629
54ac275e3fc4
commit https://github.com/vim/vim/commit/3848e00e0177abdb31bc600234967863ec487233
Christian Brabandt <cb@256bit.org>
parents:
8560
diff
changeset
|
2716 'emoji' 'emo' boolean (default: on) |
54ac275e3fc4
commit https://github.com/vim/vim/commit/3848e00e0177abdb31bc600234967863ec487233
Christian Brabandt <cb@256bit.org>
parents:
8560
diff
changeset
|
2717 global |
54ac275e3fc4
commit https://github.com/vim/vim/commit/3848e00e0177abdb31bc600234967863ec487233
Christian Brabandt <cb@256bit.org>
parents:
8560
diff
changeset
|
2718 When on all Unicode emoji characters are considered to be full width. |
54ac275e3fc4
commit https://github.com/vim/vim/commit/3848e00e0177abdb31bc600234967863ec487233
Christian Brabandt <cb@256bit.org>
parents:
8560
diff
changeset
|
2719 |
54ac275e3fc4
commit https://github.com/vim/vim/commit/3848e00e0177abdb31bc600234967863ec487233
Christian Brabandt <cb@256bit.org>
parents:
8560
diff
changeset
|
2720 |
7 | 2721 *'encoding'* *'enc'* *E543* |
2722 'encoding' 'enc' string (default: "latin1" or value from $LANG) | |
2723 global | |
2724 Sets the character encoding used inside Vim. It applies to text in | |
2725 the buffers, registers, Strings in expressions, text stored in the | |
2726 viminfo file, etc. It sets the kind of characters which Vim can work | |
2727 with. See |encoding-names| for the possible values. | |
2728 | |
2729 NOTE: Changing this option will not change the encoding of the | |
39 | 2730 existing text in Vim. It may cause non-ASCII text to become invalid. |
7 | 2731 It should normally be kept at its default value, or set when Vim |
1152 | 2732 starts up. See |multibyte|. To reload the menus see |:menutrans|. |
7 | 2733 |
2317
2b2cd34569eb
Disallow setting 'enc' in a modeline. (Patrick Texier)
Bram Moolenaar <bram@vim.org>
parents:
2314
diff
changeset
|
2734 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
|
2735 corrupt the text. |
2b2cd34569eb
Disallow setting 'enc' in a modeline. (Patrick Texier)
Bram Moolenaar <bram@vim.org>
parents:
2314
diff
changeset
|
2736 |
10895
c391bfbdb452
Updated runtime files.
Christian Brabandt <cb@256bit.org>
parents:
10734
diff
changeset
|
2737 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
|
2738 to "utf-8". Although care has been taken to allow different values of |
7 | 2739 'encoding', "utf-8" is the natural choice for the environment and |
2740 avoids unnecessary conversion overhead. "utf-8" has not been made | |
10 | 2741 the default to prevent different behavior of the GUI and terminal |
7 | 2742 versions, and to avoid changing the encoding of newly created files |
2743 without your knowledge (in case 'fileencodings' is empty). | |
2744 | |
2745 The character encoding of files can be different from 'encoding'. | |
10 | 2746 This is specified with 'fileencoding'. The conversion is done with |
7 | 2747 iconv() or as specified with 'charconvert'. |
2748 | |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
2749 If you need to know whether 'encoding' is a multi-byte encoding, you |
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
2750 can use: > |
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
2751 if has("multi_byte_encoding") |
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
2752 < |
7 | 2753 Normally 'encoding' will be equal to your current locale. This will |
2754 be the default if Vim recognizes your environment settings. If | |
2755 'encoding' is not set to the current locale, 'termencoding' must be | |
2756 set to convert typed and displayed text. See |encoding-table|. | |
2757 | |
2758 When you set this option, it fires the |EncodingChanged| autocommand | |
2759 event so that you can set up fonts if necessary. | |
2760 | |
2761 When the option is set, the value is converted to lowercase. Thus | |
2762 you can set it with uppercase values too. Underscores are translated | |
2763 to '-' signs. | |
2764 When the encoding is recognized, it is changed to the standard name. | |
2765 For example "Latin-1" becomes "latin1", "ISO_88592" becomes | |
2766 "iso-8859-2" and "utf8" becomes "utf-8". | |
2767 | |
2768 Note: "latin1" is also used when the encoding could not be detected. | |
2769 This only works when editing files in the same encoding! When the | |
2770 actual character set is not latin1, make sure 'fileencoding' and | |
2771 'fileencodings' are empty. When conversion is needed, switch to using | |
2772 utf-8. | |
2773 | |
2774 When "unicode", "ucs-2" or "ucs-4" is used, Vim internally uses utf-8. | |
2775 You don't notice this while editing, but it does matter for the | |
2776 |viminfo-file|. And Vim expects the terminal to use utf-8 too. Thus | |
2777 setting 'encoding' to one of these values instead of utf-8 only has | |
2778 effect for encoding used for files when 'fileencoding' is empty. | |
448 | 2779 |
2780 When 'encoding' is set to a Unicode encoding, and 'fileencodings' was | |
2781 not set yet, the default for 'fileencodings' is changed. | |
7 | 2782 |
2783 *'endofline'* *'eol'* *'noendofline'* *'noeol'* | |
2784 'endofline' 'eol' boolean (default on) | |
2785 local to buffer | |
2786 When writing a file and this option is off and the 'binary' option | |
6933 | 2787 is on, or 'fixeol' option is off, no <EOL> will be written for the |
2788 last line in the file. This option is automatically set or reset when | |
2789 starting to edit a new file, depending on whether file has an <EOL> | |
2790 for the last line in the file. Normally you don't have to set or | |
2791 reset this option. | |
2792 When 'binary' is off and 'fixeol' is on the value is not used when | |
2793 writing the file. When 'binary' is on or 'fixeol' is off it is used | |
2794 to remember the presence of a <EOL> for the last line in the file, so | |
2795 that when you write the file the situation from the original file can | |
2796 be kept. But you can change it if you want to. | |
7 | 2797 |
2798 *'equalalways'* *'ea'* *'noequalalways'* *'noea'* | |
2799 'equalalways' 'ea' boolean (default on) | |
2800 global | |
2801 When on, all the windows are automatically made the same size after | |
33 | 2802 splitting or closing a window. This also happens the moment the |
2803 option is switched on. When off, splitting a window will reduce the | |
2804 size of the current window and leave the other windows the same. When | |
2805 closing a window the extra lines are given to the window next to it | |
2806 (depending on 'splitbelow' and 'splitright'). | |
7 | 2807 When mixing vertically and horizontally split windows, a minimal size |
2808 is computed and some windows may be larger if there is room. The | |
2809 'eadirection' option tells in which direction the size is affected. | |
1354 | 2810 Changing the height and width of a window can be avoided by setting |
2811 'winfixheight' and 'winfixwidth', respectively. | |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
2812 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
|
2813 currently not equalized (it's complicated, but may be implemented in |
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
2814 the future). |
7 | 2815 |
2816 *'equalprg'* *'ep'* | |
2817 'equalprg' 'ep' string (default "") | |
2818 global or local to buffer |global-local| | |
2819 External program to use for "=" command. When this option is empty | |
1621 | 2820 the internal formatting functions are used; either 'lisp', 'cindent' |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
2821 or 'indentexpr'. When Vim was compiled without internal formatting, |
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
2822 the "indent" program is used. |
10 | 2823 Environment variables are expanded |:set_env|. See |option-backslash| |
7 | 2824 about including spaces and backslashes. |
2825 This option cannot be set from a |modeline| or in the |sandbox|, for | |
2826 security reasons. | |
2827 | |
2828 *'errorbells'* *'eb'* *'noerrorbells'* *'noeb'* | |
2829 'errorbells' 'eb' boolean (default off) | |
2830 global | |
2831 Ring the bell (beep or screen flash) for error messages. This only | |
2832 makes a difference for error messages, the bell will be used always | |
2833 for a lot of errors without a message (e.g., hitting <Esc> in Normal | |
10 | 2834 mode). See 'visualbell' on how to make the bell behave like a beep, |
6949 | 2835 screen flash or do nothing. See 'belloff' to finetune when to ring the |
2836 bell. | |
7 | 2837 |
2838 *'errorfile'* *'ef'* | |
2839 'errorfile' 'ef' string (Amiga default: "AztecC.Err", | |
2840 others: "errors.err") | |
2841 global | |
2842 {not available when compiled without the |+quickfix| | |
2843 feature} | |
2844 Name of the errorfile for the QuickFix mode (see |:cf|). | |
2845 When the "-q" command-line argument is used, 'errorfile' is set to the | |
2846 following argument. See |-q|. | |
2847 NOT used for the ":make" command. See 'makeef' for that. | |
2848 Environment variables are expanded |:set_env|. | |
2849 See |option-backslash| about including spaces and backslashes. | |
2850 This option cannot be set from a |modeline| or in the |sandbox|, for | |
2851 security reasons. | |
2852 | |
2853 *'errorformat'* *'efm'* | |
2854 'errorformat' 'efm' string (default is very long) | |
2855 global or local to buffer |global-local| | |
2856 {not available when compiled without the |+quickfix| | |
2857 feature} | |
2858 Scanf-like description of the format for the lines in the error file | |
2859 (see |errorformat|). | |
2860 | |
2861 *'esckeys'* *'ek'* *'noesckeys'* *'noek'* | |
2862 'esckeys' 'ek' boolean (Vim default: on, Vi default: off) | |
2863 global | |
2864 Function keys that start with an <Esc> are recognized in Insert | |
2865 mode. When this option is off, the cursor and function keys cannot be | |
2866 used in Insert mode if they start with an <Esc>. The advantage of | |
2867 this is that the single <Esc> is recognized immediately, instead of | |
2868 after one second. Instead of resetting this option, you might want to | |
2869 try changing the values for 'timeoutlen' and 'ttimeoutlen'. Note that | |
2870 when 'esckeys' is off, you can still map anything, but the cursor keys | |
2871 won't work by default. | |
2872 NOTE: This option is set to the Vi default value when 'compatible' is | |
2873 set and to the Vim default value when 'compatible' is reset. | |
2874 | |
2875 *'eventignore'* *'ei'* | |
2876 'eventignore' 'ei' string (default "") | |
2877 global | |
2878 A list of autocommand event names, which are to be ignored. | |
844 | 2879 When set to "all" or when "all" is one of the items, all autocommand |
2880 events are ignored, autocommands will not be executed. | |
7 | 2881 Otherwise this is a comma separated list of event names. Example: > |
2882 :set ei=WinEnter,WinLeave | |
2883 < | |
2884 *'expandtab'* *'et'* *'noexpandtab'* *'noet'* | |
2885 'expandtab' 'et' boolean (default off) | |
2886 local to buffer | |
2887 In Insert mode: Use the appropriate number of spaces to insert a | |
10 | 2888 <Tab>. Spaces are used in indents with the '>' and '<' commands and |
7 | 2889 when 'autoindent' is on. To insert a real tab when 'expandtab' is |
2890 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
|
2891 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
|
2892 the 'paste' option is reset. |
7 | 2893 NOTE: This option is reset when 'compatible' is set. |
2894 | |
2895 *'exrc'* *'ex'* *'noexrc'* *'noex'* | |
2896 'exrc' 'ex' boolean (default off) | |
2897 global | |
2898 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
|
2899 directory. |
018fead968c1
commit https://github.com/vim/vim/commit/36f44c21da2e912c008683a0c4447fca2a071e9a
Christian Brabandt <cb@256bit.org>
parents:
9975
diff
changeset
|
2900 |
018fead968c1
commit https://github.com/vim/vim/commit/36f44c21da2e912c008683a0c4447fca2a071e9a
Christian Brabandt <cb@256bit.org>
parents:
9975
diff
changeset
|
2901 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
|
2902 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
|
2903 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
|
2904 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
|
2905 matching directory. |
018fead968c1
commit https://github.com/vim/vim/commit/36f44c21da2e912c008683a0c4447fca2a071e9a
Christian Brabandt <cb@256bit.org>
parents:
9975
diff
changeset
|
2906 |
018fead968c1
commit https://github.com/vim/vim/commit/36f44c21da2e912c008683a0c4447fca2a071e9a
Christian Brabandt <cb@256bit.org>
parents:
9975
diff
changeset
|
2907 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
|
2908 'secure' option (see |initialization|). |
018fead968c1
commit https://github.com/vim/vim/commit/36f44c21da2e912c008683a0c4447fca2a071e9a
Christian Brabandt <cb@256bit.org>
parents:
9975
diff
changeset
|
2909 Also see |.vimrc| and |gui-init|. |
7 | 2910 This option cannot be set from a |modeline| or in the |sandbox|, for |
2911 security reasons. | |
2912 | |
2913 *'fileencoding'* *'fenc'* *E213* | |
2914 'fileencoding' 'fenc' string (default: "") | |
2915 local to buffer | |
2916 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
|
2917 |
7 | 2918 When 'fileencoding' is different from 'encoding', conversion will be |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
2919 done when writing the file. For reading see below. |
7 | 2920 When 'fileencoding' is empty, the same value as 'encoding' will be |
2921 used (no conversion when reading or writing a file). | |
11062 | 2922 No error will be given when the value is set, only when it is used, |
2923 only when writing a file. | |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
2924 Conversion will also be done when 'encoding' and 'fileencoding' are |
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
2925 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
|
2926 because internally Unicode is always stored as utf-8. |
7 | 2927 WARNING: Conversion can cause loss of information! When |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
2928 'encoding' is "utf-8" or another Unicode encoding, conversion |
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
2929 is most likely done in a way that the reverse conversion |
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
2930 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
|
2931 characters may be lost! |
2317
2b2cd34569eb
Disallow setting 'enc' in a modeline. (Patrick Texier)
Bram Moolenaar <bram@vim.org>
parents:
2314
diff
changeset
|
2932 |
7 | 2933 See 'encoding' for the possible values. Additionally, values may be |
2934 specified that can be handled by the converter, see | |
2935 |mbyte-conversion|. | |
2317
2b2cd34569eb
Disallow setting 'enc' in a modeline. (Patrick Texier)
Bram Moolenaar <bram@vim.org>
parents:
2314
diff
changeset
|
2936 |
7 | 2937 When reading a file 'fileencoding' will be set from 'fileencodings'. |
2938 To read a file in a certain encoding it won't work by setting | |
1152 | 2939 'fileencoding', use the |++enc| argument. One exception: when |
2940 'fileencodings' is empty the value of 'fileencoding' is used. | |
692 | 2941 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
|
2942 |
7 | 2943 Prepending "8bit-" and "2byte-" has no meaning here, they are ignored. |
2944 When the option is set, the value is converted to lowercase. Thus | |
2945 you can set it with uppercase values too. '_' characters are | |
2946 replaced with '-'. If a name is recognized from the list for | |
2947 'encoding', it is replaced by the standard name. For example | |
2948 "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
|
2949 |
7 | 2950 When this option is set, after starting to edit a file, the 'modified' |
2951 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
|
2952 |
2b2cd34569eb
Disallow setting 'enc' in a modeline. (Patrick Texier)
Bram Moolenaar <bram@vim.org>
parents:
2314
diff
changeset
|
2953 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
|
2954 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
|
2955 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
|
2956 '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
|
2957 |
7 | 2958 This option can not be changed when 'modifiable' is off. |
2959 | |
2960 *'fe'* | |
2961 NOTE: Before version 6.0 this option specified the encoding for the | |
10 | 2962 whole of Vim, this was a mistake. Now use 'encoding' instead. The |
7 | 2963 old short name was 'fe', which is no longer used. |
2964 | |
2965 *'fileencodings'* *'fencs'* | |
39 | 2966 'fileencodings' 'fencs' string (default: "ucs-bom", |
2967 "ucs-bom,utf-8,default,latin1" when | |
2968 'encoding' is set to a Unicode value) | |
7 | 2969 global |
2970 This is a list of character encodings considered when starting to edit | |
2971 an existing file. When a file is read, Vim tries to use the first | |
2972 mentioned character encoding. If an error is detected, the next one | |
2973 in the list is tried. When an encoding is found that works, | |
10 | 2974 'fileencoding' is set to it. If all fail, 'fileencoding' is set to |
7 | 2975 an empty string, which means the value of 'encoding' is used. |
2976 WARNING: Conversion can cause loss of information! When | |
2977 'encoding' is "utf-8" (or one of the other Unicode variants) | |
2978 conversion is most likely done in a way that the reverse | |
2979 conversion results in the same text. When 'encoding' is not | |
596 | 2980 "utf-8" some non-ASCII characters may be lost! You can use |
2981 the |++bad| argument to specify what is done with characters | |
2982 that can't be converted. | |
7 | 2983 For an empty file or a file with only ASCII characters most encodings |
2984 will work and the first entry of 'fileencodings' will be used (except | |
2985 "ucs-bom", which requires the BOM to be present). If you prefer | |
2986 another encoding use an BufReadPost autocommand event to test if your | |
2987 preferred encoding is to be used. Example: > | |
2988 au BufReadPost * if search('\S', 'w') == 0 | | |
2989 \ set fenc=iso-2022-jp | endif | |
2990 < This sets 'fileencoding' to "iso-2022-jp" if the file does not contain | |
2991 non-blank characters. | |
596 | 2992 When the |++enc| argument is used then the value of 'fileencodings' is |
2993 not used. | |
692 | 2994 Note that 'fileencodings' is not used for a new file, the global value |
2995 of 'fileencoding' is used instead. You can set it with: > | |
2996 :setglobal fenc=iso-8859-2 | |
2997 < This means that a non-existing file may get a different encoding than | |
2998 an empty file. | |
7 | 2999 The special value "ucs-bom" can be used to check for a Unicode BOM |
3000 (Byte Order Mark) at the start of the file. It must not be preceded | |
3001 by "utf-8" or another Unicode encoding for this to work properly. | |
3002 An entry for an 8-bit encoding (e.g., "latin1") should be the last, | |
3003 because Vim cannot detect an error, thus the encoding is always | |
3004 accepted. | |
39 | 3005 The special value "default" can be used for the encoding from the |
3006 environment. This is the default value for 'encoding'. It is useful | |
3007 when 'encoding' is set to "utf-8" and your environment uses a | |
3008 non-latin1 encoding, such as Russian. | |
777 | 3009 When 'encoding' is "utf-8" and a file contains an illegal byte |
3010 sequence it won't be recognized as UTF-8. You can use the |8g8| | |
3011 command to find the illegal byte sequence. | |
7 | 3012 WRONG VALUES: WHAT'S WRONG: |
3013 latin1,utf-8 "latin1" will always be used | |
3014 utf-8,ucs-bom,latin1 BOM won't be recognized in an utf-8 | |
3015 file | |
3016 cp1250,latin1 "cp1250" will always be used | |
3017 If 'fileencodings' is empty, 'fileencoding' is not modified. | |
3018 See 'fileencoding' for the possible values. | |
3019 Setting this option does not have an effect until the next time a file | |
3020 is read. | |
3021 | |
3022 *'fileformat'* *'ff'* | |
15840
734b1928a5aa
patch 8.1.0927: USE_CR is never defined
Bram Moolenaar <Bram@vim.org>
parents:
15804
diff
changeset
|
3023 '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
|
3024 Unix, macOS default: "unix") |
7 | 3025 local to buffer |
3026 This gives the <EOL> of the current buffer, which is used for | |
3027 reading/writing the buffer from/to a file: | |
3028 dos <CR> <NL> | |
3029 unix <NL> | |
3030 mac <CR> | |
3031 When "dos" is used, CTRL-Z at the end of a file is ignored. | |
3032 See |file-formats| and |file-read|. | |
3033 For the character encoding of the file see 'fileencoding'. | |
3034 When 'binary' is set, the value of 'fileformat' is ignored, file I/O | |
4264 | 3035 works like it was set to "unix". |
7 | 3036 This option is set automatically when starting to edit a file and |
3037 'fileformats' is not empty and 'binary' is off. | |
3038 When this option is set, after starting to edit a file, the 'modified' | |
3039 option is set, because the file would be different when written. | |
3040 This option can not be changed when 'modifiable' is off. | |
3041 For backwards compatibility: When this option is set to "dos", | |
3042 'textmode' is set, otherwise 'textmode' is reset. | |
3043 | |
3044 *'fileformats'* *'ffs'* | |
3045 'fileformats' 'ffs' string (default: | |
15840
734b1928a5aa
patch 8.1.0927: USE_CR is never defined
Bram Moolenaar <Bram@vim.org>
parents:
15804
diff
changeset
|
3046 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
|
3047 Vim Unix, macOS: "unix,dos", |
7 | 3048 Vi Cygwin: "unix,dos", |
3049 Vi others: "") | |
3050 global | |
3051 This gives the end-of-line (<EOL>) formats that will be tried when | |
3052 starting to edit a new buffer and when reading a file into an existing | |
3053 buffer: | |
3054 - When empty, the format defined with 'fileformat' will be used | |
3055 always. It is not set automatically. | |
3056 - When set to one name, that format will be used whenever a new buffer | |
10 | 3057 is opened. 'fileformat' is set accordingly for that buffer. The |
7 | 3058 'fileformats' name will be used when a file is read into an existing |
3059 buffer, no matter what 'fileformat' for that buffer is set to. | |
3060 - When more than one name is present, separated by commas, automatic | |
3061 <EOL> detection will be done when reading a file. When starting to | |
3062 edit a file, a check is done for the <EOL>: | |
3063 1. If all lines end in <CR><NL>, and 'fileformats' includes "dos", | |
3064 'fileformat' is set to "dos". | |
3065 2. If a <NL> is found and 'fileformats' includes "unix", 'fileformat' | |
10 | 3066 is set to "unix". Note that when a <NL> is found without a |
7 | 3067 preceding <CR>, "unix" is preferred over "dos". |
6647 | 3068 3. If 'fileformat' has not yet been set, and if a <CR> is found, and |
3069 if 'fileformats' includes "mac", 'fileformat' is set to "mac". | |
2587 | 3070 This means that "mac" is only chosen when: |
3071 "unix" is not present or no <NL> is found in the file, and | |
3072 "dos" is not present or no <CR><NL> is found in the file. | |
3073 Except: if "unix" was chosen, but there is a <CR> before | |
3074 the first <NL>, and there appear to be more <CR>s than <NL>s in | |
2642 | 3075 the first few lines, "mac" is used. |
7 | 3076 4. If 'fileformat' is still not set, the first name from |
3077 'fileformats' is used. | |
3078 When reading a file into an existing buffer, the same is done, but | |
3079 this happens like 'fileformat' has been set appropriately for that | |
3080 file only, the option is not changed. | |
3081 When 'binary' is set, the value of 'fileformats' is not used. | |
3082 | |
8748
b1a19a2f73f0
commit https://github.com/vim/vim/commit/4f3f668c8486444e53163c29d2fc79bf47eb3c82
Christian Brabandt <cb@256bit.org>
parents:
8629
diff
changeset
|
3083 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
|
3084 can overrule this by setting 'fileformat' in your .vimrc. |
2662 | 3085 |
7 | 3086 For systems with a Dos-like <EOL> (<CR><NL>), when reading files that |
3087 are ":source"ed and for vimrc files, automatic <EOL> detection may be | |
3088 done: | |
3089 - When 'fileformats' is empty, there is no automatic detection. Dos | |
3090 format will be used. | |
3091 - When 'fileformats' is set to one or more names, automatic detection | |
3092 is done. This is based on the first <NL> in the file: If there is a | |
3093 <CR> in front of it, Dos format is used, otherwise Unix format is | |
3094 used. | |
3095 Also see |file-formats|. | |
3096 For backwards compatibility: When this option is set to an empty | |
3097 string or one format (no comma is included), 'textauto' is reset, | |
3098 otherwise 'textauto' is set. | |
3099 NOTE: This option is set to the Vi default value when 'compatible' is | |
3100 set and to the Vim default value when 'compatible' is reset. | |
3101 | |
4264 | 3102 *'fileignorecase'* *'fic'* *'nofileignorecase'* *'nofic'* |
3103 'fileignorecase' 'fic' boolean (default on for systems where case in file | |
3104 names is normally ignored) | |
4242 | 3105 global |
3106 When set case is ignored when using file names and directories. | |
3107 See 'wildignorecase' for only ignoring case when doing completion. | |
3108 | |
7 | 3109 *'filetype'* *'ft'* |
3110 'filetype' 'ft' string (default: "") | |
3111 local to buffer | |
3112 When this option is set, the FileType autocommand event is triggered. | |
3113 All autocommands that match with the value of this option will be | |
3114 executed. Thus the value of 'filetype' is used in place of the file | |
3115 name. | |
3116 Otherwise this option does not always reflect the current file type. | |
3117 This option is normally set when the file type is detected. To enable | |
3118 this use the ":filetype on" command. |:filetype| | |
3119 Setting this option to a different value is most useful in a modeline, | |
3120 for a file for which the file type is not automatically recognized. | |
782 | 3121 Example, for in an IDL file: |
3122 /* vim: set filetype=idl : */ ~ | |
3123 |FileType| |filetypes| | |
3124 When a dot appears in the value then this separates two filetype | |
3125 names. Example: | |
3126 /* vim: set filetype=c.doxygen : */ ~ | |
3127 This will use the "c" filetype first, then the "doxygen" filetype. | |
3128 This works both for filetype plugins and for syntax files. More than | |
3129 one dot may appear. | |
7 | 3130 This option is not copied to another buffer, independent of the 's' or |
3131 'S' flag in 'cpoptions'. | |
36 | 3132 Only normal file name characters can be used, "/\*?[|<>" are illegal. |
7 | 3133 |
3134 *'fillchars'* *'fcs'* | |
3135 'fillchars' 'fcs' string (default "vert:|,fold:-") | |
3136 global | |
3137 {not available when compiled without the |+windows| | |
3138 and |+folding| features} | |
3139 Characters to fill the statuslines and vertical separators. | |
3140 It is a comma separated list of items: | |
3141 | |
3142 item default Used for ~ | |
3143 stl:c ' ' or '^' statusline of the current window | |
8061
abd64cf67bcf
commit https://github.com/vim/vim/commit/38a55639d603823efcf2d2fdf542dbffdeb60b75
Christian Brabandt <cb@256bit.org>
parents:
7876
diff
changeset
|
3144 stlnc:c ' ' or '=' statusline of the non-current windows |
7 | 3145 vert:c '|' vertical separators |:vsplit| |
3146 fold:c '-' filling 'foldtext' | |
3147 diff:c '-' deleted lines of the 'diff' option | |
3148 | |
10 | 3149 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
|
3150 "stlnc" the space will be used when there is highlighting, '^' or '=' |
7 | 3151 otherwise. |
3152 | |
3153 Example: > | |
8061
abd64cf67bcf
commit https://github.com/vim/vim/commit/38a55639d603823efcf2d2fdf542dbffdeb60b75
Christian Brabandt <cb@256bit.org>
parents:
7876
diff
changeset
|
3154 :set fillchars=stl:^,stlnc:=,vert:\|,fold:-,diff:- |
7 | 3155 < This is similar to the default, except that these characters will also |
3156 be used when there is highlighting. | |
3157 | |
819 | 3158 for "stl" and "stlnc" only single-byte values are supported. |
3159 | |
7 | 3160 The highlighting used for these items: |
3161 item highlight group ~ | |
3162 stl:c StatusLine |hl-StatusLine| | |
3163 stlnc:c StatusLineNC |hl-StatusLineNC| | |
3164 vert:c VertSplit |hl-VertSplit| | |
3165 fold:c Folded |hl-Folded| | |
3166 diff:c DiffDelete |hl-DiffDelete| | |
3167 | |
6933 | 3168 *'fixendofline'* *'fixeol'* *'nofixendofline'* *'nofixeol'* |
3169 'fixendofline' 'fixeol' boolean (default on) | |
3170 local to buffer | |
3171 When writing a file and this option is on, <EOL> at the end of file | |
3172 will be restored if missing. Turn this option off if you want to | |
3173 preserve the situation from the original file. | |
3174 When the 'binary' option is set the value of this option doesn't | |
3175 matter. | |
3176 See the 'endofline' option. | |
3177 | |
7 | 3178 *'fkmap'* *'fk'* *'nofkmap'* *'nofk'* |
3179 'fkmap' 'fk' boolean (default off) *E198* | |
3180 global | |
3181 {only available when compiled with the |+rightleft| | |
3182 feature} | |
15850
a6ca8cf07a98
patch 8.1.0932: Farsi support is outdated and unused
Bram Moolenaar <Bram@vim.org>
parents:
15840
diff
changeset
|
3183 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
|
3184 |farsi.txt|. |
7 | 3185 |
3186 *'foldclose'* *'fcl'* | |
3187 'foldclose' 'fcl' string (default "") | |
3188 global | |
3189 {not available when compiled without the |+folding| | |
3190 feature} | |
3191 When set to "all", a fold is closed when the cursor isn't in it and | |
3192 its level is higher than 'foldlevel'. Useful if you want folds to | |
3193 automatically close when moving out of them. | |
3194 | |
3195 *'foldcolumn'* *'fdc'* | |
3196 'foldcolumn' 'fdc' number (default 0) | |
3197 local to window | |
3198 {not available when compiled without the |+folding| | |
3199 feature} | |
3200 When non-zero, a column with the specified width is shown at the side | |
3201 of the window which indicates open and closed folds. The maximum | |
3202 value is 12. | |
3203 See |folding|. | |
3204 | |
3205 *'foldenable'* *'fen'* *'nofoldenable'* *'nofen'* | |
3206 'foldenable' 'fen' boolean (default on) | |
3207 local to window | |
3208 {not available when compiled without the |+folding| | |
3209 feature} | |
3210 When off, all folds are open. This option can be used to quickly | |
3211 switch between showing all text unfolded and viewing the text with | |
3212 folds (including manually opened or closed folds). It can be toggled | |
10 | 3213 with the |zi| command. The 'foldcolumn' will remain blank when |
7 | 3214 'foldenable' is off. |
3215 This option is set by commands that create a new fold or close a fold. | |
3216 See |folding|. | |
3217 | |
3218 *'foldexpr'* *'fde'* | |
3219 'foldexpr' 'fde' string (default: "0") | |
3220 local to window | |
3221 {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
|
3222 or |+eval| features} |
7 | 3223 The expression used for when 'foldmethod' is "expr". It is evaluated |
634 | 3224 for each line to obtain its fold level. See |fold-expr|. |
782 | 3225 |
3682 | 3226 The expression will be evaluated in the |sandbox| if set from a |
3227 modeline, see |sandbox-option|. | |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
3228 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
|
3229 on. |
634 | 3230 |
3231 It is not allowed to change text or jump to another window while | |
3232 evaluating 'foldexpr' |textlock|. | |
7 | 3233 |
3234 *'foldignore'* *'fdi'* | |
3235 'foldignore' 'fdi' string (default: "#") | |
3236 local to window | |
3237 {not available when compiled without the |+folding| | |
3238 feature} | |
3239 Used only when 'foldmethod' is "indent". Lines starting with | |
3240 characters in 'foldignore' will get their fold level from surrounding | |
10 | 3241 lines. White space is skipped before checking for this character. |
7 | 3242 The default "#" works well for C programs. See |fold-indent|. |
3243 | |
3244 *'foldlevel'* *'fdl'* | |
3245 'foldlevel' 'fdl' number (default: 0) | |
3246 local to window | |
3247 {not available when compiled without the |+folding| | |
3248 feature} | |
3249 Sets the fold level: Folds with a higher level will be closed. | |
3250 Setting this option to zero will close all folds. Higher numbers will | |
3251 close fewer folds. | |
3252 This option is set by commands like |zm|, |zM| and |zR|. | |
3253 See |fold-foldlevel|. | |
3254 | |
3255 *'foldlevelstart'* *'fdls'* | |
3256 'foldlevelstart' 'fdls' number (default: -1) | |
3257 global | |
3258 {not available when compiled without the |+folding| | |
3259 feature} | |
3260 Sets 'foldlevel' when starting to edit another buffer in a window. | |
3261 Useful to always start editing with all folds closed (value zero), | |
3262 some folds closed (one) or no folds closed (99). | |
3263 This is done before reading any modeline, thus a setting in a modeline | |
10 | 3264 overrules this option. Starting to edit a file for |diff-mode| also |
7 | 3265 ignores this option and closes all folds. |
3266 It is also done before BufReadPre autocommands, to allow an autocmd to | |
3267 overrule the 'foldlevel' value for specific files. | |
3268 When the value is negative, it is not used. | |
3269 | |
3270 *'foldmarker'* *'fmr'* *E536* | |
3271 'foldmarker' 'fmr' string (default: "{{{,}}}") | |
3272 local to window | |
3273 {not available when compiled without the |+folding| | |
3274 feature} | |
3275 The start and end marker used when 'foldmethod' is "marker". There | |
3276 must be one comma, which separates the start and end marker. The | |
3277 marker is a literal string (a regular expression would be too slow). | |
3278 See |fold-marker|. | |
3279 | |
3280 *'foldmethod'* *'fdm'* | |
3281 'foldmethod' 'fdm' string (default: "manual") | |
3282 local to window | |
3283 {not available when compiled without the |+folding| | |
3284 feature} | |
3285 The kind of folding used for the current window. Possible values: | |
3286 |fold-manual| manual Folds are created manually. | |
3287 |fold-indent| indent Lines with equal indent form a fold. | |
3288 |fold-expr| expr 'foldexpr' gives the fold level of a line. | |
3289 |fold-marker| marker Markers are used to specify folds. | |
3290 |fold-syntax| syntax Syntax highlighting items specify folds. | |
3291 |fold-diff| diff Fold text that is not changed. | |
3292 | |
3293 *'foldminlines'* *'fml'* | |
3294 'foldminlines' 'fml' number (default: 1) | |
3295 local to window | |
3296 {not available when compiled without the |+folding| | |
3297 feature} | |
2709 | 3298 Sets the number of screen lines above which a fold can be displayed |
3299 closed. Also for manually closed folds. With the default value of | |
3300 one a fold can only be closed if it takes up two or more screen lines. | |
3301 Set to zero to be able to close folds of just one screen line. | |
2826 | 3302 Note that this only has an effect on what is displayed. After using |
7 | 3303 "zc" to close a fold, which is displayed open because it's smaller |
3304 than 'foldminlines', a following "zc" may close a containing fold. | |
3305 | |
3306 *'foldnestmax'* *'fdn'* | |
3307 'foldnestmax' 'fdn' number (default: 20) | |
3308 local to window | |
3309 {not available when compiled without the |+folding| | |
3310 feature} | |
3311 Sets the maximum nesting of folds for the "indent" and "syntax" | |
3312 methods. This avoids that too many folds will be created. Using more | |
3313 than 20 doesn't work, because the internal limit is 20. | |
3314 | |
3315 *'foldopen'* *'fdo'* | |
3316 'foldopen' 'fdo' string (default: "block,hor,mark,percent,quickfix, | |
3317 search,tag,undo") | |
3318 global | |
3319 {not available when compiled without the |+folding| | |
3320 feature} | |
3321 Specifies for which type of commands folds will be opened, if the | |
3322 command moves the cursor into a closed fold. It is a comma separated | |
3323 list of items. | |
2625 | 3324 NOTE: When the command is part of a mapping this option is not used. |
3325 Add the |zv| command to the mapping to get the same effect. | |
3326 (rationale: the mapping may want to control opening folds itself) | |
3327 | |
7 | 3328 item commands ~ |
3329 all any | |
3330 block "(", "{", "[[", "[{", etc. | |
3331 hor horizontal movements: "l", "w", "fx", etc. | |
3332 insert any command in Insert mode | |
3333 jump far jumps: "G", "gg", etc. | |
3334 mark jumping to a mark: "'m", CTRL-O, etc. | |
3335 percent "%" | |
3336 quickfix ":cn", ":crew", ":make", etc. | |
3337 search search for a pattern: "/", "n", "*", "gd", etc. | |
3338 (not for a search pattern in a ":" command) | |
819 | 3339 Also for |[s| and |]s|. |
7 | 3340 tag jumping to a tag: ":ta", CTRL-T, etc. |
3341 undo undo or redo: "u" and CTRL-R | |
3342 When a movement command is used for an operator (e.g., "dl" or "y%") | |
3343 this option is not used. This means the operator will include the | |
3344 whole closed fold. | |
3345 Note that vertical movements are not here, because it would make it | |
3346 very difficult to move onto a closed fold. | |
3347 In insert mode the folds containing the cursor will always be open | |
3348 when text is inserted. | |
3349 To close folds you can re-apply 'foldlevel' with the |zx| command or | |
3350 set the 'foldclose' option to "all". | |
3351 | |
3352 *'foldtext'* *'fdt'* | |
3353 'foldtext' 'fdt' string (default: "foldtext()") | |
3354 local to window | |
3355 {not available when compiled without the |+folding| | |
3356 feature} | |
3357 An expression which is used to specify the text displayed for a closed | |
3358 fold. See |fold-foldtext|. | |
3359 | |
3682 | 3360 The expression will be evaluated in the |sandbox| if set from a |
3361 modeline, see |sandbox-option|. | |
634 | 3362 |
3363 It is not allowed to change text or jump to another window while | |
3364 evaluating 'foldtext' |textlock|. | |
3365 | |
9286
64035abb986b
commit https://github.com/vim/vim/commit/c95a302a4c42ec8230473cd4a5e0064d0a143aa8
Christian Brabandt <cb@256bit.org>
parents:
9227
diff
changeset
|
3366 *'formatexpr'* *'fex'* |
64035abb986b
commit https://github.com/vim/vim/commit/c95a302a4c42ec8230473cd4a5e0064d0a143aa8
Christian Brabandt <cb@256bit.org>
parents:
9227
diff
changeset
|
3367 'formatexpr' 'fex' string (default "") |
64035abb986b
commit https://github.com/vim/vim/commit/c95a302a4c42ec8230473cd4a5e0064d0a143aa8
Christian Brabandt <cb@256bit.org>
parents:
9227
diff
changeset
|
3368 local to buffer |
64035abb986b
commit https://github.com/vim/vim/commit/c95a302a4c42ec8230473cd4a5e0064d0a143aa8
Christian Brabandt <cb@256bit.org>
parents:
9227
diff
changeset
|
3369 {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
|
3370 feature} |
64035abb986b
commit https://github.com/vim/vim/commit/c95a302a4c42ec8230473cd4a5e0064d0a143aa8
Christian Brabandt <cb@256bit.org>
parents:
9227
diff
changeset
|
3371 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
|
3372 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
|
3373 option is empty 'formatprg' is used. |
64035abb986b
commit https://github.com/vim/vim/commit/c95a302a4c42ec8230473cd4a5e0064d0a143aa8
Christian Brabandt <cb@256bit.org>
parents:
9227
diff
changeset
|
3374 |
64035abb986b
commit https://github.com/vim/vim/commit/c95a302a4c42ec8230473cd4a5e0064d0a143aa8
Christian Brabandt <cb@256bit.org>
parents:
9227
diff
changeset
|
3375 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
|
3376 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
|
3377 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
|
3378 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
|
3379 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
|
3380 it yet! |
64035abb986b
commit https://github.com/vim/vim/commit/c95a302a4c42ec8230473cd4a5e0064d0a143aa8
Christian Brabandt <cb@256bit.org>
parents:
9227
diff
changeset
|
3381 |
64035abb986b
commit https://github.com/vim/vim/commit/c95a302a4c42ec8230473cd4a5e0064d0a143aa8
Christian Brabandt <cb@256bit.org>
parents:
9227
diff
changeset
|
3382 Example: > |
64035abb986b
commit https://github.com/vim/vim/commit/c95a302a4c42ec8230473cd4a5e0064d0a143aa8
Christian Brabandt <cb@256bit.org>
parents:
9227
diff
changeset
|
3383 :set formatexpr=mylang#Format() |
64035abb986b
commit https://github.com/vim/vim/commit/c95a302a4c42ec8230473cd4a5e0064d0a143aa8
Christian Brabandt <cb@256bit.org>
parents:
9227
diff
changeset
|
3384 < 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
|
3385 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
|
3386 |
64035abb986b
commit https://github.com/vim/vim/commit/c95a302a4c42ec8230473cd4a5e0064d0a143aa8
Christian Brabandt <cb@256bit.org>
parents:
9227
diff
changeset
|
3387 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
|
3388 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
|
3389 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
|
3390 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
|
3391 return "i" or "R" in this situation. |
13341
acd7eaa13d2b
Updated runtime files.
Christian Brabandt <cb@256bit.org>
parents:
13314
diff
changeset
|
3392 |
9286
64035abb986b
commit https://github.com/vim/vim/commit/c95a302a4c42ec8230473cd4a5e0064d0a143aa8
Christian Brabandt <cb@256bit.org>
parents:
9227
diff
changeset
|
3393 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
|
3394 the internal format mechanism. |
64035abb986b
commit https://github.com/vim/vim/commit/c95a302a4c42ec8230473cd4a5e0064d0a143aa8
Christian Brabandt <cb@256bit.org>
parents:
9227
diff
changeset
|
3395 |
64035abb986b
commit https://github.com/vim/vim/commit/c95a302a4c42ec8230473cd4a5e0064d0a143aa8
Christian Brabandt <cb@256bit.org>
parents:
9227
diff
changeset
|
3396 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
|
3397 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
|
3398 since changing the buffer text is not allowed. |
11160 | 3399 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
|
3400 |
41 | 3401 *'formatlistpat'* *'flp'* |
3402 'formatlistpat' 'flp' string (default: "^\s*\d\+[\]:.)}\t ]\s*") | |
3403 local to buffer | |
3404 A pattern that is used to recognize a list header. This is used for | |
3405 the "n" flag in 'formatoptions'. | |
3406 The pattern must match exactly the text that will be the indent for | |
140 | 3407 the line below it. You can use |/\ze| to mark the end of the match |
41 | 3408 while still checking more characters. There must be a character |
3409 following the pattern, when it matches the whole line it is handled | |
3410 like there is no match. | |
3411 The default recognizes a number, followed by an optional punctuation | |
3412 character and white space. | |
3413 | |
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
|
3414 *'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
|
3415 '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
|
3416 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
|
3417 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
|
3418 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
|
3419 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
|
3420 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
|
3421 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
|
3422 "+=" 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
|
3423 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
|
3424 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
|
3425 |
7 | 3426 *'formatprg'* *'fp'* |
3427 '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
|
3428 global or local to buffer |global-local| |
7 | 3429 The name of an external program that will be used to format the lines |
667 | 3430 selected with the |gq| operator. The program must take the input on |
7 | 3431 stdin and produce the output on stdout. The Unix program "fmt" is |
557 | 3432 such a program. |
667 | 3433 If the 'formatexpr' option is not empty it will be used instead. |
3434 Otherwise, if 'formatprg' option is an empty string, the internal | |
3435 format function will be used |C-indenting|. | |
557 | 3436 Environment variables are expanded |:set_env|. See |option-backslash| |
3437 about including spaces and backslashes. | |
3682 | 3438 This option cannot be set from a |modeline| or in the |sandbox|, for |
3439 security reasons. | |
667 | 3440 |
7196
42717d048817
commit https://github.com/vim/vim/commit/d94464ee294a351ce7b6ba18e8bd3f24f1bef920
Christian Brabandt <cb@256bit.org>
parents:
7147
diff
changeset
|
3441 *'fsync'* *'fs'* *'nofsync'* *'nofs'* |
36 | 3442 'fsync' 'fs' boolean (default on) |
3443 global | |
3444 When on, the library function fsync() will be called after writing a | |
3445 file. This will flush a file to disk, ensuring that it is safely | |
3446 written even on filesystems which do metadata-only journaling. This | |
3447 will force the harddrive to spin up on Linux systems running in laptop | |
3448 mode, so it may be undesirable in some situations. Be warned that | |
3449 turning this off increases the chances of data loss after a crash. On | |
3450 systems without an fsync() implementation, this variable is always | |
3451 off. | |
3452 Also see 'swapsync' for controlling fsync() on swap files. | |
12865
ebb4f6c93598
patch 8.0.1309: cannot use 'balloonexpr' in a terminal
Christian Brabandt <cb@256bit.org>
parents:
12826
diff
changeset
|
3453 'fsync' also applies to |writefile()|, unless a flag is used to |
ebb4f6c93598
patch 8.0.1309: cannot use 'balloonexpr' in a terminal
Christian Brabandt <cb@256bit.org>
parents:
12826
diff
changeset
|
3454 overrule it. |
36 | 3455 |
7 | 3456 *'gdefault'* *'gd'* *'nogdefault'* *'nogd'* |
3457 'gdefault' 'gd' boolean (default off) | |
3458 global | |
3459 When on, the ":substitute" flag 'g' is default on. This means that | |
3460 all matches in a line are substituted instead of one. When a 'g' flag | |
3461 is given to a ":substitute" command, this will toggle the substitution | |
3462 of all or one match. See |complex-change|. | |
3463 | |
3464 command 'gdefault' on 'gdefault' off ~ | |
3465 :s/// subst. all subst. one | |
3466 :s///g subst. one subst. all | |
3467 :s///gg subst. all subst. one | |
3468 | |
3469 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
|
3470 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
|
3471 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
|
3472 has the opposite effect of that it normally does. |
7 | 3473 |
3474 *'grepformat'* *'gfm'* | |
6213 | 3475 'grepformat' 'gfm' string (default "%f:%l:%m,%f:%l%m,%f %l%m") |
7 | 3476 global |
3477 Format to recognize for the ":grep" command output. | |
3478 This is a scanf-like string that uses the same format as the | |
3479 'errorformat' option: see |errorformat|. | |
3480 | |
3481 *'grepprg'* *'gp'* | |
3482 'grepprg' 'gp' string (default "grep -n ", | |
3483 Unix: "grep -n $* /dev/null", | |
3484 Win32: "findstr /n" or "grep -n", | |
3485 VMS: "SEARCH/NUMBERS ") | |
3486 global or local to buffer |global-local| | |
233 | 3487 Program to use for the |:grep| command. This option may contain '%' |
7 | 3488 and '#' characters, which are expanded like when used in a command- |
3489 line. The placeholder "$*" is allowed to specify where the arguments | |
3490 will be included. Environment variables are expanded |:set_env|. See | |
3491 |option-backslash| about including spaces and backslashes. | |
3492 When your "grep" accepts the "-H" argument, use this to make ":grep" | |
3493 also work well with a single file: > | |
3494 :set grepprg=grep\ -nH | |
161 | 3495 < Special value: When 'grepprg' is set to "internal" the |:grep| command |
657 | 3496 works like |:vimgrep|, |:lgrep| like |:lvimgrep|, |:grepadd| like |
3497 |:vimgrepadd| and |:lgrepadd| like |:lvimgrepadd|. | |
41 | 3498 See also the section |:make_makeprg|, since most of the comments there |
7 | 3499 apply equally to 'grepprg'. |
3500 For Win32, the default is "findstr /n" if "findstr.exe" can be found, | |
3501 otherwise it's "grep -n". | |
3502 This option cannot be set from a |modeline| or in the |sandbox|, for | |
3503 security reasons. | |
3504 | |
3505 *'guicursor'* *'gcr'* *E545* *E546* *E548* *E549* | |
3506 'guicursor' 'gcr' string (default "n-v-c:block-Cursor/lCursor, | |
3507 ve:ver35-Cursor, | |
3508 o:hor50-Cursor, | |
3509 i-ci:ver25-Cursor/lCursor, | |
3510 r-cr:hor20-Cursor/lCursor, | |
3511 sm:block-Cursor | |
3512 -blinkwait175-blinkoff150-blinkon175", | |
3513 for MS-DOS and Win32 console: | |
3514 "n-v-c:block,o:hor50,i-ci:hor15, | |
3515 r-cr:hor30,sm:block") | |
3516 global | |
3517 {only available when compiled with GUI enabled, and | |
3518 for MS-DOS and Win32 console} | |
3519 This option tells Vim what the cursor should look like in different | |
10 | 3520 modes. It fully works in the GUI. In an MSDOS or Win32 console, only |
7 | 3521 the height of the cursor can be changed. This can be done by |
3522 specifying a block cursor, or a percentage for a vertical or | |
3523 horizontal cursor. | |
6727 | 3524 For a console the 't_SI', 't_SR', and 't_EI' escape sequences are |
3525 used. | |
7 | 3526 |
10 | 3527 The option is a comma separated list of parts. Each part consist of a |
7 | 3528 mode-list and an argument-list: |
3529 mode-list:argument-list,mode-list:argument-list,.. | |
3530 The mode-list is a dash separated list of these modes: | |
3531 n Normal mode | |
3532 v Visual mode | |
3533 ve Visual mode with 'selection' "exclusive" (same as 'v', | |
3534 if not specified) | |
3535 o Operator-pending mode | |
3536 i Insert mode | |
3537 r Replace mode | |
3538 c Command-line Normal (append) mode | |
3539 ci Command-line Insert mode | |
3540 cr Command-line Replace mode | |
3541 sm showmatch in Insert mode | |
3542 a all modes | |
3543 The argument-list is a dash separated list of these arguments: | |
3544 hor{N} horizontal bar, {N} percent of the character height | |
3545 ver{N} vertical bar, {N} percent of the character width | |
3546 block block cursor, fills the whole character | |
3547 [only one of the above three should be present] | |
3548 blinkwait{N} *cursor-blinking* | |
3549 blinkon{N} | |
3550 blinkoff{N} | |
3551 blink times for cursor: blinkwait is the delay before | |
3552 the cursor starts blinking, blinkon is the time that | |
3553 the cursor is shown and blinkoff is the time that the | |
3554 cursor is not shown. The times are in msec. When one | |
3555 of the numbers is zero, there is no blinking. The | |
3556 default is: "blinkwait700-blinkon400-blinkoff250". | |
3557 These numbers are used for a missing entry. This | |
3558 means that blinking is enabled by default. To switch | |
3559 blinking off you can use "blinkon0". The cursor only | |
3560 blinks when Vim is waiting for input, not while | |
3561 executing a command. | |
3562 To make the cursor blink in an xterm, see | |
3563 |xterm-blink|. | |
3564 {group-name} | |
3565 a highlight group name, that sets the color and font | |
3566 for the cursor | |
3567 {group-name}/{group-name} | |
3568 Two highlight group names, the first is used when | |
3569 no language mappings are used, the other when they | |
3570 are. |language-mapping| | |
3571 | |
3572 Examples of parts: | |
3573 n-c-v:block-nCursor in Normal, Command-line and Visual mode, use a | |
3574 block cursor with colors from the "nCursor" | |
3575 highlight group | |
3576 i-ci:ver30-iCursor-blinkwait300-blinkon200-blinkoff150 | |
3577 In Insert and Command-line Insert mode, use a | |
3578 30% vertical bar cursor with colors from the | |
3579 "iCursor" highlight group. Blink a bit | |
3580 faster. | |
3581 | |
3582 The 'a' mode is different. It will set the given argument-list for | |
3583 all modes. It does not reset anything to defaults. This can be used | |
3584 to do a common setting for all modes. For example, to switch off | |
3585 blinking: "a:blinkon0" | |
3586 | |
3587 Examples of cursor highlighting: > | |
3588 :highlight Cursor gui=reverse guifg=NONE guibg=NONE | |
3589 :highlight Cursor gui=NONE guifg=bg guibg=fg | |
3590 < | |
3591 *'guifont'* *'gfn'* | |
2908 | 3592 *E235* *E596* |
7 | 3593 'guifont' 'gfn' string (default "") |
3594 global | |
3595 {only available when compiled with GUI enabled} | |
3596 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
|
3597 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
|
3598 See |gui-font| for the details. |
7 | 3599 |
3600 *'guifontset'* *'gfs'* | |
3601 *E250* *E252* *E234* *E597* *E598* | |
3602 'guifontset' 'gfs' string (default "") | |
3603 global | |
3604 {only available when compiled with GUI enabled and | |
3605 with the |+xfontset| feature} | |
10895
c391bfbdb452
Updated runtime files.
Christian Brabandt <cb@256bit.org>
parents:
10734
diff
changeset
|
3606 {not available in the GTK+ GUI} |
7 | 3607 When not empty, specifies two (or more) fonts to be used. The first |
3608 one for normal English, the second one for your special language. See | |
3609 |xfontset|. | |
16439
9d20e26dc13c
patch 8.1.1224: MS-Windows: cannot specify font weight
Bram Moolenaar <Bram@vim.org>
parents:
16427
diff
changeset
|
3610 |
7 | 3611 *'guifontwide'* *'gfw'* *E231* *E533* *E534* |
3612 'guifontwide' 'gfw' string (default "") | |
3613 global | |
3614 {only available when compiled with GUI enabled} | |
3615 When not empty, specifies a comma-separated list of fonts to be used | |
3616 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
|
3617 used. See |gui-fontwide|. |
4055 | 3618 |
7 | 3619 *'guiheadroom'* *'ghr'* |
3620 'guiheadroom' 'ghr' number (default 50) | |
3621 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
|
3622 - {only for GTK and X11 GUI} |
7 | 3623 The number of pixels subtracted from the screen height when fitting |
3624 the GUI window on the screen. Set this before the GUI is started, | |
3625 e.g., in your |gvimrc| file. When zero, the whole screen height will | |
10 | 3626 be used by the window. When positive, the specified number of pixel |
7 | 3627 lines will be left for window decorations and other items on the |
3628 screen. Set it to a negative value to allow windows taller than the | |
3629 screen. | |
3630 | |
3631 *'guioptions'* *'go'* | |
14945 | 3632 'guioptions' 'go' string (default "egmrLtT" (MS-Windows, |
3633 "t" is removed in |defaults.vim|), | |
9669
284b4eb307fc
commit https://github.com/vim/vim/commit/8c08b5b569e2a9e9f63dea514591ecfa2d3bb392
Christian Brabandt <cb@256bit.org>
parents:
9665
diff
changeset
|
3634 "aegimrLtT" (GTK, Motif and Athena), |
284b4eb307fc
commit https://github.com/vim/vim/commit/8c08b5b569e2a9e9f63dea514591ecfa2d3bb392
Christian Brabandt <cb@256bit.org>
parents:
9665
diff
changeset
|
3635 ) |
7 | 3636 global |
3637 {only available when compiled with GUI enabled} | |
8 | 3638 This option only has an effect in the GUI version of Vim. It is a |
7 | 3639 sequence of letters which describes what components and options of the |
3640 GUI should be used. | |
3641 To avoid problems with flags that are added in the future, use the | |
3642 "+=" and "-=" feature of ":set" |add-option-flags|. | |
3643 | |
13470
6faef782f50b
patch 8.0.1609: shell commands in the GUI use a dumb terminal
Christian Brabandt <cb@256bit.org>
parents:
13437
diff
changeset
|
3644 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
|
3645 *'go-!'* |
6faef782f50b
patch 8.0.1609: shell commands in the GUI use a dumb terminal
Christian Brabandt <cb@256bit.org>
parents:
13437
diff
changeset
|
3646 '!' 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
|
3647 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
|
3648 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
|
3649 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
|
3650 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
|
3651 upwards as needed. |
14999 | 3652 *'go-a'* |
7 | 3653 'a' Autoselect: If present, then whenever VISUAL mode is started, |
3654 or the Visual area extended, Vim tries to become the owner of | |
3655 the windowing system's global selection. This means that the | |
3656 Visually highlighted text is available for pasting into other | |
3657 applications as well as into Vim itself. When the Visual mode | |
3658 ends, possibly due to an operation on the text, or when an | |
3659 application wants to paste the selection, the highlighted text | |
3660 is automatically yanked into the "* selection register. | |
3661 Thus the selection is still available for pasting into other | |
3662 applications after the VISUAL mode has ended. | |
3663 If not present, then Vim won't become the owner of the | |
3664 windowing system's global selection unless explicitly told to | |
3665 by a yank or delete operation for the "* register. | |
3666 The same applies to the modeless selection. | |
3674 | 3667 *'go-P'* |
3668 '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
|
3669 register. |
1152 | 3670 *'go-A'* |
10 | 3671 'A' Autoselect for the modeless selection. Like 'a', but only |
7 | 3672 applies to the modeless selection. |
3673 | |
3674 'guioptions' autoselect Visual autoselect modeless ~ | |
3675 "" - - | |
3676 "a" yes yes | |
3677 "A" - yes | |
3678 "aA" yes yes | |
3679 | |
1152 | 3680 *'go-c'* |
7 | 3681 'c' Use console dialogs instead of popup dialogs for simple |
3682 choices. | |
1152 | 3683 *'go-e'* |
697 | 3684 'e' Add tab pages when indicated with 'showtabline'. |
688 | 3685 'guitablabel' can be used to change the text in the labels. |
3686 When 'e' is missing a non-GUI tab pages line may be used. | |
857 | 3687 The GUI tabs are only supported on some systems, currently |
1621 | 3688 GTK, Motif, Mac OS/X and MS-Windows. |
1152 | 3689 *'go-f'* |
7 | 3690 'f' Foreground: Don't use fork() to detach the GUI from the shell |
3691 where it was started. Use this for programs that wait for the | |
3692 editor to finish (e.g., an e-mail program). Alternatively you | |
3693 can use "gvim -f" or ":gui -f" to start the GUI in the | |
3694 foreground. |gui-fork| | |
3695 Note: Set this option in the vimrc file. The forking may have | |
819 | 3696 happened already when the |gvimrc| file is read. |
1152 | 3697 *'go-i'* |
7 | 3698 'i' Use a Vim icon. For GTK with KDE it is used in the left-upper |
3699 corner of the window. It's black&white on non-GTK, because of | |
3700 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
|
3701 *'go-m'* |
7 | 3702 'm' Menu bar is present. |
2290
22529abcd646
Fixed ":s" message. Docs updates.
Bram Moolenaar <bram@vim.org>
parents:
2283
diff
changeset
|
3703 *'go-M'* |
10 | 3704 'M' The system menu "$VIMRUNTIME/menu.vim" is not sourced. Note |
7 | 3705 that this flag must be added in the .vimrc file, before |
819 | 3706 switching on syntax or filetype recognition (when the |gvimrc| |
7 | 3707 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
|
3708 `: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
|
3709 *'go-g'* |
7 | 3710 'g' Grey menu items: Make menu items that are not active grey. If |
3711 'g' is not included inactive menu items are not shown at all. | |
3712 Exception: Athena will always use grey menu items. | |
1152 | 3713 *'go-t'* |
7 | 3714 't' Include tearoff menu items. Currently only works for Win32, |
3715 GTK+, and Motif 1.2 GUI. | |
1152 | 3716 *'go-T'* |
236 | 3717 'T' Include Toolbar. Currently only in Win32, GTK+, Motif, Photon |
856 | 3718 and Athena GUIs. |
1152 | 3719 *'go-r'* |
7 | 3720 'r' Right-hand scrollbar is always present. |
2290
22529abcd646
Fixed ":s" message. Docs updates.
Bram Moolenaar <bram@vim.org>
parents:
2283
diff
changeset
|
3721 *'go-R'* |
7 | 3722 'R' Right-hand scrollbar is present when there is a vertically |
3723 split window. | |
2290
22529abcd646
Fixed ":s" message. Docs updates.
Bram Moolenaar <bram@vim.org>
parents:
2283
diff
changeset
|
3724 *'go-l'* |
7 | 3725 'l' Left-hand scrollbar is always present. |
2290
22529abcd646
Fixed ":s" message. Docs updates.
Bram Moolenaar <bram@vim.org>
parents:
2283
diff
changeset
|
3726 *'go-L'* |
7 | 3727 'L' Left-hand scrollbar is present when there is a vertically |
3728 split window. | |
1152 | 3729 *'go-b'* |
7 | 3730 'b' Bottom (horizontal) scrollbar is present. Its size depends on |
3731 the longest visible line, or on the cursor line if the 'h' | |
3732 flag is included. |gui-horiz-scroll| | |
2290
22529abcd646
Fixed ":s" message. Docs updates.
Bram Moolenaar <bram@vim.org>
parents:
2283
diff
changeset
|
3733 *'go-h'* |
7 | 3734 'h' Limit horizontal scrollbar size to the length of the cursor |
3735 line. Reduces computations. |gui-horiz-scroll| | |
3736 | |
3737 And yes, you may even have scrollbars on the left AND the right if | |
3738 you really want to :-). See |gui-scrollbars| for more information. | |
3739 | |
2290
22529abcd646
Fixed ":s" message. Docs updates.
Bram Moolenaar <bram@vim.org>
parents:
2283
diff
changeset
|
3740 *'go-v'* |
7 | 3741 'v' Use a vertical button layout for dialogs. When not included, |
3742 a horizontal layout is preferred, but when it doesn't fit a | |
3743 vertical layout is used anyway. | |
2290
22529abcd646
Fixed ":s" message. Docs updates.
Bram Moolenaar <bram@vim.org>
parents:
2283
diff
changeset
|
3744 *'go-p'* |
7 | 3745 'p' Use Pointer callbacks for X11 GUI. This is required for some |
3746 window managers. If the cursor is not blinking or hollow at | |
3747 the right moment, try adding this flag. This must be done | |
819 | 3748 before starting the GUI. Set it in your |gvimrc|. Adding or |
7 | 3749 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
|
3750 *'go-F'* |
10 | 3751 '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
|
3752 *'go-k'* |
29a728529f92
patch 8.0.1278: GUI window always resizes when adding scrollbar
Christian Brabandt <cb@256bit.org>
parents:
12785
diff
changeset
|
3753 '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
|
3754 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
|
3755 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
|
3756 '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
|
3757 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
|
3758 removing GUI components. |
1152 | 3759 |
7 | 3760 *'guipty'* *'noguipty'* |
3761 'guipty' boolean (default on) | |
3762 global | |
3763 {only available when compiled with GUI enabled} | |
3764 Only in the GUI: If on, an attempt is made to open a pseudo-tty for | |
3765 I/O to/from shell commands. See |gui-pty|. | |
3766 | |
688 | 3767 *'guitablabel'* *'gtl'* |
3768 'guitablabel' 'gtl' string (default empty) | |
3769 global | |
692 | 3770 {only available when compiled with GUI enabled and |
2570
71b56b4e7785
Make the references to features in the help more consistent. (Sylvain Hitier)
Bram Moolenaar <bram@vim.org>
parents:
2561
diff
changeset
|
3771 with the |+windows| feature} |
688 | 3772 When nonempty describes the text to use in a label of the GUI tab |
857 | 3773 pages line. When empty and when the result is empty Vim will use a |
3774 default label. See |setting-guitablabel| for more info. | |
688 | 3775 |
692 | 3776 The format of this option is like that of 'statusline'. |
839 | 3777 '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
|
3778 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
|
3779 modeline, see |sandbox-option|. |
692 | 3780 |
688 | 3781 Only used when the GUI tab pages line is displayed. 'e' must be |
3782 present in 'guioptions'. For the non-GUI tab pages line 'tabline' is | |
3783 used. | |
3784 | |
839 | 3785 *'guitabtooltip'* *'gtt'* |
3786 'guitabtooltip' 'gtt' string (default empty) | |
3787 global | |
3788 {only available when compiled with GUI enabled and | |
2570
71b56b4e7785
Make the references to features in the help more consistent. (Sylvain Hitier)
Bram Moolenaar <bram@vim.org>
parents:
2561
diff
changeset
|
3789 with the |+windows| feature} |
839 | 3790 When nonempty describes the text to use in a tooltip for the GUI tab |
3791 pages line. When empty Vim will use a default tooltip. | |
3792 This option is otherwise just like 'guitablabel' above. | |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
3793 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
|
3794 :let &guitabtooltip = "line one\nline two" |
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
3795 < |
839 | 3796 |
7 | 3797 *'helpfile'* *'hf'* |
3798 'helpfile' 'hf' string (default (MSDOS) "$VIMRUNTIME\doc\help.txt" | |
3799 (others) "$VIMRUNTIME/doc/help.txt") | |
3800 global | |
3801 Name of the main help file. All distributed help files should be | |
3802 placed together in one directory. Additionally, all "doc" directories | |
3803 in 'runtimepath' will be used. | |
3804 Environment variables are expanded |:set_env|. For example: | |
3805 "$VIMRUNTIME/doc/help.txt". If $VIMRUNTIME is not set, $VIM is also | |
10 | 3806 tried. Also see |$VIMRUNTIME| and |option-backslash| about including |
7 | 3807 spaces and backslashes. |
3808 This option cannot be set from a |modeline| or in the |sandbox|, for | |
3809 security reasons. | |
3810 | |
3811 *'helpheight'* *'hh'* | |
3812 'helpheight' 'hh' number (default 20) | |
3813 global | |
2570
71b56b4e7785
Make the references to features in the help more consistent. (Sylvain Hitier)
Bram Moolenaar <bram@vim.org>
parents:
2561
diff
changeset
|
3814 {not available when compiled without the |+windows| |
7 | 3815 feature} |
3816 Minimal initial height of the help window when it is opened with the | |
3817 ":help" command. The initial height of the help window is half of the | |
3818 current window, or (when the 'ea' option is on) the same as other | |
3819 windows. When the height is less than 'helpheight', the height is | |
3820 set to 'helpheight'. Set to zero to disable. | |
3821 | |
3822 *'helplang'* *'hlg'* | |
3823 'helplang' 'hlg' string (default: messages language or empty) | |
3824 global | |
3825 {only available when compiled with the |+multi_lang| | |
3826 feature} | |
3827 Comma separated list of languages. Vim will use the first language | |
3828 for which the desired help can be found. The English help will always | |
3829 be used as a last resort. You can add "en" to prefer English over | |
3830 another language, but that will only find tags that exist in that | |
3831 language and not in the English help. | |
3832 Example: > | |
3833 :set helplang=de,it | |
3834 < This will first search German, then Italian and finally English help | |
3835 files. | |
3836 When using |CTRL-]| and ":help!" in a non-English help file Vim will | |
3837 try to find the tag in the current language before using this option. | |
3838 See |help-translated|. | |
3839 | |
3840 *'hidden'* *'hid'* *'nohidden'* *'nohid'* | |
3841 'hidden' 'hid' boolean (default off) | |
3842 global | |
3843 When off a buffer is unloaded when it is |abandon|ed. When on a | |
3844 buffer becomes hidden when it is |abandon|ed. If the buffer is still | |
3845 displayed in another window, it does not become hidden, of course. | |
3846 The commands that move through the buffer list sometimes make a buffer | |
3847 hidden although the 'hidden' option is off: When the buffer is | |
3848 modified, 'autowrite' is off or writing is not possible, and the '!' | |
10 | 3849 flag was used. See also |windows.txt|. |
12 | 3850 To only make one buffer hidden use the 'bufhidden' option. |
7 | 3851 This option is set for one command with ":hide {command}" |:hide|. |
3852 WARNING: It's easy to forget that you have changes in hidden buffers. | |
3853 Think twice when using ":q!" or ":qa!". | |
3854 | |
3855 *'highlight'* *'hl'* | |
3856 '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
|
3857 "8:SpecialKey,~:EndOfBuffer,@:NonText, |
7da89d9c744b
commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents:
9860
diff
changeset
|
3858 d:Directory,e:ErrorMsg,i:IncSearch, |
7da89d9c744b
commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents:
9860
diff
changeset
|
3859 l:Search,m:MoreMsg,M:ModeMsg,n:LineNr, |
7da89d9c744b
commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents:
9860
diff
changeset
|
3860 N:CursorLineNr,r:Question,s:StatusLine, |
7da89d9c744b
commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents:
9860
diff
changeset
|
3861 S:StatusLineNC,c:VertSplit,t:Title, |
15194 | 3862 v:Visual,V:VisualNOS,w:WarningMsg, |
3863 W:WildMenu,f:Folded,F:FoldColumn, | |
3864 A:DiffAdd,C:DiffChange,D:DiffDelete, | |
3865 T:DiffText,>:SignColumn,-:Conceal, | |
15281 | 3866 B:SpellBad,P:SpellCap,R:SpellRare, |
15194 | 3867 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
|
3868 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
|
3869 #:TabLineSel,_:TabLineFill,!:CursorColumn, |
11914 | 3870 .:CursorLine,o:ColorColumn,q:QuickFixLine, |
12254 | 3871 z:StatusLineTerm,Z:StatusLineTermNC") |
7 | 3872 global |
3873 This option can be used to set highlighting mode for various | |
3874 occasions. It is a comma separated list of character pairs. The | |
3875 first character in a pair gives the occasion, the second the mode to | |
10 | 3876 use for that occasion. The occasions are: |
7 | 3877 |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
|
3878 |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
|
3879 |hl-NonText| @ '@' at the end of the window and |
7 | 3880 characters from 'showbreak' |
3881 |hl-Directory| d directories in CTRL-D listing and other special | |
3882 things in listings | |
3883 |hl-ErrorMsg| e error messages | |
3884 h (obsolete, ignored) | |
3885 |hl-IncSearch| i 'incsearch' highlighting | |
3886 |hl-Search| l last search pattern highlighting (see 'hlsearch') | |
3887 |hl-MoreMsg| m |more-prompt| | |
3888 |hl-ModeMsg| M Mode (e.g., "-- INSERT --") | |
2178
c6f1aa1e9f32
Add 'relativenumber' patch from Markus Heidelberg.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
3889 |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
|
3890 when 'number' or 'relativenumber' option is set. |
4073 | 3891 |hl-CursorLineNr| N like n for when 'cursorline' or 'relativenumber' is |
3892 set. | |
7 | 3893 |hl-Question| r |hit-enter| prompt and yes/no questions |
3894 |hl-StatusLine| s status line of current window |status-line| | |
12785 | 3895 |hl-StatusLineNC| S status lines of not-current windows |
7 | 3896 |hl-Title| t Titles for output from ":set all", ":autocmd" etc. |
3897 |hl-VertSplit| c column used to separate vertically split windows | |
3898 |hl-Visual| v Visual mode | |
3899 |hl-VisualNOS| V Visual mode when Vim does is "Not Owning the | |
3900 Selection" Only X11 Gui's |gui-x11| and | |
3901 |xterm-clipboard|. | |
3902 |hl-WarningMsg| w warning messages | |
3903 |hl-WildMenu| W wildcard matches displayed for 'wildmenu' | |
3904 |hl-Folded| f line used for closed folds | |
3905 |hl-FoldColumn| F 'foldcolumn' | |
386 | 3906 |hl-DiffAdd| A added line in diff mode |
3907 |hl-DiffChange| C changed line in diff mode | |
3908 |hl-DiffDelete| D deleted line in diff mode | |
3909 |hl-DiffText| T inserted text in diff mode | |
7 | 3910 |hl-SignColumn| > column used for |signs| |
15194 | 3911 |hl-Conceal| - the placeholders used for concealed characters |
3912 (see 'conceallevel') | |
221 | 3913 |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
|
3914 |hl-SpellCap| P word that should start with capital |spell| |
221 | 3915 |hl-SpellRare| R rare word |spell| |
3916 |hl-SpellLocal| L word from other region |spell| | |
15194 | 3917 |hl-Pmenu| + popup menu normal line |
3918 |hl-PmenuSel| = popup menu selected line | |
3919 |hl-PmenuSbar| x popup menu scrollbar | |
3920 |hl-PmenuThumb| X popup menu scrollbar thumb | |
7 | 3921 |
3922 The display modes are: | |
3923 r reverse (termcap entry "mr" and "me") | |
3924 i italic (termcap entry "ZH" and "ZR") | |
3925 b bold (termcap entry "md" and "me") | |
3926 s standout (termcap entry "so" and "se") | |
3927 u underline (termcap entry "us" and "ue") | |
205 | 3928 c undercurl (termcap entry "Cs" and "Ce") |
12317
2a8890b80923
patch 8.0.1038: strike-through text not supported
Christian Brabandt <cb@256bit.org>
parents:
12293
diff
changeset
|
3929 t strikethrough (termcap entry "Ts" and "Te") |
7 | 3930 n no highlighting |
3931 - no highlighting | |
3932 : use a highlight group | |
3933 The default is used for occasions that are not included. | |
3934 If you want to change what the display modes do, see |dos-colors| | |
3935 for an example. | |
3936 When using the ':' display mode, this must be followed by the name of | |
3937 a highlight group. A highlight group can be used to define any type | |
3938 of highlighting, including using color. See |:highlight| on how to | |
3939 define one. The default uses a different group for each occasion. | |
3940 See |highlight-default| for the default highlight groups. | |
3941 | |
3942 *'history'* *'hi'* | |
9669
284b4eb307fc
commit https://github.com/vim/vim/commit/8c08b5b569e2a9e9f63dea514591ecfa2d3bb392
Christian Brabandt <cb@256bit.org>
parents:
9665
diff
changeset
|
3943 '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
|
3944 set to 200 in |defaults.vim|) |
7 | 3945 global |
3946 A history of ":" commands, and a history of previous search patterns | |
5991 | 3947 is remembered. This option decides how many entries may be stored in |
7 | 3948 each of these histories (see |cmdline-editing|). |
5991 | 3949 The maximum value is 10000. |
7 | 3950 NOTE: This option is set to the Vi default value when 'compatible' is |
3951 set and to the Vim default value when 'compatible' is reset. | |
3952 | |
3953 *'hkmap'* *'hk'* *'nohkmap'* *'nohk'* | |
3954 'hkmap' 'hk' boolean (default off) | |
3955 global | |
3956 {only available when compiled with the |+rightleft| | |
3957 feature} | |
3958 When on, the keyboard is mapped for the Hebrew character set. | |
3959 Normally you would set 'allowrevins' and use CTRL-_ in insert mode to | |
3960 toggle this option. See |rileft.txt|. | |
3961 NOTE: This option is reset when 'compatible' is set. | |
3962 | |
3963 *'hkmapp'* *'hkp'* *'nohkmapp'* *'nohkp'* | |
3964 'hkmapp' 'hkp' boolean (default off) | |
3965 global | |
3966 {only available when compiled with the |+rightleft| | |
3967 feature} | |
3968 When on, phonetic keyboard mapping is used. 'hkmap' must also be on. | |
3969 This is useful if you have a non-Hebrew keyboard. | |
3970 See |rileft.txt|. | |
3971 NOTE: This option is reset when 'compatible' is set. | |
3972 | |
11160 | 3973 *'hlsearch'* *'hls'* *'nohlsearch'* *'nohls'* |
3974 'hlsearch' 'hls' boolean (default off) | |
3975 global | |
3976 {not available when compiled without the | |
3977 |+extra_search| feature} | |
3978 When there is a previous search pattern, highlight all its matches. | |
3979 The type of highlighting used can be set with the 'l' occasion in the | |
3980 'highlight' option. This uses the "Search" highlight group by | |
3981 default. Note that only the matching text is highlighted, any offsets | |
3982 are not applied. | |
3983 See also: 'incsearch' and |:match|. | |
3984 When you get bored looking at the highlighted matches, you can turn it | |
3985 off with |:nohlsearch|. This does not change the option value, as | |
3986 soon as you use a search command, the highlighting comes back. | |
3987 'redrawtime' specifies the maximum time spent on finding matches. | |
3988 When the search pattern can match an end-of-line, Vim will try to | |
3989 highlight all of the matched text. However, this depends on where the | |
3990 search starts. This will be the first line in the window or the first | |
3991 line below a closed fold. A match in a previous line which is not | |
3992 drawn may not continue in a newly drawn line. | |
3993 You can specify whether the highlight status is restored on startup | |
3994 with the 'h' flag in 'viminfo' |viminfo-h|. | |
3995 NOTE: This option is reset when 'compatible' is set. | |
3996 | |
7 | 3997 *'icon'* *'noicon'* |
3998 'icon' boolean (default off, on when title can be restored) | |
3999 global | |
4000 {not available when compiled without the |+title| | |
4001 feature} | |
4002 When on, the icon text of the window will be set to the value of | |
4003 'iconstring' (if it is not empty), or to the name of the file | |
4004 currently being edited. Only the last part of the name is used. | |
4005 Overridden by the 'iconstring' option. | |
4006 Only works if the terminal supports setting window icons (currently | |
4007 only X11 GUI and terminals with a non-empty 't_IS' option - these are | |
4008 Unix xterm and iris-ansi by default, where 't_IS' is taken from the | |
4009 builtin termcap). | |
4010 When Vim was compiled with HAVE_X11 defined, the original icon will be | |
233 | 4011 restored if possible |X11|. See |X11-icon| for changing the icon on |
7 | 4012 X11. |
6259 | 4013 For MS-Windows the icon can be changed, see |windows-icon|. |
7 | 4014 |
4015 *'iconstring'* | |
4016 'iconstring' string (default "") | |
4017 global | |
4018 {not available when compiled without the |+title| | |
4019 feature} | |
4020 When this option is not empty, it will be used for the icon text of | |
4021 the window. This happens only when the 'icon' option is on. | |
4022 Only works if the terminal supports setting window icon text | |
4023 (currently only X11 GUI and terminals with a non-empty 't_IS' option). | |
4024 Does not work for MS Windows. | |
4025 When Vim was compiled with HAVE_X11 defined, the original icon will be | |
4026 restored if possible |X11|. | |
4027 When this option contains printf-style '%' items, they will be | |
10 | 4028 expanded according to the rules used for 'statusline'. See |
7 | 4029 'titlestring' for example settings. |
4030 {not available when compiled without the |+statusline| feature} | |
4031 | |
4032 *'ignorecase'* *'ic'* *'noignorecase'* *'noic'* | |
4033 'ignorecase' 'ic' boolean (default off) | |
4034 global | |
4035 Ignore case in search patterns. Also used when searching in the tags | |
4036 file. | |
7266
6ba7182fb7bd
commit https://github.com/vim/vim/commit/0f6562e9036f889185dff49a75c7fc5ffb28b307
Christian Brabandt <cb@256bit.org>
parents:
7245
diff
changeset
|
4037 Also see 'smartcase' and 'tagcase'. |
7 | 4038 Can be overruled by using "\c" or "\C" in the pattern, see |
4039 |/ignorecase|. | |
4040 | |
5008
3717d569027d
updated for version 7.3.1248
Bram Moolenaar <bram@vim.org>
parents:
4869
diff
changeset
|
4041 *'imactivatefunc'* *'imaf'* |
3717d569027d
updated for version 7.3.1248
Bram Moolenaar <bram@vim.org>
parents:
4869
diff
changeset
|
4042 'imactivatefunc' 'imaf' string (default "") |
3717d569027d
updated for version 7.3.1248
Bram Moolenaar <bram@vim.org>
parents:
4869
diff
changeset
|
4043 global |
3717d569027d
updated for version 7.3.1248
Bram Moolenaar <bram@vim.org>
parents:
4869
diff
changeset
|
4044 This option specifies a function that will be called to |
12936
c53a80f39a52
patch 8.0.1344: using 'imactivatefunc' in the GUI does not work
Christian Brabandt <cb@256bit.org>
parents:
12934
diff
changeset
|
4045 activate or deactivate the Input Method. |
c53a80f39a52
patch 8.0.1344: using 'imactivatefunc' in the GUI does not work
Christian Brabandt <cb@256bit.org>
parents:
12934
diff
changeset
|
4046 It is not used in the GUI. |
5008
3717d569027d
updated for version 7.3.1248
Bram Moolenaar <bram@vim.org>
parents:
4869
diff
changeset
|
4047 |
3717d569027d
updated for version 7.3.1248
Bram Moolenaar <bram@vim.org>
parents:
4869
diff
changeset
|
4048 Example: > |
3717d569027d
updated for version 7.3.1248
Bram Moolenaar <bram@vim.org>
parents:
4869
diff
changeset
|
4049 function ImActivateFunc(active) |
3717d569027d
updated for version 7.3.1248
Bram Moolenaar <bram@vim.org>
parents:
4869
diff
changeset
|
4050 if a:active |
3717d569027d
updated for version 7.3.1248
Bram Moolenaar <bram@vim.org>
parents:
4869
diff
changeset
|
4051 ... do something |
3717d569027d
updated for version 7.3.1248
Bram Moolenaar <bram@vim.org>
parents:
4869
diff
changeset
|
4052 else |
3717d569027d
updated for version 7.3.1248
Bram Moolenaar <bram@vim.org>
parents:
4869
diff
changeset
|
4053 ... do something |
3717d569027d
updated for version 7.3.1248
Bram Moolenaar <bram@vim.org>
parents:
4869
diff
changeset
|
4054 endif |
3717d569027d
updated for version 7.3.1248
Bram Moolenaar <bram@vim.org>
parents:
4869
diff
changeset
|
4055 " return value is not used |
3717d569027d
updated for version 7.3.1248
Bram Moolenaar <bram@vim.org>
parents:
4869
diff
changeset
|
4056 endfunction |
3717d569027d
updated for version 7.3.1248
Bram Moolenaar <bram@vim.org>
parents:
4869
diff
changeset
|
4057 set imactivatefunc=ImActivateFunc |
3717d569027d
updated for version 7.3.1248
Bram Moolenaar <bram@vim.org>
parents:
4869
diff
changeset
|
4058 < |
7 | 4059 *'imactivatekey'* *'imak'* |
4060 'imactivatekey' 'imak' string (default "") | |
4061 global | |
4062 {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
|
4063 |+GUI_GTK|} *E599* |
7 | 4064 Specifies the key that your Input Method in X-Windows uses for |
4065 activation. When this is specified correctly, vim can fully control | |
4066 IM with 'imcmdline', 'iminsert' and 'imsearch'. | |
4067 You can't use this option to change the activation key, the option | |
4068 tells Vim what the key is. | |
4069 Format: | |
4070 [MODIFIER_FLAG-]KEY_STRING | |
4071 | |
4072 These characters can be used for MODIFIER_FLAG (case is ignored): | |
4073 S Shift key | |
4074 L Lock key | |
4075 C Control key | |
4076 1 Mod1 key | |
4077 2 Mod2 key | |
4078 3 Mod3 key | |
4079 4 Mod4 key | |
4080 5 Mod5 key | |
4081 Combinations are allowed, for example "S-C-space" or "SC-space" are | |
4082 both shift+ctrl+space. | |
4083 See <X11/keysymdef.h> and XStringToKeysym for KEY_STRING. | |
4084 | |
4085 Example: > | |
4086 :set imactivatekey=S-space | |
4087 < "S-space" means shift+space. This is the activation key for kinput2 + | |
4088 canna (Japanese), and ami (Korean). | |
4089 | |
4090 *'imcmdline'* *'imc'* *'noimcmdline'* *'noimc'* | |
4091 'imcmdline' 'imc' boolean (default off) | |
4092 global | |
4093 When set the Input Method is always on when starting to edit a command | |
4094 line, unless entering a search pattern (see 'imsearch' for that). | |
4095 Setting this option is useful when your input method allows entering | |
4096 English characters directly, e.g., when it's used to type accented | |
4097 characters with dead keys. | |
4098 | |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
4099 *'imdisable'* *'imd'* *'noimdisable'* *'noimd'* |
7 | 4100 'imdisable' 'imd' boolean (default off, on for some systems (SGI)) |
4101 global | |
4102 When set the Input Method is never used. This is useful to disable | |
4103 the IM when it doesn't work properly. | |
4104 Currently this option is on by default for SGI/IRIX machines. This | |
4105 may change in later releases. | |
4106 | |
4107 *'iminsert'* *'imi'* | |
12469
61d910f0999d
patch 8.0.1114: default for 'iminsert' is annoying
Christian Brabandt <cb@256bit.org>
parents:
12317
diff
changeset
|
4108 'iminsert' 'imi' number (default 0) |
7 | 4109 local to buffer |
4110 Specifies whether :lmap or an Input Method (IM) is to be used in | |
4111 Insert mode. Valid values: | |
4112 0 :lmap is off and IM is off | |
4113 1 :lmap is ON and IM is off | |
4114 2 :lmap is off and IM is ON | |
4115 To always reset the option to zero when leaving Insert mode with <Esc> | |
4116 this can be used: > | |
4117 :inoremap <ESC> <ESC>:set iminsert=0<CR> | |
4118 < This makes :lmap and IM turn off automatically when leaving Insert | |
4119 mode. | |
4120 Note that this option changes when using CTRL-^ in Insert mode | |
4121 |i_CTRL-^|. | |
4122 The value is set to 1 when setting 'keymap' to a valid keymap name. | |
4123 It is also used for the argument of commands like "r" and "f". | |
4124 The value 0 may not work correctly with Athena and Motif with some XIM | |
4125 methods. Use 'imdisable' to disable XIM then. | |
4126 | |
12920
327e1264b9bf
patch 8.0.1336: cannot use imactivatefunc() unless compiled with +xim
Christian Brabandt <cb@256bit.org>
parents:
12865
diff
changeset
|
4127 You can set 'imactivatefunc' and 'imstatusfunc' to handle IME/XIM |
14519 | 4128 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
|
4129 |+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
|
4130 |
7 | 4131 *'imsearch'* *'ims'* |
12469
61d910f0999d
patch 8.0.1114: default for 'iminsert' is annoying
Christian Brabandt <cb@256bit.org>
parents:
12317
diff
changeset
|
4132 'imsearch' 'ims' number (default -1) |
7 | 4133 local to buffer |
4134 Specifies whether :lmap or an Input Method (IM) is to be used when | |
4135 entering a search pattern. Valid values: | |
4136 -1 the value of 'iminsert' is used, makes it look like | |
4137 'iminsert' is also used when typing a search pattern | |
4138 0 :lmap is off and IM is off | |
4139 1 :lmap is ON and IM is off | |
4140 2 :lmap is off and IM is ON | |
4141 Note that this option changes when using CTRL-^ in Command-line mode | |
4142 |c_CTRL-^|. | |
4143 The value is set to 1 when it is not -1 and setting the 'keymap' | |
4144 option to a valid keymap name. | |
4145 The value 0 may not work correctly with Athena and Motif with some XIM | |
4146 methods. Use 'imdisable' to disable XIM then. | |
4147 | |
5008
3717d569027d
updated for version 7.3.1248
Bram Moolenaar <bram@vim.org>
parents:
4869
diff
changeset
|
4148 *'imstatusfunc'* *'imsf'* |
3717d569027d
updated for version 7.3.1248
Bram Moolenaar <bram@vim.org>
parents:
4869
diff
changeset
|
4149 'imstatusfunc' 'imsf' string (default "") |
3717d569027d
updated for version 7.3.1248
Bram Moolenaar <bram@vim.org>
parents:
4869
diff
changeset
|
4150 global |
3717d569027d
updated for version 7.3.1248
Bram Moolenaar <bram@vim.org>
parents:
4869
diff
changeset
|
4151 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
|
4152 of Input Method. It must return a positive number when IME is active. |
12936
c53a80f39a52
patch 8.0.1344: using 'imactivatefunc' in the GUI does not work
Christian Brabandt <cb@256bit.org>
parents:
12934
diff
changeset
|
4153 It is not used in the GUI. |
5008
3717d569027d
updated for version 7.3.1248
Bram Moolenaar <bram@vim.org>
parents:
4869
diff
changeset
|
4154 |
3717d569027d
updated for version 7.3.1248
Bram Moolenaar <bram@vim.org>
parents:
4869
diff
changeset
|
4155 Example: > |
3717d569027d
updated for version 7.3.1248
Bram Moolenaar <bram@vim.org>
parents:
4869
diff
changeset
|
4156 function ImStatusFunc() |
3717d569027d
updated for version 7.3.1248
Bram Moolenaar <bram@vim.org>
parents:
4869
diff
changeset
|
4157 let is_active = ...do something |
3717d569027d
updated for version 7.3.1248
Bram Moolenaar <bram@vim.org>
parents:
4869
diff
changeset
|
4158 return is_active ? 1 : 0 |
3717d569027d
updated for version 7.3.1248
Bram Moolenaar <bram@vim.org>
parents:
4869
diff
changeset
|
4159 endfunction |
3717d569027d
updated for version 7.3.1248
Bram Moolenaar <bram@vim.org>
parents:
4869
diff
changeset
|
4160 set imstatusfunc=ImStatusFunc |
3717d569027d
updated for version 7.3.1248
Bram Moolenaar <bram@vim.org>
parents:
4869
diff
changeset
|
4161 < |
3717d569027d
updated for version 7.3.1248
Bram Moolenaar <bram@vim.org>
parents:
4869
diff
changeset
|
4162 NOTE: This function is invoked very often. Keep it fast. |
3717d569027d
updated for version 7.3.1248
Bram Moolenaar <bram@vim.org>
parents:
4869
diff
changeset
|
4163 |
12293
1ff5e5dfa9b0
patch 8.0.1026: GTK on-the-spot input has problems
Christian Brabandt <cb@256bit.org>
parents:
12254
diff
changeset
|
4164 *'imstyle'* *'imst'* |
1ff5e5dfa9b0
patch 8.0.1026: GTK on-the-spot input has problems
Christian Brabandt <cb@256bit.org>
parents:
12254
diff
changeset
|
4165 '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
|
4166 global |
1ff5e5dfa9b0
patch 8.0.1026: GTK on-the-spot input has problems
Christian Brabandt <cb@256bit.org>
parents:
12254
diff
changeset
|
4167 {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
|
4168 |+GUI_GTK|} |
12499 | 4169 This option specifies the input style of Input Method: |
4170 0 use on-the-spot style | |
4171 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
|
4172 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
|
4173 |
12559 | 4174 For a long time on-the-spot style had been used in the GTK version of |
4175 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
|
4176 |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
|
4177 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
|
4178 have any problem with it, try using on-the-spot style. |
1ff5e5dfa9b0
patch 8.0.1026: GTK on-the-spot input has problems
Christian Brabandt <cb@256bit.org>
parents:
12254
diff
changeset
|
4179 |
7 | 4180 *'include'* *'inc'* |
4181 'include' 'inc' string (default "^\s*#\s*include") | |
4182 global or local to buffer |global-local| | |
4183 {not available when compiled without the | |
4184 |+find_in_path| feature} | |
10 | 4185 Pattern to be used to find an include command. It is a search |
7 | 4186 pattern, just like for the "/" command (See |pattern|). The default |
4187 value is for C programs. This option is used for the commands "[i", | |
532 | 4188 "]I", "[d", etc. |
4189 Normally the 'isfname' option is used to recognize the file name that | |
534 | 4190 comes after the matched pattern. But if "\zs" appears in the pattern |
4191 then the text matched from "\zs" to the end, or until "\ze" if it | |
4192 appears, is used as the file name. Use this to include characters | |
4193 that are not in 'isfname', such as a space. You can then use | |
4194 'includeexpr' to process the matched text. | |
532 | 4195 See |option-backslash| about including spaces and backslashes. |
7 | 4196 |
4197 *'includeexpr'* *'inex'* | |
4198 'includeexpr' 'inex' string (default "") | |
4199 local to buffer | |
4200 {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
|
4201 |+find_in_path| or |+eval| features} |
7 | 4202 Expression to be used to transform the string found with the 'include' |
10 | 4203 option to a file name. Mostly useful to change "." to "/" for Java: > |
7 | 4204 :set includeexpr=substitute(v:fname,'\\.','/','g') |
4205 < The "v:fname" variable will be set to the file name that was detected. | |
634 | 4206 |
7 | 4207 Also used for the |gf| command if an unmodified file name can't be |
10 | 4208 found. Allows doing "gf" on the name after an 'include' statement. |
7 | 4209 Also used for |<cfile>|. |
4210 | |
3682 | 4211 The expression will be evaluated in the |sandbox| when set from a |
4212 modeline, see |sandbox-option|. | |
634 | 4213 |
4214 It is not allowed to change text or jump to another window while | |
4215 evaluating 'includeexpr' |textlock|. | |
4216 | |
7 | 4217 *'incsearch'* *'is'* *'noincsearch'* *'nois'* |
9669
284b4eb307fc
commit https://github.com/vim/vim/commit/8c08b5b569e2a9e9f63dea514591ecfa2d3bb392
Christian Brabandt <cb@256bit.org>
parents:
9665
diff
changeset
|
4218 'incsearch' 'is' boolean (default off, set in |defaults.vim| if the |
284b4eb307fc
commit https://github.com/vim/vim/commit/8c08b5b569e2a9e9f63dea514591ecfa2d3bb392
Christian Brabandt <cb@256bit.org>
parents:
9665
diff
changeset
|
4219 +reltime feature is supported) |
7 | 4220 global |
4221 {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
|
4222 |+extra_search| features} |
17 | 4223 While typing a search command, show where the pattern, as it was typed |
4224 so far, matches. The matched string is highlighted. If the pattern | |
4225 is invalid or not found, nothing is shown. The screen will be updated | |
4226 often, this is only useful on fast terminals. | |
14637 | 4227 Also applies to the pattern in commands: > |
4228 :global | |
4229 :lvimgrep | |
4230 :lvimgrepadd | |
4231 :smagic | |
4232 :snomagic | |
4233 :sort | |
4234 :substitute | |
4235 :vglobal | |
4236 :vimgrep | |
4237 :vimgrepadd | |
4238 < Note that the match will be shown, but the cursor will return to its | |
17 | 4239 original position when no match is found and when pressing <Esc>. You |
4240 still need to finish the search command with <Enter> to move the | |
4241 cursor to the match. | |
10261
bdd7fc1a38c0
commit https://github.com/vim/vim/commit/dc08328821a2c11e33dfb1980332e4923ec64fca
Christian Brabandt <cb@256bit.org>
parents:
10244
diff
changeset
|
4242 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
|
4243 previous match. |c_CTRL-G| |c_CTRL-T| |
1521 | 4244 When compiled with the |+reltime| feature Vim only searches for about |
4245 half a second. With a complicated pattern and/or a lot of text the | |
4246 match may not be found. This is to avoid that Vim hangs while you | |
4247 are typing the pattern. | |
17 | 4248 The highlighting can be set with the 'i' flag in 'highlight'. |
12968 | 4249 When 'hlsearch' is on, all matched strings are highlighted too while |
4250 typing a search command. See also: 'hlsearch'. | |
14519 | 4251 If you don't want to turn 'hlsearch' on, but want to highlight all |
4252 matches while searching, you can turn on and off 'hlsearch' with | |
4253 autocmd. Example: > | |
12720
37c384802df4
patch 8.0.1238: incremental search only shows one match
Christian Brabandt <cb@256bit.org>
parents:
12608
diff
changeset
|
4254 augroup vimrc-incsearch-highlight |
37c384802df4
patch 8.0.1238: incremental search only shows one match
Christian Brabandt <cb@256bit.org>
parents:
12608
diff
changeset
|
4255 autocmd! |
12744
0c704288ced4
patch 8.0.1250: 'hlsearch' highlighting not removed after incsearch
Christian Brabandt <cb@256bit.org>
parents:
12720
diff
changeset
|
4256 autocmd CmdlineEnter /,\? :set hlsearch |
0c704288ced4
patch 8.0.1250: 'hlsearch' highlighting not removed after incsearch
Christian Brabandt <cb@256bit.org>
parents:
12720
diff
changeset
|
4257 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
|
4258 augroup END |
37c384802df4
patch 8.0.1238: incremental search only shows one match
Christian Brabandt <cb@256bit.org>
parents:
12608
diff
changeset
|
4259 < |
772 | 4260 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
|
4261 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
|
4262 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
|
4263 converted to lowercase. |
772 | 4264 CTRL-R CTRL-W can be used to add the word at the end of the current |
4265 match, excluding the characters that were already typed. | |
7 | 4266 NOTE: This option is reset when 'compatible' is set. |
4267 | |
4268 *'indentexpr'* *'inde'* | |
4269 'indentexpr' 'inde' string (default "") | |
4270 local to buffer | |
4271 {not available when compiled without the |+cindent| | |
4272 or |+eval| features} | |
4273 Expression which is evaluated to obtain the proper indent for a line. | |
4274 It is used when a new line is created, for the |=| operator and | |
4275 in Insert mode as specified with the 'indentkeys' option. | |
4276 When this option is not empty, it overrules the 'cindent' and | |
2833 | 4277 'smartindent' indenting. When 'lisp' is set, this option is |
4278 overridden by the Lisp indentation algorithm. | |
7 | 4279 When 'paste' is set this option is not used for indenting. |
4280 The expression is evaluated with |v:lnum| set to the line number for | |
534 | 4281 which the indent is to be computed. The cursor is also in this line |
7 | 4282 when the expression is evaluated (but it may be moved around). |
4283 The expression must return the number of spaces worth of indent. It | |
4284 can return "-1" to keep the current indent (this means 'autoindent' is | |
4285 used for the indent). | |
4286 Functions useful for computing the indent are |indent()|, |cindent()| | |
4287 and |lispindent()|. | |
4288 The evaluation of the expression must not have side effects! It must | |
4289 not change the text, jump to another window, etc. Afterwards the | |
4290 cursor position is always restored, thus the cursor may be moved. | |
4291 Normally this option would be set to call a function: > | |
4292 :set indentexpr=GetMyIndent() | |
4293 < Error messages will be suppressed, unless the 'debug' option contains | |
4294 "msg". | |
634 | 4295 See |indent-expression|. |
11160 | 4296 NOTE: This option is set to "" when 'compatible' is set. |
7 | 4297 |
3682 | 4298 The expression will be evaluated in the |sandbox| when set from a |
4299 modeline, see |sandbox-option|. | |
634 | 4300 |
4301 It is not allowed to change text or jump to another window while | |
4302 evaluating 'indentexpr' |textlock|. | |
4303 | |
4304 | |
7 | 4305 *'indentkeys'* *'indk'* |
15701
9cd11f6beb70
patch 8.1.0858: 'indentkeys' and 'cinkeys' defaults are different
Bram Moolenaar <Bram@vim.org>
parents:
15512
diff
changeset
|
4306 'indentkeys' 'indk' string (default "0{,0},0),0],:,0#,!^F,o,O,e") |
7 | 4307 local to buffer |
4308 {not available when compiled without the |+cindent| | |
4309 feature} | |
4310 A list of keys that, when typed in Insert mode, cause reindenting of | |
4311 the current line. Only happens if 'indentexpr' isn't empty. | |
4312 The format is identical to 'cinkeys', see |indentkeys-format|. | |
4313 See |C-indenting| and |indent-expression|. | |
4314 | |
4315 *'infercase'* *'inf'* *'noinfercase'* *'noinf'* | |
4316 'infercase' 'inf' boolean (default off) | |
4317 local to buffer | |
4318 When doing keyword completion in insert mode |ins-completion|, and | |
1621 | 4319 'ignorecase' is also on, the case of the match is adjusted depending |
4320 on the typed text. If the typed text contains a lowercase letter | |
4321 where the match has an upper case letter, the completed part is made | |
4322 lowercase. If the typed text has no lowercase letters and the match | |
4323 has a lowercase letter where the typed text has an uppercase letter, | |
4324 and there is a letter before it, the completed part is made uppercase. | |
4325 With 'noinfercase' the match is used as-is. | |
7 | 4326 |
4327 *'insertmode'* *'im'* *'noinsertmode'* *'noim'* | |
4328 'insertmode' 'im' boolean (default off) | |
4329 global | |
4330 Makes Vim work in a way that Insert mode is the default mode. Useful | |
4331 if you want to use Vim as a modeless editor. Used for |evim|. | |
4332 These Insert mode commands will be useful: | |
4333 - 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
|
4334 - Use CTRL-O to execute one Normal mode command |i_CTRL-O|. When |
7 | 4335 this is a mapping, it is executed as if 'insertmode' was off. |
4336 Normal mode remains active until the mapping is finished. | |
4337 - Use CTRL-L to execute a number of Normal mode commands, then use | |
477 | 4338 <Esc> to get back to Insert mode. Note that CTRL-L moves the cursor |
4339 left, like <Esc> does when 'insertmode' isn't set. |i_CTRL-L| | |
7 | 4340 |
4341 These items change when 'insertmode' is set: | |
4342 - when starting to edit of a file, Vim goes to Insert mode. | |
4343 - <Esc> in Insert mode is a no-op and beeps. | |
4344 - <Esc> in Normal mode makes Vim go to Insert mode. | |
4345 - CTRL-L in Insert mode is a command, it is not inserted. | |
4346 - CTRL-Z in Insert mode suspends Vim, see |CTRL-Z|. *i_CTRL-Z* | |
4347 However, when <Esc> is used inside a mapping, it behaves like | |
4348 'insertmode' was not set. This was done to be able to use the same | |
4349 mappings with 'insertmode' set or not set. | |
4350 When executing commands with |:normal| 'insertmode' is not used. | |
4351 | |
4352 NOTE: This option is reset when 'compatible' is set. | |
4353 | |
4354 *'isfname'* *'isf'* | |
4355 'isfname' 'isf' string (default for MS-DOS, Win32 and OS/2: | |
4356 "@,48-57,/,\,.,-,_,+,,,#,$,%,{,},[,],:,@-@,!,~,=" | |
4357 for AMIGA: "@,48-57,/,.,-,_,+,,,$,:" | |
4358 for VMS: "@,48-57,/,.,-,_,+,,,#,$,%,<,>,[,],:,;,~" | |
4359 for OS/390: "@,240-249,/,.,-,_,+,,,#,$,%,~,=" | |
4360 otherwise: "@,48-57,/,.,-,_,+,,,#,$,%,~,=") | |
4361 global | |
4362 The characters specified by this option are included in file names and | |
4363 path names. Filenames are used for commands like "gf", "[i" and in | |
10 | 4364 the tags file. It is also used for "\f" in a |pattern|. |
7 | 4365 Multi-byte characters 256 and above are always included, only the |
4366 characters up to 255 are specified with this option. | |
4367 For UTF-8 the characters 0xa0 to 0xff are included as well. | |
1621 | 4368 Think twice before adding white space to this option. Although a |
4369 space may appear inside a file name, the effect will be that Vim | |
4370 doesn't know where a file name starts or ends when doing completion. | |
4371 It most likely works better without a space in 'isfname'. | |
7 | 4372 |
4373 Note that on systems using a backslash as path separator, Vim tries to | |
4374 do its best to make it work as you would expect. That is a bit | |
4375 tricky, since Vi originally used the backslash to escape special | |
4376 characters. Vim will not remove a backslash in front of a normal file | |
4377 name character on these systems, but it will on Unix and alikes. The | |
4378 '&' and '^' are not included by default, because these are special for | |
4379 cmd.exe. | |
4380 | |
4381 The format of this option is a list of parts, separated with commas. | |
10 | 4382 Each part can be a single character number or a range. A range is two |
4383 character numbers with '-' in between. A character number can be a | |
7 | 4384 decimal number between 0 and 255 or the ASCII character itself (does |
4385 not work for digits). Example: | |
4386 "_,-,128-140,#-43" (include '_' and '-' and the range | |
4387 128 to 140 and '#' to 43) | |
4388 If a part starts with '^', the following character number or range | |
4389 will be excluded from the option. The option is interpreted from left | |
4390 to right. Put the excluded character after the range where it is | |
4391 included. To include '^' itself use it as the last character of the | |
4392 option or the end of a range. Example: | |
4393 "^a-z,#,^" (exclude 'a' to 'z', include '#' and '^') | |
4394 If the character is '@', all characters where isalpha() returns TRUE | |
4395 are included. Normally these are the characters a to z and A to Z, | |
4396 plus accented characters. To include '@' itself use "@-@". Examples: | |
4397 "@,^a-z" All alphabetic characters, excluding lower | |
1621 | 4398 case ASCII letters. |
7 | 4399 "a-z,A-Z,@-@" All letters plus the '@' character. |
4400 A comma can be included by using it where a character number is | |
4401 expected. Example: | |
4402 "48-57,,,_" Digits, comma and underscore. | |
4403 A comma can be excluded by prepending a '^'. Example: | |
4404 " -~,^,,9" All characters from space to '~', excluding | |
4405 comma, plus <Tab>. | |
4406 See |option-backslash| about including spaces and backslashes. | |
4407 | |
4408 *'isident'* *'isi'* | |
4409 'isident' 'isi' string (default for MS-DOS, Win32 and OS/2: | |
4410 "@,48-57,_,128-167,224-235" | |
4411 otherwise: "@,48-57,_,192-255") | |
4412 global | |
4413 The characters given by this option are included in identifiers. | |
4414 Identifiers are used in recognizing environment variables and after a | |
4415 match of the 'define' option. It is also used for "\i" in a | |
233 | 4416 |pattern|. See 'isfname' for a description of the format of this |
14864 | 4417 option. For '@' only characters up to 255 are used. |
7 | 4418 Careful: If you change this option, it might break expanding |
10 | 4419 environment variables. E.g., when '/' is included and Vim tries to |
7 | 4420 expand "$HOME/.viminfo". Maybe you should change 'iskeyword' instead. |
4421 | |
4422 *'iskeyword'* *'isk'* | |
4423 'iskeyword' 'isk' string (Vim default for MS-DOS and Win32: | |
4424 "@,48-57,_,128-167,224-235" | |
4425 otherwise: "@,48-57,_,192-255" | |
4426 Vi default: "@,48-57,_") | |
4427 local to buffer | |
4428 Keywords are used in searching and recognizing with many commands: | |
10 | 4429 "w", "*", "[i", etc. It is also used for "\k" in a |pattern|. See |
14864 | 4430 'isfname' for a description of the format of this option. For '@' |
4431 characters above 255 check the "word" character class. | |
4432 For C programs you could use "a-z,A-Z,48-57,_,.,-,>". | |
7 | 4433 For a help file it is set to all non-blank printable characters except |
4434 '*', '"' and '|' (so that CTRL-] on a command finds the help for that | |
4435 command). | |
4436 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
|
4437 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
|
4438 uses |:syn-iskeyword|. |
7 | 4439 NOTE: This option is set to the Vi default value when 'compatible' is |
4440 set and to the Vim default value when 'compatible' is reset. | |
4441 | |
4442 *'isprint'* *'isp'* | |
4443 'isprint' 'isp' string (default for MS-DOS, Win32, OS/2 and Macintosh: | |
4444 "@,~-255"; otherwise: "@,161-255") | |
4445 global | |
4446 The characters given by this option are displayed directly on the | |
4447 screen. It is also used for "\p" in a |pattern|. The characters from | |
4448 space (ASCII 32) to '~' (ASCII 126) are always displayed directly, | |
4449 even when they are not included in 'isprint' or excluded. See | |
4450 'isfname' for a description of the format of this option. | |
4451 | |
4452 Non-printable characters are displayed with two characters: | |
4453 0 - 31 "^@" - "^_" | |
4454 32 - 126 always single characters | |
4455 127 "^?" | |
4456 128 - 159 "~@" - "~_" | |
4457 160 - 254 "| " - "|~" | |
4458 255 "~?" | |
4459 When 'encoding' is a Unicode one, illegal bytes from 128 to 255 are | |
4460 displayed as <xx>, with the hexadecimal value of the byte. | |
4461 When 'display' contains "uhex" all unprintable characters are | |
4462 displayed as <xx>. | |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
4463 The SpecialKey highlighting will be used for unprintable characters. |
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
4464 |hl-SpecialKey| |
7 | 4465 |
4466 Multi-byte characters 256 and above are always included, only the | |
4467 characters up to 255 are specified with this option. When a character | |
4468 is printable but it is not available in the current font, a | |
4469 replacement character will be shown. | |
4470 Unprintable and zero-width Unicode characters are displayed as <xxxx>. | |
4471 There is no option to specify these characters. | |
4472 | |
4473 *'joinspaces'* *'js'* *'nojoinspaces'* *'nojs'* | |
4474 'joinspaces' 'js' boolean (default on) | |
4475 global | |
4476 Insert two spaces after a '.', '?' and '!' with a join command. | |
4477 When 'cpoptions' includes the 'j' flag, only do this after a '.'. | |
4478 Otherwise only one space is inserted. | |
4479 NOTE: This option is set when 'compatible' is set. | |
4480 | |
4481 *'key'* | |
4482 'key' string (default "") | |
4483 local to buffer | |
2283
7e1bd501306d
Mainly documentation updates.
Bram Moolenaar <bram@vim.org>
parents:
2265
diff
changeset
|
4484 {only available when compiled with the |+cryptv| |
7e1bd501306d
Mainly documentation updates.
Bram Moolenaar <bram@vim.org>
parents:
2265
diff
changeset
|
4485 feature} |
7 | 4486 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
|
4487 See |encryption| and 'cryptmethod'. |
7 | 4488 Careful: Do not set the key value by hand, someone might see the typed |
4489 key. Use the |:X| command. But you can make 'key' empty: > | |
4490 :set key= | |
4491 < It is not possible to get the value of this option with ":set key" or | |
4492 "echo &key". This is to avoid showing it to someone who shouldn't | |
4493 know. It also means you cannot see it yourself once you have set it, | |
4494 be careful not to make a typing error! | |
2698
b6471224d2af
Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents:
2681
diff
changeset
|
4495 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
|
4496 enabled. When 'key' is set it returns "*****" (five stars). |
7 | 4497 |
4498 *'keymap'* *'kmp'* *E544* | |
4499 'keymap' 'kmp' string (default "") | |
4500 local to buffer | |
4501 {only available when compiled with the |+keymap| | |
4502 feature} | |
4503 Name of a keyboard mapping. See |mbyte-keymap|. | |
4504 Setting this option to a valid keymap name has the side effect of | |
4505 setting 'iminsert' to one, so that the keymap becomes effective. | |
4506 'imsearch' is also set to one, unless it was -1 | |
36 | 4507 Only normal file name characters can be used, "/\*?[|<>" are illegal. |
7 | 4508 |
4509 *'keymodel'* *'km'* | |
4510 'keymodel' 'km' string (default "") | |
4511 global | |
4512 List of comma separated words, which enable special things that keys | |
4513 can do. These values can be used: | |
4514 startsel Using a shifted special key starts selection (either | |
4515 Select mode or Visual mode, depending on "key" being | |
4516 present in 'selectmode'). | |
4517 stopsel Using a not-shifted special key stops selection. | |
4518 Special keys in this context are the cursor keys, <End>, <Home>, | |
4519 <PageUp> and <PageDown>. | |
4520 The 'keymodel' option is set by the |:behave| command. | |
4521 | |
4522 *'keywordprg'* *'kp'* | |
4523 '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
|
4524 VMS: "help") |
7 | 4525 global or local to buffer |global-local| |
4526 Program to use for the |K| command. Environment variables are | |
4527 expanded |:set_env|. ":help" may be used to access the Vim internal | |
4528 help. (Note that previously setting the global option to the empty | |
4529 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
|
4530 When the first character is ":", the command is invoked as a Vim |
0d52ddff8db4
commit https://github.com/vim/vim/commit/2ff8b64679242e73248774a388d54931c9ce49bd
Christian Brabandt <cb@256bit.org>
parents:
9097
diff
changeset
|
4531 Ex command prefixed with [count]. |
0d52ddff8db4
commit https://github.com/vim/vim/commit/2ff8b64679242e73248774a388d54931c9ce49bd
Christian Brabandt <cb@256bit.org>
parents:
9097
diff
changeset
|
4532 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
|
4533 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
|
4534 argument. For "man -s" the "-s" is removed when there is no count. |
7 | 4535 See |option-backslash| about including spaces and backslashes. |
4536 Example: > | |
4537 :set keywordprg=man\ -s | |
4538 < This option cannot be set from a |modeline| or in the |sandbox|, for | |
4539 security reasons. | |
4540 | |
4541 *'langmap'* *'lmap'* *E357* *E358* | |
4542 'langmap' 'lmap' string (default "") | |
4543 global | |
4544 {only available when compiled with the |+langmap| | |
4545 feature} | |
4546 This option allows switching your keyboard into a special language | |
10 | 4547 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
|
4548 inserted directly. When in Normal mode the 'langmap' option takes |
7 | 4549 care of translating these special characters to the original meaning |
4550 of the key. This means you don't have to change the keyboard mode to | |
4551 be able to execute Normal mode commands. | |
4552 This is the opposite of the 'keymap' option, where characters are | |
4553 mapped in Insert mode. | |
9975
03fa8a51e9dc
commit https://github.com/vim/vim/commit/e4a3bcf28d92d0bde9ca227ccb40d401038185e5
Christian Brabandt <cb@256bit.org>
parents:
9913
diff
changeset
|
4554 Also consider resetting 'langremap' to avoid 'langmap' applies to |
6369 | 4555 characters resulting from a mapping. |
5908 | 4556 This option cannot be set from a |modeline| or in the |sandbox|, for |
4557 security reasons. | |
7 | 4558 |
699 | 4559 Example (for Greek, in UTF-8): *greek* > |
4560 :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 | 4561 < Example (exchanges meaning of z and y for commands): > |
4562 :set langmap=zy,yz,ZY,YZ | |
4563 < | |
4564 The 'langmap' option is a list of parts, separated with commas. Each | |
4565 part can be in one of two forms: | |
4566 1. A list of pairs. Each pair is a "from" character immediately | |
4567 followed by the "to" character. Examples: "aA", "aAbBcC". | |
4568 2. A list of "from" characters, a semi-colon and a list of "to" | |
4569 characters. Example: "abc;ABC" | |
4570 Example: "aA,fgh;FGH,cCdDeE" | |
4571 Special characters need to be preceded with a backslash. These are | |
4572 ";", ',' and backslash itself. | |
4573 | |
4574 This will allow you to activate vim actions without having to switch | |
4575 back and forth between the languages. Your language characters will | |
4576 be understood as normal vim English characters (according to the | |
4577 langmap mappings) in the following cases: | |
4578 o Normal/Visual mode (commands, buffer/register names, user mappings) | |
4579 o Insert/Replace Mode: Register names after CTRL-R | |
4580 o Insert/Replace Mode: Mappings | |
4581 Characters entered in Command-line mode will NOT be affected by | |
4582 this option. Note that this option can be changed at any time | |
4583 allowing to switch between mappings for different languages/encodings. | |
4584 Use a mapping to avoid having to type it each time! | |
4585 | |
4586 *'langmenu'* *'lm'* | |
4587 'langmenu' 'lm' string (default "") | |
4588 global | |
4589 {only available when compiled with the |+menu| and | |
4590 |+multi_lang| features} | |
4591 Language to use for menu translation. Tells which file is loaded | |
4592 from the "lang" directory in 'runtimepath': > | |
4593 "lang/menu_" . &langmenu . ".vim" | |
4594 < (without the spaces). For example, to always use the Dutch menus, no | |
4595 matter what $LANG is set to: > | |
4596 :set langmenu=nl_NL.ISO_8859-1 | |
4597 < When 'langmenu' is empty, |v:lang| is used. | |
36 | 4598 Only normal file name characters can be used, "/\*?[|<>" are illegal. |
7 | 4599 If your $LANG is set to a non-English language but you do want to use |
4600 the English menus: > | |
4601 :set langmenu=none | |
4602 < This option must be set before loading menus, switching on filetype | |
4603 detection or syntax highlighting. Once the menus are defined setting | |
4604 this option has no effect. But you could do this: > | |
4605 :source $VIMRUNTIME/delmenu.vim | |
4606 :set langmenu=de_DE.ISO_8859-1 | |
4607 :source $VIMRUNTIME/menu.vim | |
4608 < Warning: This deletes all menus that you defined yourself! | |
4609 | |
7196
42717d048817
commit https://github.com/vim/vim/commit/d94464ee294a351ce7b6ba18e8bd3f24f1bef920
Christian Brabandt <cb@256bit.org>
parents:
7147
diff
changeset
|
4610 *'langnoremap'* *'lnr'* *'nolangnoremap'* *'nolnr'* |
9669
284b4eb307fc
commit https://github.com/vim/vim/commit/8c08b5b569e2a9e9f63dea514591ecfa2d3bb392
Christian Brabandt <cb@256bit.org>
parents:
9665
diff
changeset
|
4611 'langnoremap' 'lnr' boolean (default off, set in |defaults.vim|) |
6339 | 4612 global |
4613 {only available when compiled with the |+langmap| | |
4614 feature} | |
9975
03fa8a51e9dc
commit https://github.com/vim/vim/commit/e4a3bcf28d92d0bde9ca227ccb40d401038185e5
Christian Brabandt <cb@256bit.org>
parents:
9913
diff
changeset
|
4615 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
|
4616 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
|
4617 '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
|
4618 |
03fa8a51e9dc
commit https://github.com/vim/vim/commit/e4a3bcf28d92d0bde9ca227ccb40d401038185e5
Christian Brabandt <cb@256bit.org>
parents:
9913
diff
changeset
|
4619 *'langremap'* *'lrm'* *'nolangremap'* *'nolrm'* |
03fa8a51e9dc
commit https://github.com/vim/vim/commit/e4a3bcf28d92d0bde9ca227ccb40d401038185e5
Christian Brabandt <cb@256bit.org>
parents:
9913
diff
changeset
|
4620 'langremap' 'lrm' boolean (default on, reset in |defaults.vim|) |
03fa8a51e9dc
commit https://github.com/vim/vim/commit/e4a3bcf28d92d0bde9ca227ccb40d401038185e5
Christian Brabandt <cb@256bit.org>
parents:
9913
diff
changeset
|
4621 global |
03fa8a51e9dc
commit https://github.com/vim/vim/commit/e4a3bcf28d92d0bde9ca227ccb40d401038185e5
Christian Brabandt <cb@256bit.org>
parents:
9913
diff
changeset
|
4622 {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
|
4623 feature} |
03fa8a51e9dc
commit https://github.com/vim/vim/commit/e4a3bcf28d92d0bde9ca227ccb40d401038185e5
Christian Brabandt <cb@256bit.org>
parents:
9913
diff
changeset
|
4624 When off, setting 'langmap' does not apply to characters resulting from |
6339 | 4625 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
|
4626 '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
|
4627 This option defaults to on for backwards compatibility. Set it off if |
6339 | 4628 that works for you to avoid mappings to break. |
4629 | |
7 | 4630 *'laststatus'* *'ls'* |
4631 'laststatus' 'ls' number (default 1) | |
4632 global | |
4633 The value of this option influences when the last window will have a | |
4634 status line: | |
4635 0: never | |
4636 1: only if there are at least two windows | |
4637 2: always | |
4638 The screen looks nicer with a status line if you have several | |
4639 windows, but it takes another screen line. |status-line| | |
4640 | |
4641 *'lazyredraw'* *'lz'* *'nolazyredraw'* *'nolz'* | |
4642 'lazyredraw' 'lz' boolean (default off) | |
4643 global | |
4644 When this option is set, the screen will not be redrawn while | |
4645 executing macros, registers and other commands that have not been | |
10 | 4646 typed. Also, updating the window title is postponed. To force an |
7 | 4647 update use |:redraw|. |
4648 | |
4649 *'linebreak'* *'lbr'* *'nolinebreak'* *'nolbr'* | |
4650 'linebreak' 'lbr' boolean (default off) | |
4651 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
|
4652 {not available when compiled without the |+linebreak| |
7 | 4653 feature} |
6009 | 4654 If on, Vim will wrap long lines at a character in 'breakat' rather |
7 | 4655 than at the last character that fits on the screen. Unlike |
4656 'wrapmargin' and 'textwidth', this does not insert <EOL>s in the file, | |
6009 | 4657 it only affects the way the file is displayed, not its contents. |
4658 If 'breakindent' is set, line is visually indented. Then, the value | |
4659 of 'showbreak' is used to put in front of wrapped lines. This option | |
6026 | 4660 is not used when the 'wrap' option is off. |
7 | 4661 Note that <Tab> characters after an <EOL> are mostly not displayed |
4662 with the right amount of white space. | |
4663 | |
4664 *'lines'* *E593* | |
4665 'lines' number (default 24 or terminal height) | |
4666 global | |
4667 Number of lines of the Vim window. | |
4668 Normally you don't need to set this. It is done automatically by the | |
161 | 4669 terminal initialization code. Also see |posix-screen-size|. |
7 | 4670 When Vim is running in the GUI or in a resizable window, setting this |
4671 option will cause the window size to be changed. When you only want | |
4672 to use the size for the GUI, put the command in your |gvimrc| file. | |
4673 Vim limits the number of lines to what fits on the screen. You can | |
4674 use this command to get the tallest window possible: > | |
4675 :set lines=999 | |
571 | 4676 < 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
|
4677 If you get fewer lines than expected, check the 'guiheadroom' option. |
7 | 4678 When you set this option and Vim is unable to change the physical |
4679 number of lines of the display, the display may be messed up. | |
4680 | |
4681 *'linespace'* *'lsp'* | |
4682 'linespace' 'lsp' number (default 0, 1 for Win32 GUI) | |
4683 global | |
4684 {only in the GUI} | |
4685 Number of pixel lines inserted between characters. Useful if the font | |
4686 uses the full character cell height, making lines touch each other. | |
4687 When non-zero there is room for underlining. | |
180 | 4688 With some fonts there can be too much room between lines (to have |
4689 space for ascents and descents). Then it makes sense to set | |
4690 'linespace' to a negative value. This may cause display problems | |
4691 though! | |
7 | 4692 |
4693 *'lisp'* *'nolisp'* | |
4694 'lisp' boolean (default off) | |
4695 local to buffer | |
4696 {not available when compiled without the |+lispindent| | |
4697 feature} | |
4698 Lisp mode: When <Enter> is typed in insert mode set the indent for | |
4699 the next line to Lisp standards (well, sort of). Also happens with | |
4700 "cc" or "S". 'autoindent' must also be on for this to work. The 'p' | |
4701 flag in 'cpoptions' changes the method of indenting: Vi compatible or | |
4702 better. Also see 'lispwords'. | |
4703 The '-' character is included in keyword characters. Redefines the | |
4704 "=" operator to use this same indentation algorithm rather than | |
4705 calling an external program if 'equalprg' is empty. | |
4706 This option is not used when 'paste' is set. | |
4707 | |
4708 *'lispwords'* *'lw'* | |
4709 'lispwords' 'lw' string (default is very long) | |
5712 | 4710 global or local to buffer |global-local| |
7 | 4711 {not available when compiled without the |+lispindent| |
4712 feature} | |
4713 Comma separated list of words that influence the Lisp indenting. | |
4714 |'lisp'| | |
4715 | |
4716 *'list'* *'nolist'* | |
4717 'list' boolean (default off) | |
4718 local to window | |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
4719 List mode: Show tabs as CTRL-I is displayed, display $ after end of |
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
4720 line. Useful to see the difference between tabs and spaces and for |
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
4721 trailing blanks. Further changed by the 'listchars' option. |
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
4722 |
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
4723 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
|
4724 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
|
4725 position while displaying Tabs with spaces, use: > |
5161
f7add3891e95
Updated runtime files. Fix NL translations.
Bram Moolenaar <bram@vim.org>
parents:
5146
diff
changeset
|
4726 :set list lcs=tab:\ \ |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
4727 < |
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
4728 Note that list mode will also affect formatting (set with 'textwidth' |
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
4729 or 'wrapmargin') when 'cpoptions' includes 'L'. See 'listchars' for |
7 | 4730 changing the way tabs are displayed. |
4731 | |
4732 *'listchars'* *'lcs'* | |
4733 'listchars' 'lcs' string (default "eol:$") | |
4734 global | |
2458 | 4735 Strings to use in 'list' mode and for the |:list| command. It is a |
4736 comma separated list of string settings. | |
6777 | 4737 *lcs-eol* |
7 | 4738 eol:c Character to show at the end of each line. When |
4739 omitted, there is no extra character at the end of the | |
4740 line. | |
6777 | 4741 *lcs-tab* |
15502
bc17a9d37810
patch 8.1.0759: showing two characters for tab is limited
Bram Moolenaar <Bram@vim.org>
parents:
15396
diff
changeset
|
4742 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
|
4743 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
|
4744 |
bc17a9d37810
patch 8.1.0759: showing two characters for tab is limited
Bram Moolenaar <Bram@vim.org>
parents:
15396
diff
changeset
|
4745 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
|
4746 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
|
4747 > |
bc17a9d37810
patch 8.1.0759: showing two characters for tab is limited
Bram Moolenaar <Bram@vim.org>
parents:
15396
diff
changeset
|
4748 >- |
bc17a9d37810
patch 8.1.0759: showing two characters for tab is limited
Bram Moolenaar <Bram@vim.org>
parents:
15396
diff
changeset
|
4749 >-- |
bc17a9d37810
patch 8.1.0759: showing two characters for tab is limited
Bram Moolenaar <Bram@vim.org>
parents:
15396
diff
changeset
|
4750 etc. |
bc17a9d37810
patch 8.1.0759: showing two characters for tab is limited
Bram Moolenaar <Bram@vim.org>
parents:
15396
diff
changeset
|
4751 |
bc17a9d37810
patch 8.1.0759: showing two characters for tab is limited
Bram Moolenaar <Bram@vim.org>
parents:
15396
diff
changeset
|
4752 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
|
4753 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
|
4754 "tab:<->" displays: |
bc17a9d37810
patch 8.1.0759: showing two characters for tab is limited
Bram Moolenaar <Bram@vim.org>
parents:
15396
diff
changeset
|
4755 > |
bc17a9d37810
patch 8.1.0759: showing two characters for tab is limited
Bram Moolenaar <Bram@vim.org>
parents:
15396
diff
changeset
|
4756 <> |
bc17a9d37810
patch 8.1.0759: showing two characters for tab is limited
Bram Moolenaar <Bram@vim.org>
parents:
15396
diff
changeset
|
4757 <-> |
bc17a9d37810
patch 8.1.0759: showing two characters for tab is limited
Bram Moolenaar <Bram@vim.org>
parents:
15396
diff
changeset
|
4758 <--> |
bc17a9d37810
patch 8.1.0759: showing two characters for tab is limited
Bram Moolenaar <Bram@vim.org>
parents:
15396
diff
changeset
|
4759 etc. |
bc17a9d37810
patch 8.1.0759: showing two characters for tab is limited
Bram Moolenaar <Bram@vim.org>
parents:
15396
diff
changeset
|
4760 |
bc17a9d37810
patch 8.1.0759: showing two characters for tab is limited
Bram Moolenaar <Bram@vim.org>
parents:
15396
diff
changeset
|
4761 When "tab:" is omitted, a tab is shown as ^I. |
6777 | 4762 *lcs-space* |
4763 space:c Character to show for a space. When omitted, spaces | |
4764 are left blank. | |
4765 *lcs-trail* | |
10 | 4766 trail:c Character to show for trailing spaces. When omitted, |
6777 | 4767 trailing spaces are blank. Overrides the "space" |
4768 setting for trailing spaces. | |
4769 *lcs-extends* | |
7 | 4770 extends:c Character to show in the last column, when 'wrap' is |
4771 off and the line continues beyond the right of the | |
4772 screen. | |
6777 | 4773 *lcs-precedes* |
7 | 4774 precedes:c Character to show in the first column, when 'wrap' |
4775 is off and there is text preceding the character | |
4776 visible in the first column. | |
6777 | 4777 *lcs-conceal* |
2250
1bac28a53fae
Add the conceal patch from Vince Negri.
Bram Moolenaar <bram@vim.org>
parents:
2249
diff
changeset
|
4778 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
|
4779 'conceallevel' is set to 1. |
6777 | 4780 *lcs-nbsp* |
6801 | 4781 nbsp:c Character to show for a non-breakable space character |
4782 (0xA0 (160 decimal) and U+202F). Left blank when | |
4783 omitted. | |
7 | 4784 |
10 | 4785 The characters ':' and ',' should not be used. UTF-8 characters can |
7 | 4786 be used when 'encoding' is "utf-8", otherwise only printable |
819 | 4787 characters are allowed. All characters must be single width. |
7 | 4788 |
4789 Examples: > | |
4790 :set lcs=tab:>-,trail:- | |
12 | 4791 :set lcs=tab:>-,eol:<,nbsp:% |
7 | 4792 :set lcs=extends:>,precedes:< |
4793 < The "NonText" highlighting will be used for "eol", "extends" and | |
6777 | 4794 "precedes". "SpecialKey" for "nbsp", "space", "tab" and "trail". |
1152 | 4795 |hl-NonText| |hl-SpecialKey| |
7 | 4796 |
4797 *'lpl'* *'nolpl'* *'loadplugins'* *'noloadplugins'* | |
4798 'loadplugins' 'lpl' boolean (default on) | |
4799 global | |
4800 When on the plugin scripts are loaded when starting up |load-plugins|. | |
4801 This option can be reset in your |vimrc| file to disable the loading | |
4802 of plugins. | |
11666
5cd9ba96561d
patch 8.0.0716: not easy to start Vim cleanly
Christian Brabandt <cb@256bit.org>
parents:
11659
diff
changeset
|
4803 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
|
4804 line arguments reset this option. See |-u| and |--noplugin|. |
7 | 4805 |
7196
42717d048817
commit https://github.com/vim/vim/commit/d94464ee294a351ce7b6ba18e8bd3f24f1bef920
Christian Brabandt <cb@256bit.org>
parents:
7147
diff
changeset
|
4806 *'luadll'* |
8629
54ac275e3fc4
commit https://github.com/vim/vim/commit/3848e00e0177abdb31bc600234967863ec487233
Christian Brabandt <cb@256bit.org>
parents:
8560
diff
changeset
|
4807 '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
|
4808 global |
7196
42717d048817
commit https://github.com/vim/vim/commit/d94464ee294a351ce7b6ba18e8bd3f24f1bef920
Christian Brabandt <cb@256bit.org>
parents:
7147
diff
changeset
|
4809 {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
|
4810 feature} |
7528
53163e4d9e4f
commit https://github.com/vim/vim/commit/25e4fcde767084d1a79e0926bc301c92987c0cce
Christian Brabandt <cb@256bit.org>
parents:
7477
diff
changeset
|
4811 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
|
4812 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
|
4813 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
|
4814 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
|
4815 security reasons. |
42717d048817
commit https://github.com/vim/vim/commit/d94464ee294a351ce7b6ba18e8bd3f24f1bef920
Christian Brabandt <cb@256bit.org>
parents:
7147
diff
changeset
|
4816 |
842 | 4817 *'macatsui'* *'nomacatsui'* |
4818 'macatsui' boolean (default on) | |
4819 global | |
4820 {only available in Mac GUI version} | |
4821 This is a workaround for when drawing doesn't work properly. When set | |
4822 and compiled with multi-byte support ATSUI text drawing is used. When | |
4823 not set ATSUI text drawing is not used. Switch this option off when | |
4824 you experience drawing problems. In a future version the problems may | |
4825 be solved and this option becomes obsolete. Therefore use this method | |
4826 to unset it: > | |
4827 if exists('&macatsui') | |
4828 set nomacatsui | |
4829 endif | |
1152 | 4830 < Another option to check if you have drawing problems is |
4831 'termencoding'. | |
4832 | |
7 | 4833 *'magic'* *'nomagic'* |
4834 'magic' boolean (default on) | |
4835 global | |
4836 Changes the special characters that can be used in search patterns. | |
4837 See |pattern|. | |
10140
b11ceef7116e
commit https://github.com/vim/vim/commit/64d8e25bf6efe5f18b032563521c3ce278c316ab
Christian Brabandt <cb@256bit.org>
parents:
10027
diff
changeset
|
4838 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
|
4839 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
|
4840 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
|
4841 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
|
4842 when you want to |/\M|. |
7 | 4843 |
4844 *'makeef'* *'mef'* | |
4845 'makeef' 'mef' string (default: "") | |
4846 global | |
4847 {not available when compiled without the |+quickfix| | |
4848 feature} | |
4849 Name of the errorfile for the |:make| command (see |:make_makeprg|) | |
4850 and the |:grep| command. | |
4851 When it is empty, an internally generated temp file will be used. | |
4852 When "##" is included, it is replaced by a number to make the name | |
4853 unique. This makes sure that the ":make" command doesn't overwrite an | |
4854 existing file. | |
4855 NOT used for the ":cf" command. See 'errorfile' for that. | |
4856 Environment variables are expanded |:set_env|. | |
4857 See |option-backslash| about including spaces and backslashes. | |
4858 This option cannot be set from a |modeline| or in the |sandbox|, for | |
4859 security reasons. | |
4860 | |
11063
e71d3bdf3bc3
patch 8.0.0420: text garbled when the system encoding differs from 'encoding'
Christian Brabandt <cb@256bit.org>
parents:
11062
diff
changeset
|
4861 *'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
|
4862 '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
|
4863 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
|
4864 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
|
4865 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
|
4866 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
|
4867 `: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
|
4868 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
|
4869 |
e71d3bdf3bc3
patch 8.0.0420: text garbled when the system encoding differs from 'encoding'
Christian Brabandt <cb@256bit.org>
parents:
11062
diff
changeset
|
4870 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
|
4871 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
|
4872 '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
|
4873 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
|
4874 :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
|
4875 :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
|
4876 < |
7 | 4877 *'makeprg'* *'mp'* |
4878 'makeprg' 'mp' string (default "make", VMS: "MMS") | |
4879 global or local to buffer |global-local| | |
1152 | 4880 Program to use for the ":make" command. See |:make_makeprg|. |
13341
acd7eaa13d2b
Updated runtime files.
Christian Brabandt <cb@256bit.org>
parents:
13314
diff
changeset
|
4881 This option may contain '%' and '#' characters (see |:_%| and |:_#|), |
acd7eaa13d2b
Updated runtime files.
Christian Brabandt <cb@256bit.org>
parents:
13314
diff
changeset
|
4882 which are expanded to the current and alternate file name. Use |::S| |
5690 | 4883 to escape file names in case they contain special characters. |
1152 | 4884 Environment variables are expanded |:set_env|. See |option-backslash| |
4885 about including spaces and backslashes. | |
4886 Note that a '|' must be escaped twice: once for ":set" and once for | |
4887 the interpretation of a command. When you use a filter called | |
4888 "myfilter" do it like this: > | |
7 | 4889 :set makeprg=gmake\ \\\|\ myfilter |
4890 < The placeholder "$*" can be given (even multiple times) to specify | |
4891 where the arguments will be included, for example: > | |
4892 :set makeprg=latex\ \\\\nonstopmode\ \\\\input\\{$*} | |
4893 < This option cannot be set from a |modeline| or in the |sandbox|, for | |
4894 security reasons. | |
4895 | |
4896 *'matchpairs'* *'mps'* | |
4897 'matchpairs' 'mps' string (default "(:),{:},[:]") | |
4898 local to buffer | |
4899 Characters that form pairs. The |%| command jumps from one to the | |
4073 | 4900 other. |
4901 Only character pairs are allowed that are different, thus you cannot | |
4902 jump between two double quotes. | |
4903 The characters must be separated by a colon. | |
1152 | 4904 The pairs must be separated by a comma. Example for including '<' and |
4905 '>' (HTML): > | |
7 | 4906 :set mps+=<:> |
4907 | |
4908 < A more exotic example, to jump between the '=' and ';' in an | |
4909 assignment, useful for languages like C and Java: > | |
4910 :au FileType c,cpp,java set mps+==:; | |
4911 | |
4912 < 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
|
4913 the $VIMRUNTIME/pack/dist/opt/matchit directory. |add-local-help| |
7 | 4914 |
4915 *'matchtime'* *'mat'* | |
4916 'matchtime' 'mat' number (default 5) | |
4917 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
|
4918 {in Nvi} |
7 | 4919 Tenths of a second to show the matching paren, when 'showmatch' is |
4920 set. Note that this is not in milliseconds, like other options that | |
4921 set a time. This is to be compatible with Nvi. | |
4922 | |
714 | 4923 *'maxcombine'* *'mco'* |
4924 'maxcombine' 'mco' number (default 2) | |
4925 global | |
4926 The maximum number of combining characters supported for displaying. | |
4927 Only used when 'encoding' is "utf-8". | |
4928 The default is OK for most languages. Hebrew may require 4. | |
4929 Maximum value is 6. | |
4930 Even when this option is set to 2 you can still edit text with more | |
4931 combining characters, you just can't see them. Use |g8| or |ga|. | |
4932 See |mbyte-combining|. | |
4933 | |
7 | 4934 *'maxfuncdepth'* *'mfd'* |
4935 'maxfuncdepth' 'mfd' number (default 100) | |
4936 global | |
2570
71b56b4e7785
Make the references to features in the help more consistent. (Sylvain Hitier)
Bram Moolenaar <bram@vim.org>
parents:
2561
diff
changeset
|
4937 {not available when compiled without the |+eval| |
1152 | 4938 feature} |
7 | 4939 Maximum depth of function calls for user functions. This normally |
4940 catches endless recursion. When using a recursive function with | |
4941 more depth, set 'maxfuncdepth' to a bigger number. But this will use | |
4942 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
|
4943 Increasing this limit above 200 also changes the maximum for Ex |
14006 | 4944 command recursion, see |E169|. |
7 | 4945 See also |:function|. |
4946 | |
4947 *'maxmapdepth'* *'mmd'* *E223* | |
4948 'maxmapdepth' 'mmd' number (default 1000) | |
4949 global | |
4950 Maximum number of times a mapping is done without resulting in a | |
4951 character to be used. This normally catches endless mappings, like | |
4952 ":map x y" with ":map y x". It still does not catch ":map g wg", | |
4953 because the 'w' is used before the next mapping is done. See also | |
4954 |key-mapping|. | |
4955 | |
4956 *'maxmem'* *'mm'* | |
4957 'maxmem' 'mm' number (default between 256 to 5120 (system | |
4958 dependent) or half the amount of memory | |
4959 available) | |
4960 global | |
4961 Maximum amount of memory (in Kbyte) to use for one buffer. When this | |
4962 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
|
4963 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
|
4964 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
|
4965 limit. |
65c3e8259124
patch 8.0.1531: cannot use 24 bit colors in MS-Windows console
Christian Brabandt <cb@256bit.org>
parents:
13234
diff
changeset
|
4966 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
|
4967 Also see 'maxmemtot'. |
7 | 4968 |
189 | 4969 *'maxmempattern'* *'mmp'* |
4970 'maxmempattern' 'mmp' number (default 1000) | |
4971 global | |
4972 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
|
4973 The maximum value is about 2000000. Use this to work without a limit. |
189 | 4974 *E363* |
1152 | 4975 When Vim runs into the limit it gives an error message and mostly |
4976 behaves like CTRL-C was typed. | |
189 | 4977 Running into the limit often means that the pattern is very |
4978 inefficient or too complex. This may already happen with the pattern | |
4979 "\(.\)*" 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
|
4980 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
|
4981 text structure. |
4a588e3afd4a
Update runtime files, add Danish translations.
Christian Brabandt <cb@256bit.org>
parents:
14249
diff
changeset
|
4982 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
|
4983 which case you get an "Out of memory" error instead. |
189 | 4984 |
7 | 4985 *'maxmemtot'* *'mmt'* |
4986 'maxmemtot' 'mmt' number (default between 2048 and 10240 (system | |
4987 dependent) or half the amount of memory | |
4988 available) | |
4989 global | |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
4990 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
|
4991 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
|
4992 without a limit. |
05cf4cc72a9f
commit https://github.com/vim/vim/commit/fa7353428f705f7a13465a1943dddeede4083023
Christian Brabandt <cb@256bit.org>
parents:
7272
diff
changeset
|
4993 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
|
4994 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
|
4995 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
|
4996 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
|
4997 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
|
4998 used. |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
4999 Also see 'maxmem'. |
7 | 5000 |
5001 *'menuitems'* *'mis'* | |
5002 'menuitems' 'mis' number (default 25) | |
5003 global | |
5004 {not available when compiled without the |+menu| | |
5005 feature} | |
5006 Maximum number of items to use in a menu. Used for menus that are | |
5007 generated from a list of items, e.g., the Buffers menu. Changing this | |
5008 option has no direct effect, the menu must be refreshed first. | |
5009 | |
484 | 5010 *'mkspellmem'* *'msm'* |
5011 'mkspellmem' 'msm' string (default "460000,2000,500") | |
5012 global | |
5013 {not available when compiled without the |+syntax| | |
5014 feature} | |
5015 Parameters for |:mkspell|. This tunes when to start compressing the | |
5016 word tree. Compression can be slow when there are many words, but | |
5017 it's needed to avoid running out of memory. The amount of memory used | |
5018 per word depends very much on how similar the words are, that's why | |
5019 this tuning is complicated. | |
5020 | |
5021 There are three numbers, separated by commas: | |
5022 {start},{inc},{added} | |
5023 | |
5024 For most languages the uncompressed word tree fits in memory. {start} | |
5025 gives the amount of memory in Kbyte that can be used before any | |
5026 compression is done. It should be a bit smaller than the amount of | |
5027 memory that is available to Vim. | |
5028 | |
5029 When going over the {start} limit the {inc} number specifies the | |
5030 amount of memory in Kbyte that can be allocated before another | |
5031 compression is done. A low number means compression is done after | |
5032 less words are added, which is slow. A high number means more memory | |
5033 will be allocated. | |
5034 | |
5035 After doing compression, {added} times 1024 words can be added before | |
5036 the {inc} limit is ignored and compression is done when any extra | |
5037 amount of memory is needed. A low number means there is a smaller | |
5038 chance of hitting the {inc} limit, less memory is used but it's | |
5039 slower. | |
5040 | |
5041 The languages for which these numbers are important are Italian and | |
5042 Hungarian. The default works for when you have about 512 Mbyte. If | |
5043 you have 1 Gbyte you could use: > | |
5044 :set mkspellmem=900000,3000,800 | |
5045 < If you have less than 512 Mbyte |:mkspell| may fail for some | |
5046 languages, no matter what you set 'mkspellmem' to. | |
5047 | |
7 | 5048 *'modeline'* *'ml'* *'nomodeline'* *'noml'* |
1111 | 5049 'modeline' 'ml' boolean (Vim default: on (off for root), |
5050 Vi default: off) | |
7 | 5051 local to buffer |
5052 *'modelines'* *'mls'* | |
5053 'modelines' 'mls' number (default 5) | |
5054 global | |
5055 If 'modeline' is on 'modelines' gives the number of lines that is | |
5056 checked for set commands. If 'modeline' is off or 'modelines' is zero | |
5057 no lines are checked. See |modeline|. | |
5058 NOTE: 'modeline' is set to the Vi default value when 'compatible' is | |
5059 set and to the Vim default value when 'compatible' is reset. | |
5060 | |
5061 *'modifiable'* *'ma'* *'nomodifiable'* *'noma'* | |
5062 'modifiable' 'ma' boolean (default on) | |
5063 local to buffer | |
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
|
5064 *E21* |
7 | 5065 When off the buffer contents cannot be changed. The 'fileformat' and |
5066 'fileencoding' options also can't be changed. | |
10617 | 5067 Can be reset on startup with the |-M| command line argument. |
7 | 5068 |
5069 *'modified'* *'mod'* *'nomodified'* *'nomod'* | |
5070 'modified' 'mod' boolean (default off) | |
5071 local to buffer | |
5072 When on, the buffer is considered to be modified. This option is set | |
5073 when: | |
5074 1. A change was made to the text since it was last written. Using the | |
5075 |undo| command to go back to the original text will reset the | |
5076 option. But undoing changes that were made before writing the | |
5077 buffer will set the option again, since the text is different from | |
5078 when it was written. | |
5079 2. 'fileformat' or 'fileencoding' is different from its original | |
5080 value. The original value is set when the buffer is read or | |
5081 written. A ":set nomodified" command also resets the original | |
5082 values to the current values and the 'modified' option will be | |
5083 reset. | |
8748
b1a19a2f73f0
commit https://github.com/vim/vim/commit/4f3f668c8486444e53163c29d2fc79bf47eb3c82
Christian Brabandt <cb@256bit.org>
parents:
8629
diff
changeset
|
5084 Similarly for 'eol' and 'bomb'. |
3082 | 5085 This option is not set when a change is made to the buffer as the |
5086 result of a BufNewFile, BufRead/BufReadPost, BufWritePost, | |
5087 FileAppendPost or VimLeave autocommand event. See |gzip-example| for | |
5088 an explanation. | |
7 | 5089 When 'buftype' is "nowrite" or "nofile" this option may be set, but |
5090 will be ignored. | |
13437 | 5091 Note that the text may actually be the same, e.g. 'modified' is set |
5092 when using "rA" on an "A". | |
7 | 5093 |
5094 *'more'* *'nomore'* | |
5095 'more' boolean (Vim default: on, Vi default: off) | |
5096 global | |
5097 When on, listings pause when the whole screen is filled. You will get | |
5098 the |more-prompt|. When this option is off there are no pauses, the | |
5099 listing continues until finished. | |
5100 NOTE: This option is set to the Vi default value when 'compatible' is | |
5101 set and to the Vim default value when 'compatible' is reset. | |
5102 | |
5103 *'mouse'* *E538* | |
9669
284b4eb307fc
commit https://github.com/vim/vim/commit/8c08b5b569e2a9e9f63dea514591ecfa2d3bb392
Christian Brabandt <cb@256bit.org>
parents:
9665
diff
changeset
|
5104 'mouse' string (default "", "a" for GUI, MS-DOS and Win32, |
284b4eb307fc
commit https://github.com/vim/vim/commit/8c08b5b569e2a9e9f63dea514591ecfa2d3bb392
Christian Brabandt <cb@256bit.org>
parents:
9665
diff
changeset
|
5105 set to "a" in |defaults.vim|) |
7 | 5106 global |
5107 Enable the use of the mouse. Only works for certain terminals | |
1621 | 5108 (xterm, MS-DOS, Win32 |win32-mouse|, QNX pterm, *BSD console with |
5109 sysmouse and Linux console with gpm). For using the mouse in the | |
5110 GUI, see |gui-mouse|. | |
7 | 5111 The mouse can be enabled for different modes: |
12826 | 5112 n Normal mode and Terminal modes |
7 | 5113 v Visual mode |
5114 i Insert mode | |
5115 c Command-line mode | |
5116 h all previous modes when editing a help file | |
5117 a all previous modes | |
5118 r for |hit-enter| and |more-prompt| prompt | |
14864 | 5119 Normally you would enable the mouse in all five modes with: > |
7 | 5120 :set mouse=a |
5121 < When the mouse is not enabled, the GUI will still use the mouse for | |
5122 modeless selection. This doesn't move the text cursor. | |
5123 | |
5124 See |mouse-using|. Also see |'clipboard'|. | |
5125 | |
5126 Note: When enabling the mouse in a terminal, copy/paste will use the | |
10 | 5127 "* register if there is access to an X-server. The xterm handling of |
7 | 5128 the mouse buttons can still be used by keeping the shift key pressed. |
5129 Also see the 'clipboard' option. | |
5130 | |
5131 *'mousefocus'* *'mousef'* *'nomousefocus'* *'nomousef'* | |
5132 'mousefocus' 'mousef' boolean (default off) | |
5133 global | |
5134 {only works in the GUI} | |
5135 The window that the mouse pointer is on is automatically activated. | |
5136 When changing the window layout or window focus in another way, the | |
5137 mouse pointer is moved to the window with keyboard focus. Off is the | |
5138 default because it makes using the pull down menus a little goofy, as | |
5139 a pointer transit may activate a window unintentionally. | |
5140 | |
5141 *'mousehide'* *'mh'* *'nomousehide'* *'nomh'* | |
5142 'mousehide' 'mh' boolean (default on) | |
5143 global | |
5144 {only works in the GUI} | |
5145 When on, the mouse pointer is hidden when characters are typed. | |
5146 The mouse pointer is restored when the mouse is moved. | |
5147 | |
5148 *'mousemodel'* *'mousem'* | |
5149 'mousemodel' 'mousem' string (default "extend", "popup" for MS-DOS and Win32) | |
5150 global | |
5151 Sets the model to use for the mouse. The name mostly specifies what | |
5152 the right mouse button is used for: | |
5153 extend Right mouse button extends a selection. This works | |
5154 like in an xterm. | |
5155 popup Right mouse button pops up a menu. The shifted left | |
5156 mouse button extends a selection. This works like | |
233 | 5157 with Microsoft Windows. |
7 | 5158 popup_setpos Like "popup", but the cursor will be moved to the |
5159 position where the mouse was clicked, and thus the | |
5160 selected operation will act upon the clicked object. | |
5161 If clicking inside a selection, that selection will | |
233 | 5162 be acted upon, i.e. no cursor move. This implies of |
7 | 5163 course, that right clicking outside a selection will |
5164 end Visual mode. | |
5165 Overview of what button does what for each model: | |
5166 mouse extend popup(_setpos) ~ | |
5167 left click place cursor place cursor | |
5168 left drag start selection start selection | |
5169 shift-left search word extend selection | |
5170 right click extend selection popup menu (place cursor) | |
5171 right drag extend selection - | |
5172 middle click paste paste | |
5173 | |
5174 In the "popup" model the right mouse button produces a pop-up menu. | |
5175 You need to define this first, see |popup-menu|. | |
13437 | 5176 In a terminal the popup menu works if Vim is compiled with the |
5177 |+insert_expand| option. | |
7 | 5178 |
5179 Note that you can further refine the meaning of buttons with mappings. | |
5180 See |gui-mouse-mapping|. But mappings are NOT used for modeless | |
5181 selection (because that's handled in the GUI code directly). | |
5182 | |
5183 The 'mousemodel' option is set by the |:behave| command. | |
5184 | |
5185 *'mouseshape'* *'mouses'* *E547* | |
15932 | 5186 'mouseshape' 'mouses' string (default "i-r:beam,s:updown,sd:udsizing, |
5187 vs:leftright,vd:lrsizing,m:no, | |
5188 ml:up-arrow,v:rightup-arrow") | |
7 | 5189 global |
5190 {only available when compiled with the |+mouseshape| | |
5191 feature} | |
5192 This option tells Vim what the mouse pointer should look like in | |
5193 different modes. The option is a comma separated list of parts, much | |
5194 like used for 'guicursor'. Each part consist of a mode/location-list | |
5195 and an argument-list: | |
5196 mode-list:shape,mode-list:shape,.. | |
5197 The mode-list is a dash separated list of these modes/locations: | |
5198 In a normal window: ~ | |
5199 n Normal mode | |
5200 v Visual mode | |
5201 ve Visual mode with 'selection' "exclusive" (same as 'v', | |
5202 if not specified) | |
5203 o Operator-pending mode | |
5204 i Insert mode | |
5205 r Replace mode | |
5206 | |
5207 Others: ~ | |
5208 c appending to the command-line | |
5209 ci inserting in the command-line | |
5210 cr replacing in the command-line | |
5211 m at the 'Hit ENTER' or 'More' prompts | |
5212 ml idem, but cursor in the last line | |
5213 e any mode, pointer below last window | |
5214 s any mode, pointer on a status line | |
5215 sd any mode, while dragging a status line | |
5216 vs any mode, pointer on a vertical separator line | |
5217 vd any mode, while dragging a vertical separator line | |
5218 a everywhere | |
5219 | |
5220 The shape is one of the following: | |
5221 avail name looks like ~ | |
5222 w x arrow Normal mouse pointer | |
5223 w x blank no pointer at all (use with care!) | |
5224 w x beam I-beam | |
5225 w x updown up-down sizing arrows | |
5226 w x leftright left-right sizing arrows | |
5227 w x busy The system's usual busy pointer | |
5228 w x no The system's usual 'no input' pointer | |
5229 x udsizing indicates up-down resizing | |
5230 x lrsizing indicates left-right resizing | |
5231 x crosshair like a big thin + | |
5232 x hand1 black hand | |
5233 x hand2 white hand | |
5234 x pencil what you write with | |
5235 x question big ? | |
5236 x rightup-arrow arrow pointing right-up | |
5237 w x up-arrow arrow pointing up | |
5238 x <number> any X11 pointer number (see X11/cursorfont.h) | |
5239 | |
5240 The "avail" column contains a 'w' if the shape is available for Win32, | |
5241 x for X11. | |
5242 Any modes not specified or shapes not available use the normal mouse | |
5243 pointer. | |
5244 | |
5245 Example: > | |
5246 :set mouseshape=s:udsizing,m:no | |
5247 < will make the mouse turn to a sizing arrow over the status lines and | |
5248 indicate no input when the hit-enter prompt is displayed (since | |
5249 clicking the mouse has no effect in this state.) | |
5250 | |
5251 *'mousetime'* *'mouset'* | |
5252 'mousetime' 'mouset' number (default 500) | |
5253 global | |
5254 Only for GUI, MS-DOS, Win32 and Unix with xterm. Defines the maximum | |
5255 time in msec between two mouse clicks for the second click to be | |
5256 recognized as a multi click. | |
5257 | |
12608
b390f5003e2f
patch 8.0.1182: cannot see or change mzscheme dll name
Christian Brabandt <cb@256bit.org>
parents:
12559
diff
changeset
|
5258 *'mzschemedll'* |
b390f5003e2f
patch 8.0.1182: cannot see or change mzscheme dll name
Christian Brabandt <cb@256bit.org>
parents:
12559
diff
changeset
|
5259 '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
|
5260 global |
b390f5003e2f
patch 8.0.1182: cannot see or change mzscheme dll name
Christian Brabandt <cb@256bit.org>
parents:
12559
diff
changeset
|
5261 {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
|
5262 feature} |
b390f5003e2f
patch 8.0.1182: cannot see or change mzscheme dll name
Christian Brabandt <cb@256bit.org>
parents:
12559
diff
changeset
|
5263 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
|
5264 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
|
5265 Environment variables are expanded |:set_env|. |
12785 | 5266 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
|
5267 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
|
5268 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
|
5269 security reasons. |
b390f5003e2f
patch 8.0.1182: cannot see or change mzscheme dll name
Christian Brabandt <cb@256bit.org>
parents:
12559
diff
changeset
|
5270 |
b390f5003e2f
patch 8.0.1182: cannot see or change mzscheme dll name
Christian Brabandt <cb@256bit.org>
parents:
12559
diff
changeset
|
5271 *'mzschemegcdll'* |
b390f5003e2f
patch 8.0.1182: cannot see or change mzscheme dll name
Christian Brabandt <cb@256bit.org>
parents:
12559
diff
changeset
|
5272 '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
|
5273 global |
b390f5003e2f
patch 8.0.1182: cannot see or change mzscheme dll name
Christian Brabandt <cb@256bit.org>
parents:
12559
diff
changeset
|
5274 {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
|
5275 feature} |
b390f5003e2f
patch 8.0.1182: cannot see or change mzscheme dll name
Christian Brabandt <cb@256bit.org>
parents:
12559
diff
changeset
|
5276 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
|
5277 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
|
5278 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
|
5279 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
|
5280 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
|
5281 security reasons. |
b390f5003e2f
patch 8.0.1182: cannot see or change mzscheme dll name
Christian Brabandt <cb@256bit.org>
parents:
12559
diff
changeset
|
5282 |
14 | 5283 *'mzquantum'* *'mzq'* |
5284 'mzquantum' 'mzq' number (default 100) | |
5285 global | |
5286 {not available when compiled without the |+mzscheme| | |
5287 feature} | |
5288 The number of milliseconds between polls for MzScheme threads. | |
5289 Negative or zero value means no thread scheduling. | |
11160 | 5290 NOTE: This option is set to the Vim default value when 'compatible' |
5291 is reset. | |
14 | 5292 |
7 | 5293 *'nrformats'* *'nf'* |
9669
284b4eb307fc
commit https://github.com/vim/vim/commit/8c08b5b569e2a9e9f63dea514591ecfa2d3bb392
Christian Brabandt <cb@256bit.org>
parents:
9665
diff
changeset
|
5294 '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
|
5295 set to "bin,hex" in |defaults.vim|) |
7 | 5296 local to buffer |
5297 This defines what bases Vim will consider for numbers when using the | |
5298 CTRL-A and CTRL-X commands for adding to and subtracting from a number | |
5299 respectively; see |CTRL-A| for more info on these commands. | |
625 | 5300 alpha If included, single alphabetical characters will be |
7 | 5301 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
|
5302 letter index a), b), etc. *octal-nrformats* |
625 | 5303 octal If included, numbers that start with a zero will be considered |
7 | 5304 to be octal. Example: Using CTRL-A on "007" results in "010". |
625 | 5305 hex If included, numbers starting with "0x" or "0X" will be |
7 | 5306 considered to be hexadecimal. Example: Using CTRL-X on |
5307 "0x100" results in "0x0ff". | |
7528
53163e4d9e4f
commit https://github.com/vim/vim/commit/25e4fcde767084d1a79e0926bc301c92987c0cce
Christian Brabandt <cb@256bit.org>
parents:
7477
diff
changeset
|
5308 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
|
5309 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
|
5310 "0b1000" subtracts one, resulting in "0b0111". |
7 | 5311 Numbers which simply begin with a digit in the range 1-9 are always |
5312 considered decimal. This also happens for numbers that are not | |
5313 recognized as octal or hex. | |
5314 | |
5315 *'number'* *'nu'* *'nonumber'* *'nonu'* | |
5316 'number' 'nu' boolean (default off) | |
5317 local to window | |
5318 Print the line number in front of each line. When the 'n' option is | |
5319 excluded from 'cpoptions' a wrapped line will not use the column of | |
5320 line numbers (this is the default when 'compatible' isn't set). | |
13 | 5321 The 'numberwidth' option can be used to set the room used for the line |
5322 number. | |
7 | 5323 When a long, wrapped line doesn't start with the first character, '-' |
5324 characters are put before the number. | |
3445 | 5325 See |hl-LineNr| and |hl-CursorLineNr| for the highlighting used for |
5326 the number. | |
4780 | 5327 *number_relativenumber* |
5328 The 'relativenumber' option changes the displayed number to be | |
5329 relative to the cursor. Together with 'number' there are these | |
5330 four combinations (cursor in line 3): | |
5331 | |
8629
54ac275e3fc4
commit https://github.com/vim/vim/commit/3848e00e0177abdb31bc600234967863ec487233
Christian Brabandt <cb@256bit.org>
parents:
8560
diff
changeset
|
5332 'nonu' 'nu' 'nonu' 'nu' |
4780 | 5333 'nornu' 'nornu' 'rnu' 'rnu' |
5334 | |
5335 |apple | 1 apple | 2 apple | 2 apple | |
5336 |pear | 2 pear | 1 pear | 1 pear | |
5337 |nobody | 3 nobody | 0 nobody |3 nobody | |
5338 |there | 4 there | 1 there | 1 there | |
7 | 5339 |
13 | 5340 *'numberwidth'* *'nuw'* |
5341 'numberwidth' 'nuw' number (Vim default: 4 Vi default: 8) | |
5342 local to window | |
14 | 5343 {only available when compiled with the |+linebreak| |
5344 feature} | |
13 | 5345 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
|
5346 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
|
5347 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
|
5348 the text, there is one less character for the number itself. |
13 | 5349 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
|
5350 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
|
5351 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
|
5352 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
|
5353 up to 999. When the buffer has 1000 lines five columns will be used. |
13 | 5354 The minimum value is 1, the maximum value is 10. |
11160 | 5355 NOTE: This option is set to the Vi default value when 'compatible' is |
5356 set and to the Vim default value when 'compatible' is reset. | |
13 | 5357 |
523 | 5358 *'omnifunc'* *'ofu'* |
5359 'omnifunc' 'ofu' string (default: empty) | |
502 | 5360 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
|
5361 {not available when compiled without the |+eval| |
71b56b4e7785
Make the references to features in the help more consistent. (Sylvain Hitier)
Bram Moolenaar <bram@vim.org>
parents:
2561
diff
changeset
|
5362 or |+insert_expand| features} |
623 | 5363 This option specifies a function to be used for Insert mode omni |
5364 completion with CTRL-X CTRL-O. |i_CTRL-X_CTRL-O| | |
648 | 5365 See |complete-functions| for an explanation of how the function is |
5366 invoked and what it should return. | |
1004 | 5367 This option is usually set by a filetype plugin: |
859 | 5368 |:filetype-plugin-on| |
3682 | 5369 This option cannot be set from a |modeline| or in the |sandbox|, for |
5370 security reasons. | |
502 | 5371 |
5372 | |
1152 | 5373 *'opendevice'* *'odev'* *'noopendevice'* *'noodev'* |
1004 | 5374 'opendevice' 'odev' boolean (default off) |
5375 global | |
5376 {only for MS-DOS, MS-Windows and OS/2} | |
5377 Enable reading and writing from devices. This may get Vim stuck on a | |
5378 device that can be opened but doesn't actually do the I/O. Therefore | |
5379 it is off by default. | |
5380 Note that on MS-Windows editing "aux.h", "lpt1.txt" and the like also | |
5381 result in editing a device. | |
5382 | |
5383 | |
593 | 5384 *'operatorfunc'* *'opfunc'* |
5385 'operatorfunc' 'opfunc' string (default: empty) | |
5386 global | |
5387 This option specifies a function to be called by the |g@| operator. | |
5388 See |:map-operator| for more info and an example. | |
5389 | |
5390 This option cannot be set from a |modeline| or in the |sandbox|, for | |
5391 security reasons. | |
5392 | |
5393 | |
2908 | 5394 *'osfiletype'* *'oft'* |
5395 'osfiletype' 'oft' string (default: "") | |
7 | 5396 local to buffer |
2908 | 5397 This option was supported on RISC OS, which has been removed. |
5398 | |
7 | 5399 |
8182
95d59081580f
commit https://github.com/vim/vim/commit/f6fee0e2d4341c0c2f5339c1268e5877fafd07cf
Christian Brabandt <cb@256bit.org>
parents:
8148
diff
changeset
|
5400 *'packpath'* *'pp'* |
95d59081580f
commit https://github.com/vim/vim/commit/f6fee0e2d4341c0c2f5339c1268e5877fafd07cf
Christian Brabandt <cb@256bit.org>
parents:
8148
diff
changeset
|
5401 'packpath' 'pp' string (default: see 'runtimepath') |
95d59081580f
commit https://github.com/vim/vim/commit/f6fee0e2d4341c0c2f5339c1268e5877fafd07cf
Christian Brabandt <cb@256bit.org>
parents:
8148
diff
changeset
|
5402 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
|
5403 |
95d59081580f
commit https://github.com/vim/vim/commit/f6fee0e2d4341c0c2f5339c1268e5877fafd07cf
Christian Brabandt <cb@256bit.org>
parents:
8148
diff
changeset
|
5404 |
7 | 5405 *'paragraphs'* *'para'* |
1564 | 5406 'paragraphs' 'para' string (default "IPLPPPQPP TPHPLIPpLpItpplpipbp") |
7 | 5407 global |
5408 Specifies the nroff macros that separate paragraphs. These are pairs | |
5409 of two letters (see |object-motions|). | |
5410 | |
5411 *'paste'* *'nopaste'* | |
5412 'paste' boolean (default off) | |
5413 global | |
10 | 5414 Put Vim in Paste mode. This is useful if you want to cut or copy |
5415 some text from one window and paste it in Vim. This will avoid | |
7 | 5416 unexpected effects. |
5417 Setting this option is useful when using Vim in a terminal, where Vim | |
10 | 5418 cannot distinguish between typed text and pasted text. In the GUI, Vim |
7 | 5419 knows about pasting and will mostly do the right thing without 'paste' |
5420 being set. The same is true for a terminal where Vim handles the | |
5421 mouse clicks itself. | |
148 | 5422 This option is reset when starting the GUI. Thus if you set it in |
5423 your .vimrc it will work in a terminal, but not in the GUI. Setting | |
5424 'paste' in the GUI has side effects: e.g., the Paste toolbar button | |
5425 will no longer work in Insert mode, because it uses a mapping. | |
7 | 5426 When the 'paste' option is switched on (also when it was already on): |
5427 - mapping in Insert mode and Command-line mode is disabled | |
5428 - abbreviations are disabled | |
5429 - 'autoindent' is reset | |
7147
c590de398af9
commit https://github.com/vim/vim/commit/ca63501fbcd1cf9c8aa9ff12c093c95b62a89ed7
Christian Brabandt <cb@256bit.org>
parents:
7080
diff
changeset
|
5430 - 'expandtab' is reset |
c590de398af9
commit https://github.com/vim/vim/commit/ca63501fbcd1cf9c8aa9ff12c093c95b62a89ed7
Christian Brabandt <cb@256bit.org>
parents:
7080
diff
changeset
|
5431 - 'formatoptions' is used like it is empty |
7 | 5432 - 'revins' is reset |
5433 - 'ruler' is reset | |
5434 - 'showmatch' is reset | |
7147
c590de398af9
commit https://github.com/vim/vim/commit/ca63501fbcd1cf9c8aa9ff12c093c95b62a89ed7
Christian Brabandt <cb@256bit.org>
parents:
7080
diff
changeset
|
5435 - 'smartindent' is reset |
c590de398af9
commit https://github.com/vim/vim/commit/ca63501fbcd1cf9c8aa9ff12c093c95b62a89ed7
Christian Brabandt <cb@256bit.org>
parents:
7080
diff
changeset
|
5436 - 'smarttab' is reset |
c590de398af9
commit https://github.com/vim/vim/commit/ca63501fbcd1cf9c8aa9ff12c093c95b62a89ed7
Christian Brabandt <cb@256bit.org>
parents:
7080
diff
changeset
|
5437 - 'softtabstop' is set to 0 |
c590de398af9
commit https://github.com/vim/vim/commit/ca63501fbcd1cf9c8aa9ff12c093c95b62a89ed7
Christian Brabandt <cb@256bit.org>
parents:
7080
diff
changeset
|
5438 - 'textwidth' is set to 0 |
c590de398af9
commit https://github.com/vim/vim/commit/ca63501fbcd1cf9c8aa9ff12c093c95b62a89ed7
Christian Brabandt <cb@256bit.org>
parents:
7080
diff
changeset
|
5439 - 'wrapmargin' is set to 0 |
7 | 5440 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
|
5441 - 'cindent' |
c590de398af9
commit https://github.com/vim/vim/commit/ca63501fbcd1cf9c8aa9ff12c093c95b62a89ed7
Christian Brabandt <cb@256bit.org>
parents:
7080
diff
changeset
|
5442 - 'indentexpr' |
7 | 5443 - 'lisp' |
5444 NOTE: When you start editing another file while the 'paste' option is | |
5445 on, settings from the modelines or autocommands may change the | |
5446 settings again, causing trouble when pasting text. You might want to | |
5447 set the 'paste' option again. | |
5448 When the 'paste' option is reset the mentioned options are restored to | |
5449 the value before the moment 'paste' was switched from off to on. | |
5450 Resetting 'paste' before ever setting it does not have any effect. | |
5451 Since mapping doesn't work while 'paste' is active, you need to use | |
5452 the 'pastetoggle' option to toggle the 'paste' option with some key. | |
5453 | |
5454 *'pastetoggle'* *'pt'* | |
5455 'pastetoggle' 'pt' string (default "") | |
5456 global | |
5457 When non-empty, specifies the key sequence that toggles the 'paste' | |
5458 option. This is like specifying a mapping: > | |
5459 :map {keys} :set invpaste<CR> | |
5460 < Where {keys} is the value of 'pastetoggle'. | |
5461 The difference is that it will work even when 'paste' is set. | |
5462 'pastetoggle' works in Insert mode and Normal mode, but not in | |
5463 Command-line mode. | |
5464 Mappings are checked first, thus overrule 'pastetoggle'. However, | |
5465 when 'paste' is on mappings are ignored in Insert mode, thus you can do | |
5466 this: > | |
5467 :map <F10> :set paste<CR> | |
5468 :map <F11> :set nopaste<CR> | |
5469 :imap <F10> <C-O>:set paste<CR> | |
5470 :imap <F11> <nop> | |
5471 :set pastetoggle=<F11> | |
5472 < This will make <F10> start paste mode and <F11> stop paste mode. | |
5473 Note that typing <F10> in paste mode inserts "<F10>", since in paste | |
5474 mode everything is inserted literally, except the 'pastetoggle' key | |
5475 sequence. | |
1621 | 5476 When the value has several bytes 'ttimeoutlen' applies. |
7 | 5477 |
5478 *'pex'* *'patchexpr'* | |
5479 'patchexpr' 'pex' string (default "") | |
5480 global | |
5481 {not available when compiled without the |+diff| | |
5482 feature} | |
5483 Expression which is evaluated to apply a patch to a file and generate | |
10 | 5484 the resulting new version of the file. See |diff-patchexpr|. |
7 | 5485 |
6091
7090d7f160f7
Update runtime files. Add vroom file support.
Bram Moolenaar <bram@vim.org>
parents:
6032
diff
changeset
|
5486 *'patchmode'* *'pm'* *E205* *E206* |
7 | 5487 'patchmode' 'pm' string (default "") |
5488 global | |
5489 When non-empty the oldest version of a file is kept. This can be used | |
5490 to keep the original version of a file if you are changing files in a | |
5491 source distribution. Only the first time that a file is written a | |
5492 copy of the original file will be kept. The name of the copy is the | |
5493 name of the original file with the string in the 'patchmode' option | |
5494 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
|
5495 ".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
|
5496 (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
|
5497 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
|
5498 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
|
5499 empty file is created. |
7 | 5500 When the 'backupskip' pattern matches, a patchmode file is not made. |
5501 Using 'patchmode' for compressed files appends the extension at the | |
5502 end (e.g., "file.gz.orig"), thus the resulting name isn't always | |
5503 recognized as a compressed file. | |
36 | 5504 Only normal file name characters can be used, "/\*?[|<>" are illegal. |
7 | 5505 |
3224 | 5506 *'path'* *'pa'* *E343* *E345* *E347* *E854* |
7 | 5507 'path' 'pa' string (default on Unix: ".,/usr/include,," |
5508 on OS/2: ".,/emx/include,," | |
5509 other systems: ".,,") | |
5510 global or local to buffer |global-local| | |
5511 This is a list of directories which will be searched when using the | |
1668 | 5512 |gf|, [f, ]f, ^Wf, |:find|, |:sfind|, |:tabfind| and other commands, |
5513 provided that the file being searched for has a relative path (not | |
5514 starting with "/", "./" or "../"). The directories in the 'path' | |
5515 option may be relative or absolute. | |
7 | 5516 - Use commas to separate directory names: > |
5517 :set path=.,/usr/local/include,/usr/include | |
5518 < - Spaces can also be used to separate directory names (for backwards | |
5519 compatibility with version 3.0). To have a space in a directory | |
5520 name, precede it with an extra backslash, and escape the space: > | |
5521 :set path=.,/dir/with\\\ space | |
5522 < - To include a comma in a directory name precede it with an extra | |
5523 backslash: > | |
5524 :set path=.,/dir/with\\,comma | |
5525 < - To search relative to the directory of the current file, use: > | |
5526 :set path=. | |
5527 < - To search in the current directory use an empty string between two | |
5528 commas: > | |
5529 :set path=,, | |
5530 < - A directory name may end in a ':' or '/'. | |
5531 - Environment variables are expanded |:set_env|. | |
5532 - When using |netrw.vim| URLs can be used. For example, adding | |
5533 "http://www.vim.org" will make ":find index.html" work. | |
1668 | 5534 - Search upwards and downwards in a directory tree using "*", "**" and |
5535 ";". See |file-searching| for info and syntax. | |
7 | 5536 {not available when compiled without the |+path_extra| feature} |
5537 - Careful with '\' characters, type two to get one in the option: > | |
5538 :set path=.,c:\\include | |
5539 < Or just use '/' instead: > | |
5540 :set path=.,c:/include | |
5541 < Don't forget "." or files won't even be found in the same directory as | |
5542 the file! | |
10 | 5543 The maximum length is limited. How much depends on the system, mostly |
7 | 5544 it is something like 256 or 1024 characters. |
5545 You can check if all the include files are found, using the value of | |
5546 'path', see |:checkpath|. | |
5547 The use of |:set+=| and |:set-=| is preferred when adding or removing | |
5548 directories from the list. This avoids problems when a future version | |
5549 uses another default. To remove the current directory use: > | |
5550 :set path-= | |
5551 < To add the current directory use: > | |
5552 :set path+= | |
5553 < To use an environment variable, you probably need to replace the | |
5554 separator. Here is an example to append $INCL, in which directory | |
5555 names are separated with a semi-colon: > | |
5556 :let &path = &path . "," . substitute($INCL, ';', ',', 'g') | |
5557 < Replace the ';' with a ':' or whatever separator is used. Note that | |
5558 this doesn't work when $INCL contains a comma or white space. | |
5559 | |
12499 | 5560 *'perldll'* |
5561 'perldll' string (default depends on the build) | |
5562 global | |
5563 {only available when compiled with the |+perl/dyn| | |
5564 feature} | |
5565 Specifies the name of the Perl shared library. The default is | |
5566 DYNAMIC_PERL_DLL, which was specified at compile time. | |
5567 Environment variables are expanded |:set_env|. | |
5568 This option cannot be set from a |modeline| or in the |sandbox|, for | |
5569 security reasons. | |
5570 | |
7 | 5571 *'preserveindent'* *'pi'* *'nopreserveindent'* *'nopi'* |
5572 'preserveindent' 'pi' boolean (default off) | |
5573 local to buffer | |
5574 When changing the indent of the current line, preserve as much of the | |
5575 indent structure as possible. Normally the indent is replaced by a | |
5576 series of tabs followed by spaces as required (unless |'expandtab'| is | |
5577 enabled, in which case only spaces are used). Enabling this option | |
5578 means the indent will preserve as many existing characters as possible | |
5579 for indenting, and only add additional tabs or spaces as required. | |
1621 | 5580 'expandtab' does not apply to the preserved white space, a Tab remains |
5581 a Tab. | |
7 | 5582 NOTE: When using ">>" multiple times the resulting indent is a mix of |
5583 tabs and spaces. You might not like this. | |
11160 | 5584 NOTE: This option is reset when 'compatible' is set. |
7 | 5585 Also see 'copyindent'. |
5586 Use |:retab| to clean up white space. | |
5587 | |
5588 *'previewheight'* *'pvh'* | |
5589 'previewheight' 'pvh' number (default 12) | |
5590 global | |
5591 {not available when compiled without the |+windows| or | |
2570
71b56b4e7785
Make the references to features in the help more consistent. (Sylvain Hitier)
Bram Moolenaar <bram@vim.org>
parents:
2561
diff
changeset
|
5592 |+quickfix| features} |
7 | 5593 Default height for a preview window. Used for |:ptag| and associated |
5594 commands. Used for |CTRL-W_}| when no count is given. | |
5595 | |
5596 *'previewwindow'* *'nopreviewwindow'* | |
5597 *'pvw'* *'nopvw'* *E590* | |
5598 'previewwindow' 'pvw' boolean (default off) | |
5599 local to window | |
5600 {not available when compiled without the |+windows| or | |
2570
71b56b4e7785
Make the references to features in the help more consistent. (Sylvain Hitier)
Bram Moolenaar <bram@vim.org>
parents:
2561
diff
changeset
|
5601 |+quickfix| features} |
10 | 5602 Identifies the preview window. Only one window can have this option |
7 | 5603 set. It's normally not set directly, but by using one of the commands |
5604 |:ptag|, |:pedit|, etc. | |
5605 | |
5606 *'printdevice'* *'pdev'* | |
5607 'printdevice' 'pdev' string (default empty) | |
5608 global | |
5609 {only available when compiled with the |+printer| | |
5610 feature} | |
15 | 5611 The name of the printer to be used for |:hardcopy|. |
5612 See |pdev-option|. | |
36 | 5613 This option cannot be set from a |modeline| or in the |sandbox|, for |
5614 security reasons. | |
15 | 5615 |
5616 *'printencoding'* *'penc'* | |
14864 | 5617 'printencoding' 'penc' string (default empty, except for some systems) |
7 | 5618 global |
5619 {only available when compiled with the |+printer| | |
5620 and |+postscript| features} | |
15 | 5621 Sets the character encoding used when printing. |
5622 See |penc-option|. | |
7 | 5623 |
5624 *'printexpr'* *'pexpr'* | |
14864 | 5625 'printexpr' 'pexpr' string (default: see below) |
7 | 5626 global |
5627 {only available when compiled with the |+printer| | |
5628 and |+postscript| features} | |
15 | 5629 Expression used to print the PostScript produced with |:hardcopy|. |
5630 See |pexpr-option|. | |
10449
222b1432814e
commit https://github.com/vim/vim/commit/5162822914372fc916a93f85848c0c82209e7cec
Christian Brabandt <cb@256bit.org>
parents:
10272
diff
changeset
|
5631 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
|
5632 security reasons. |
15 | 5633 |
5634 *'printfont'* *'pfn'* | |
7 | 5635 'printfont' 'pfn' string (default "courier") |
5636 global | |
5637 {only available when compiled with the |+printer| | |
5638 feature} | |
15 | 5639 The name of the font that will be used for |:hardcopy|. |
5640 See |pfn-option|. | |
7 | 5641 |
5642 *'printheader'* *'pheader'* | |
5643 'printheader' 'pheader' string (default "%<%f%h%m%=Page %N") | |
5644 global | |
5645 {only available when compiled with the |+printer| | |
5646 feature} | |
15 | 5647 The format of the header produced in |:hardcopy| output. |
5648 See |pheader-option|. | |
5649 | |
5650 *'printmbcharset'* *'pmbcs'* | |
5651 'printmbcharset' 'pmbcs' string (default "") | |
5652 global | |
15878 | 5653 {only available when compiled with the |+printer| |
5654 and |+postscript| features} | |
15 | 5655 The CJK character set to be used for CJK output from |:hardcopy|. |
5656 See |pmbcs-option|. | |
5657 | |
5658 *'printmbfont'* *'pmbfn'* | |
5659 'printmbfont' 'pmbfn' string (default "") | |
5660 global | |
15878 | 5661 {only available when compiled with the |+printer| |
5662 and |+postscript| features} | |
15 | 5663 List of font names to be used for CJK output from |:hardcopy|. |
5664 See |pmbfn-option|. | |
7 | 5665 |
5666 *'printoptions'* *'popt'* | |
5667 'printoptions' 'popt' string (default "") | |
5668 global | |
5669 {only available when compiled with |+printer| feature} | |
15 | 5670 List of items that control the format of the output of |:hardcopy|. |
5671 See |popt-option|. | |
5672 | |
168 | 5673 *'prompt'* *'noprompt'* |
5674 'prompt' boolean (default on) | |
5675 global | |
5676 When on a ":" prompt is used in Ex mode. | |
5677 | |
766 | 5678 *'pumheight'* *'ph'* |
5679 'pumheight' 'ph' number (default 0) | |
5680 global | |
5681 {not available when compiled without the | |
5682 |+insert_expand| feature} | |
853 | 5683 Determines the maximum number of items to show in the popup menu for |
5684 Insert mode completion. When zero as much space as available is used. | |
766 | 5685 |ins-completion-menu|. |
5686 | |
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
|
5687 *'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
|
5688 '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
|
5689 global |
6e972d830e13
patch 8.0.1491: the minimum width of the popup menu is hard coded
Christian Brabandt <cb@256bit.org>
parents:
13231
diff
changeset
|
5690 {not available when compiled without the |
6e972d830e13
patch 8.0.1491: the minimum width of the popup menu is hard coded
Christian Brabandt <cb@256bit.org>
parents:
13231
diff
changeset
|
5691 |+insert_expand| feature} |
13341
acd7eaa13d2b
Updated runtime files.
Christian Brabandt <cb@256bit.org>
parents:
13314
diff
changeset
|
5692 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
|
5693 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
|
5694 |
7228
873eae260c97
commit https://github.com/vim/vim/commit/b4ff518d95aa57c2f8c0568c915035bef849581b
Christian Brabandt <cb@256bit.org>
parents:
7218
diff
changeset
|
5695 *'pythondll'* |
8629
54ac275e3fc4
commit https://github.com/vim/vim/commit/3848e00e0177abdb31bc600234967863ec487233
Christian Brabandt <cb@256bit.org>
parents:
8560
diff
changeset
|
5696 '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
|
5697 global |
7228
873eae260c97
commit https://github.com/vim/vim/commit/b4ff518d95aa57c2f8c0568c915035bef849581b
Christian Brabandt <cb@256bit.org>
parents:
7218
diff
changeset
|
5698 {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
|
5699 feature} |
7528
53163e4d9e4f
commit https://github.com/vim/vim/commit/25e4fcde767084d1a79e0926bc301c92987c0cce
Christian Brabandt <cb@256bit.org>
parents:
7477
diff
changeset
|
5700 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
|
5701 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
|
5702 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
|
5703 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
|
5704 security reasons. |
873eae260c97
commit https://github.com/vim/vim/commit/b4ff518d95aa57c2f8c0568c915035bef849581b
Christian Brabandt <cb@256bit.org>
parents:
7218
diff
changeset
|
5705 |
13154
53cc7ea77c54
patch 8.0.1451: difficult to set the python home directories properly
Christian Brabandt <cb@256bit.org>
parents:
13150
diff
changeset
|
5706 *'pythonhome'* |
53cc7ea77c54
patch 8.0.1451: difficult to set the python home directories properly
Christian Brabandt <cb@256bit.org>
parents:
13150
diff
changeset
|
5707 '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
|
5708 global |
53cc7ea77c54
patch 8.0.1451: difficult to set the python home directories properly
Christian Brabandt <cb@256bit.org>
parents:
13150
diff
changeset
|
5709 {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
|
5710 feature} |
53cc7ea77c54
patch 8.0.1451: difficult to set the python home directories properly
Christian Brabandt <cb@256bit.org>
parents:
13150
diff
changeset
|
5711 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
|
5712 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
|
5713 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
|
5714 home directory. |
53cc7ea77c54
patch 8.0.1451: difficult to set the python home directories properly
Christian Brabandt <cb@256bit.org>
parents:
13150
diff
changeset
|
5715 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
|
5716 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
|
5717 security reasons. |
53cc7ea77c54
patch 8.0.1451: difficult to set the python home directories properly
Christian Brabandt <cb@256bit.org>
parents:
13150
diff
changeset
|
5718 |
7218
36dc8df8560f
commit https://github.com/vim/vim/commit/0796c0625fa4b9eb2f47fe8c976b78523924e1fb
Christian Brabandt <cb@256bit.org>
parents:
7196
diff
changeset
|
5719 *'pythonthreedll'* |
7528
53163e4d9e4f
commit https://github.com/vim/vim/commit/25e4fcde767084d1a79e0926bc301c92987c0cce
Christian Brabandt <cb@256bit.org>
parents:
7477
diff
changeset
|
5720 '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
|
5721 global |
7196
42717d048817
commit https://github.com/vim/vim/commit/d94464ee294a351ce7b6ba18e8bd3f24f1bef920
Christian Brabandt <cb@256bit.org>
parents:
7147
diff
changeset
|
5722 {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
|
5723 feature} |
7528
53163e4d9e4f
commit https://github.com/vim/vim/commit/25e4fcde767084d1a79e0926bc301c92987c0cce
Christian Brabandt <cb@256bit.org>
parents:
7477
diff
changeset
|
5724 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
|
5725 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
|
5726 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
|
5727 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
|
5728 security reasons. |
42717d048817
commit https://github.com/vim/vim/commit/d94464ee294a351ce7b6ba18e8bd3f24f1bef920
Christian Brabandt <cb@256bit.org>
parents:
7147
diff
changeset
|
5729 |
13154
53cc7ea77c54
patch 8.0.1451: difficult to set the python home directories properly
Christian Brabandt <cb@256bit.org>
parents:
13150
diff
changeset
|
5730 *'pythonthreehome'* |
53cc7ea77c54
patch 8.0.1451: difficult to set the python home directories properly
Christian Brabandt <cb@256bit.org>
parents:
13150
diff
changeset
|
5731 '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
|
5732 global |
53cc7ea77c54
patch 8.0.1451: difficult to set the python home directories properly
Christian Brabandt <cb@256bit.org>
parents:
13150
diff
changeset
|
5733 {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
|
5734 feature} |
53cc7ea77c54
patch 8.0.1451: difficult to set the python home directories properly
Christian Brabandt <cb@256bit.org>
parents:
13150
diff
changeset
|
5735 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
|
5736 '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
|
5737 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
|
5738 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
|
5739 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
|
5740 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
|
5741 security reasons. |
53cc7ea77c54
patch 8.0.1451: difficult to set the python home directories properly
Christian Brabandt <cb@256bit.org>
parents:
13150
diff
changeset
|
5742 |
10722
7598ce51bf2a
patch 8.0.0251: not easy to select Python 2 or 3
Christian Brabandt <cb@256bit.org>
parents:
10617
diff
changeset
|
5743 *'pyxversion'* *'pyx'* |
7598ce51bf2a
patch 8.0.0251: not easy to select Python 2 or 3
Christian Brabandt <cb@256bit.org>
parents:
10617
diff
changeset
|
5744 '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
|
5745 global |
7598ce51bf2a
patch 8.0.0251: not easy to select Python 2 or 3
Christian Brabandt <cb@256bit.org>
parents:
10617
diff
changeset
|
5746 {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
|
5747 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
|
5748 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
|
5749 |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
|
5750 |
7598ce51bf2a
patch 8.0.0251: not easy to select Python 2 or 3
Christian Brabandt <cb@256bit.org>
parents:
10617
diff
changeset
|
5751 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
|
5752 |+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
|
5753 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
|
5754 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
|
5755 |
7598ce51bf2a
patch 8.0.0251: not easy to select Python 2 or 3
Christian Brabandt <cb@256bit.org>
parents:
10617
diff
changeset
|
5756 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
|
5757 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
|
5758 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
|
5759 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
|
5760 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
|
5761 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
|
5762 |
7598ce51bf2a
patch 8.0.0251: not easy to select Python 2 or 3
Christian Brabandt <cb@256bit.org>
parents:
10617
diff
changeset
|
5763 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
|
5764 '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
|
5765 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
|
5766 |
7598ce51bf2a
patch 8.0.0251: not easy to select Python 2 or 3
Christian Brabandt <cb@256bit.org>
parents:
10617
diff
changeset
|
5767 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
|
5768 security reasons. |
7598ce51bf2a
patch 8.0.0251: not easy to select Python 2 or 3
Christian Brabandt <cb@256bit.org>
parents:
10617
diff
changeset
|
5769 |
140 | 5770 *'quoteescape'* *'qe'* |
12 | 5771 'quoteescape' 'qe' string (default "\") |
5772 local to buffer | |
5773 The characters that are used to escape quotes in a string. Used for | |
5774 objects like a', a" and a` |a'|. | |
5775 When one of the characters in this option is found inside a string, | |
5776 the following character will be skipped. The default value makes the | |
5777 text "foo\"bar\\" considered to be one string. | |
5778 | |
7 | 5779 *'readonly'* *'ro'* *'noreadonly'* *'noro'* |
5780 'readonly' 'ro' boolean (default off) | |
5781 local to buffer | |
5782 If on, writes fail unless you use a '!'. Protects you from | |
5783 accidentally overwriting a file. Default on when Vim is started | |
5784 in read-only mode ("vim -R") or when the executable is called "view". | |
164 | 5785 When using ":w!" the 'readonly' option is reset for the current |
5786 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
|
5787 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
|
5788 newly edited buffer. |
10617 | 5789 See 'modifiable' for disallowing changes to the buffer. |
7 | 5790 |
1521 | 5791 *'redrawtime'* *'rdt'* |
5792 'redrawtime' 'rdt' number (default 2000) | |
5793 global | |
5794 {only available when compiled with the |+reltime| | |
5795 feature} | |
5796 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
|
5797 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
|
5798 highlighting. |
1521 | 5799 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
|
5800 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
|
5801 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
|
5802 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
|
5803 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
|
5804 pattern. |
1521 | 5805 |
4681
2eb30f341e8d
Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents:
4502
diff
changeset
|
5806 *'regexpengine'* *'re'* |
4502
605c9ce57ec3
Updated runtime files, language files and translations.
Bram Moolenaar <bram@vim.org>
parents:
4358
diff
changeset
|
5807 'regexpengine' 're' number (default 0) |
605c9ce57ec3
Updated runtime files, language files and translations.
Bram Moolenaar <bram@vim.org>
parents:
4358
diff
changeset
|
5808 global |
605c9ce57ec3
Updated runtime files, language files and translations.
Bram Moolenaar <bram@vim.org>
parents:
4358
diff
changeset
|
5809 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
|
5810 The possible values are: |
605c9ce57ec3
Updated runtime files, language files and translations.
Bram Moolenaar <bram@vim.org>
parents:
4358
diff
changeset
|
5811 0 automatic selection |
605c9ce57ec3
Updated runtime files, language files and translations.
Bram Moolenaar <bram@vim.org>
parents:
4358
diff
changeset
|
5812 1 old engine |
605c9ce57ec3
Updated runtime files, language files and translations.
Bram Moolenaar <bram@vim.org>
parents:
4358
diff
changeset
|
5813 2 NFA engine |
605c9ce57ec3
Updated runtime files, language files and translations.
Bram Moolenaar <bram@vim.org>
parents:
4358
diff
changeset
|
5814 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
|
5815 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
|
5816 for debugging the regexp engine. |
6328 | 5817 Using automatic selection enables Vim to switch the engine, if the |
5818 default engine becomes too costly. E.g., when the NFA engine uses too | |
5819 many states. This should prevent Vim from hanging on a combination of | |
5820 a complex pattern with long text. | |
4502
605c9ce57ec3
Updated runtime files, language files and translations.
Bram Moolenaar <bram@vim.org>
parents:
4358
diff
changeset
|
5821 |
2178
c6f1aa1e9f32
Add 'relativenumber' patch from Markus Heidelberg.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
5822 *'relativenumber'* *'rnu'* *'norelativenumber'* *'nornu'* |
c6f1aa1e9f32
Add 'relativenumber' patch from Markus Heidelberg.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
5823 'relativenumber' 'rnu' boolean (default off) |
c6f1aa1e9f32
Add 'relativenumber' patch from Markus Heidelberg.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
5824 local to window |
c6f1aa1e9f32
Add 'relativenumber' patch from Markus Heidelberg.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
5825 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
|
5826 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
|
5827 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
|
5828 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
|
5829 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
|
5830 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
|
5831 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
|
5832 'compatible' isn't set). |
c6f1aa1e9f32
Add 'relativenumber' patch from Markus Heidelberg.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
5833 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
|
5834 number. |
c6f1aa1e9f32
Add 'relativenumber' patch from Markus Heidelberg.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
5835 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
|
5836 characters are put before the number. |
3445 | 5837 See |hl-LineNr| and |hl-CursorLineNr| for the highlighting used for |
5838 the number. | |
13341
acd7eaa13d2b
Updated runtime files.
Christian Brabandt <cb@256bit.org>
parents:
13314
diff
changeset
|
5839 |
4780 | 5840 The number in front of the cursor line also depends on the value of |
5841 'number', see |number_relativenumber| for all combinations of the two | |
5842 options. | |
2178
c6f1aa1e9f32
Add 'relativenumber' patch from Markus Heidelberg.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
5843 |
7 | 5844 *'remap'* *'noremap'* |
5845 'remap' boolean (default on) | |
5846 global | |
5847 Allows for mappings to work recursively. If you do not want this for | |
5848 a single entry, use the :noremap[!] command. | |
717 | 5849 NOTE: To avoid portability problems with Vim scripts, always keep |
5850 this option at the default "on". Only switch it off when working with | |
5851 old Vi scripts. | |
7 | 5852 |
6110 | 5853 *'renderoptions'* *'rop'* |
5854 'renderoptions' 'rop' string (default: empty) | |
5855 global | |
5856 {only available when compiled with GUI and DIRECTX on | |
5857 MS-Windows} | |
5858 Select a text renderer and set its options. The options depend on the | |
5859 renderer. | |
5860 | |
5861 Syntax: > | |
5862 set rop=type:{renderer}(,{name}:{value})* | |
5863 < | |
5864 Currently, only one optional renderer is available. | |
5865 | |
5866 render behavior ~ | |
5867 directx Vim will draw text using DirectX (DirectWrite). It makes | |
5868 drawn glyphs more beautiful than default GDI. | |
5869 It requires 'encoding' is "utf-8", and only works on | |
5870 MS-Windows Vista or newer version. | |
5871 | |
5872 Options: | |
5873 name meaning type value ~ | |
5874 gamma gamma float 1.0 - 2.2 (maybe) | |
5875 contrast enhancedContrast float (unknown) | |
5876 level clearTypeLevel float (unknown) | |
5877 geom pixelGeometry int 0 - 2 (see below) | |
5878 renmode renderingMode int 0 - 6 (see below) | |
5879 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
|
5880 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
|
5881 |
18e6f4addce9
patch 8.0.1369: MS-Windows: drawing underline slow, mFallbackDC not updated
Christian Brabandt <cb@256bit.org>
parents:
12971
diff
changeset
|
5882 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
|
5883 https://msdn.microsoft.com/en-us/library/dd368190.aspx |
6110 | 5884 |
5885 For geom: structure of a device pixel. | |
5886 0 - DWRITE_PIXEL_GEOMETRY_FLAT | |
5887 1 - DWRITE_PIXEL_GEOMETRY_RGB | |
5888 2 - DWRITE_PIXEL_GEOMETRY_BGR | |
5889 | |
5890 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
|
5891 https://msdn.microsoft.com/en-us/library/dd368114.aspx |
6110 | 5892 |
5893 For renmode: method of rendering glyphs. | |
5894 0 - DWRITE_RENDERING_MODE_DEFAULT | |
5895 1 - DWRITE_RENDERING_MODE_ALIASED | |
5896 2 - DWRITE_RENDERING_MODE_GDI_CLASSIC | |
5897 3 - DWRITE_RENDERING_MODE_GDI_NATURAL | |
5898 4 - DWRITE_RENDERING_MODE_NATURAL | |
5899 5 - DWRITE_RENDERING_MODE_NATURAL_SYMMETRIC | |
5900 6 - DWRITE_RENDERING_MODE_OUTLINE | |
5901 | |
5902 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
|
5903 https://msdn.microsoft.com/en-us/library/dd368118.aspx |
6110 | 5904 |
5905 For taamode: antialiasing mode used for drawing text. | |
5906 0 - D2D1_TEXT_ANTIALIAS_MODE_DEFAULT | |
5907 1 - D2D1_TEXT_ANTIALIAS_MODE_CLEARTYPE | |
5908 2 - D2D1_TEXT_ANTIALIAS_MODE_GRAYSCALE | |
5909 3 - D2D1_TEXT_ANTIALIAS_MODE_ALIASED | |
5910 | |
5911 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
|
5912 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
|
5913 |
13150
808625d4b71b
patch 8.0.1449: slow redrawing with DirectX
Christian Brabandt <cb@256bit.org>
parents:
13100
diff
changeset
|
5914 For scrlines: |
808625d4b71b
patch 8.0.1449: slow redrawing with DirectX
Christian Brabandt <cb@256bit.org>
parents:
13100
diff
changeset
|
5915 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
|
5916 is now deprecated. If specified, it is simply ignored. |
6110 | 5917 |
5918 Example: > | |
5919 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
|
5920 set gfn=Ricty_Diminished:h12 |
6110 | 5921 set rop=type:directx |
5922 < | |
12934
2ebc3df65ca2
patch 8.0.1343: MS-Windows: does not show colored emojis
Christian Brabandt <cb@256bit.org>
parents:
12930
diff
changeset
|
5923 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
|
5924 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
|
5925 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
|
5926 |
2ebc3df65ca2
patch 8.0.1343: MS-Windows: does not show colored emojis
Christian Brabandt <cb@256bit.org>
parents:
12930
diff
changeset
|
5927 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
|
5928 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
|
5929 |
12986
18e6f4addce9
patch 8.0.1369: MS-Windows: drawing underline slow, mFallbackDC not updated
Christian Brabandt <cb@256bit.org>
parents:
12971
diff
changeset
|
5930 - '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
|
5931 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
|
5932 bitmap glyphs). |
2ebc3df65ca2
patch 8.0.1343: MS-Windows: does not show colored emojis
Christian Brabandt <cb@256bit.org>
parents:
12930
diff
changeset
|
5933 - '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
|
5934 |
2ebc3df65ca2
patch 8.0.1343: MS-Windows: does not show colored emojis
Christian Brabandt <cb@256bit.org>
parents:
12930
diff
changeset
|
5935 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
|
5936 (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
|
5937 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
|
5938 |
2ebc3df65ca2
patch 8.0.1343: MS-Windows: does not show colored emojis
Christian Brabandt <cb@256bit.org>
parents:
12930
diff
changeset
|
5939 - 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
|
5940 be used. |
2ebc3df65ca2
patch 8.0.1343: MS-Windows: does not show colored emojis
Christian Brabandt <cb@256bit.org>
parents:
12930
diff
changeset
|
5941 - 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
|
5942 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
|
5943 will be used. |
2ebc3df65ca2
patch 8.0.1343: MS-Windows: does not show colored emojis
Christian Brabandt <cb@256bit.org>
parents:
12930
diff
changeset
|
5944 - 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
|
5945 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
|
5946 cell. |
6110 | 5947 |
5948 Other render types are currently not supported. | |
5949 | |
7 | 5950 *'report'* |
5951 'report' number (default 2) | |
5952 global | |
5953 Threshold for reporting number of lines changed. When the number of | |
5954 changed lines is more than 'report' a message will be given for most | |
5955 ":" commands. If you want it always, set 'report' to 0. | |
5956 For the ":substitute" command the number of substitutions is used | |
5957 instead of the number of lines. | |
5958 | |
5959 *'restorescreen'* *'rs'* *'norestorescreen'* *'nors'* | |
5960 'restorescreen' 'rs' boolean (default on) | |
5961 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
|
5962 {only in Windows 95/NT console version} |
7 | 5963 When set, the screen contents is restored when exiting Vim. This also |
5964 happens when executing external commands. | |
5965 | |
5966 For non-Windows Vim: You can set or reset the 't_ti' and 't_te' | |
5967 options in your .vimrc. To disable restoring: | |
5968 set t_ti= t_te= | |
5969 To enable restoring (for an xterm): | |
5970 set t_ti=^[7^[[r^[[?47h t_te=^[[?47l^[8 | |
5971 (Where ^[ is an <Esc>, type CTRL-V <Esc> to insert it) | |
5972 | |
5973 *'revins'* *'ri'* *'norevins'* *'nori'* | |
5974 'revins' 'ri' boolean (default off) | |
5975 global | |
5976 {only available when compiled with the |+rightleft| | |
5977 feature} | |
5978 Inserting characters in Insert mode will work backwards. See "typing | |
5979 backwards" |ins-reverse|. This option can be toggled with the CTRL-_ | |
5980 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
|
5981 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
|
5982 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
|
5983 reset. |
7 | 5984 |
5985 *'rightleft'* *'rl'* *'norightleft'* *'norl'* | |
5986 'rightleft' 'rl' boolean (default off) | |
5987 local to window | |
5988 {only available when compiled with the |+rightleft| | |
5989 feature} | |
5990 When on, display orientation becomes right-to-left, i.e., characters | |
5991 that are stored in the file appear from the right to the left. | |
5992 Using this option, it is possible to edit files for languages that | |
5993 are written from the right to the left such as Hebrew and Arabic. | |
5994 This option is per window, so it is possible to edit mixed files | |
5995 simultaneously, or to view the same file in both ways (this is | |
5996 useful whenever you have a mixed text file with both right-to-left | |
5997 and left-to-right strings so that both sets are displayed properly | |
5998 in different windows). Also see |rileft.txt|. | |
5999 | |
2341 | 6000 *'rightleftcmd'* *'rlc'* |
7 | 6001 'rightleftcmd' 'rlc' string (default "search") |
6002 local to window | |
6003 {only available when compiled with the |+rightleft| | |
6004 feature} | |
6005 Each word in this option enables the command line editing to work in | |
6006 right-to-left mode for a group of commands: | |
6007 | |
6008 search "/" and "?" commands | |
6009 | |
6010 This is useful for languages such as Hebrew, Arabic and Farsi. | |
6011 The 'rightleft' option must be set for 'rightleftcmd' to take effect. | |
6012 | |
7196
42717d048817
commit https://github.com/vim/vim/commit/d94464ee294a351ce7b6ba18e8bd3f24f1bef920
Christian Brabandt <cb@256bit.org>
parents:
7147
diff
changeset
|
6013 *'rubydll'* |
8629
54ac275e3fc4
commit https://github.com/vim/vim/commit/3848e00e0177abdb31bc600234967863ec487233
Christian Brabandt <cb@256bit.org>
parents:
8560
diff
changeset
|
6014 '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
|
6015 global |
7196
42717d048817
commit https://github.com/vim/vim/commit/d94464ee294a351ce7b6ba18e8bd3f24f1bef920
Christian Brabandt <cb@256bit.org>
parents:
7147
diff
changeset
|
6016 {only available when compiled with the |+ruby/dyn| |
42717d048817
commit https://github.com/vim/vim/commit/d94464ee294a351ce7b6ba18e8bd3f24f1bef920
Christian Brabandt <cb@256bit.org>
parents:
7147
diff
changeset
|
6017 feature} |
7528
53163e4d9e4f
commit https://github.com/vim/vim/commit/25e4fcde767084d1a79e0926bc301c92987c0cce
Christian Brabandt <cb@256bit.org>
parents:
7477
diff
changeset
|
6018 Specifies the name of the Ruby shared library. The default is |
53163e4d9e4f
commit https://github.com/vim/vim/commit/25e4fcde767084d1a79e0926bc301c92987c0cce
Christian Brabandt <cb@256bit.org>
parents:
7477
diff
changeset
|
6019 DYNAMIC_RUBY_DLL, which was specified at compile time. |
8951
0bdeaf7092bc
commit https://github.com/vim/vim/commit/aa3b15dbebf333282503d6031e2f9ba6ee4398ed
Christian Brabandt <cb@256bit.org>
parents:
8876
diff
changeset
|
6020 Environment variables are expanded |:set_env|. |
7196
42717d048817
commit https://github.com/vim/vim/commit/d94464ee294a351ce7b6ba18e8bd3f24f1bef920
Christian Brabandt <cb@256bit.org>
parents:
7147
diff
changeset
|
6021 This option cannot be set from a |modeline| or in the |sandbox|, for |
42717d048817
commit https://github.com/vim/vim/commit/d94464ee294a351ce7b6ba18e8bd3f24f1bef920
Christian Brabandt <cb@256bit.org>
parents:
7147
diff
changeset
|
6022 security reasons. |
42717d048817
commit https://github.com/vim/vim/commit/d94464ee294a351ce7b6ba18e8bd3f24f1bef920
Christian Brabandt <cb@256bit.org>
parents:
7147
diff
changeset
|
6023 |
7 | 6024 *'ruler'* *'ru'* *'noruler'* *'noru'* |
9669
284b4eb307fc
commit https://github.com/vim/vim/commit/8c08b5b569e2a9e9f63dea514591ecfa2d3bb392
Christian Brabandt <cb@256bit.org>
parents:
9665
diff
changeset
|
6025 'ruler' 'ru' boolean (default off, set in |defaults.vim|) |
7 | 6026 global |
6027 {not available when compiled without the | |
6028 |+cmdline_info| feature} | |
6029 Show the line and column number of the cursor position, separated by a | |
10 | 6030 comma. When there is room, the relative position of the displayed |
7 | 6031 text in the file is shown on the far right: |
6032 Top first line is visible | |
6033 Bot last line is visible | |
6034 All first and last line are visible | |
6035 45% relative position in the file | |
6036 If 'rulerformat' is set, it will determine the contents of the ruler. | |
10 | 6037 Each window has its own ruler. If a window has a status line, the |
7 | 6038 ruler is shown there. Otherwise it is shown in the last line of the |
233 | 6039 screen. If the statusline is given by 'statusline' (i.e. not empty), |
7 | 6040 this option takes precedence over 'ruler' and 'rulerformat' |
6041 If the number of characters displayed is different from the number of | |
6042 bytes in the text (e.g., for a TAB or a multi-byte character), both | |
6043 the text column (byte number) and the screen column are shown, | |
6044 separated with a dash. | |
6045 For an empty line "0-1" is shown. | |
6046 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
|
6047 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
|
6048 reset. |
7 | 6049 If you don't want to see the ruler all the time but want to know where |
6050 you are, use "g CTRL-G" |g_CTRL-G|. | |
6051 NOTE: This option is reset when 'compatible' is set. | |
6052 | |
6053 *'rulerformat'* *'ruf'* | |
6054 'rulerformat' 'ruf' string (default empty) | |
6055 global | |
6056 {not available when compiled without the |+statusline| | |
6057 feature} | |
6058 When this option is not empty, it determines the content of the ruler | |
6059 string, as displayed for the 'ruler' option. | |
692 | 6060 The format of this option is like that of 'statusline'. |
7 | 6061 The default ruler width is 17 characters. To make the ruler 15 |
6062 characters wide, put "%15(" at the start and "%)" at the end. | |
6063 Example: > | |
6064 :set rulerformat=%15(%c%V\ %p%%%) | |
6065 < | |
6066 *'runtimepath'* *'rtp'* *vimfiles* | |
6067 'runtimepath' 'rtp' string (default: | |
6068 Unix: "$HOME/.vim, | |
6069 $VIM/vimfiles, | |
6070 $VIMRUNTIME, | |
6071 $VIM/vimfiles/after, | |
6072 $HOME/.vim/after" | |
6073 Amiga: "home:vimfiles, | |
6074 $VIM/vimfiles, | |
6075 $VIMRUNTIME, | |
6076 $VIM/vimfiles/after, | |
6077 home:vimfiles/after" | |
6078 PC, OS/2: "$HOME/vimfiles, | |
6079 $VIM/vimfiles, | |
6080 $VIMRUNTIME, | |
6081 $VIM/vimfiles/after, | |
6082 $HOME/vimfiles/after" | |
6083 Macintosh: "$VIM:vimfiles, | |
6084 $VIMRUNTIME, | |
6085 $VIM:vimfiles:after" | |
6086 RISC-OS: "Choices:vimfiles, | |
6087 $VIMRUNTIME, | |
6088 Choices:vimfiles/after" | |
6089 VMS: "sys$login:vimfiles, | |
6090 $VIM/vimfiles, | |
6091 $VIMRUNTIME, | |
6092 $VIM/vimfiles/after, | |
233 | 6093 sys$login:vimfiles/after") |
7 | 6094 global |
6095 This is a list of directories which will be searched for runtime | |
6096 files: | |
6097 filetype.vim filetypes by file name |new-filetype| | |
6098 scripts.vim filetypes by file contents |new-filetype-scripts| | |
164 | 6099 autoload/ automatically loaded scripts |autoload-functions| |
7 | 6100 colors/ color scheme files |:colorscheme| |
6101 compiler/ compiler files |:compiler| | |
6102 doc/ documentation |write-local-help| | |
6103 ftplugin/ filetype plugins |write-filetype-plugin| | |
6104 indent/ indent scripts |indent-expression| | |
6105 keymap/ key mapping files |mbyte-keymap| | |
6106 lang/ menu translations |:menutrans| | |
6107 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
|
6108 pack/ packages |:packadd| |
7 | 6109 plugin/ plugin scripts |write-plugin| |
6110 print/ files for printing |postscript-print-encoding| | |
650 | 6111 spell/ spell checking files |spell| |
7 | 6112 syntax/ syntax files |mysyntaxfile| |
6113 tutor/ files for vimtutor |tutor| | |
6114 | |
6115 And any other file searched for with the |:runtime| command. | |
6116 | |
6117 The defaults for most systems are setup to search five locations: | |
6118 1. In your home directory, for your personal preferences. | |
6119 2. In a system-wide Vim directory, for preferences from the system | |
6120 administrator. | |
6121 3. In $VIMRUNTIME, for files distributed with Vim. | |
6122 *after-directory* | |
6123 4. In the "after" directory in the system-wide Vim directory. This is | |
6124 for the system administrator to overrule or add to the distributed | |
6125 defaults (rarely needed) | |
6126 5. In the "after" directory in your home directory. This is for | |
6127 personal preferences to overrule or add to the distributed defaults | |
6128 or system-wide settings (rarely needed). | |
6129 | |
10211
b7da8d4c594c
commit https://github.com/vim/vim/commit/d07969093a9b3051511c478d71c36de6fc33c0d6
Christian Brabandt <cb@256bit.org>
parents:
10198
diff
changeset
|
6130 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
|
6131 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
|
6132 string. |
9116
bc38030aec7d
commit https://github.com/vim/vim/commit/26852128a2b713ef49341a0c18daba928444e7eb
Christian Brabandt <cb@256bit.org>
parents:
9098
diff
changeset
|
6133 |
7 | 6134 Note that, unlike 'path', no wildcards like "**" are allowed. Normal |
6135 wildcards are allowed, but can significantly slow down searching for | |
10 | 6136 runtime files. For speed, use as few items as possible and avoid |
7 | 6137 wildcards. |
6138 See |:runtime|. | |
6139 Example: > | |
6140 :set runtimepath=~/vimruntime,/mygroup/vim,$VIMRUNTIME | |
6141 < This will use the directory "~/vimruntime" first (containing your | |
6142 personal Vim runtime files), then "/mygroup/vim" (shared between a | |
6143 group of people) and finally "$VIMRUNTIME" (the distributed runtime | |
6144 files). | |
6145 You probably should always include $VIMRUNTIME somewhere, to use the | |
6146 distributed runtime files. You can put a directory before $VIMRUNTIME | |
6147 to find files which replace a distributed runtime files. You can put | |
6148 a directory after $VIMRUNTIME to find files which add to distributed | |
6149 runtime files. | |
13437 | 6150 When Vim is started with |--clean| the home directory entries are not |
6151 included. | |
7 | 6152 This option cannot be set from a |modeline| or in the |sandbox|, for |
6153 security reasons. | |
6154 | |
6155 *'scroll'* *'scr'* | |
6156 'scroll' 'scr' number (default: half the window height) | |
6157 local to window | |
6158 Number of lines to scroll with CTRL-U and CTRL-D commands. Will be | |
6159 set to half the number of lines in the window when the window size | |
6160 changes. If you give a count to the CTRL-U or CTRL-D command it will | |
10 | 6161 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
|
6162 height with ":set scroll=0". |
7 | 6163 |
6164 *'scrollbind'* *'scb'* *'noscrollbind'* *'noscb'* | |
6165 'scrollbind' 'scb' boolean (default off) | |
6166 local to window | |
6167 See also |scroll-binding|. When this option is set, the current | |
6168 window scrolls as other scrollbind windows (windows that also have | |
6169 this option set) scroll. This option is useful for viewing the | |
6170 differences between two versions of a file, see 'diff'. | |
6171 See |'scrollopt'| for options that determine how this option should be | |
6172 interpreted. | |
6173 This option is mostly reset when splitting a window to edit another | |
6174 file. This means that ":split | edit file" results in two windows | |
6175 with scroll-binding, but ":split file" does not. | |
6176 | |
6177 *'scrolljump'* *'sj'* | |
6178 'scrolljump' 'sj' number (default 1) | |
6179 global | |
6180 Minimal number of lines to scroll when the cursor gets off the | |
6181 screen (e.g., with "j"). Not used for scroll commands (e.g., CTRL-E, | |
6182 CTRL-D). Useful if your terminal scrolls very slowly. | |
532 | 6183 When set to a negative number from -1 to -100 this is used as the |
6184 percentage of the window height. Thus -50 scrolls half the window | |
6185 height. | |
7 | 6186 NOTE: This option is set to 1 when 'compatible' is set. |
6187 | |
6188 *'scrolloff'* *'so'* | |
10218
584c835a2de1
commit https://github.com/vim/vim/commit/50ba526fbf3e9e5e0e6b0b3086a4d5df581ebc7e
Christian Brabandt <cb@256bit.org>
parents:
10211
diff
changeset
|
6189 '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
|
6190 global or local to window |global-local| |
7 | 6191 Minimal number of screen lines to keep above and below the cursor. |
6192 This will make some context visible around where you are working. If | |
6193 you set it to a very large value (999) the cursor line will always be | |
6194 in the middle of the window (except at the start or end of the file or | |
6195 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
|
6196 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
|
6197 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
|
6198 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
|
6199 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
|
6200 < For scrolling horizontally see 'sidescrolloff'. |
7 | 6201 NOTE: This option is set to 0 when 'compatible' is set. |
6202 | |
6203 *'scrollopt'* *'sbo'* | |
6204 'scrollopt' 'sbo' string (default "ver,jump") | |
6205 global | |
6206 This is a comma-separated list of words that specifies how | |
236 | 6207 'scrollbind' windows should behave. 'sbo' stands for ScrollBind |
6208 Options. | |
7 | 6209 The following words are available: |
6210 ver Bind vertical scrolling for 'scrollbind' windows | |
6211 hor Bind horizontal scrolling for 'scrollbind' windows | |
6212 jump Applies to the offset between two windows for vertical | |
6213 scrolling. This offset is the difference in the first | |
6214 displayed line of the bound windows. When moving | |
6215 around in a window, another 'scrollbind' window may | |
6216 reach a position before the start or after the end of | |
6217 the buffer. The offset is not changed though, when | |
6218 moving back the 'scrollbind' window will try to scroll | |
6219 to the desired position when possible. | |
6220 When now making that window the current one, two | |
6221 things can be done with the relative offset: | |
6222 1. When "jump" is not included, the relative offset is | |
6223 adjusted for the scroll position in the new current | |
6224 window. When going back to the other window, the | |
1152 | 6225 new relative offset will be used. |
7 | 6226 2. When "jump" is included, the other windows are |
6227 scrolled to keep the same relative offset. When | |
6228 going back to the other window, it still uses the | |
6229 same relative offset. | |
6230 Also see |scroll-binding|. | |
819 | 6231 When 'diff' mode is active there always is vertical scroll binding, |
6232 even when "ver" isn't there. | |
7 | 6233 |
6234 *'sections'* *'sect'* | |
6235 'sections' 'sect' string (default "SHNHH HUnhsh") | |
6236 global | |
6237 Specifies the nroff macros that separate sections. These are pairs of | |
6238 two letters (See |object-motions|). The default makes a section start | |
6239 at the nroff macros ".SH", ".NH", ".H", ".HU", ".nh" and ".sh". | |
6240 | |
6241 *'secure'* *'nosecure'* *E523* | |
6242 'secure' boolean (default off) | |
6243 global | |
6244 When on, ":autocmd", shell and write commands are not allowed in | |
6245 ".vimrc" and ".exrc" in the current directory and map commands are | |
6246 displayed. Switch it off only if you know that you will not run into | |
6247 problems, or when the 'exrc' option is off. On Unix this option is | |
6248 only used if the ".vimrc" or ".exrc" is not owned by you. This can be | |
10 | 6249 dangerous if the systems allows users to do a "chown". You better set |
7 | 6250 'secure' at the end of your ~/.vimrc then. |
6251 This option cannot be set from a |modeline| or in the |sandbox|, for | |
6252 security reasons. | |
6253 | |
6254 *'selection'* *'sel'* | |
6255 'selection' 'sel' string (default "inclusive") | |
6256 global | |
6257 This option defines the behavior of the selection. It is only used | |
6258 in Visual and Select mode. | |
6259 Possible values: | |
6260 value past line inclusive ~ | |
6261 old no yes | |
6262 inclusive yes yes | |
6263 exclusive yes no | |
6264 "past line" means that the cursor is allowed to be positioned one | |
6265 character past the line. | |
6266 "inclusive" means that the last character of the selection is included | |
6267 in an operation. For example, when "x" is used to delete the | |
6268 selection. | |
9975
03fa8a51e9dc
commit https://github.com/vim/vim/commit/e4a3bcf28d92d0bde9ca227ccb40d401038185e5
Christian Brabandt <cb@256bit.org>
parents:
9913
diff
changeset
|
6269 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
|
6270 the end of line the line break still isn't included. |
7 | 6271 Note that when "exclusive" is used and selecting from the end |
6272 backwards, you cannot include the last character of a line, when | |
6273 starting in Normal mode and 'virtualedit' empty. | |
6274 | |
6275 The 'selection' option is set by the |:behave| command. | |
6276 | |
6277 *'selectmode'* *'slm'* | |
6278 'selectmode' 'slm' string (default "") | |
6279 global | |
6280 This is a comma separated list of words, which specifies when to start | |
6281 Select mode instead of Visual mode, when a selection is started. | |
6282 Possible values: | |
6283 mouse when using the mouse | |
6284 key when using shifted special keys | |
6285 cmd when using "v", "V" or CTRL-V | |
6286 See |Select-mode|. | |
6287 The 'selectmode' option is set by the |:behave| command. | |
6288 | |
6289 *'sessionoptions'* *'ssop'* | |
6290 'sessionoptions' 'ssop' string (default: "blank,buffers,curdir,folds, | |
13437 | 6291 help,options,tabpages,winsize,terminal") |
7 | 6292 global |
2570
71b56b4e7785
Make the references to features in the help more consistent. (Sylvain Hitier)
Bram Moolenaar <bram@vim.org>
parents:
2561
diff
changeset
|
6293 {not available when compiled without the |+mksession| |
7 | 6294 feature} |
6295 Changes the effect of the |:mksession| command. It is a comma | |
6296 separated list of words. Each word enables saving and restoring | |
6297 something: | |
6298 word save and restore ~ | |
6299 blank empty windows | |
6300 buffers hidden and unloaded buffers, not just those in windows | |
6301 curdir the current directory | |
6302 folds manually created folds, opened/closed folds and local | |
6303 fold options | |
6304 globals global variables that start with an uppercase letter | |
75 | 6305 and contain at least one lowercase letter. Only |
6306 String and Number types are stored. | |
7 | 6307 help the help window |
6308 localoptions options and mappings local to a window or buffer (not | |
6309 global values for local options) | |
6310 options all options and mappings (also global values for local | |
6311 options) | |
6312 resize size of the Vim window: 'lines' and 'columns' | |
6313 sesdir the directory in which the session file is located | |
6314 will become the current directory (useful with | |
6315 projects accessed over a network from different | |
6316 systems) | |
6317 slash backslashes in file names replaced with forward | |
6318 slashes | |
827 | 6319 tabpages all tab pages; without this only the current tab page |
6320 is restored, so that you can make a session for each | |
6321 tab page separately | |
14519 | 6322 terminal include terminal windows where the command can be |
6323 restored | |
7 | 6324 unix with Unix end-of-line format (single <NL>), even when |
6325 on Windows or DOS | |
6326 winpos position of the whole Vim window | |
6327 winsize window sizes | |
6328 | |
6329 Don't include both "curdir" and "sesdir". | |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
6330 When neither "curdir" nor "sesdir" is included, file names are stored |
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
6331 with absolute paths. |
7 | 6332 "slash" and "unix" are useful on Windows when sharing session files |
6333 with Unix. The Unix version of Vim cannot source dos format scripts, | |
6334 but the Windows version of Vim can source unix format scripts. | |
6335 | |
6336 *'shell'* *'sh'* *E91* | |
6337 'shell' 'sh' string (default $SHELL or "sh", | |
6338 MS-DOS and Win32: "command.com" or | |
6339 "cmd.exe", OS/2: "cmd") | |
6340 global | |
6341 Name of the shell to use for ! and :! commands. When changing the | |
6342 value also check these options: 'shelltype', 'shellpipe', 'shellslash' | |
6343 'shellredir', 'shellquote', 'shellxquote' and 'shellcmdflag'. | |
10 | 6344 It is allowed to give an argument to the command, e.g. "csh -f". |
7 | 6345 See |option-backslash| about including spaces and backslashes. |
6346 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
|
6347 |
7 | 6348 If the name of the shell contains a space, you might need to enclose |
13162
51521b8a370c
patch 8.0.1455: if $SHELL contains a space then 'shell' is incorrect
Christian Brabandt <cb@256bit.org>
parents:
13154
diff
changeset
|
6349 it in quotes or escape the space. Example with quotes: > |
7 | 6350 :set shell=\"c:\program\ files\unix\sh.exe\"\ -f |
6351 < Note the backslash before each quote (to avoid starting a comment) and | |
10 | 6352 each space (to avoid ending the option value). Also note that the |
7 | 6353 "-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
|
6354 name. Vim automagically recognizes the backslashes that are path |
7 | 6355 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
|
6356 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
|
6357 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
|
6358 :set shell=/bin/with\\\ space/sh |
14519 | 6359 < 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
|
6360 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
|
6361 |
7 | 6362 Under MS-Windows, when the executable ends in ".com" it must be |
6363 included. Thus setting the shell to "command.com" or "4dos.com" | |
6364 works, but "command" and "4dos" do not work for all commands (e.g., | |
6365 filtering). | |
6366 For unknown reasons, when using "4dos.com" the current directory is | |
6367 changed to "C:\". To avoid this set 'shell' like this: > | |
6368 :set shell=command.com\ /c\ 4dos | |
6369 < This option cannot be set from a |modeline| or in the |sandbox|, for | |
6370 security reasons. | |
6371 | |
6372 *'shellcmdflag'* *'shcf'* | |
3356 | 6373 'shellcmdflag' 'shcf' string (default: "-c"; |
3371 | 6374 MS-DOS and Win32, when 'shell' does not |
6375 contain "sh" somewhere: "/c") | |
7 | 6376 global |
6377 Flag passed to the shell to execute "!" and ":!" commands; e.g., | |
6378 "bash.exe -c ls" or "command.com /c dir". For the MS-DOS-like | |
6379 systems, the default is set according to the value of 'shell', to | |
11262 | 6380 reduce the need to set this option by the user. |
3082 | 6381 On Unix it can have more than one flag. Each white space separated |
6382 part is passed as an argument to the shell command. | |
6383 See |option-backslash| about including spaces and backslashes. | |
6384 Also see |dos-shell| for MS-DOS and MS-Windows. | |
7 | 6385 This option cannot be set from a |modeline| or in the |sandbox|, for |
6386 security reasons. | |
6387 | |
6388 *'shellpipe'* *'sp'* | |
6389 'shellpipe' 'sp' string (default ">", "| tee", "|& tee" or "2>&1| tee") | |
6390 global | |
6391 {not available when compiled without the |+quickfix| | |
6392 feature} | |
6393 String to be used to put the output of the ":make" command in the | |
10 | 6394 error file. See also |:make_makeprg|. See |option-backslash| about |
7 | 6395 including spaces and backslashes. |
6396 The name of the temporary file can be represented by "%s" if necessary | |
6397 (the file name is appended automatically if no %s appears in the value | |
6398 of this option). | |
6399 For the Amiga and MS-DOS the default is ">". The output is directly | |
6400 saved in a file and not echoed to the screen. | |
6401 For Unix the default it "| tee". The stdout of the compiler is saved | |
6402 in a file and echoed to the screen. If the 'shell' option is "csh" or | |
6403 "tcsh" after initializations, the default becomes "|& tee". If the | |
2788 | 6404 'shell' option is "sh", "ksh", "mksh", "pdksh", "zsh" or "bash" the |
6405 default becomes "2>&1| tee". This means that stderr is also included. | |
6406 Before using the 'shell' option a path is removed, thus "/bin/sh" uses | |
6407 "sh". | |
7 | 6408 The initialization of this option is done after reading the ".vimrc" |
6409 and the other initializations, so that when the 'shell' option is set | |
6410 there, the 'shellpipe' option changes automatically, unless it was | |
6411 explicitly set before. | |
6412 When 'shellpipe' is set to an empty string, no redirection of the | |
6413 ":make" output will be done. This is useful if you use a 'makeprg' | |
6414 that writes to 'makeef' by itself. If you want no piping, but do | |
6415 want to include the 'makeef', set 'shellpipe' to a single space. | |
6416 Don't forget to precede the space with a backslash: ":set sp=\ ". | |
6417 In the future pipes may be used for filtering and this option will | |
6418 become obsolete (at least for Unix). | |
6419 This option cannot be set from a |modeline| or in the |sandbox|, for | |
6420 security reasons. | |
6421 | |
6422 *'shellquote'* *'shq'* | |
6423 'shellquote' 'shq' string (default: ""; MS-DOS and Win32, when 'shell' | |
6424 contains "sh" somewhere: "\"") | |
6425 global | |
6426 Quoting character(s), put around the command passed to the shell, for | |
6427 the "!" and ":!" commands. The redirection is kept outside of the | |
6428 quoting. See 'shellxquote' to include the redirection. It's | |
6429 probably not useful to set both options. | |
6430 This is an empty string by default. Only known to be useful for | |
6431 third-party shells on MS-DOS-like systems, such as the MKS Korn Shell | |
6432 or bash, where it should be "\"". The default is adjusted according | |
6433 the value of 'shell', to reduce the need to set this option by the | |
6434 user. See |dos-shell|. | |
6435 This option cannot be set from a |modeline| or in the |sandbox|, for | |
6436 security reasons. | |
6437 | |
6438 *'shellredir'* *'srr'* | |
6439 'shellredir' 'srr' string (default ">", ">&" or ">%s 2>&1") | |
6440 global | |
6441 String to be used to put the output of a filter command in a temporary | |
6442 file. See also |:!|. See |option-backslash| about including spaces | |
6443 and backslashes. | |
6444 The name of the temporary file can be represented by "%s" if necessary | |
6445 (the file name is appended automatically if no %s appears in the value | |
6446 of this option). | |
6447 The default is ">". For Unix, if the 'shell' option is "csh", "tcsh" | |
6448 or "zsh" during initializations, the default becomes ">&". If the | |
6449 'shell' option is "sh", "ksh" or "bash" the default becomes | |
6450 ">%s 2>&1". This means that stderr is also included. | |
6451 For Win32, the Unix checks are done and additionally "cmd" is checked | |
6452 for, which makes the default ">%s 2>&1". Also, the same names with | |
6453 ".exe" appended are checked for. | |
6454 The initialization of this option is done after reading the ".vimrc" | |
6455 and the other initializations, so that when the 'shell' option is set | |
6456 there, the 'shellredir' option changes automatically unless it was | |
6457 explicitly set before. | |
6458 In the future pipes may be used for filtering and this option will | |
6459 become obsolete (at least for Unix). | |
6460 This option cannot be set from a |modeline| or in the |sandbox|, for | |
6461 security reasons. | |
6462 | |
6463 *'shellslash'* *'ssl'* *'noshellslash'* *'nossl'* | |
6464 'shellslash' 'ssl' boolean (default off) | |
6465 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
|
6466 {only for MSDOS, MS-Windows and OS/2} |
7 | 6467 When set, a forward slash is used when expanding file names. This is |
6468 useful when a Unix-like shell is used instead of command.com or | |
6469 cmd.exe. Backward slashes can still be typed, but they are changed to | |
6470 forward slashes by Vim. | |
6471 Note that setting or resetting this option has no effect for some | |
6472 existing file names, thus this option needs to be set before opening | |
6473 any file for best results. This might change in the future. | |
6474 'shellslash' only works when a backslash can be used as a path | |
6475 separator. To test if this is so use: > | |
6476 if exists('+shellslash') | |
6477 < | |
168 | 6478 *'shelltemp'* *'stmp'* *'noshelltemp'* *'nostmp'* |
6479 'shelltemp' 'stmp' boolean (Vi default off, Vim default on) | |
6480 global | |
6481 When on, use temp files for shell commands. When off use a pipe. | |
6482 When using a pipe is not possible temp files are used anyway. | |
2965 | 6483 Currently a pipe is only supported on Unix and MS-Windows 2K and |
6484 later. You can check it with: > | |
168 | 6485 :if has("filterpipe") |
6486 < The advantage of using a pipe is that nobody can read the temp file | |
6487 and the 'shell' command does not need to support redirection. | |
6488 The advantage of using a temp file is that the file type and encoding | |
6489 can be detected. | |
6490 The |FilterReadPre|, |FilterReadPost| and |FilterWritePre|, | |
6491 |FilterWritePost| autocommands event are not triggered when | |
6492 'shelltemp' is off. | |
9533
9f921133ee90
commit https://github.com/vim/vim/commit/269f595f9eef584937e7eae70fde68cdd7da5bcf
Christian Brabandt <cb@256bit.org>
parents:
9464
diff
changeset
|
6493 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
|
6494 temp files. |
11160 | 6495 NOTE: This option is set to the Vim default value when 'compatible' |
6496 is reset. | |
168 | 6497 |
7 | 6498 *'shelltype'* *'st'* |
6499 'shelltype' 'st' number (default 0) | |
6500 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
|
6501 {only for the Amiga} |
7 | 6502 On the Amiga this option influences the way how the commands work |
6503 which use a shell. | |
6504 0 and 1: always use the shell | |
6505 2 and 3: use the shell only to filter lines | |
6506 4 and 5: use shell only for ':sh' command | |
6507 When not using the shell, the command is executed directly. | |
6508 | |
6509 0 and 2: use "shell 'shellcmdflag' cmd" to start external commands | |
6510 1 and 3: use "shell cmd" to start external commands | |
6511 | |
3371 | 6512 *'shellxescape'* *'sxe'* |
6513 'shellxescape' 'sxe' string (default: ""; | |
6514 for MS-DOS and MS-Windows: "\"&|<>()@^") | |
6515 global | |
6516 When 'shellxquote' is set to "(" then the characters listed in this | |
6517 option will be escaped with a '^' character. This makes it possible | |
6518 to execute most external commands with cmd.exe. | |
6519 | |
7 | 6520 *'shellxquote'* *'sxq'* |
6521 'shellxquote' 'sxq' string (default: ""; | |
3359 | 6522 for Win32, when 'shell' is cmd.exe: "(" |
6523 for Win32, when 'shell' contains "sh" | |
6524 somewhere: "\"" | |
7 | 6525 for Unix, when using system(): "\"") |
6526 global | |
6527 Quoting character(s), put around the command passed to the shell, for | |
6528 the "!" and ":!" commands. Includes the redirection. See | |
6529 'shellquote' to exclude the redirection. It's probably not useful | |
6530 to set both options. | |
3359 | 6531 When the value is '(' then ')' is appended. When the value is '"(' |
6532 then ')"' is appended. | |
6533 When the value is '(' then also see 'shellxescape'. | |
3352 | 6534 This is an empty string by default on most systems, but is known to be |
6535 useful for on Win32 version, either for cmd.exe which automatically | |
6536 strips off the first and last quote on a command, or 3rd-party shells | |
6537 such as the MKS Korn Shell or bash, where it should be "\"". The | |
6538 default is adjusted according the value of 'shell', to reduce the need | |
6539 to set this option by the user. See |dos-shell|. | |
7 | 6540 This option cannot be set from a |modeline| or in the |sandbox|, for |
6541 security reasons. | |
6542 | |
6543 *'shiftround'* *'sr'* *'noshiftround'* *'nosr'* | |
6544 'shiftround' 'sr' boolean (default off) | |
6545 global | |
6546 Round indent to multiple of 'shiftwidth'. Applies to > and < | |
6547 commands. CTRL-T and CTRL-D in Insert mode always round the indent to | |
6548 a multiple of 'shiftwidth' (this is Vi compatible). | |
6549 NOTE: This option is reset when 'compatible' is set. | |
6550 | |
6551 *'shiftwidth'* *'sw'* | |
6552 'shiftwidth' 'sw' number (default 8) | |
6553 local to buffer | |
10 | 6554 Number of spaces to use for each step of (auto)indent. Used for |
7 | 6555 |'cindent'|, |>>|, |<<|, etc. |
3893 | 6556 When zero the 'ts' value will be used. Use the |shiftwidth()| |
6557 function to get the effective shiftwidth value. | |
7 | 6558 |
6559 *'shortmess'* *'shm'* | |
16533
5e25171e0e75
patch 8.1.1270: cannot see current match position
Bram Moolenaar <Bram@vim.org>
parents:
16447
diff
changeset
|
6560 '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
|
6561 POSIX default: "AS") |
7 | 6562 global |
6563 This option helps to avoid all the |hit-enter| prompts caused by file | |
6564 messages, for example with CTRL-G, and to avoid some other messages. | |
6565 It is a list of flags: | |
6566 flag meaning when present ~ | |
6567 f use "(3 of 5)" instead of "(file 3 of 5)" | |
6568 i use "[noeol]" instead of "[Incomplete last line]" | |
6569 l use "999L, 888C" instead of "999 lines, 888 characters" | |
6570 m use "[+]" instead of "[Modified]" | |
6571 n use "[New]" instead of "[New File]" | |
6572 r use "[RO]" instead of "[readonly]" | |
6573 w use "[w]" instead of "written" for file write message | |
6574 and "[a]" instead of "appended" for ':w >> file' command | |
6575 x use "[dos]" instead of "[dos format]", "[unix]" instead of | |
6576 "[unix format]" and "[mac]" instead of "[mac format]". | |
6577 a all of the above abbreviations | |
6578 | |
6579 o overwrite message for writing a file with subsequent message | |
6580 for reading a file (useful for ":wn" or when 'autowrite' on) | |
6581 O message for reading a file overwrites any previous message. | |
6582 Also for quickfix message (e.g., ":cn"). | |
6583 s don't give "search hit BOTTOM, continuing at TOP" or "search | |
16610 | 6584 hit TOP, continuing at BOTTOM" messages; when using the search |
6585 count do not show "W" after the count message (see S below) | |
7 | 6586 t truncate file message at the start if it is too long to fit |
6587 on the command-line, "<" will appear in the left most column. | |
6588 Ignored in Ex mode. | |
6589 T truncate other messages in the middle if they are too long to | |
233 | 6590 fit on the command line. "..." will appear in the middle. |
7 | 6591 Ignored in Ex mode. |
6592 W don't give "written" or "[w]" when writing a file | |
6593 A don't give the "ATTENTION" message when an existing swap file | |
6594 is found. | |
6595 I don't give the intro message when starting Vim |:intro|. | |
5946 | 6596 c don't give |ins-completion-menu| messages. For example, |
6597 "-- XXX completion (YYY)", "match 1 of 2", "The only match", | |
6598 "Pattern not found", "Back at original", etc. | |
8560
f3c636c673f7
commit https://github.com/vim/vim/commit/426dd0219512af5f4abeb0901b533159253ffba3
Christian Brabandt <cb@256bit.org>
parents:
8497
diff
changeset
|
6599 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
|
6600 F don't give the file info when editing a file, like `:silent` |
f3c636c673f7
commit https://github.com/vim/vim/commit/426dd0219512af5f4abeb0901b533159253ffba3
Christian Brabandt <cb@256bit.org>
parents:
8497
diff
changeset
|
6601 was used for the command |
16533
5e25171e0e75
patch 8.1.1270: cannot see current match position
Bram Moolenaar <Bram@vim.org>
parents:
16447
diff
changeset
|
6602 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
|
6603 "[1/5]" |
7 | 6604 |
6605 This gives you the opportunity to avoid that a change between buffers | |
6606 requires you to hit <Enter>, but still gives as useful a message as | |
6607 possible for the space available. To get the whole message that you | |
6608 would have got with 'shm' empty, use ":file!" | |
6609 Useful values: | |
6610 shm= No abbreviation of message. | |
6611 shm=a Abbreviation, but no loss of information. | |
6612 shm=at Abbreviation, and truncate message when necessary. | |
6613 | |
6614 NOTE: This option is set to the Vi default value when 'compatible' is | |
6615 set and to the Vim default value when 'compatible' is reset. | |
6616 | |
6617 *'shortname'* *'sn'* *'noshortname'* *'nosn'* | |
6618 'shortname' 'sn' boolean (default off) | |
6619 local to buffer | |
6620 Filenames are assumed to be 8 characters plus one extension of 3 | |
6621 characters. Multiple dots in file names are not allowed. When this | |
6622 option is on, dots in file names are replaced with underscores when | |
6623 adding an extension (".~" or ".swp"). This option is not available | |
6624 for MS-DOS, because then it would always be on. This option is useful | |
6625 when editing files on an MS-DOS compatible filesystem, e.g., messydos | |
6626 or crossdos. When running the Win32 GUI version under Win32s, this | |
6627 option is always on by default. | |
6628 | |
6629 *'showbreak'* *'sbr'* *E595* | |
6630 'showbreak' 'sbr' string (default "") | |
6631 global | |
2570
71b56b4e7785
Make the references to features in the help more consistent. (Sylvain Hitier)
Bram Moolenaar <bram@vim.org>
parents:
2561
diff
changeset
|
6632 {not available when compiled without the |+linebreak| |
7 | 6633 feature} |
6634 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
|
6635 values are "> " or "+++ ": > |
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
6636 :set showbreak=>\ |
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
6637 < 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
|
6638 this: > |
2314
233eb4412f5d
Added 'colorcolumn' option. Partly by Gregor Uhlenheuer.
Bram Moolenaar <bram@vim.org>
parents:
2302
diff
changeset
|
6639 :let &showbreak = '+++ ' |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
6640 < Only printable single-cell characters are allowed, excluding <Tab> and |
7 | 6641 comma (in a future version the comma might be used to separate the |
6642 part that is shown at the end and at the start of a line). | |
6643 The characters are highlighted according to the '@' flag in | |
6644 'highlight'. | |
6645 Note that tabs after the showbreak will be displayed differently. | |
6646 If you want the 'showbreak' to appear in between line numbers, add the | |
6647 "n" flag to 'cpoptions'. | |
6648 | |
6649 *'showcmd'* *'sc'* *'noshowcmd'* *'nosc'* | |
9669
284b4eb307fc
commit https://github.com/vim/vim/commit/8c08b5b569e2a9e9f63dea514591ecfa2d3bb392
Christian Brabandt <cb@256bit.org>
parents:
9665
diff
changeset
|
6650 '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
|
6651 Vi default: off, set in |defaults.vim|) |
7 | 6652 global |
6653 {not available when compiled without the | |
6654 |+cmdline_info| feature} | |
1152 | 6655 Show (partial) command in the last line of the screen. Set this |
6656 option off if your terminal is slow. | |
7 | 6657 In Visual mode the size of the selected area is shown: |
6658 - 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
|
6659 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
|
6660 means two characters and six bytes. |
7 | 6661 - When selecting more than one line, the number of lines. |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
6662 - When selecting a block, the size in screen characters: |
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
6663 {lines}x{columns}. |
7 | 6664 NOTE: This option is set to the Vi default value when 'compatible' is |
6665 set and to the Vim default value when 'compatible' is reset. | |
6666 | |
6667 *'showfulltag'* *'sft'* *'noshowfulltag'* *'nosft'* | |
6668 'showfulltag' 'sft' boolean (default off) | |
6669 global | |
6670 When completing a word in insert mode (see |ins-completion|) from the | |
6671 tags file, show both the tag name and a tidied-up form of the search | |
10 | 6672 pattern (if there is one) as possible matches. Thus, if you have |
7 | 6673 matched a C function, you can see a template for what arguments are |
6674 required (coding style permitting). | |
1621 | 6675 Note that this doesn't work well together with having "longest" in |
6676 'completeopt', because the completion from the search pattern may not | |
6677 match the typed text. | |
7 | 6678 |
6679 *'showmatch'* *'sm'* *'noshowmatch'* *'nosm'* | |
6680 'showmatch' 'sm' boolean (default off) | |
6681 global | |
6682 When a bracket is inserted, briefly jump to the matching one. The | |
6683 jump is only done if the match can be seen on the screen. The time to | |
6684 show the match can be set with 'matchtime'. | |
6685 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
|
6686 seen or not). |
c590de398af9
commit https://github.com/vim/vim/commit/ca63501fbcd1cf9c8aa9ff12c093c95b62a89ed7
Christian Brabandt <cb@256bit.org>
parents:
7080
diff
changeset
|
6687 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
|
6688 reset. |
7 | 6689 When the 'm' flag is not included in 'cpoptions', typing a character |
6690 will immediately move the cursor back to where it belongs. | |
6691 See the "sm" field in 'guicursor' for setting the cursor shape and | |
6692 blinking when showing the match. | |
6693 The 'matchpairs' option can be used to specify the characters to show | |
6694 matches for. 'rightleft' and 'revins' are used to look for opposite | |
6695 matches. | |
699 | 6696 Also see the matchparen plugin for highlighting the match when moving |
6697 around |pi_paren.txt|. | |
6698 Note: Use of the short form is rated PG. | |
7 | 6699 |
6700 *'showmode'* *'smd'* *'noshowmode'* *'nosmd'* | |
6701 'showmode' 'smd' boolean (Vim default: on, Vi default: off) | |
6702 global | |
6703 If in Insert, Replace or Visual mode put a message on the last line. | |
6704 Use the 'M' flag in 'highlight' to set the type of highlighting for | |
6705 this message. | |
10 | 6706 When |XIM| may be used the message will include "XIM". But this |
7 | 6707 doesn't mean XIM is really active, especially when 'imactivatekey' is |
6708 not set. | |
6709 NOTE: This option is set to the Vi default value when 'compatible' is | |
6710 set and to the Vim default value when 'compatible' is reset. | |
6711 | |
677 | 6712 *'showtabline'* *'stal'* |
6713 'showtabline' 'stal' number (default 1) | |
6714 global | |
2570
71b56b4e7785
Make the references to features in the help more consistent. (Sylvain Hitier)
Bram Moolenaar <bram@vim.org>
parents:
2561
diff
changeset
|
6715 {not available when compiled without the |+windows| |
677 | 6716 feature} |
6717 The value of this option specifies when the line with tab page labels | |
6718 will be displayed: | |
6719 0: never | |
6720 1: only if there are at least two tab pages | |
6721 2: always | |
6722 This is both for the GUI and non-GUI implementation of the tab pages | |
6723 line. | |
6724 See |tab-page| for more information about tab pages. | |
6725 | |
7 | 6726 *'sidescroll'* *'ss'* |
6727 'sidescroll' 'ss' number (default 0) | |
6728 global | |
6729 The minimal number of columns to scroll horizontally. Used only when | |
6730 the 'wrap' option is off and the cursor is moved off of the screen. | |
6731 When it is zero the cursor will be put in the middle of the screen. | |
6732 When using a slow terminal set it to a large number or 0. When using | |
6733 a fast terminal use a small number or 1. Not used for "zh" and "zl" | |
6734 commands. | |
6735 | |
6736 *'sidescrolloff'* *'siso'* | |
6737 '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
|
6738 global or local to window |global-local| |
7 | 6739 The minimal number of screen columns to keep to the left and to the |
534 | 6740 right of the cursor if 'nowrap' is set. Setting this option to a |
6741 value greater than 0 while having |'sidescroll'| also at a non-zero | |
6742 value makes some context visible in the line you are scrolling in | |
6743 horizontally (except at beginning of the line). Setting this option | |
6744 to a large value (like 999) has the effect of keeping the cursor | |
6745 horizontally centered in the window, as long as one does not come too | |
6746 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
|
6747 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
|
6748 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
|
6749 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
|
6750 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
|
6751 < NOTE: This option is set to 0 when 'compatible' is set. |
7 | 6752 |
6753 Example: Try this together with 'sidescroll' and 'listchars' as | |
6754 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
|
6755 onto the "extends" character: > |
7 | 6756 |
6757 :set nowrap sidescroll=1 listchars=extends:>,precedes:< | |
6758 :set sidescrolloff=1 | |
9852
4eea48b76d03
commit https://github.com/vim/vim/commit/95ec9d6a6ab3117d60ff638670a803d43974ba51
Christian Brabandt <cb@256bit.org>
parents:
9737
diff
changeset
|
6759 < |
4eea48b76d03
commit https://github.com/vim/vim/commit/95ec9d6a6ab3117d60ff638670a803d43974ba51
Christian Brabandt <cb@256bit.org>
parents:
9737
diff
changeset
|
6760 *'signcolumn'* *'scl'* |
4eea48b76d03
commit https://github.com/vim/vim/commit/95ec9d6a6ab3117d60ff638670a803d43974ba51
Christian Brabandt <cb@256bit.org>
parents:
9737
diff
changeset
|
6761 'signcolumn' 'scl' string (default "auto") |
4eea48b76d03
commit https://github.com/vim/vim/commit/95ec9d6a6ab3117d60ff638670a803d43974ba51
Christian Brabandt <cb@256bit.org>
parents:
9737
diff
changeset
|
6762 local to window |
4eea48b76d03
commit https://github.com/vim/vim/commit/95ec9d6a6ab3117d60ff638670a803d43974ba51
Christian Brabandt <cb@256bit.org>
parents:
9737
diff
changeset
|
6763 {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
|
6764 feature} |
9860
9eaf8ef656e9
commit https://github.com/vim/vim/commit/0952131376a517fc12dc5ae908a97018b4ee23f0
Christian Brabandt <cb@256bit.org>
parents:
9852
diff
changeset
|
6765 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
|
6766 "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
|
6767 "no" never |
9eaf8ef656e9
commit https://github.com/vim/vim/commit/0952131376a517fc12dc5ae908a97018b4ee23f0
Christian Brabandt <cb@256bit.org>
parents:
9852
diff
changeset
|
6768 "yes" always |
7 | 6769 |
6770 | |
6771 *'smartcase'* *'scs'* *'nosmartcase'* *'noscs'* | |
6772 'smartcase' 'scs' boolean (default off) | |
6773 global | |
6774 Override the 'ignorecase' option if the search pattern contains upper | |
6775 case characters. Only used when the search pattern is typed and | |
6776 'ignorecase' option is on. Used for the commands "/", "?", "n", "N", | |
3557 | 6777 ":g" and ":s". Not used for "*", "#", "gd", tag search, etc. After |
7 | 6778 "*" and "#" you can make 'smartcase' used by doing a "/" command, |
6779 recalling the search pattern from history and hitting <Enter>. | |
6780 NOTE: This option is reset when 'compatible' is set. | |
6781 | |
6782 *'smartindent'* *'si'* *'nosmartindent'* *'nosi'* | |
6783 'smartindent' 'si' boolean (default off) | |
6784 local to buffer | |
6785 {not available when compiled without the | |
6786 |+smartindent| feature} | |
6787 Do smart autoindenting when starting a new line. Works for C-like | |
6788 programs, but can also be used for other languages. 'cindent' does | |
6789 something like this, works better in most cases, but is more strict, | |
2662 | 6790 see |C-indenting|. When 'cindent' is on or 'indentexpr' is set, |
2642 | 6791 setting 'si' has no effect. 'indentexpr' is a more advanced |
6792 alternative. | |
7 | 6793 Normally 'autoindent' should also be on when using 'smartindent'. |
6794 An indent is automatically inserted: | |
6795 - After a line ending in '{'. | |
6796 - After a line starting with a keyword from 'cinwords'. | |
6797 - Before a line starting with '}' (only with the "O" command). | |
6798 When typing '}' as the first character in a new line, that line is | |
6799 given the same indent as the matching '{'. | |
6800 When typing '#' as the first character in a new line, the indent for | |
6801 that line is removed, the '#' is put in the first column. The indent | |
10 | 6802 is restored for the next line. If you don't want this, use this |
7 | 6803 mapping: ":inoremap # X^H#", where ^H is entered with CTRL-V CTRL-H. |
6804 When using the ">>" command, lines starting with '#' are not shifted | |
6805 right. | |
11160 | 6806 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
|
6807 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
|
6808 reset. |
7 | 6809 |
6810 *'smarttab'* *'sta'* *'nosmarttab'* *'nosta'* | |
6811 'smarttab' 'sta' boolean (default off) | |
6812 global | |
6813 When on, a <Tab> in front of a line inserts blanks according to | |
648 | 6814 'shiftwidth'. 'tabstop' or 'softtabstop' is used in other places. A |
6815 <BS> will delete a 'shiftwidth' worth of space at the start of the | |
6816 line. | |
650 | 6817 When off, a <Tab> always inserts blanks according to 'tabstop' or |
648 | 6818 'softtabstop'. 'shiftwidth' is only used for shifting text left or |
6819 right |shift-left-right|. | |
1263 | 6820 What gets inserted (a <Tab> or spaces) depends on the 'expandtab' |
7 | 6821 option. Also see |ins-expandtab|. When 'expandtab' is not set, the |
11 | 6822 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
|
6823 This option is reset when 'paste' is set and restored when 'paste' is |
c590de398af9
commit https://github.com/vim/vim/commit/ca63501fbcd1cf9c8aa9ff12c093c95b62a89ed7
Christian Brabandt <cb@256bit.org>
parents:
7080
diff
changeset
|
6824 reset. |
7 | 6825 NOTE: This option is reset when 'compatible' is set. |
6826 | |
6827 *'softtabstop'* *'sts'* | |
6828 'softtabstop' 'sts' number (default 0) | |
6829 local to buffer | |
6830 Number of spaces that a <Tab> counts for while performing editing | |
6831 operations, like inserting a <Tab> or using <BS>. It "feels" like | |
6832 <Tab>s are being inserted, while in fact a mix of spaces and <Tab>s is | |
6833 used. This is useful to keep the 'ts' setting at its standard value | |
6834 of 8, while being able to edit like it is set to 'sts'. However, | |
6835 commands like "x" still work on the actual characters. | |
6836 When 'sts' is zero, this feature is off. | |
3893 | 6837 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
|
6838 '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
|
6839 when 'paste' is reset. |
7 | 6840 See also |ins-expandtab|. When 'expandtab' is not set, the number of |
6841 spaces is minimized by using <Tab>s. | |
6842 The 'L' flag in 'cpoptions' changes how tabs are used when 'list' is | |
6843 set. | |
6844 NOTE: This option is set to 0 when 'compatible' is set. | |
6845 | |
14175
2ad722003b36
patch 8.1.0105: all tab stops are the same
Christian Brabandt <cb@256bit.org>
parents:
14019
diff
changeset
|
6846 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
|
6847 '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
|
6848 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
|
6849 |
221 | 6850 *'spell'* *'nospell'* |
6851 'spell' boolean (default off) | |
6852 local to window | |
6853 {not available when compiled without the |+syntax| | |
6854 feature} | |
6855 When on spell checking will be done. See |spell|. | |
236 | 6856 The languages are specified with 'spelllang'. |
221 | 6857 |
386 | 6858 *'spellcapcheck'* *'spc'* |
389 | 6859 'spellcapcheck' 'spc' string (default "[.?!]\_[\])'" \t]\+") |
386 | 6860 local to buffer |
6861 {not available when compiled without the |+syntax| | |
6862 feature} | |
6863 Pattern to locate the end of a sentence. The following word will be | |
6864 checked to start with a capital letter. If not then it is highlighted | |
484 | 6865 with SpellCap |hl-SpellCap| (unless the word is also badly spelled). |
386 | 6866 When this check is not wanted make this option empty. |
6867 Only used when 'spell' is set. | |
389 | 6868 Be careful with special characters, see |option-backslash| about |
6869 including spaces and backslashes. | |
480 | 6870 To set this option automatically depending on the language, see |
6871 |set-spc-auto|. | |
386 | 6872 |
314 | 6873 *'spellfile'* *'spf'* |
6874 'spellfile' 'spf' string (default empty) | |
6875 local to buffer | |
6876 {not available when compiled without the |+syntax| | |
6877 feature} | |
6878 Name of the word list file where words are added for the |zg| and |zw| | |
401 | 6879 commands. It must end in ".{encoding}.add". You need to include the |
6880 path, otherwise the file is placed in the current directory. | |
386 | 6881 *E765* |
6882 It may also be a comma separated list of names. A count before the | |
6883 |zg| and |zw| commands can be used to access each. This allows using | |
6884 a personal word list file and a project word list file. | |
314 | 6885 When a word is added while this option is empty Vim will set it for |
819 | 6886 you: Using the first directory in 'runtimepath' that is writable. If |
6887 there is no "spell" directory yet it will be created. For the file | |
6888 name the first language name that appears in 'spelllang' is used, | |
353 | 6889 ignoring the region. |
6890 The resulting ".spl" file will be used for spell checking, it does not | |
6891 have to appear in 'spelllang'. | |
6892 Normally one file is used for all regions, but you can add the region | |
6893 name if you want to. However, it will then only be used when | |
6894 'spellfile' is set to it, for entries in 'spelllang' only files | |
6895 without region name will be found. | |
336 | 6896 This option cannot be set from a |modeline| or in the |sandbox|, for |
6897 security reasons. | |
314 | 6898 |
221 | 6899 *'spelllang'* *'spl'* |
314 | 6900 'spelllang' 'spl' string (default "en") |
221 | 6901 local to buffer |
6902 {not available when compiled without the |+syntax| | |
6903 feature} | |
353 | 6904 A comma separated list of word list names. When the 'spell' option is |
6905 on spellchecking will be done for these languages. Example: > | |
6906 set spelllang=en_us,nl,medical | |
6907 < This means US English, Dutch and medical words are recognized. Words | |
6908 that are not recognized will be highlighted. | |
16380 | 6909 The word list name must consist of alphanumeric characters, a dash or |
6910 an underscore. It should not include a comma or dot. Using a dash is | |
353 | 6911 recommended to separate the two letter language name from a |
6912 specification. Thus "en-rare" is used for rare English words. | |
6913 A region name must come last and have the form "_xx", where "xx" is | |
6914 the two-letter, lower case region name. You can use more than one | |
6915 region by listing them: "en_us,en_ca" supports both US and Canadian | |
6916 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
|
6917 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
|
6918 en_ca, en_gb and en_us). |
5477 | 6919 If the name "cjk" is included East Asian characters are excluded from |
6920 spell checking. This is useful when editing text that also has Asian | |
6921 words. | |
484 | 6922 *E757* |
419 | 6923 As a special case the name of a .spl file can be given as-is. The |
6924 first "_xx" in the name is removed and used as the region name | |
6925 (_xx is an underscore, two letters and followed by a non-letter). | |
6926 This is mainly for testing purposes. You must make sure the correct | |
6927 encoding is used, Vim doesn't check it. | |
236 | 6928 When 'encoding' is set the word lists are reloaded. Thus it's a good |
419 | 6929 idea to set 'spelllang' after setting 'encoding' to avoid loading the |
6930 files twice. | |
353 | 6931 How the related spell files are found is explained here: |spell-load|. |
221 | 6932 |
653 | 6933 If the |spellfile.vim| plugin is active and you use a language name |
6934 for which Vim cannot find the .spl file in 'runtimepath' the plugin | |
6935 will ask you if you want to download the file. | |
6936 | |
480 | 6937 After this option has been set successfully, Vim will source the files |
6938 "spell/LANG.vim" in 'runtimepath'. "LANG" is the value of 'spelllang' | |
15068 | 6939 up to the first character that is not an ASCII letter or number and |
6940 not a dash. Also see |set-spc-auto|. | |
480 | 6941 |
6942 | |
344 | 6943 *'spellsuggest'* *'sps'* |
6944 'spellsuggest' 'sps' string (default "best") | |
6945 global | |
6946 {not available when compiled without the |+syntax| | |
6947 feature} | |
593 | 6948 Methods used for spelling suggestions. Both for the |z=| command and |
374 | 6949 the |spellsuggest()| function. This is a comma-separated list of |
6950 items: | |
6951 | |
6952 best Internal method that works best for English. Finds | |
6953 changes like "fast" and uses a bit of sound-a-like | |
6954 scoring to improve the ordering. | |
6955 | |
6956 double Internal method that uses two methods and mixes the | |
6957 results. The first method is "fast", the other method | |
344 | 6958 computes how much the suggestion sounds like the bad |
374 | 6959 word. That only works when the language specifies |
6960 sound folding. Can be slow and doesn't always give | |
6961 better results. | |
6962 | |
6963 fast Internal method that only checks for simple changes: | |
6964 character inserts/deletes/swaps. Works well for | |
6965 simple typing mistakes. | |
6966 | |
593 | 6967 {number} The maximum number of suggestions listed for |z=|. |
484 | 6968 Not used for |spellsuggest()|. The number of |
6969 suggestions is never more than the value of 'lines' | |
6970 minus two. | |
6971 | |
374 | 6972 file:{filename} Read file {filename}, which must have two columns, |
6973 separated by a slash. The first column contains the | |
6974 bad word, the second column the suggested good word. | |
6975 Example: | |
6976 theribal/terrible ~ | |
6977 Use this for common mistakes that do not appear at the | |
6978 top of the suggestion list with the internal methods. | |
6979 Lines without a slash are ignored, use this for | |
6980 comments. | |
5862 | 6981 The word in the second column must be correct, |
6982 otherwise it will not be used. Add the word to an | |
6983 ".add" file if it is currently flagged as a spelling | |
6984 mistake. | |
374 | 6985 The file is used for all languages. |
6986 | |
6987 expr:{expr} Evaluate expression {expr}. Use a function to avoid | |
6988 trouble with spaces. |v:val| holds the badly spelled | |
6989 word. The expression must evaluate to a List of | |
6990 Lists, each with a suggestion and a score. | |
6991 Example: | |
11062 | 6992 [['the', 33], ['that', 44]] ~ |
593 | 6993 Set 'verbose' and use |z=| to see the scores that the |
374 | 6994 internal methods use. A lower score is better. |
6995 This may invoke |spellsuggest()| if you temporarily | |
6996 set 'spellsuggest' to exclude the "expr:" part. | |
6997 Errors are silently ignored, unless you set the | |
6998 'verbose' option to a non-zero value. | |
6999 | |
7000 Only one of "best", "double" or "fast" may be used. The others may | |
7001 appear several times in any order. Example: > | |
7002 :set sps=file:~/.vim/sugg,best,expr:MySuggest() | |
7003 < | |
7004 This option cannot be set from a |modeline| or in the |sandbox|, for | |
7005 security reasons. | |
344 | 7006 |
7007 | |
7 | 7008 *'splitbelow'* *'sb'* *'nosplitbelow'* *'nosb'* |
7009 'splitbelow' 'sb' boolean (default off) | |
7010 global | |
2570
71b56b4e7785
Make the references to features in the help more consistent. (Sylvain Hitier)
Bram Moolenaar <bram@vim.org>
parents:
2561
diff
changeset
|
7011 {not available when compiled without the |+windows| |
7 | 7012 feature} |
7013 When on, splitting a window will put the new window below the current | |
7014 one. |:split| | |
7015 | |
7016 *'splitright'* *'spr'* *'nosplitright'* *'nospr'* | |
7017 'splitright' 'spr' boolean (default off) | |
7018 global | |
2570
71b56b4e7785
Make the references to features in the help more consistent. (Sylvain Hitier)
Bram Moolenaar <bram@vim.org>
parents:
2561
diff
changeset
|
7019 {not available when compiled without the |+vertsplit| |
7 | 7020 feature} |
7021 When on, splitting a window will put the new window right of the | |
7022 current one. |:vsplit| | |
7023 | |
7024 *'startofline'* *'sol'* *'nostartofline'* *'nosol'* | |
7025 'startofline' 'sol' boolean (default on) | |
7026 global | |
7027 When "on" the commands listed below move the cursor to the first | |
11 | 7028 non-blank of the line. When off the cursor is kept in the same column |
10 | 7029 (if possible). This applies to the commands: CTRL-D, CTRL-U, CTRL-B, |
11 | 7030 CTRL-F, "G", "H", "M", "L", gg, and to the commands "d", "<<" and ">>" |
7 | 7031 with a linewise operator, with "%" with a count and to buffer changing |
7032 commands (CTRL-^, :bnext, :bNext, etc.). Also for an Ex command that | |
7033 only has a line number, e.g., ":25" or ":+". | |
7034 In case of buffer changing commands the cursor is placed at the column | |
7035 where it was the last time the buffer was edited. | |
7036 NOTE: This option is set when 'compatible' is set. | |
7037 | |
2709 | 7038 *'statusline'* *'stl'* *E540* *E542* |
7 | 7039 'statusline' 'stl' string (default empty) |
40 | 7040 global or local to window |global-local| |
7 | 7041 {not available when compiled without the |+statusline| |
7042 feature} | |
7043 When nonempty, this option determines the content of the status line. | |
7044 Also see |status-line|. | |
7045 | |
7046 The option consists of printf style '%' items interspersed with | |
7047 normal text. Each status line item is of the form: | |
7048 %-0{minwid}.{maxwid}{item} | |
7876
93f747af7b58
commit https://github.com/vim/vim/commit/5e9b2fa9bb0e6061cf18457c173cd141a5dc9c92
Christian Brabandt <cb@256bit.org>
parents:
7687
diff
changeset
|
7049 All fields except the {item} are optional. A single percent sign can |
2709 | 7050 be given as "%%". Up to 80 items can be specified. *E541* |
7 | 7051 |
680 | 7052 When the option starts with "%!" then it is used as an expression, |
7053 evaluated and the result is used as the option value. Example: > | |
7054 :set statusline=%!MyStatusLine() | |
7055 < The result can contain %{} items that will be evaluated too. | |
3445 | 7056 Note that the "%!" expression is evaluated in the context of the |
7057 current window and buffer, while %{} items are evaluated in the | |
7058 context of the window that the statusline belongs to. | |
680 | 7059 |
7060 When there is error while evaluating the option then it will be made | |
7061 empty to avoid further errors. Otherwise screen updating would loop. | |
7062 | |
7 | 7063 Note that the only effect of 'ruler' when this option is set (and |
7064 'laststatus' is 2) is controlling the output of |CTRL-G|. | |
7065 | |
7066 field meaning ~ | |
233 | 7067 - Left justify the item. The default is right justified |
7 | 7068 when minwid is larger than the length of the item. |
233 | 7069 0 Leading zeroes in numeric items. Overridden by '-'. |
7 | 7070 minwid Minimum width of the item, padding as set by '-' & '0'. |
7071 Value must be 50 or less. | |
10 | 7072 maxwid Maximum width of the item. Truncation occurs with a '<' |
7 | 7073 on the left for text items. Numeric items will be |
7074 shifted down to maxwid-2 digits followed by '>'number | |
7075 where number is the amount of missing digits, much like | |
7076 an exponential notation. | |
7077 item A one letter code as described below. | |
7078 | |
7079 Following is a description of the possible statusline items. The | |
7080 second character in "item" is the type: | |
7081 N for number | |
7082 S for string | |
7083 F for flags as described below | |
7084 - not applicable | |
7085 | |
7086 item meaning ~ | |
1152 | 7087 f S Path to the file in the buffer, as typed or relative to current |
7088 directory. | |
7 | 7089 F S Full path to the file in the buffer. |
7090 t S File name (tail) of file in the buffer. | |
1698 | 7091 m F Modified flag, text is "[+]"; "[-]" if 'modifiable' is off. |
7 | 7092 M F Modified flag, text is ",+" or ",-". |
1698 | 7093 r F Readonly flag, text is "[RO]". |
7 | 7094 R F Readonly flag, text is ",RO". |
1698 | 7095 h F Help buffer flag, text is "[help]". |
7 | 7096 H F Help buffer flag, text is ",HLP". |
1698 | 7097 w F Preview window flag, text is "[Preview]". |
7 | 7098 W F Preview window flag, text is ",PRV". |
1698 | 7099 y F Type of file in the buffer, e.g., "[vim]". See 'filetype'. |
7 | 7100 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
|
7101 q S "[Quickfix List]", "[Location List]" or empty. |
7 | 7102 k S Value of "b:keymap_name" or 'keymap' when |:lmap| mappings are |
7103 being used: "<keymap>" | |
7104 n N Buffer number. | |
2709 | 7105 b N Value of character under cursor. |
7 | 7106 B N As above, in hexadecimal. |
7107 o N Byte number in file of byte under cursor, first byte is 1. | |
7108 Mnemonic: Offset from start of file (with one added) | |
7109 {not available when compiled without |+byte_offset| feature} | |
7110 O N As above, in hexadecimal. | |
233 | 7111 N N Printer page number. (Only works in the 'printheader' option.) |
7 | 7112 l N Line number. |
7113 L N Number of lines in buffer. | |
7114 c N Column number. | |
7115 v N Virtual column number. | |
10 | 7116 V N Virtual column number as -{num}. Not displayed if equal to 'c'. |
7 | 7117 p N Percentage through file in lines as in |CTRL-G|. |
7118 P S Percentage through file of displayed window. This is like the | |
5055 | 7119 percentage described for 'ruler'. Always 3 in length, unless |
7120 translated. | |
233 | 7121 a S Argument list status as in default title. ({current} of {max}) |
7 | 7122 Empty if the argument file count is zero or one. |
680 | 7123 { 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
|
7124 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
|
7125 expression cannot contain a '}' character, call a function to |
a34b1323286c
patch 8.0.1743: terminal window options are named inconsistently
Christian Brabandt <cb@256bit.org>
parents:
13735
diff
changeset
|
7126 work around that. |
7 | 7127 ( - Start of item group. Can be used for setting the width and |
7128 alignment of a section. Must be followed by %) somewhere. | |
7129 ) - End of item group. No width fields allowed. | |
681 | 7130 T N For 'tabline': start of tab page N label. Use %T after the last |
7131 label. This information is used for mouse clicks. | |
7132 X N For 'tabline': start of close tab N label. Use %X after the | |
7133 label, e.g.: %3Xclose%X. Use %999X for a "close current tab" | |
7134 mark. This information is used for mouse clicks. | |
7 | 7135 < - Where to truncate line if too long. Default is at the start. |
7136 No width fields allowed. | |
7137 = - Separation point between left and right aligned items. | |
7138 No width fields allowed. | |
680 | 7139 # - Set highlight group. The name must follow and then a # again. |
7140 Thus use %#HLname# for highlight group HLname. The same | |
7141 highlighting is used, also for the statusline of non-current | |
7142 windows. | |
7 | 7143 * - Set highlight group to User{N}, where {N} is taken from the |
233 | 7144 minwid field, e.g. %1*. Restore normal highlight with %* or %0*. |
7 | 7145 The difference between User{N} and StatusLine will be applied |
7146 to StatusLineNC for the statusline of non-current windows. | |
7147 The number N must be between 1 and 9. See |hl-User1..9| | |
7148 | |
1698 | 7149 When displaying a flag, Vim removes the leading comma, if any, when |
7150 that flag comes right after plaintext. This will make a nice display | |
7151 when flags are used like in the examples below. | |
7 | 7152 |
233 | 7153 When all items in a group becomes an empty string (i.e. flags that are |
7 | 7154 not set) and a minwid is not set for the group, the whole group will |
7155 become empty. This will make a group like the following disappear | |
7156 completely from the statusline when none of the flags are set. > | |
7157 :set statusline=...%(\ [%M%R%H]%)... | |
7245
8896150aba23
commit https://github.com/vim/vim/commit/e392eb41f8dfc01bd13634e534ac6b4d505326f4
Christian Brabandt <cb@256bit.org>
parents:
7233
diff
changeset
|
7158 < *g:actual_curbuf* |
7 | 7159 Beware that an expression is evaluated each and every time the status |
7160 line is displayed. The current buffer and current window will be set | |
7161 temporarily to that of the window (and buffer) whose statusline is | |
233 | 7162 currently being drawn. The expression will evaluate in this context. |
14519 | 7163 The variable "g:actual_curbuf" is set to the `bufnr()` number of the |
634 | 7164 real current buffer. |
7165 | |
3682 | 7166 The 'statusline' option will be evaluated in the |sandbox| if set from |
7167 a modeline, see |sandbox-option|. | |
634 | 7168 |
7169 It is not allowed to change text or jump to another window while | |
7170 evaluating 'statusline' |textlock|. | |
7 | 7171 |
7172 If the statusline is not updated when you want it (e.g., after setting | |
7173 a variable that's used in an expression), you can force an update by | |
7174 setting an option without changing its value. Example: > | |
7175 :let &ro = &ro | |
7176 | |
7177 < A result of all digits is regarded a number for display purposes. | |
7178 Otherwise the result is taken as flag text and applied to the rules | |
7179 described above. | |
7180 | |
199 | 7181 Watch out for errors in expressions. They may render Vim unusable! |
7 | 7182 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
|
7183 edit your .vimrc or whatever with "vim --clean" to get it right. |
7 | 7184 |
7185 Examples: | |
7186 Emulate standard status line with 'ruler' set > | |
7187 :set statusline=%<%f\ %h%m%r%=%-14.(%l,%c%V%)\ %P | |
7188 < Similar, but add ASCII value of char under the cursor (like "ga") > | |
7189 :set statusline=%<%f%h%m%r%=%b\ 0x%B\ \ %l,%c%V\ %P | |
7190 < Display byte count and byte value, modified flag in red. > | |
7191 :set statusline=%<%f%=\ [%1*%M%*%n%R%H]\ %-19(%3l,%02c%03V%)%O'%02b' | |
7192 :hi User1 term=inverse,bold cterm=inverse,bold ctermfg=red | |
7193 < Display a ,GZ flag if a compressed file is loaded > | |
7194 :set statusline=...%r%{VarExists('b:gzflag','\ [GZ]')}%h... | |
7195 < In the |:autocmd|'s: > | |
7196 :let b:gzflag = 1 | |
7197 < And: > | |
7198 :unlet b:gzflag | |
7199 < And define this function: > | |
7200 :function VarExists(var, val) | |
7201 : if exists(a:var) | return a:val | else | return '' | endif | |
7202 :endfunction | |
7203 < | |
7204 *'suffixes'* *'su'* | |
7205 'suffixes' 'su' string (default ".bak,~,.o,.h,.info,.swp,.obj") | |
7206 global | |
7207 Files with these suffixes get a lower priority when multiple files | |
7208 match a wildcard. See |suffixes|. Commas can be used to separate the | |
10 | 7209 suffixes. Spaces after the comma are ignored. A dot is also seen as |
7210 the start of a suffix. To avoid a dot or comma being recognized as a | |
7 | 7211 separator, precede it with a backslash (see |option-backslash| about |
7212 including spaces and backslashes). | |
7213 See 'wildignore' for completely ignoring files. | |
7214 The use of |:set+=| and |:set-=| is preferred when adding or removing | |
7215 suffixes from the list. This avoids problems when a future version | |
7216 uses another default. | |
7217 | |
7218 *'suffixesadd'* *'sua'* | |
7219 'suffixesadd' 'sua' string (default "") | |
7220 local to buffer | |
7221 {not available when compiled without the | |
7222 |+file_in_path| feature} | |
7223 Comma separated list of suffixes, which are used when searching for a | |
7224 file for the "gf", "[I", etc. commands. Example: > | |
7225 :set suffixesadd=.java | |
7226 < | |
7227 *'swapfile'* *'swf'* *'noswapfile'* *'noswf'* | |
7228 'swapfile' 'swf' boolean (default on) | |
7229 local to buffer | |
10 | 7230 Use a swapfile for the buffer. This option can be reset when a |
7 | 7231 swapfile is not wanted for a specific buffer. For example, with |
7232 confidential information that even root must not be able to access. | |
7233 Careful: All text will be in memory: | |
7234 - Don't use this for big files. | |
7235 - Recovery will be impossible! | |
7236 A swapfile will only be present when |'updatecount'| is non-zero and | |
7237 'swapfile' is set. | |
7238 When 'swapfile' is reset, the swap file for the current buffer is | |
7239 immediately deleted. When 'swapfile' is set, and 'updatecount' is | |
7240 non-zero, a swap file is immediately created. | |
7241 Also see |swap-file| and |'swapsync'|. | |
5763 | 7242 If you want to open a new buffer without creating a swap file for it, |
7243 use the |:noswapfile| modifier. | |
13341
acd7eaa13d2b
Updated runtime files.
Christian Brabandt <cb@256bit.org>
parents:
13314
diff
changeset
|
7244 See 'directory' for where the swap file is created. |
7 | 7245 |
7246 This option is used together with 'bufhidden' and 'buftype' to | |
7247 specify special kinds of buffers. See |special-buffers|. | |
7248 | |
7249 *'swapsync'* *'sws'* | |
7250 'swapsync' 'sws' string (default "fsync") | |
7251 global | |
7252 When this option is not empty a swap file is synced to disk after | |
10 | 7253 writing to it. This takes some time, especially on busy unix systems. |
7 | 7254 When this option is empty parts of the swap file may be in memory and |
7255 not written to disk. When the system crashes you may lose more work. | |
7256 On Unix the system does a sync now and then without Vim asking for it, | |
7257 so the disadvantage of setting this option off is small. On some | |
7258 systems the swap file will not be written at all. For a unix system | |
7259 setting it to "sync" will use the sync() call instead of the default | |
7260 fsync(), which may work better on some systems. | |
36 | 7261 The 'fsync' option is used for the actual file. |
7 | 7262 |
7263 *'switchbuf'* *'swb'* | |
7264 'switchbuf' 'swb' string (default "") | |
7265 global | |
7266 This option controls the behavior when switching between buffers. | |
7267 Possible values (comma separated list): | |
7268 useopen If included, jump to the first open window that | |
7269 contains the specified buffer (if there is one). | |
7270 Otherwise: Do not examine other windows. | |
7271 This setting is checked with |quickfix| commands, when | |
7272 jumping to errors (":cc", ":cn", "cp", etc.). It is | |
7273 also used in all buffer related split commands, for | |
7274 example ":sbuffer", ":sbnext", or ":sbrewind". | |
825 | 7275 usetab Like "useopen", but also consider windows in other tab |
856 | 7276 pages. |
7 | 7277 split If included, split the current window before loading |
3153 | 7278 a buffer for a |quickfix| command that display errors. |
16086 | 7279 Otherwise: do not split, use current window (when used |
7280 in the quickfix window: the previously used window or | |
7281 split if there is no other window). | |
6843 | 7282 vsplit Just like "split" but split vertically. |
1621 | 7283 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
|
7284 "split" when both are present. |
7 | 7285 |
410 | 7286 *'synmaxcol'* *'smc'* |
7287 'synmaxcol' 'smc' number (default 3000) | |
7288 local to buffer | |
7289 {not available when compiled without the |+syntax| | |
7290 feature} | |
419 | 7291 Maximum column in which to search for syntax items. In long lines the |
7292 text after this column is not highlighted and following lines may not | |
7293 be highlighted correctly, because the syntax state is cleared. | |
410 | 7294 This helps to avoid very slow redrawing for an XML file that is one |
7295 long line. | |
7296 Set to zero to remove the limit. | |
7297 | |
7 | 7298 *'syntax'* *'syn'* |
7299 'syntax' 'syn' string (default empty) | |
7300 local to buffer | |
7301 {not available when compiled without the |+syntax| | |
7302 feature} | |
7303 When this option is set, the syntax with this name is loaded, unless | |
7304 syntax highlighting has been switched off with ":syntax off". | |
7305 Otherwise this option does not always reflect the current syntax (the | |
7306 b:current_syntax variable does). | |
7307 This option is most useful in a modeline, for a file which syntax is | |
782 | 7308 not automatically recognized. Example, in an IDL file: |
7309 /* vim: set syntax=idl : */ ~ | |
7310 When a dot appears in the value then this separates two filetype | |
7311 names. Example: | |
7312 /* vim: set syntax=c.doxygen : */ ~ | |
7313 This will use the "c" syntax first, then the "doxygen" syntax. | |
7314 Note that the second one must be prepared to be loaded as an addition, | |
7315 otherwise it will be skipped. More than one dot may appear. | |
7316 To switch off syntax highlighting for the current file, use: > | |
7 | 7317 :set syntax=OFF |
7318 < To switch syntax highlighting on according to the current value of the | |
7319 'filetype' option: > | |
7320 :set syntax=ON | |
7321 < What actually happens when setting the 'syntax' option is that the | |
7322 Syntax autocommand event is triggered with the value as argument. | |
7323 This option is not copied to another buffer, independent of the 's' or | |
7324 'S' flag in 'cpoptions'. | |
36 | 7325 Only normal file name characters can be used, "/\*?[|<>" are illegal. |
7 | 7326 |
699 | 7327 *'tabline'* *'tal'* |
677 | 7328 'tabline' 'tal' string (default empty) |
674 | 7329 global |
2570
71b56b4e7785
Make the references to features in the help more consistent. (Sylvain Hitier)
Bram Moolenaar <bram@vim.org>
parents:
2561
diff
changeset
|
7330 {not available when compiled without the |+windows| |
674 | 7331 feature} |
677 | 7332 When nonempty, this option determines the content of the tab pages |
7333 line at the top of the Vim window. When empty Vim will use a default | |
681 | 7334 tab pages line. See |setting-tabline| for more info. |
677 | 7335 |
7336 The tab pages line only appears as specified with the 'showtabline' | |
688 | 7337 option and only when there is no GUI tab line. When 'e' is in |
7338 '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
|
7339 instead. Note that the two tab pages lines are very different. |
677 | 7340 |
7341 The value is evaluated like with 'statusline'. You can use | |
7342 |tabpagenr()|, |tabpagewinnr()| and |tabpagebuflist()| to figure out | |
681 | 7343 the text to be displayed. Use "%1T" for the first label, "%2T" for |
7344 the second one, etc. Use "%X" items for closing labels. | |
677 | 7345 |
15396
325e4a8ba1b6
patch 8.1.0706: tabline is not always redrawn
Bram Moolenaar <Bram@vim.org>
parents:
15281
diff
changeset
|
7346 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
|
7347 trigger it to be updated, use |:redrawtabline|. |
325e4a8ba1b6
patch 8.1.0706: tabline is not always redrawn
Bram Moolenaar <Bram@vim.org>
parents:
15281
diff
changeset
|
7348 |
677 | 7349 Keep in mind that only one of the tab pages is the current one, others |
7350 are invisible and you can't jump to their windows. | |
7351 | |
674 | 7352 |
699 | 7353 *'tabpagemax'* *'tpm'* |
7354 'tabpagemax' 'tpm' number (default 10) | |
7355 global | |
2570
71b56b4e7785
Make the references to features in the help more consistent. (Sylvain Hitier)
Bram Moolenaar <bram@vim.org>
parents:
2561
diff
changeset
|
7356 {not available when compiled without the |+windows| |
699 | 7357 feature} |
7358 Maximum number of tab pages to be opened by the |-p| command line | |
7359 argument or the ":tab all" command. |tabpage| | |
7360 | |
7361 | |
7362 *'tabstop'* *'ts'* | |
7 | 7363 'tabstop' 'ts' number (default 8) |
7364 local to buffer | |
7365 Number of spaces that a <Tab> in the file counts for. Also see | |
7366 |:retab| command, and 'softtabstop' option. | |
7367 | |
7368 Note: Setting 'tabstop' to any other value than 8 can make your file | |
7369 appear wrong in many places (e.g., when printing it). | |
7370 | |
7371 There are four main ways to use tabs in Vim: | |
7372 1. Always keep 'tabstop' at 8, set 'softtabstop' and 'shiftwidth' to 4 | |
7373 (or 3 or whatever you prefer) and use 'noexpandtab'. Then Vim | |
1263 | 7374 will use a mix of tabs and spaces, but typing <Tab> and <BS> will |
7 | 7375 behave like a tab appears every 4 (or 3) characters. |
7376 2. Set 'tabstop' and 'shiftwidth' to whatever you prefer and use | |
7377 'expandtab'. This way you will always insert spaces. The | |
7378 formatting will never be messed up when 'tabstop' is changed. | |
7379 3. Set 'tabstop' and 'shiftwidth' to whatever you prefer and use a | |
10 | 7380 |modeline| to set these values when editing the file again. Only |
7 | 7381 works when using Vim to edit the file. |
7382 4. Always set 'tabstop' and 'shiftwidth' to the same value, and | |
7383 'noexpandtab'. This should then work (for initial indents only) | |
7384 for any tabstop setting that people use. It might be nice to have | |
7385 tabs after the first non-blank inserted as spaces if you do this | |
7386 though. Otherwise aligned comments will be wrong when 'tabstop' is | |
7387 changed. | |
7388 | |
14175
2ad722003b36
patch 8.1.0105: all tab stops are the same
Christian Brabandt <cb@256bit.org>
parents:
14019
diff
changeset
|
7389 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
|
7390 '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
|
7391 than an empty string. |
2ad722003b36
patch 8.1.0105: all tab stops are the same
Christian Brabandt <cb@256bit.org>
parents:
14019
diff
changeset
|
7392 |
7 | 7393 *'tagbsearch'* *'tbs'* *'notagbsearch'* *'notbs'* |
7394 'tagbsearch' 'tbs' boolean (default on) | |
7395 global | |
7396 When searching for a tag (e.g., for the |:ta| command), Vim can either | |
10 | 7397 use a binary search or a linear search in a tags file. Binary |
7 | 7398 searching makes searching for a tag a LOT faster, but a linear search |
7399 will find more tags if the tags file wasn't properly sorted. | |
7400 Vim normally assumes that your tags files are sorted, or indicate that | |
7401 they are not sorted. Only when this is not the case does the | |
7402 'tagbsearch' option need to be switched off. | |
7403 | |
7404 When 'tagbsearch' is on, binary searching is first used in the tags | |
10 | 7405 files. In certain situations, Vim will do a linear search instead for |
7 | 7406 certain files, or retry all files with a linear search. When |
7407 'tagbsearch' is off, only a linear search is done. | |
7408 | |
7409 Linear searching is done anyway, for one file, when Vim finds a line | |
7410 at the start of the file indicating that it's not sorted: > | |
1621 | 7411 !_TAG_FILE_SORTED 0 /some comment/ |
7 | 7412 < [The whitespace before and after the '0' must be a single <Tab>] |
7413 | |
7414 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
|
7415 files listed in 'tags', and case is ignored or a pattern is used |
7 | 7416 instead of a normal tag name, a retry is done with a linear search. |
7417 Tags in unsorted tags files, and matches with different case will only | |
7418 be found in the retry. | |
7419 | |
22 | 7420 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
|
7421 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
|
7422 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
|
7423 sorted with the -f switch to "sort" in most unices, as in the command: |
6ba7182fb7bd
commit https://github.com/vim/vim/commit/0f6562e9036f889185dff49a75c7fc5ffb28b307
Christian Brabandt <cb@256bit.org>
parents:
7245
diff
changeset
|
7424 "sort -f -o tags tags". For "Exuberant ctags" version 5.x or higher |
6ba7182fb7bd
commit https://github.com/vim/vim/commit/0f6562e9036f889185dff49a75c7fc5ffb28b307
Christian Brabandt <cb@256bit.org>
parents:
7245
diff
changeset
|
7425 (at least 5.5) the --sort=foldcase switch can be used for this as |
6ba7182fb7bd
commit https://github.com/vim/vim/commit/0f6562e9036f889185dff49a75c7fc5ffb28b307
Christian Brabandt <cb@256bit.org>
parents:
7245
diff
changeset
|
7426 well. Note that case must be folded to uppercase for this to work. |
6ba7182fb7bd
commit https://github.com/vim/vim/commit/0f6562e9036f889185dff49a75c7fc5ffb28b307
Christian Brabandt <cb@256bit.org>
parents:
7245
diff
changeset
|
7427 |
6ba7182fb7bd
commit https://github.com/vim/vim/commit/0f6562e9036f889185dff49a75c7fc5ffb28b307
Christian Brabandt <cb@256bit.org>
parents:
7245
diff
changeset
|
7428 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
|
7429 '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
|
7430 "ignore". |
9913
bb00c661b3a4
commit https://github.com/vim/vim/commit/66e29d7112e437b2b50efe1f82c7e892736d23e4
Christian Brabandt <cb@256bit.org>
parents:
9887
diff
changeset
|
7431 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
|
7432 '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
|
7433 characters. |
7 | 7434 |
7435 When 'tagbsearch' is off, tags searching is slower when a full match | |
7436 exists, but faster when no full match exists. Tags in unsorted tags | |
7437 files may only be found with 'tagbsearch' off. | |
7438 When the tags file is not sorted, or sorted in a wrong way (not on | |
7439 ASCII byte value), 'tagbsearch' should be off, or the line given above | |
7440 must be included in the tags file. | |
7441 This option doesn't affect commands that find all matching tags (e.g., | |
7442 command-line completion and ":help"). | |
7443 | |
7266
6ba7182fb7bd
commit https://github.com/vim/vim/commit/0f6562e9036f889185dff49a75c7fc5ffb28b307
Christian Brabandt <cb@256bit.org>
parents:
7245
diff
changeset
|
7444 *'tagcase'* *'tc'* |
6ba7182fb7bd
commit https://github.com/vim/vim/commit/0f6562e9036f889185dff49a75c7fc5ffb28b307
Christian Brabandt <cb@256bit.org>
parents:
7245
diff
changeset
|
7445 'tagcase' 'tc' string (default "followic") |
6ba7182fb7bd
commit https://github.com/vim/vim/commit/0f6562e9036f889185dff49a75c7fc5ffb28b307
Christian Brabandt <cb@256bit.org>
parents:
7245
diff
changeset
|
7446 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
|
7447 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
|
7448 file: |
6ba7182fb7bd
commit https://github.com/vim/vim/commit/0f6562e9036f889185dff49a75c7fc5ffb28b307
Christian Brabandt <cb@256bit.org>
parents:
7245
diff
changeset
|
7449 followic Follow the 'ignorecase' option |
9913
bb00c661b3a4
commit https://github.com/vim/vim/commit/66e29d7112e437b2b50efe1f82c7e892736d23e4
Christian Brabandt <cb@256bit.org>
parents:
9887
diff
changeset
|
7450 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
|
7451 ignore Ignore case |
6ba7182fb7bd
commit https://github.com/vim/vim/commit/0f6562e9036f889185dff49a75c7fc5ffb28b307
Christian Brabandt <cb@256bit.org>
parents:
7245
diff
changeset
|
7452 match Match case |
9913
bb00c661b3a4
commit https://github.com/vim/vim/commit/66e29d7112e437b2b50efe1f82c7e892736d23e4
Christian Brabandt <cb@256bit.org>
parents:
9887
diff
changeset
|
7453 smart Ignore case unless an upper case letter is used |
11160 | 7454 NOTE: This option is set to the Vi default value when 'compatible' is |
7455 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
|
7456 |
16447
54ffc82f38a8
patch 8.1.1228: not possible to process tags with a function
Bram Moolenaar <Bram@vim.org>
parents:
16443
diff
changeset
|
7457 *'tagfunc'* *'tfu'* |
54ffc82f38a8
patch 8.1.1228: not possible to process tags with a function
Bram Moolenaar <Bram@vim.org>
parents:
16443
diff
changeset
|
7458 '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
|
7459 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
|
7460 {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
|
7461 feature} |
54ffc82f38a8
patch 8.1.1228: not possible to process tags with a function
Bram Moolenaar <Bram@vim.org>
parents:
16443
diff
changeset
|
7462 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
|
7463 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
|
7464 tags. See |tag-function| for an explanation of how to write the |
54ffc82f38a8
patch 8.1.1228: not possible to process tags with a function
Bram Moolenaar <Bram@vim.org>
parents:
16443
diff
changeset
|
7465 function and an example. |
54ffc82f38a8
patch 8.1.1228: not possible to process tags with a function
Bram Moolenaar <Bram@vim.org>
parents:
16443
diff
changeset
|
7466 |
7 | 7467 *'taglength'* *'tl'* |
7468 'taglength' 'tl' number (default 0) | |
7469 global | |
7470 If non-zero, tags are significant up to this number of characters. | |
7471 | |
7472 *'tagrelative'* *'tr'* *'notagrelative'* *'notr'* | |
7473 'tagrelative' 'tr' boolean (Vim default: on, Vi default: off) | |
7474 global | |
824 | 7475 If on and using a tags file in another directory, file names in that |
7476 tags file are relative to the directory where the tags file is. | |
7 | 7477 NOTE: This option is set to the Vi default value when 'compatible' is |
7478 set and to the Vim default value when 'compatible' is reset. | |
7479 | |
7480 *'tags'* *'tag'* *E433* | |
7481 'tags' 'tag' string (default "./tags,tags", when compiled with | |
7482 |+emacs_tags|: "./tags,./TAGS,tags,TAGS") | |
7483 global or local to buffer |global-local| | |
7484 Filenames for the tag command, separated by spaces or commas. To | |
7485 include a space or comma in a file name, precede it with a backslash | |
7486 (see |option-backslash| about including spaces and backslashes). | |
7487 When a file name starts with "./", the '.' is replaced with the path | |
7488 of the current file. But only when the 'd' flag is not included in | |
7489 'cpoptions'. Environment variables are expanded |:set_env|. Also see | |
7490 |tags-option|. | |
7491 "*", "**" 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
|
7492 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
|
7493 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
|
7494 contain wildcards, it is used as-is. E.g., "/lib/**/tags?" will find |
d7ecfc8b784c
Update help about wildcards in 'tags' option.
Bram Moolenaar <bram@vim.org>
parents:
2492
diff
changeset
|
7495 files called "tags?". {not available when compiled without the |
d7ecfc8b784c
Update help about wildcards in 'tags' option.
Bram Moolenaar <bram@vim.org>
parents:
2492
diff
changeset
|
7496 |+path_extra| feature} |
515 | 7497 The |tagfiles()| function can be used to get a list of the file names |
7498 actually used. | |
7 | 7499 If Vim was compiled with the |+emacs_tags| feature, Emacs-style tag |
7500 files are also supported. They are automatically recognized. The | |
7501 default value becomes "./tags,./TAGS,tags,TAGS", unless case | |
7502 differences are ignored (MS-Windows). |emacs-tags| | |
7503 The use of |:set+=| and |:set-=| is preferred when adding or removing | |
7504 file names from the list. This avoids problems when a future version | |
7505 uses another default. | |
7506 | |
7507 *'tagstack'* *'tgst'* *'notagstack'* *'notgst'* | |
7508 'tagstack' 'tgst' boolean (default on) | |
7509 global | |
7510 When on, the |tagstack| is used normally. When off, a ":tag" or | |
7511 ":tselect" command with an argument will not push the tag onto the | |
7512 tagstack. A following ":tag" without an argument, a ":pop" command or | |
7513 any other command that uses the tagstack will use the unmodified | |
7514 tagstack, but does change the pointer to the active entry. | |
7515 Resetting this option is useful when using a ":tag" command in a | |
7516 mapping which should not change the tagstack. | |
7517 | |
7538
c9fc24b76293
commit https://github.com/vim/vim/commit/8a5115cf18751022387af2085f374d38c60dde83
Christian Brabandt <cb@256bit.org>
parents:
7528
diff
changeset
|
7518 *'tcldll'* |
8629
54ac275e3fc4
commit https://github.com/vim/vim/commit/3848e00e0177abdb31bc600234967863ec487233
Christian Brabandt <cb@256bit.org>
parents:
8560
diff
changeset
|
7519 '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
|
7520 global |
c9fc24b76293
commit https://github.com/vim/vim/commit/8a5115cf18751022387af2085f374d38c60dde83
Christian Brabandt <cb@256bit.org>
parents:
7528
diff
changeset
|
7521 {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
|
7522 feature} |
c9fc24b76293
commit https://github.com/vim/vim/commit/8a5115cf18751022387af2085f374d38c60dde83
Christian Brabandt <cb@256bit.org>
parents:
7528
diff
changeset
|
7523 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
|
7524 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
|
7525 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
|
7526 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
|
7527 security reasons. |
c9fc24b76293
commit https://github.com/vim/vim/commit/8a5115cf18751022387af2085f374d38c60dde83
Christian Brabandt <cb@256bit.org>
parents:
7528
diff
changeset
|
7528 |
7 | 7529 *'term'* *E529* *E530* *E531* |
7530 'term' string (default is $TERM, if that fails: | |
7531 in the GUI: "builtin_gui" | |
7532 on Amiga: "amiga" | |
7533 on BeOS: "beos-ansi" | |
7534 on Mac: "mac-ansi" | |
7535 on MiNT: "vt52" | |
7536 on MS-DOS: "pcterm" | |
7537 on OS/2: "os2ansi" | |
7538 on Unix: "ansi" | |
7539 on VMS: "ansi" | |
7540 on Win 32: "win32") | |
7541 global | |
7542 Name of the terminal. Used for choosing the terminal control | |
7543 characters. Environment variables are expanded |:set_env|. | |
7544 For example: > | |
7545 :set term=$TERM | |
7546 < See |termcap|. | |
7547 | |
7548 *'termbidi'* *'tbidi'* | |
7549 *'notermbidi'* *'notbidi'* | |
7550 'termbidi' 'tbidi' boolean (default off, on for "mlterm") | |
7551 global | |
7552 {only available when compiled with the |+arabic| | |
7553 feature} | |
7554 The terminal is in charge of Bi-directionality of text (as specified | |
7555 by Unicode). The terminal is also expected to do the required shaping | |
7556 that some languages (such as Arabic) require. | |
7557 Setting this option implies that 'rightleft' will not be set when | |
7558 'arabic' is set and the value of 'arabicshape' will be ignored. | |
7559 Note that setting 'termbidi' has the immediate effect that | |
7560 'arabicshape' is ignored, but 'rightleft' isn't changed automatically. | |
7561 This option is reset when the GUI is started. | |
7562 For further details see |arabic.txt|. | |
7563 | |
7564 *'termencoding'* *'tenc'* | |
10895
c391bfbdb452
Updated runtime files.
Christian Brabandt <cb@256bit.org>
parents:
10734
diff
changeset
|
7565 'termencoding' 'tenc' string (default ""; with GTK+ GUI: "utf-8"; with |
7 | 7566 Macintosh GUI: "macroman") |
7567 global | |
7568 Encoding used for the terminal. This specifies what character | |
7569 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
|
7570 the GUI it only applies to the keyboard ('encoding' is used for the |
1152 | 7571 display). Except for the Mac when 'macatsui' is off, then |
7572 'termencoding' should be "macroman". | |
7 | 7573 *E617* |
10895
c391bfbdb452
Updated runtime files.
Christian Brabandt <cb@256bit.org>
parents:
10734
diff
changeset
|
7574 Note: This does not apply to the GTK+ GUI. After the GUI has been |
7 | 7575 successfully initialized, 'termencoding' is forcibly set to "utf-8". |
7576 Any attempts to set a different value will be rejected, and an error | |
7577 message is shown. | |
7080
1a34f5272977
commit https://github.com/vim/vim/commit/ac360bf2ca293735fc7c6654dc2b3066f4c62488
Christian Brabandt <cb@256bit.org>
parents:
7051
diff
changeset
|
7578 For the Win32 GUI and console versions 'termencoding' is not used, |
7 | 7579 because the Win32 system always passes Unicode characters. |
7580 When empty, the same encoding is used as for the 'encoding' option. | |
7581 This is the normal value. | |
7582 Not all combinations for 'termencoding' and 'encoding' are valid. See | |
7583 |encoding-table|. | |
7584 The value for this option must be supported by internal conversions or | |
7585 iconv(). When this is not possible no conversion will be done and you | |
7586 will probably experience problems with non-ASCII characters. | |
7587 Example: You are working with the locale set to euc-jp (Japanese) and | |
7588 want to edit a UTF-8 file: > | |
7589 :let &termencoding = &encoding | |
7590 :set encoding=utf-8 | |
7591 < You need to do this when your system has no locale support for UTF-8. | |
7592 | |
13314
65c3e8259124
patch 8.0.1531: cannot use 24 bit colors in MS-Windows console
Christian Brabandt <cb@256bit.org>
parents:
13234
diff
changeset
|
7593 *'termguicolors'* *'tgc'* *E954* |
9027
773d627cac0b
commit https://github.com/vim/vim/commit/61be73bb0f965a895bfb064ea3e55476ac175162
Christian Brabandt <cb@256bit.org>
parents:
8969
diff
changeset
|
7594 'termguicolors' 'tgc' boolean (default off) |
773d627cac0b
commit https://github.com/vim/vim/commit/61be73bb0f965a895bfb064ea3e55476ac175162
Christian Brabandt <cb@256bit.org>
parents:
8969
diff
changeset
|
7595 global |
773d627cac0b
commit https://github.com/vim/vim/commit/61be73bb0f965a895bfb064ea3e55476ac175162
Christian Brabandt <cb@256bit.org>
parents:
8969
diff
changeset
|
7596 {not available when compiled without the |
773d627cac0b
commit https://github.com/vim/vim/commit/61be73bb0f965a895bfb064ea3e55476ac175162
Christian Brabandt <cb@256bit.org>
parents:
8969
diff
changeset
|
7597 |+termguicolors| feature} |
773d627cac0b
commit https://github.com/vim/vim/commit/61be73bb0f965a895bfb064ea3e55476ac175162
Christian Brabandt <cb@256bit.org>
parents:
8969
diff
changeset
|
7598 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
|
7599 the terminal (thus using 24-bit color). |
13341
acd7eaa13d2b
Updated runtime files.
Christian Brabandt <cb@256bit.org>
parents:
13314
diff
changeset
|
7600 |
13314
65c3e8259124
patch 8.0.1531: cannot use 24 bit colors in MS-Windows console
Christian Brabandt <cb@256bit.org>
parents:
13234
diff
changeset
|
7601 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
|
7602 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
|
7603 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
|
7604 |
65c3e8259124
patch 8.0.1531: cannot use 24 bit colors in MS-Windows console
Christian Brabandt <cb@256bit.org>
parents:
13234
diff
changeset
|
7605 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
|
7606 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
|
7607 if has('vcon') |
13341
acd7eaa13d2b
Updated runtime files.
Christian Brabandt <cb@256bit.org>
parents:
13314
diff
changeset
|
7608 < This requires Vim to be built with the |+vtp| feature. |
acd7eaa13d2b
Updated runtime files.
Christian Brabandt <cb@256bit.org>
parents:
13314
diff
changeset
|
7609 |
11473 | 7610 Note that the "cterm" attributes are still used, not the "gui" ones. |
11160 | 7611 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
|
7612 |
13735 | 7613 *'termwinkey'* *'twk'* |
7614 'termwinkey' 'twk' string (default "") | |
11659
49c12c93abf3
Updated runtime files and translations.
Christian Brabandt <cb@256bit.org>
parents:
11529
diff
changeset
|
7615 local to window |
11914 | 7616 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
|
7617 are sent to the job running in the window. |
11914 | 7618 The <> notation can be used, e.g.: > |
13735 | 7619 :set termwinkey=<C-L> |
11914 | 7620 < The string must be one key stroke but can be multiple bytes. |
7621 When not set CTRL-W is used, so that CTRL-W : gets you to the command | |
13735 | 7622 line. If 'termwinkey' is set to CTRL-L then CTRL-L : gets you to the |
11914 | 7623 command line. |
11659
49c12c93abf3
Updated runtime files and translations.
Christian Brabandt <cb@256bit.org>
parents:
11529
diff
changeset
|
7624 |
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
|
7625 *'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
|
7626 '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
|
7627 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
|
7628 {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
|
7629 |+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
|
7630 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
|
7631 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
|
7632 the memory usage. See |Terminal-Normal|. |
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
|
7633 |
13735 | 7634 *'termwinsize'* *'tws'* |
7635 'termwinsize' 'tws' string (default "") | |
11659
49c12c93abf3
Updated runtime files and translations.
Christian Brabandt <cb@256bit.org>
parents:
11529
diff
changeset
|
7636 local to 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
|
7637 Size of the |terminal| window. Format: {rows}x{columns} or |
b28d679b1843
patch 8.0.1722: cannot specify a minimal size for a terminal window
Christian Brabandt <cb@256bit.org>
parents:
13680
diff
changeset
|
7638 {rows}*{columns}. |
11659
49c12c93abf3
Updated runtime files and translations.
Christian Brabandt <cb@256bit.org>
parents:
11529
diff
changeset
|
7639 - 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
|
7640 - 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
|
7641 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
|
7642 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
|
7643 - 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
|
7644 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
|
7645 columns. |
b28d679b1843
patch 8.0.1722: cannot specify a minimal size for a terminal window
Christian Brabandt <cb@256bit.org>
parents:
13680
diff
changeset
|
7646 - 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
|
7647 - 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
|
7648 - Using "0x0" or "0*0" is the same as empty. |
b28d679b1843
patch 8.0.1722: cannot specify a minimal size for a terminal window
Christian Brabandt <cb@256bit.org>
parents:
13680
diff
changeset
|
7649 |
b28d679b1843
patch 8.0.1722: cannot specify a minimal size for a terminal window
Christian Brabandt <cb@256bit.org>
parents:
13680
diff
changeset
|
7650 Examples: |
b28d679b1843
patch 8.0.1722: cannot specify a minimal size for a terminal window
Christian Brabandt <cb@256bit.org>
parents:
13680
diff
changeset
|
7651 "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
|
7652 "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
|
7653 "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
|
7654 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
|
7655 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
|
7656 adjusted to that size, if possible. |
11659
49c12c93abf3
Updated runtime files and translations.
Christian Brabandt <cb@256bit.org>
parents:
11529
diff
changeset
|
7657 |
15746
c017195b121b
patch 8.1.0880: MS-Windows: inconsistent selection of winpty/conpty
Bram Moolenaar <Bram@vim.org>
parents:
15729
diff
changeset
|
7658 *'termwintype'* *'twt'* |
c017195b121b
patch 8.1.0880: MS-Windows: inconsistent selection of winpty/conpty
Bram Moolenaar <Bram@vim.org>
parents:
15729
diff
changeset
|
7659 '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
|
7660 global |
c017195b121b
patch 8.1.0880: MS-Windows: inconsistent selection of winpty/conpty
Bram Moolenaar <Bram@vim.org>
parents:
15729
diff
changeset
|
7661 {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
|
7662 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
|
7663 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
|
7664 window. |
c017195b121b
patch 8.1.0880: MS-Windows: inconsistent selection of winpty/conpty
Bram Moolenaar <Bram@vim.org>
parents:
15729
diff
changeset
|
7665 |
c017195b121b
patch 8.1.0880: MS-Windows: inconsistent selection of winpty/conpty
Bram Moolenaar <Bram@vim.org>
parents:
15729
diff
changeset
|
7666 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
|
7667 "" 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
|
7668 "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
|
7669 "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
|
7670 |
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
|
7671 |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
|
7672 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
|
7673 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
|
7674 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
|
7675 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
|
7676 |
7 | 7677 *'terse'* *'noterse'* |
7678 'terse' boolean (default off) | |
7679 global | |
7680 When set: Add 's' flag to 'shortmess' option (this makes the message | |
7681 for a search that hits the start or end of the file not being | |
7682 displayed). When reset: Remove 's' flag from 'shortmess' option. {Vi | |
7683 shortens a lot of messages} | |
7684 | |
7685 *'textauto'* *'ta'* *'notextauto'* *'nota'* | |
7686 'textauto' 'ta' boolean (Vim default: on, Vi default: off) | |
7687 global | |
7688 This option is obsolete. Use 'fileformats'. | |
7689 For backwards compatibility, when 'textauto' is set, 'fileformats' is | |
7690 set to the default value for the current system. When 'textauto' is | |
7691 reset, 'fileformats' is made empty. | |
7692 NOTE: This option is set to the Vi default value when 'compatible' is | |
7693 set and to the Vim default value when 'compatible' is reset. | |
7694 | |
7695 *'textmode'* *'tx'* *'notextmode'* *'notx'* | |
7696 'textmode' 'tx' boolean (MS-DOS, Win32 and OS/2: default on, | |
7697 others: default off) | |
7698 local to buffer | |
7699 This option is obsolete. Use 'fileformat'. | |
7700 For backwards compatibility, when 'textmode' is set, 'fileformat' is | |
7701 set to "dos". When 'textmode' is reset, 'fileformat' is set to | |
7702 "unix". | |
7703 | |
7704 *'textwidth'* *'tw'* | |
7705 'textwidth' 'tw' number (default 0) | |
7706 local to buffer | |
7707 Maximum width of text that is being inserted. A longer line will be | |
7708 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
|
7709 this. |
c590de398af9
commit https://github.com/vim/vim/commit/ca63501fbcd1cf9c8aa9ff12c093c95b62a89ed7
Christian Brabandt <cb@256bit.org>
parents:
7080
diff
changeset
|
7710 '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
|
7711 when 'paste' is reset. |
c590de398af9
commit https://github.com/vim/vim/commit/ca63501fbcd1cf9c8aa9ff12c093c95b62a89ed7
Christian Brabandt <cb@256bit.org>
parents:
7080
diff
changeset
|
7712 When 'textwidth' is zero, 'wrapmargin' may be used. See also |
7 | 7713 'formatoptions' and |ins-textwidth|. |
838 | 7714 When 'formatexpr' is set it will be used to break the line. |
7 | 7715 NOTE: This option is set to 0 when 'compatible' is set. |
7716 | |
7717 *'thesaurus'* *'tsr'* | |
7718 'thesaurus' 'tsr' string (default "") | |
7719 global or local to buffer |global-local| | |
7720 List of file names, separated by commas, that are used to lookup words | |
15033 | 7721 for thesaurus completion commands |i_CTRL-X_CTRL-T|. |
7722 | |
7723 Each line in the file should contain words with similar meaning, | |
7724 separated by non-keyword characters (white space is preferred). | |
7725 Maximum line length is 510 bytes. | |
7726 | |
15131 | 7727 An English word list was added to this github issue: |
7728 https://github.com/vim/vim/issues/629#issuecomment-443293282 | |
7729 Unpack thesaurus_pkg.zip, put the thesaurus.txt file somewhere, e.g. | |
7730 ~/.vim/thesaurus/english.txt, and the 'thesaurus' option to this file | |
7731 name. | |
15033 | 7732 |
10 | 7733 To include a comma in a file name precede it with a backslash. Spaces |
7 | 7734 after a comma are ignored, otherwise spaces are included in the file |
7735 name. See |option-backslash| about using backslashes. | |
7736 The use of |:set+=| and |:set-=| is preferred when adding or removing | |
7737 directories from the list. This avoids problems when a future version | |
7738 uses another default. | |
7739 Backticks cannot be used in this option for security reasons. | |
7740 | |
7741 *'tildeop'* *'top'* *'notildeop'* *'notop'* | |
7742 'tildeop' 'top' boolean (default off) | |
7743 global | |
7744 When on: The tilde command "~" behaves like an operator. | |
7745 NOTE: This option is reset when 'compatible' is set. | |
7746 | |
7747 *'timeout'* *'to'* *'notimeout'* *'noto'* | |
7748 'timeout' 'to' boolean (default on) | |
7749 global | |
7750 *'ttimeout'* *'nottimeout'* | |
11400
0f8713fe20dc
Updated runtime files.
Christian Brabandt <cb@256bit.org>
parents:
11262
diff
changeset
|
7751 'ttimeout' boolean (default off, set in |defaults.vim|) |
7 | 7752 global |
7753 These two options together determine the behavior when part of a | |
7754 mapped key sequence or keyboard code has been received: | |
7755 | |
7756 'timeout' 'ttimeout' action ~ | |
7757 off off do not time out | |
7758 on on or off time out on :mappings and key codes | |
7759 off on time out on key codes | |
7760 | |
7761 If both options are off, Vim will wait until either the complete | |
7762 mapping or key sequence has been received, or it is clear that there | |
7763 is no mapping or key sequence for the received characters. For | |
7764 example: if you have mapped "vl" and Vim has received 'v', the next | |
7765 character is needed to see if the 'v' is followed by an 'l'. | |
7766 When one of the options is on, Vim will wait for about 1 second for | |
7767 the next character to arrive. After that the already received | |
7768 characters are interpreted as single characters. The waiting time can | |
7769 be changed with the 'timeoutlen' option. | |
7770 On slow terminals or very busy systems timing out may cause | |
7771 malfunctioning cursor keys. If both options are off, Vim waits | |
7772 forever after an entered <Esc> if there are key codes that start | |
7773 with <Esc>. You will have to type <Esc> twice. If you do not have | |
7774 problems with key codes, but would like to have :mapped key | |
7775 sequences not timing out in 1 second, set the 'ttimeout' option and | |
7776 reset the 'timeout' option. | |
7777 | |
7778 NOTE: 'ttimeout' is reset when 'compatible' is set. | |
7779 | |
7780 *'timeoutlen'* *'tm'* | |
7781 'timeoutlen' 'tm' number (default 1000) | |
7782 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
|
7783 |
7 | 7784 *'ttimeoutlen'* *'ttm'* |
11400
0f8713fe20dc
Updated runtime files.
Christian Brabandt <cb@256bit.org>
parents:
11262
diff
changeset
|
7785 'ttimeoutlen' 'ttm' number (default -1, set to 100 in |defaults.vim|) |
7 | 7786 global |
7787 The time in milliseconds that is waited for a key code or mapped key | |
7788 sequence to complete. Also used for CTRL-\ CTRL-N and CTRL-\ CTRL-G | |
7789 when part of a command has been typed. | |
7790 Normally only 'timeoutlen' is used and 'ttimeoutlen' is -1. When a | |
7791 different timeout value for key codes is desired set 'ttimeoutlen' to | |
7792 a non-negative number. | |
7793 | |
7794 ttimeoutlen mapping delay key code delay ~ | |
7795 < 0 'timeoutlen' 'timeoutlen' | |
7796 >= 0 'timeoutlen' 'ttimeoutlen' | |
7797 | |
7798 The timeout only happens when the 'timeout' and 'ttimeout' options | |
7799 tell so. A useful setting would be > | |
7800 :set timeout timeoutlen=3000 ttimeoutlen=100 | |
7801 < (time out on mapping after three seconds, time out on key codes after | |
7802 a tenth of a second). | |
7803 | |
7804 *'title'* *'notitle'* | |
7805 'title' boolean (default off, on when title can be restored) | |
7806 global | |
7807 {not available when compiled without the |+title| | |
7808 feature} | |
7809 When on, the title of the window will be set to the value of | |
7810 'titlestring' (if it is not empty), or to: | |
7811 filename [+=-] (path) - VIM | |
7812 Where: | |
7813 filename the name of the file being edited | |
7814 - indicates the file cannot be modified, 'ma' off | |
7815 + indicates the file was modified | |
7816 = indicates the file is read-only | |
7817 =+ indicates the file is read-only and modified | |
7818 (path) is the path of the file being edited | |
7819 - VIM the server name |v:servername| or "VIM" | |
7820 Only works if the terminal supports setting window titles | |
7821 (currently Amiga console, Win32 console, all GUI versions and | |
7822 terminals with a non- empty 't_ts' option - these are Unix xterm and | |
7823 iris-ansi by default, where 't_ts' is taken from the builtin termcap). | |
7824 *X11* | |
7825 When Vim was compiled with HAVE_X11 defined, the original title will | |
7826 be restored if possible. The output of ":version" will include "+X11" | |
7827 when HAVE_X11 was defined, otherwise it will be "-X11". This also | |
7828 works for the icon name |'icon'|. | |
7829 But: When Vim was started with the |-X| argument, restoring the title | |
7830 will not work (except in the GUI). | |
7831 If the title cannot be restored, it is set to the value of 'titleold'. | |
7832 You might want to restore the title outside of Vim then. | |
7833 When using an xterm from a remote machine you can use this command: | |
7834 rsh machine_name xterm -display $DISPLAY & | |
7835 then the WINDOWID environment variable should be inherited and the | |
7836 title of the window should change back to what it should be after | |
7837 exiting Vim. | |
7838 | |
7839 *'titlelen'* | |
7840 'titlelen' number (default 85) | |
7841 global | |
7842 {not available when compiled without the |+title| | |
7843 feature} | |
7844 Gives the percentage of 'columns' to use for the length of the window | |
10 | 7845 title. When the title is longer, only the end of the path name is |
7846 shown. A '<' character before the path name is used to indicate this. | |
7 | 7847 Using a percentage makes this adapt to the width of the window. But |
7848 it won't work perfectly, because the actual number of characters | |
7849 available also depends on the font used and other things in the title | |
7850 bar. When 'titlelen' is zero the full path is used. Otherwise, | |
7851 values from 1 to 30000 percent can be used. | |
7852 'titlelen' is also used for the 'titlestring' option. | |
7853 | |
7854 *'titleold'* | |
7855 'titleold' string (default "Thanks for flying Vim") | |
7856 global | |
7857 {only available when compiled with the |+title| | |
7858 feature} | |
7859 This option will be used for the window title when exiting Vim if the | |
7860 original title cannot be restored. Only happens if 'title' is on or | |
7861 'titlestring' is not empty. | |
36 | 7862 This option cannot be set from a |modeline| or in the |sandbox|, for |
7863 security reasons. | |
7 | 7864 *'titlestring'* |
7865 'titlestring' string (default "") | |
7866 global | |
7867 {not available when compiled without the |+title| | |
7868 feature} | |
7869 When this option is not empty, it will be used for the title of the | |
7870 window. This happens only when the 'title' option is on. | |
7871 Only works if the terminal supports setting window titles (currently | |
7872 Amiga console, Win32 console, all GUI versions and terminals with a | |
7873 non-empty 't_ts' option). | |
7874 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
|
7875 be restored if possible, see |X11|. |
7 | 7876 When this option contains printf-style '%' items, they will be |
7877 expanded according to the rules used for 'statusline'. | |
7878 Example: > | |
7879 :auto BufEnter * let &titlestring = hostname() . "/" . expand("%:p") | |
7880 :set title titlestring=%<%F%=%l/%L-%P titlelen=70 | |
7881 < The value of 'titlelen' is used to align items in the middle or right | |
7882 of the available space. | |
7883 Some people prefer to have the file name first: > | |
7884 :set titlestring=%t%(\ %M%)%(\ (%{expand(\"%:~:.:h\")})%)%(\ %a%) | |
7885 < Note the use of "%{ }" and an expression to get the path of the file, | |
10 | 7886 without the file name. The "%( %)" constructs are used to add a |
7 | 7887 separating space only when needed. |
7888 NOTE: Use of special characters in 'titlestring' may cause the display | |
7889 to be garbled (e.g., when it contains a CR or NL character). | |
7890 {not available when compiled without the |+statusline| feature} | |
7891 | |
7892 *'toolbar'* *'tb'* | |
7893 'toolbar' 'tb' string (default "icons,tooltips") | |
7894 global | |
7895 {only for |+GUI_GTK|, |+GUI_Athena|, |+GUI_Motif| and | |
7896 |+GUI_Photon|} | |
10 | 7897 The contents of this option controls various toolbar settings. The |
7 | 7898 possible values are: |
7899 icons Toolbar buttons are shown with icons. | |
7900 text Toolbar buttons shown with text. | |
7901 horiz Icon and text of a toolbar button are | |
10 | 7902 horizontally arranged. {only in GTK+ 2 GUI} |
7 | 7903 tooltips Tooltips are active for toolbar buttons. |
7904 Tooltips refer to the popup help text which appears after the mouse | |
7905 cursor is placed over a toolbar button for a brief moment. | |
7906 | |
7907 If you want the toolbar to be shown with icons as well as text, do the | |
7908 following: > | |
7909 :set tb=icons,text | |
7910 < Motif and Athena cannot display icons and text at the same time. They | |
7911 will show icons if both are requested. | |
7912 | |
7913 If none of the strings specified in 'toolbar' are valid or if | |
7914 'toolbar' is empty, this option is ignored. If you want to disable | |
7915 the toolbar, you need to set the 'guioptions' option. For example: > | |
7916 :set guioptions-=T | |
7917 < Also see |gui-toolbar|. | |
7918 | |
7919 *'toolbariconsize'* *'tbis'* | |
7920 'toolbariconsize' 'tbis' string (default "small") | |
7921 global | |
10895
c391bfbdb452
Updated runtime files.
Christian Brabandt <cb@256bit.org>
parents:
10734
diff
changeset
|
7922 {only in the GTK+ GUI} |
7 | 7923 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
|
7924 tiny Use tiny icons. |
da01d5da2cfa
commit https://github.com/vim/vim/commit/77cdfd10382e01cc51f4ba1a9177032351843151
Christian Brabandt <cb@256bit.org>
parents:
8246
diff
changeset
|
7925 small Use small icons (default). |
da01d5da2cfa
commit https://github.com/vim/vim/commit/77cdfd10382e01cc51f4ba1a9177032351843151
Christian Brabandt <cb@256bit.org>
parents:
8246
diff
changeset
|
7926 medium Use medium-sized icons. |
da01d5da2cfa
commit https://github.com/vim/vim/commit/77cdfd10382e01cc51f4ba1a9177032351843151
Christian Brabandt <cb@256bit.org>
parents:
8246
diff
changeset
|
7927 large Use large icons. |
da01d5da2cfa
commit https://github.com/vim/vim/commit/77cdfd10382e01cc51f4ba1a9177032351843151
Christian Brabandt <cb@256bit.org>
parents:
8246
diff
changeset
|
7928 huge Use even larger icons. |
da01d5da2cfa
commit https://github.com/vim/vim/commit/77cdfd10382e01cc51f4ba1a9177032351843151
Christian Brabandt <cb@256bit.org>
parents:
8246
diff
changeset
|
7929 giant Use very big icons. |
7 | 7930 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
|
7931 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
|
7932 large=24x24, medium=24x24, small=20x20 and tiny=16x16. |
7 | 7933 |
7934 If 'toolbariconsize' is empty, the global default size as determined | |
7935 by user preferences or the current theme is used. | |
7936 | |
7937 *'ttybuiltin'* *'tbi'* *'nottybuiltin'* *'notbi'* | |
7938 'ttybuiltin' 'tbi' boolean (default on) | |
7939 global | |
7940 When on, the builtin termcaps are searched before the external ones. | |
7941 When off the builtin termcaps are searched after the external ones. | |
7942 When this option is changed, you should set the 'term' option next for | |
7943 the change to take effect, for example: > | |
7944 :set notbi term=$TERM | |
7945 < See also |termcap|. | |
7946 Rationale: The default for this option is "on", because the builtin | |
7947 termcap entries are generally better (many systems contain faulty | |
7948 xterm entries...). | |
7949 | |
7950 *'ttyfast'* *'tf'* *'nottyfast'* *'notf'* | |
7951 'ttyfast' 'tf' boolean (default off, on when 'term' is xterm, hpterm, | |
7952 sun-cmd, screen, rxvt, dtterm or | |
7953 iris-ansi; also on when running Vim in | |
7954 a DOS console) | |
7955 global | |
7956 Indicates a fast terminal connection. More characters will be sent to | |
7957 the screen for redrawing, instead of using insert/delete line | |
7958 commands. Improves smoothness of redrawing when there are multiple | |
7959 windows and the terminal does not support a scrolling region. | |
7960 Also enables the extra writing of characters at the end of each screen | |
7961 line for lines that wrap. This helps when using copy/paste with the | |
7962 mouse in an xterm and other terminals. | |
7963 | |
7964 *'ttymouse'* *'ttym'* | |
7965 'ttymouse' 'ttym' string (default depends on 'term') | |
7966 global | |
7967 {only in Unix and VMS, doesn't work in the GUI; not | |
7968 available when compiled without |+mouse|} | |
7969 Name of the terminal type for which mouse codes are to be recognized. | |
1213 | 7970 Currently these strings are valid: |
7 | 7971 *xterm-mouse* |
7972 xterm xterm-like mouse handling. The mouse generates | |
7973 "<Esc>[Mscr", where "scr" is three bytes: | |
7974 "s" = button state | |
7975 "c" = column plus 33 | |
7976 "r" = row plus 33 | |
5908 | 7977 This only works up to 223 columns! See "dec", |
7978 "urxvt", and "sgr" for solutions. | |
7 | 7979 xterm2 Works like "xterm", but with the xterm reporting the |
7980 mouse position while the mouse is dragged. This works | |
7981 much faster and more precise. Your xterm must at | |
180 | 7982 least at patchlevel 88 / XFree 3.3.3 for this to |
7 | 7983 work. See below for how Vim detects this |
7984 automatically. | |
7985 *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
|
7986 netterm NetTerm mouse handling. A left mouse click generates |
7 | 7987 "<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
|
7988 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
|
7989 supported. |
7 | 7990 *dec-mouse* |
7991 dec DEC terminal mouse handling. The mouse generates a | |
7992 rather complex sequence, starting with "<Esc>[". | |
189 | 7993 This is also available for an Xterm, if it was |
7994 configured with "--enable-dec-locator". | |
7 | 7995 *jsbterm-mouse* |
7996 jsbterm JSB term mouse handling. | |
7997 *pterm-mouse* | |
7998 pterm QNX pterm mouse handling. | |
3224 | 7999 *urxvt-mouse* |
8000 urxvt Mouse handling for the urxvt (rxvt-unicode) terminal. | |
5908 | 8001 The mouse works only if the terminal supports this |
8002 encoding style, but it does not have 223 columns limit | |
8003 unlike "xterm" or "xterm2". | |
3750 | 8004 *sgr-mouse* |
8005 sgr Mouse handling for the terminal that emits SGR-styled | |
5908 | 8006 mouse reporting. The mouse works even in columns |
8007 beyond 223. This option is backward compatible with | |
8008 "xterm2" because it can also decode "xterm2" style | |
8009 mouse codes. | |
7 | 8010 |
8011 The mouse handling must be enabled at compile time |+mouse_xterm| | |
5908 | 8012 |+mouse_dec| |+mouse_netterm| |+mouse_jsbterm| |+mouse_urxvt| |
8013 |+mouse_sgr|. | |
7 | 8014 Only "xterm"(2) is really recognized. NetTerm mouse codes are always |
8015 recognized, if enabled at compile time. DEC terminal mouse codes | |
8016 are recognized if enabled at compile time, and 'ttymouse' is not | |
5908 | 8017 "xterm", "xterm2", "urxvt" or "sgr" (because dec mouse codes conflict |
8018 with them). | |
7 | 8019 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
|
8020 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
|
8021 "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
|
8022 already. |
5908 | 8023 Additionally, if vim is compiled with the |+termresponse| feature and |
8024 |t_RV| is set to the escape sequence to request the xterm version | |
8025 number, more intelligent detection process runs. | |
7 | 8026 The "xterm2" value will be set if the xterm version is reported to be |
15131 | 8027 from 95 to 276. The "sgr" value will be set if Vim detects Mac |
8028 Terminal.app, iTerm2 or mintty, and when the xterm version is 277 or | |
8029 higher. | |
5908 | 8030 If you do not want 'ttymouse' to be set to "xterm2" or "sgr" |
8031 automatically, set t_RV to an empty string: > | |
7 | 8032 :set t_RV= |
8033 < | |
8034 *'ttyscroll'* *'tsl'* | |
8035 'ttyscroll' 'tsl' number (default 999) | |
8036 global | |
8037 Maximum number of lines to scroll the screen. If there are more lines | |
8038 to scroll the window is redrawn. For terminals where scrolling is | |
8039 very slow and redrawing is not slow this can be set to a small number, | |
8040 e.g., 3, to speed up displaying. | |
8041 | |
8042 *'ttytype'* *'tty'* | |
8043 'ttytype' 'tty' string (default from $TERM) | |
8044 global | |
8045 Alias for 'term', see above. | |
8046 | |
2214
f8222d1f9a73
Included patch for persistent undo. Lots of changes and added test.
Bram Moolenaar <bram@vim.org>
parents:
2209
diff
changeset
|
8047 *'undodir'* *'udir'* |
f8222d1f9a73
Included patch for persistent undo. Lots of changes and added test.
Bram Moolenaar <bram@vim.org>
parents:
2209
diff
changeset
|
8048 '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
|
8049 global |
2570
71b56b4e7785
Make the references to features in the help more consistent. (Sylvain Hitier)
Bram Moolenaar <bram@vim.org>
parents:
2561
diff
changeset
|
8050 {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
|
8051 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
|
8052 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
|
8053 "." 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
|
8054 "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
|
8055 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
|
8056 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
|
8057 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
|
8058 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
|
8059 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
|
8060 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
|
8061 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
|
8062 See |undo-persistence|. |
f8222d1f9a73
Included patch for persistent undo. Lots of changes and added test.
Bram Moolenaar <bram@vim.org>
parents:
2209
diff
changeset
|
8063 |
4681
2eb30f341e8d
Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents:
4502
diff
changeset
|
8064 *'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
|
8065 '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
|
8066 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
|
8067 {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
|
8068 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
|
8069 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
|
8070 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
|
8071 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
|
8072 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
|
8073 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
|
8074 before a reload to be saved for undo. |
3920 | 8075 When 'undofile' is turned off the undo file is NOT deleted. |
11160 | 8076 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
|
8077 |
7 | 8078 *'undolevels'* *'ul'* |
8079 'undolevels' 'ul' number (default 100, 1000 for Unix, VMS, | |
8080 Win32 and OS/2) | |
5446 | 8081 global or local to buffer |global-local| |
7 | 8082 Maximum number of changes that can be undone. Since undo information |
8083 is kept in memory, higher numbers will cause more memory to be used | |
8084 (nevertheless, a single change can use an unlimited amount of memory). | |
8085 Set to 0 for Vi compatibility: One level of undo and "u" undoes | |
8086 itself: > | |
8087 set ul=0 | |
8088 < But you can also get Vi compatibility by including the 'u' flag in | |
8089 '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
|
8090 Also see |undo-two-ways|. |
5446 | 8091 Set to -1 for no undo at all. You might want to do this only for the |
8092 current buffer: > | |
8093 setlocal ul=-1 | |
7 | 8094 < This helps when you run out of memory for a single change. |
6336 | 8095 |
8096 The local value is set to -123456 when the global value is to be used. | |
8097 | |
2249
6d3d35ff2c2b
Use full path in undofile(). Updated docs.
Bram Moolenaar <bram@vim.org>
parents:
2240
diff
changeset
|
8098 Also see |clear-undo|. |
7 | 8099 |
2394
a3aca345aafa
Add the 'undoreload' option to be able to undo a file reload.
Bram Moolenaar <bram@vim.org>
parents:
2382
diff
changeset
|
8100 *'undoreload'* *'ur'* |
a3aca345aafa
Add the 'undoreload' option to be able to undo a file reload.
Bram Moolenaar <bram@vim.org>
parents:
2382
diff
changeset
|
8101 '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
|
8102 global |
a3aca345aafa
Add the 'undoreload' option to be able to undo a file reload.
Bram Moolenaar <bram@vim.org>
parents:
2382
diff
changeset
|
8103 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
|
8104 ":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
|
8105 Vim. |FileChangedShell| |
12559 | 8106 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
|
8107 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
|
8108 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
|
8109 |
a3aca345aafa
Add the 'undoreload' option to be able to undo a file reload.
Bram Moolenaar <bram@vim.org>
parents:
2382
diff
changeset
|
8110 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
|
8111 |
a3aca345aafa
Add the 'undoreload' option to be able to undo a file reload.
Bram Moolenaar <bram@vim.org>
parents:
2382
diff
changeset
|
8112 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
|
8113 this option to a lower value if you run out of memory. |
7 | 8114 |
8115 *'updatecount'* *'uc'* | |
8116 'updatecount' 'uc' number (default: 200) | |
8117 global | |
8118 After typing this many characters the swap file will be written to | |
8119 disk. When zero, no swap file will be created at all (see chapter on | |
8120 recovery |crash-recovery|). 'updatecount' is set to zero by starting | |
8121 Vim with the "-n" option, see |startup|. When editing in readonly | |
8122 mode this option will be initialized to 10000. | |
8123 The swapfile can be disabled per buffer with |'swapfile'|. | |
8124 When 'updatecount' is set from zero to non-zero, swap files are | |
8125 created for all buffers that have 'swapfile' set. When 'updatecount' | |
8126 is set to zero, existing swap files are not deleted. | |
8127 Also see |'swapsync'|. | |
8128 This option has no meaning in buffers where |'buftype'| is "nofile" | |
8129 or "nowrite". | |
8130 | |
8131 *'updatetime'* *'ut'* | |
8132 'updatetime' 'ut' number (default 4000) | |
8133 global | |
8134 If this many milliseconds nothing is typed the swap file will be | |
8135 written to disk (see |crash-recovery|). Also used for the | |
8136 |CursorHold| autocommand event. | |
8137 | |
14175
2ad722003b36
patch 8.1.0105: all tab stops are the same
Christian Brabandt <cb@256bit.org>
parents:
14019
diff
changeset
|
8138 *'varsofttabstop'* *'vsts'* |
2ad722003b36
patch 8.1.0105: all tab stops are the same
Christian Brabandt <cb@256bit.org>
parents:
14019
diff
changeset
|
8139 'varsofttabstop' 'vsts' string (default "") |
2ad722003b36
patch 8.1.0105: all tab stops are the same
Christian Brabandt <cb@256bit.org>
parents:
14019
diff
changeset
|
8140 local to buffer |
2ad722003b36
patch 8.1.0105: all tab stops are the same
Christian Brabandt <cb@256bit.org>
parents:
14019
diff
changeset
|
8141 {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
|
8142 feature} |
2ad722003b36
patch 8.1.0105: all tab stops are the same
Christian Brabandt <cb@256bit.org>
parents:
14019
diff
changeset
|
8143 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
|
8144 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
|
8145 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
|
8146 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
|
8147 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
|
8148 |
2ad722003b36
patch 8.1.0105: all tab stops are the same
Christian Brabandt <cb@256bit.org>
parents:
14019
diff
changeset
|
8149 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
|
8150 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
|
8151 to use the following: > |
2ad722003b36
patch 8.1.0105: all tab stops are the same
Christian Brabandt <cb@256bit.org>
parents:
14019
diff
changeset
|
8152 :set varsofttabstop=8,32,8 |
14249
4543777545a3
Updated runtime and language files.
Christian Brabandt <cb@256bit.org>
parents:
14175
diff
changeset
|
8153 < 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
|
8154 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
|
8155 |
2ad722003b36
patch 8.1.0105: all tab stops are the same
Christian Brabandt <cb@256bit.org>
parents:
14019
diff
changeset
|
8156 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
|
8157 'varsofttabstop' is set. |
2ad722003b36
patch 8.1.0105: all tab stops are the same
Christian Brabandt <cb@256bit.org>
parents:
14019
diff
changeset
|
8158 |
2ad722003b36
patch 8.1.0105: all tab stops are the same
Christian Brabandt <cb@256bit.org>
parents:
14019
diff
changeset
|
8159 *'vartabstop'* *'vts'* |
2ad722003b36
patch 8.1.0105: all tab stops are the same
Christian Brabandt <cb@256bit.org>
parents:
14019
diff
changeset
|
8160 'vartabstop' 'vts' string (default "") |
2ad722003b36
patch 8.1.0105: all tab stops are the same
Christian Brabandt <cb@256bit.org>
parents:
14019
diff
changeset
|
8161 local to buffer |
2ad722003b36
patch 8.1.0105: all tab stops are the same
Christian Brabandt <cb@256bit.org>
parents:
14019
diff
changeset
|
8162 {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
|
8163 feature} |
2ad722003b36
patch 8.1.0105: all tab stops are the same
Christian Brabandt <cb@256bit.org>
parents:
14019
diff
changeset
|
8164 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
|
8165 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
|
8166 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
|
8167 :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
|
8168 < 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
|
8169 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
|
8170 |
2ad722003b36
patch 8.1.0105: all tab stops are the same
Christian Brabandt <cb@256bit.org>
parents:
14019
diff
changeset
|
8171 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
|
8172 is set. |
2ad722003b36
patch 8.1.0105: all tab stops are the same
Christian Brabandt <cb@256bit.org>
parents:
14019
diff
changeset
|
8173 |
7 | 8174 *'verbose'* *'vbs'* |
8175 'verbose' 'vbs' number (default 0) | |
8176 global | |
8177 When bigger than zero, Vim will give messages about what it is doing. | |
8178 Currently, these messages are given: | |
8179 >= 1 When the viminfo file is read or written. | |
8180 >= 2 When a file is ":source"'ed. | |
712 | 8181 >= 5 Every searched tags file and include file. |
7 | 8182 >= 8 Files for which a group of autocommands is executed. |
8183 >= 9 Every executed autocommand. | |
8184 >= 12 Every executed function. | |
8185 >= 13 When an exception is thrown, caught, finished, or discarded. | |
8186 >= 14 Anything pending in a ":finally" clause. | |
8187 >= 15 Every executed Ex command (truncated at 200 characters). | |
8188 | |
8189 This option can also be set with the "-V" argument. See |-V|. | |
8190 This option is also set by the |:verbose| command. | |
8191 | |
293 | 8192 When the 'verbosefile' option is set then the verbose messages are not |
8193 displayed. | |
8194 | |
8195 *'verbosefile'* *'vfile'* | |
8196 'verbosefile' 'vfile' string (default empty) | |
8197 global | |
8198 When not empty all messages are written in a file with this name. | |
8199 When the file exists messages are appended. | |
8200 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
|
8201 empty. Writes are buffered, thus may not show up for some time. |
293 | 8202 Setting 'verbosefile' to a new value is like making it empty first. |
8203 The difference with |:redir| is that verbose messages are not | |
8204 displayed when 'verbosefile' is set. | |
8205 | |
7 | 8206 *'viewdir'* *'vdir'* |
8207 'viewdir' 'vdir' string (default for Amiga, MS-DOS, OS/2 and Win32: | |
8208 "$VIM/vimfiles/view", | |
8209 for Unix: "~/.vim/view", | |
8210 for Macintosh: "$VIM:vimfiles:view" | |
8211 for VMS: "sys$login:vimfiles/view" | |
8212 for RiscOS: "Choices:vimfiles/view") | |
8213 global | |
2570
71b56b4e7785
Make the references to features in the help more consistent. (Sylvain Hitier)
Bram Moolenaar <bram@vim.org>
parents:
2561
diff
changeset
|
8214 {not available when compiled without the |+mksession| |
7 | 8215 feature} |
8216 Name of the directory where to store files for |:mkview|. | |
8217 This option cannot be set from a |modeline| or in the |sandbox|, for | |
8218 security reasons. | |
8219 | |
8220 *'viewoptions'* *'vop'* | |
12824
79a754456110
patch 8.0.1289: mkview always includes the local directory
Christian Brabandt <cb@256bit.org>
parents:
12802
diff
changeset
|
8221 'viewoptions' 'vop' string (default: "folds,options,cursor,curdir") |
7 | 8222 global |
2570
71b56b4e7785
Make the references to features in the help more consistent. (Sylvain Hitier)
Bram Moolenaar <bram@vim.org>
parents:
2561
diff
changeset
|
8223 {not available when compiled without the |+mksession| |
7 | 8224 feature} |
8225 Changes the effect of the |:mkview| command. It is a comma separated | |
10 | 8226 list of words. Each word enables saving and restoring something: |
7 | 8227 word save and restore ~ |
8228 cursor cursor position in file and in window | |
8229 folds manually created folds, opened/closed folds and local | |
8230 fold options | |
8231 options options and mappings local to a window or buffer (not | |
8232 global values for local options) | |
6213 | 8233 localoptions same as "options" |
7 | 8234 slash backslashes in file names replaced with forward |
8235 slashes | |
8236 unix with Unix end-of-line format (single <NL>), even when | |
8237 on Windows or DOS | |
12824
79a754456110
patch 8.0.1289: mkview always includes the local directory
Christian Brabandt <cb@256bit.org>
parents:
12802
diff
changeset
|
8238 curdir the window-local directory, if set with `:lcd` |
7 | 8239 |
8240 "slash" and "unix" are useful on Windows when sharing view files | |
8241 with Unix. The Unix version of Vim cannot source dos format scripts, | |
8242 but the Windows version of Vim can source unix format scripts. | |
8243 | |
8244 *'viminfo'* *'vi'* *E526* *E527* *E528* | |
8245 'viminfo' 'vi' string (Vi default: "", Vim default for MS-DOS, | |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
8246 Windows and OS/2: '100,<50,s10,h,rA:,rB:, |
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
8247 for Amiga: '100,<50,s10,h,rdf0:,rdf1:,rdf2: |
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
8248 for others: '100,<50,s10,h) |
7 | 8249 global |
2570
71b56b4e7785
Make the references to features in the help more consistent. (Sylvain Hitier)
Bram Moolenaar <bram@vim.org>
parents:
2561
diff
changeset
|
8250 {not available when compiled without the |+viminfo| |
7 | 8251 feature} |
8252 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
|
8253 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
|
8254 "NONE". |
5cd9ba96561d
patch 8.0.0716: not easy to start Vim cleanly
Christian Brabandt <cb@256bit.org>
parents:
11659
diff
changeset
|
8255 The string should be a comma separated list of parameters, each |
5cd9ba96561d
patch 8.0.0716: not easy to start Vim cleanly
Christian Brabandt <cb@256bit.org>
parents:
11659
diff
changeset
|
8256 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
|
8257 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
|
8258 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
|
8259 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
|
8260 identifying characters and the effect of their value. |
7 | 8261 CHAR VALUE ~ |
3224 | 8262 *viminfo-!* |
7 | 8263 ! When included, save and restore global variables that start |
8264 with an uppercase letter, and don't contain a lowercase | |
8265 letter. Thus "KEEPTHIS and "K_L_M" are stored, but "KeepThis" | |
2607 | 8266 and "_K_L_M" are not. Nested List and Dict items may not be |
2642 | 8267 read back correctly, you end up with an empty item. |
3224 | 8268 *viminfo-quote* |
7 | 8269 " Maximum number of lines saved for each register. Old name of |
8270 the '<' item, with the disadvantage that you need to put a | |
8271 backslash before the ", otherwise it will be recognized as the | |
8272 start of a comment! | |
3224 | 8273 *viminfo-%* |
7 | 8274 % When included, save and restore the buffer list. If Vim is |
8275 started with a file name argument, the buffer list is not | |
8276 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
|
8277 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
|
8278 ('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
|
8279 removable media (|viminfo-r|) are not saved. |
23 | 8280 When followed by a number, the number specifies the maximum |
8281 number of buffers that are stored. Without a number all | |
8282 buffers are stored. | |
3224 | 8283 *viminfo-'* |
7 | 8284 ' Maximum number of previously edited files for which the marks |
8285 are remembered. This parameter must always be included when | |
8286 'viminfo' is non-empty. | |
8287 Including this item also means that the |jumplist| and the | |
8288 |changelist| are stored in the viminfo file. | |
3224 | 8289 *viminfo-/* |
7 | 8290 / Maximum number of items in the search pattern history to be |
10 | 8291 saved. If non-zero, then the previous search and substitute |
7 | 8292 patterns are also saved. When not included, the value of |
8293 'history' is used. | |
3224 | 8294 *viminfo-:* |
7 | 8295 : Maximum number of items in the command-line history to be |
10 | 8296 saved. When not included, the value of 'history' is used. |
3224 | 8297 *viminfo-<* |
7 | 8298 < Maximum number of lines saved for each register. If zero then |
8299 registers are not saved. When not included, all lines are | |
8300 saved. '"' is the old name for this item. | |
8301 Also see the 's' item below: limit specified in Kbyte. | |
3224 | 8302 *viminfo-@* |
7 | 8303 @ Maximum number of items in the input-line history to be |
10 | 8304 saved. When not included, the value of 'history' is used. |
3224 | 8305 *viminfo-c* |
7 | 8306 c When included, convert the text in the viminfo file from the |
8307 'encoding' used when writing the file to the current | |
233 | 8308 'encoding'. See |viminfo-encoding|. |
3224 | 8309 *viminfo-f* |
7 | 8310 f Whether file marks need to be stored. If zero, file marks ('0 |
8311 to '9, 'A to 'Z) are not stored. When not present or when | |
10 | 8312 non-zero, they are all stored. '0 is used for the current |
7 | 8313 cursor position (when exiting or when doing ":wviminfo"). |
3224 | 8314 *viminfo-h* |
7 | 8315 h Disable the effect of 'hlsearch' when loading the viminfo |
8316 file. When not included, it depends on whether ":nohlsearch" | |
8317 has been used since the last search command. | |
3224 | 8318 *viminfo-n* |
7 | 8319 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
|
8320 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
|
8321 '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
|
8322 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
|
8323 expanded when opening the file, not when setting the option. |
3224 | 8324 *viminfo-r* |
7 | 8325 r Removable media. The argument is a string (up to the next |
8326 ','). This parameter can be given several times. Each | |
8327 specifies the start of a path for which no marks will be | |
8328 stored. This is to avoid removable media. For MS-DOS you | |
8329 could use "ra:,rb:", for Amiga "rdf0:,rdf1:,rdf2:". You can | |
8330 also use it for temp files, e.g., for Unix: "r/tmp". Case is | |
8331 ignored. Maximum length of each 'r' argument is 50 | |
8332 characters. | |
3224 | 8333 *viminfo-s* |
7 | 8334 s Maximum size of an item in Kbyte. If zero then registers are |
8335 not saved. Currently only applies to registers. The default | |
8336 "s10" will exclude registers with more than 10 Kbyte of text. | |
8337 Also see the '<' item above: line count limit. | |
8338 | |
8339 Example: > | |
8340 :set viminfo='50,<1000,s100,:0,n~/vim/viminfo | |
8341 < | |
8342 '50 Marks will be remembered for the last 50 files you | |
8343 edited. | |
8344 <1000 Contents of registers (up to 1000 lines each) will be | |
8345 remembered. | |
8346 s100 Registers with more than 100 Kbyte text are skipped. | |
8347 :0 Command-line history will not be saved. | |
8348 n~/vim/viminfo The name of the file to use is "~/vim/viminfo". | |
8349 no / Since '/' is not specified, the default will be used, | |
8350 that is, save all of the search history, and also the | |
8351 previous search and substitute patterns. | |
8352 no % The buffer list will not be saved nor read back. | |
8353 no h 'hlsearch' highlighting will be restored. | |
8354 | |
8355 When setting 'viminfo' from an empty value you can use |:rviminfo| to | |
8356 load the contents of the file, this is not done automatically. | |
8357 | |
8358 This option cannot be set from a |modeline| or in the |sandbox|, for | |
8359 security reasons. | |
11160 | 8360 NOTE: This option is set to the Vim default value when 'compatible' |
8361 is reset. | |
7 | 8362 |
11666
5cd9ba96561d
patch 8.0.0716: not easy to start Vim cleanly
Christian Brabandt <cb@256bit.org>
parents:
11659
diff
changeset
|
8363 *'viminfofile'* *'vif'* |
5cd9ba96561d
patch 8.0.0716: not easy to start Vim cleanly
Christian Brabandt <cb@256bit.org>
parents:
11659
diff
changeset
|
8364 'viminfofile' 'vif' string (default: "") |
5cd9ba96561d
patch 8.0.0716: not easy to start Vim cleanly
Christian Brabandt <cb@256bit.org>
parents:
11659
diff
changeset
|
8365 global |
5cd9ba96561d
patch 8.0.0716: not easy to start Vim cleanly
Christian Brabandt <cb@256bit.org>
parents:
11659
diff
changeset
|
8366 {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
|
8367 feature} |
5cd9ba96561d
patch 8.0.0716: not easy to start Vim cleanly
Christian Brabandt <cb@256bit.org>
parents:
11659
diff
changeset
|
8368 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
|
8369 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
|
8370 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
|
8371 command line flag sets it to "NONE". |
5cd9ba96561d
patch 8.0.0716: not easy to start Vim cleanly
Christian Brabandt <cb@256bit.org>
parents:
11659
diff
changeset
|
8372 |
7 | 8373 *'virtualedit'* *'ve'* |
8374 'virtualedit' 've' string (default "") | |
8375 global | |
8376 {not available when compiled without the | |
8377 |+virtualedit| feature} | |
8378 A comma separated list of these words: | |
8379 block Allow virtual editing in Visual block mode. | |
8380 insert Allow virtual editing in Insert mode. | |
8381 all Allow virtual editing in all modes. | |
772 | 8382 onemore Allow the cursor to move just past the end of the line |
782 | 8383 |
7 | 8384 Virtual editing means that the cursor can be positioned where there is |
1263 | 8385 no actual character. This can be halfway into a tab or beyond the end |
7 | 8386 of the line. Useful for selecting a rectangle in Visual mode and |
8387 editing a table. | |
772 | 8388 "onemore" is not the same, it will only allow moving the cursor just |
8389 after the last character of the line. This makes some commands more | |
8390 consistent. Previously the cursor was always past the end of the line | |
8391 if the line was empty. But it is far from Vi compatible. It may also | |
782 | 8392 break some plugins or Vim scripts. For example because |l| can move |
8393 the cursor after the last character. Use with care! | |
5220 | 8394 Using the `$` command will move to the last character in the line, not |
782 | 8395 past it. This may actually move the cursor to the left! |
5220 | 8396 The `g$` command will move to the end of the screen line. |
772 | 8397 It doesn't make sense to combine "all" with "onemore", but you will |
8398 not get a warning for it. | |
11160 | 8399 NOTE: This option is set to "" when 'compatible' is set. |
7 | 8400 |
8401 *'visualbell'* *'vb'* *'novisualbell'* *'novb'* *beep* | |
8402 'visualbell' 'vb' boolean (default off) | |
8403 global | |
11659
49c12c93abf3
Updated runtime files and translations.
Christian Brabandt <cb@256bit.org>
parents:
11529
diff
changeset
|
8404 Use a visual bell instead of beeping. The terminal code to display the |
7 | 8405 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
|
8406 use: > |
49c12c93abf3
Updated runtime files and translations.
Christian Brabandt <cb@256bit.org>
parents:
11529
diff
changeset
|
8407 :set vb t_vb= |
49c12c93abf3
Updated runtime files and translations.
Christian Brabandt <cb@256bit.org>
parents:
11529
diff
changeset
|
8408 < 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
|
8409 :set vb t_vb=[?5h$<100>[?5l |
49c12c93abf3
Updated runtime files and translations.
Christian Brabandt <cb@256bit.org>
parents:
11529
diff
changeset
|
8410 < 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
|
8411 to get a shorter or longer flash. |
49c12c93abf3
Updated runtime files and translations.
Christian Brabandt <cb@256bit.org>
parents:
11529
diff
changeset
|
8412 |
49c12c93abf3
Updated runtime files and translations.
Christian Brabandt <cb@256bit.org>
parents:
11529
diff
changeset
|
8413 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
|
8414 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
|
8415 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
|
8416 set. |
49c12c93abf3
Updated runtime files and translations.
Christian Brabandt <cb@256bit.org>
parents:
11529
diff
changeset
|
8417 |
7 | 8418 In the GUI, 't_vb' defaults to "<Esc>|f", which inverts the display |
8419 for 20 msec. If you want to use a different time, use "<Esc>|40f", | |
8420 where 40 is the time in msec. | |
11659
49c12c93abf3
Updated runtime files and translations.
Christian Brabandt <cb@256bit.org>
parents:
11529
diff
changeset
|
8421 |
49c12c93abf3
Updated runtime files and translations.
Christian Brabandt <cb@256bit.org>
parents:
11529
diff
changeset
|
8422 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
|
8423 might want to set it again in your |gvimrc|. |
49c12c93abf3
Updated runtime files and translations.
Christian Brabandt <cb@256bit.org>
parents:
11529
diff
changeset
|
8424 |
7 | 8425 Does not work on the Amiga, you always get a screen flash. |
8426 Also see 'errorbells'. | |
8427 | |
8428 *'warn'* *'nowarn'* | |
8429 'warn' boolean (default on) | |
8430 global | |
8431 Give a warning message when a shell command is used while the buffer | |
8432 has been changed. | |
8433 | |
8434 *'weirdinvert'* *'wiv'* *'noweirdinvert'* *'nowiv'* | |
8435 'weirdinvert' 'wiv' boolean (default off) | |
8436 global | |
667 | 8437 This option has the same effect as the 't_xs' terminal option. |
7 | 8438 It is provided for backwards compatibility with version 4.x. |
8439 Setting 'weirdinvert' has the effect of making 't_xs' non-empty, and | |
8440 vice versa. Has no effect when the GUI is running. | |
8441 | |
8442 *'whichwrap'* *'ww'* | |
8443 'whichwrap' 'ww' string (Vim default: "b,s", Vi default: "") | |
8444 global | |
8445 Allow specified keys that move the cursor left/right to move to the | |
8446 previous/next line when the cursor is on the first/last character in | |
8447 the line. Concatenate characters to allow this for these keys: | |
8448 char key mode ~ | |
8449 b <BS> Normal and Visual | |
8450 s <Space> Normal and Visual | |
712 | 8451 h "h" Normal and Visual (not recommended) |
8452 l "l" Normal and Visual (not recommended) | |
7 | 8453 < <Left> Normal and Visual |
8454 > <Right> Normal and Visual | |
8455 ~ "~" Normal | |
8456 [ <Left> Insert and Replace | |
8457 ] <Right> Insert and Replace | |
8458 For example: > | |
8459 :set ww=<,>,[,] | |
8460 < allows wrap only when cursor keys are used. | |
8461 When the movement keys are used in combination with a delete or change | |
8462 operator, the <EOL> also counts for a character. This makes "3h" | |
8463 different from "3dh" when the cursor crosses the end of a line. This | |
8464 is also true for "x" and "X", because they do the same as "dl" and | |
8465 "dh". If you use this, you may also want to use the mapping | |
8466 ":map <BS> X" to make backspace delete the character in front of the | |
8467 cursor. | |
714 | 8468 When 'l' is included and it is used after an operator at the end of a |
8469 line then it will not move to the next line. This makes "dl", "cl", | |
8470 "yl" etc. work normally. | |
7 | 8471 NOTE: This option is set to the Vi default value when 'compatible' is |
8472 set and to the Vim default value when 'compatible' is reset. | |
8473 | |
8474 *'wildchar'* *'wc'* | |
8475 'wildchar' 'wc' number (Vim default: <Tab>, Vi default: CTRL-E) | |
8476 global | |
8477 Character you have to type to start wildcard expansion in the | |
8478 command-line, as specified with 'wildmode'. | |
1621 | 8479 More info here: |cmdline-completion|. |
7 | 8480 The character is not recognized when used inside a macro. See |
8481 'wildcharm' for that. | |
8482 Although 'wc' is a number option, you can set it to a special key: > | |
8483 :set wc=<Esc> | |
8484 < NOTE: This option is set to the Vi default value when 'compatible' is | |
8485 set and to the Vim default value when 'compatible' is reset. | |
8486 | |
8487 *'wildcharm'* *'wcm'* | |
8488 'wildcharm' 'wcm' number (default: none (0)) | |
8489 global | |
8490 'wildcharm' works exactly like 'wildchar', except that it is | |
233 | 8491 recognized when used inside a macro. You can find "spare" command-line |
8492 keys suitable for this option by looking at |ex-edit-index|. Normally | |
7 | 8493 you'll never actually type 'wildcharm', just use it in mappings that |
8494 automatically invoke completion mode, e.g.: > | |
8495 :set wcm=<C-Z> | |
1621 | 8496 :cnoremap ss so $vim/sessions/*.vim<C-Z> |
7 | 8497 < Then after typing :ss you can use CTRL-P & CTRL-N. |
8498 | |
8499 *'wildignore'* *'wig'* | |
8500 'wildignore' 'wig' string (default "") | |
8501 global | |
8502 {not available when compiled without the |+wildignore| | |
8503 feature} | |
8504 A list of file patterns. A file that matches with one of these | |
3682 | 8505 patterns is ignored when expanding |wildcards|, completing file or |
8506 directory names, and influences the result of |expand()|, |glob()| and | |
8507 |globpath()| unless a flag is passed to disable this. | |
7 | 8508 The pattern is used like with |:autocmd|, see |autocmd-patterns|. |
8509 Also see 'suffixes'. | |
8510 Example: > | |
8511 :set wildignore=*.o,*.obj | |
8512 < The use of |:set+=| and |:set-=| is preferred when adding or removing | |
8513 a pattern from the list. This avoids problems when a future version | |
8514 uses another default. | |
8515 | |
2652 | 8516 |
2662 | 8517 *'wildignorecase'* *'wic'* *'nowildignorecase'* *'nowic'* |
2652 | 8518 'wildignorecase' 'wic' boolean (default off) |
8519 global | |
8520 When set case is ignored when completing file names and directories. | |
4242 | 8521 Has no effect when 'fileignorecase' is set. |
2652 | 8522 Does not apply when the shell is used to expand wildcards, which |
8523 happens when there are special characters. | |
8524 | |
8525 | |
7 | 8526 *'wildmenu'* *'wmnu'* *'nowildmenu'* *'nowmnu'* |
9669
284b4eb307fc
commit https://github.com/vim/vim/commit/8c08b5b569e2a9e9f63dea514591ecfa2d3bb392
Christian Brabandt <cb@256bit.org>
parents:
9665
diff
changeset
|
8527 'wildmenu' 'wmnu' boolean (default off, set in |defaults.vim|) |
7 | 8528 global |
8529 {not available if compiled without the |+wildmenu| | |
8530 feature} | |
8531 When 'wildmenu' is on, command-line completion operates in an enhanced | |
8532 mode. On pressing 'wildchar' (usually <Tab>) to invoke completion, | |
8533 the possible matches are shown just above the command line, with the | |
8534 first match highlighted (overwriting the status line, if there is | |
8535 one). Keys that show the previous/next match, such as <Tab> or | |
8536 CTRL-P/CTRL-N, cause the highlight to move to the appropriate match. | |
8537 When 'wildmode' is used, "wildmenu" mode is used where "full" is | |
8538 specified. "longest" and "list" do not start "wildmenu" mode. | |
4159 | 8539 You can check the current mode with |wildmenumode()|. |
7 | 8540 If there are more matches than can fit in the line, a ">" is shown on |
8541 the right and/or a "<" is shown on the left. The status line scrolls | |
8542 as needed. | |
8543 The "wildmenu" mode is abandoned when a key is hit that is not used | |
8544 for selecting a completion. | |
8545 While the "wildmenu" is active the following keys have special | |
8546 meanings: | |
8547 | |
8548 <Left> <Right> - select previous/next match (like CTRL-P/CTRL-N) | |
8549 <Down> - in filename/menu name completion: move into a | |
8550 subdirectory or submenu. | |
8551 <CR> - in menu completion, when the cursor is just after a | |
8552 dot: move into a submenu. | |
8553 <Up> - in filename/menu name completion: move up into | |
8554 parent directory or parent menu. | |
8555 | |
8556 This makes the menus accessible from the console |console-menus|. | |
8557 | |
8558 If you prefer the <Left> and <Right> keys to move the cursor instead | |
8559 of selecting a different match, use this: > | |
8560 :cnoremap <Left> <Space><BS><Left> | |
8561 :cnoremap <Right> <Space><BS><Right> | |
8562 < | |
8563 The "WildMenu" highlighting is used for displaying the current match | |
8564 |hl-WildMenu|. | |
8565 | |
8566 *'wildmode'* *'wim'* | |
8567 'wildmode' 'wim' string (Vim default: "full") | |
8568 global | |
8569 Completion mode that is used for the character specified with | |
10 | 8570 'wildchar'. It is a comma separated list of up to four parts. Each |
1152 | 8571 part specifies what to do for each consecutive use of 'wildchar'. The |
7 | 8572 first part specifies the behavior for the first use of 'wildchar', |
8573 The second part for the second use, etc. | |
8574 These are the possible values for each part: | |
8575 "" Complete only the first match. | |
8576 "full" Complete the next full match. After the last match, | |
8577 the original string is used and then the first match | |
8578 again. | |
8579 "longest" Complete till longest common string. If this doesn't | |
8580 result in a longer string, use the next part. | |
8581 "longest:full" Like "longest", but also start 'wildmenu' if it is | |
8582 enabled. | |
8583 "list" When more than one match, list all matches. | |
8584 "list:full" When more than one match, list all matches and | |
8585 complete first match. | |
8586 "list:longest" When more than one match, list all matches and | |
8587 complete till longest common string. | |
8588 When there is only a single match, it is fully completed in all cases. | |
8589 | |
8590 Examples: > | |
8591 :set wildmode=full | |
233 | 8592 < Complete first full match, next match, etc. (the default) > |
7 | 8593 :set wildmode=longest,full |
8594 < Complete longest common string, then each full match > | |
8595 :set wildmode=list:full | |
8596 < List all matches and complete each full match > | |
8597 :set wildmode=list,full | |
8598 < List all matches without completing, then each full match > | |
8599 :set wildmode=longest,list | |
8600 < Complete longest common string, then list alternatives. | |
1621 | 8601 More info here: |cmdline-completion|. |
7 | 8602 |
40 | 8603 *'wildoptions'* *'wop'* |
8604 'wildoptions' 'wop' string (default "") | |
8605 global | |
8606 {not available when compiled without the |+wildignore| | |
8607 feature} | |
8608 A list of words that change how command line completion is done. | |
8609 Currently only one word is allowed: | |
8610 tagfile When using CTRL-D to list matching tags, the kind of | |
856 | 8611 tag and the file of the tag is listed. Only one match |
40 | 8612 is displayed per line. Often used tag kinds are: |
8613 d #define | |
8614 f function | |
8615 Also see |cmdline-completion|. | |
8616 | |
7 | 8617 *'winaltkeys'* *'wak'* |
8618 'winaltkeys' 'wak' string (default "menu") | |
8619 global | |
8620 {only used in Win32, Motif, GTK and Photon GUI} | |
8621 Some GUI versions allow the access to menu entries by using the ALT | |
8622 key in combination with a character that appears underlined in the | |
8623 menu. This conflicts with the use of the ALT key for mappings and | |
8624 entering special characters. This option tells what to do: | |
8625 no Don't use ALT keys for menus. ALT key combinations can be | |
8626 mapped, but there is no automatic handling. This can then be | |
8627 done with the |:simalt| command. | |
8628 yes ALT key handling is done by the windowing system. ALT key | |
8629 combinations cannot be mapped. | |
8630 menu Using ALT in combination with a character that is a menu | |
10 | 8631 shortcut key, will be handled by the windowing system. Other |
7 | 8632 keys can be mapped. |
8633 If the menu is disabled by excluding 'm' from 'guioptions', the ALT | |
8634 key is never used for the menu. | |
36 | 8635 This option is not used for <F10>; on Win32 and with GTK <F10> will |
8636 select the menu, unless it has been mapped. | |
7 | 8637 |
164 | 8638 *'window'* *'wi'* |
8639 'window' 'wi' number (default screen height - 1) | |
8640 global | |
8641 Window height. Do not confuse this with the height of the Vim window, | |
8642 use 'lines' for that. | |
179 | 8643 Used for |CTRL-F| and |CTRL-B| when there is only one window and the |
8644 value is smaller than 'lines' minus one. The screen will scroll | |
8645 'window' minus two lines, with a minimum of one. | |
164 | 8646 When 'window' is equal to 'lines' minus one CTRL-F and CTRL-B scroll |
8647 in a much smarter way, taking care of wrapping lines. | |
8648 When resizing the Vim window, the value is smaller than 1 or more than | |
8649 or equal to 'lines' it will be set to 'lines' minus 1. | |
8650 | |
7 | 8651 *'winheight'* *'wh'* *E591* |
8652 'winheight' 'wh' number (default 1) | |
8653 global | |
2570
71b56b4e7785
Make the references to features in the help more consistent. (Sylvain Hitier)
Bram Moolenaar <bram@vim.org>
parents:
2561
diff
changeset
|
8654 {not available when compiled without the |+windows| |
7 | 8655 feature} |
8656 Minimal number of lines for the current window. This is not a hard | |
10 | 8657 minimum, Vim will use fewer lines if there is not enough room. If the |
1621 | 8658 focus goes to a window that is smaller, its size is increased, at the |
8659 cost of the height of other windows. | |
8660 Set 'winheight' to a small number for normal editing. | |
8661 Set it to 999 to make the current window fill most of the screen. | |
8662 Other windows will be only 'winminheight' high. This has the drawback | |
8663 that ":all" will create only two windows. To avoid "vim -o 1 2 3 4" | |
8664 to create only two windows, set the option after startup is done, | |
8665 using the |VimEnter| event: > | |
8666 au VimEnter * set winheight=999 | |
8667 < Minimum value is 1. | |
8668 The height is not adjusted after one of the commands that change the | |
7 | 8669 height of the current window. |
8670 'winheight' applies to the current window. Use 'winminheight' to set | |
8671 the minimal height for other windows. | |
8672 | |
8673 *'winfixheight'* *'wfh'* *'nowinfixheight'* *'nowfh'* | |
8674 'winfixheight' 'wfh' boolean (default off) | |
8675 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
|
8676 {not available when compiled without the |+windows| |
7 | 8677 feature} |
8678 Keep the window height when windows are opened or closed and | |
1152 | 8679 'equalalways' is set. Also for |CTRL-W_=|. Set by default for the |
8680 |preview-window| and |quickfix-window|. | |
7 | 8681 The height may be changed anyway when running out of room. |
8682 | |
782 | 8683 *'winfixwidth'* *'wfw'* *'nowinfixwidth'* *'nowfw'* |
8684 'winfixwidth' 'wfw' boolean (default off) | |
8685 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
|
8686 {not available when compiled without the |+windows| |
782 | 8687 feature} |
8688 Keep the window width when windows are opened or closed and | |
1152 | 8689 'equalalways' is set. Also for |CTRL-W_=|. |
782 | 8690 The width may be changed anyway when running out of room. |
8691 | |
7 | 8692 *'winminheight'* *'wmh'* |
8693 'winminheight' 'wmh' number (default 1) | |
8694 global | |
2570
71b56b4e7785
Make the references to features in the help more consistent. (Sylvain Hitier)
Bram Moolenaar <bram@vim.org>
parents:
2561
diff
changeset
|
8695 {not available when compiled without the |+windows| |
7 | 8696 feature} |
8697 The minimal height of a window, when it's not the current window. | |
8698 This is a hard minimum, windows will never become smaller. | |
8699 When set to zero, windows may be "squashed" to zero lines (i.e. just a | |
8700 status bar) if necessary. They will return to at least one line when | |
8701 they become active (since the cursor has to have somewhere to go.) | |
8702 Use 'winheight' to set the minimal height of the current window. | |
8703 This option is only checked when making a window smaller. Don't use a | |
8704 large number, it will cause errors when opening more than a few | |
8705 windows. A value of 0 to 3 is reasonable. | |
8706 | |
8707 *'winminwidth'* *'wmw'* | |
8708 'winminwidth' 'wmw' number (default 1) | |
8709 global | |
2570
71b56b4e7785
Make the references to features in the help more consistent. (Sylvain Hitier)
Bram Moolenaar <bram@vim.org>
parents:
2561
diff
changeset
|
8710 {not available when compiled without the |+vertsplit| |
7 | 8711 feature} |
8712 The minimal width of a window, when it's not the current window. | |
8713 This is a hard minimum, windows will never become smaller. | |
8714 When set to zero, windows may be "squashed" to zero columns (i.e. just | |
8715 a vertical separator) if necessary. They will return to at least one | |
8716 line when they become active (since the cursor has to have somewhere | |
8717 to go.) | |
8718 Use 'winwidth' to set the minimal width of the current window. | |
8719 This option is only checked when making a window smaller. Don't use a | |
8720 large number, it will cause errors when opening more than a few | |
8721 windows. A value of 0 to 12 is reasonable. | |
8722 | |
12138
bee3751f3d4e
patch 8.0.0949: winpty.dll name is fixed
Christian Brabandt <cb@256bit.org>
parents:
11914
diff
changeset
|
8723 *'winptydll'* |
bee3751f3d4e
patch 8.0.0949: winpty.dll name is fixed
Christian Brabandt <cb@256bit.org>
parents:
11914
diff
changeset
|
8724 '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
|
8725 global |
bee3751f3d4e
patch 8.0.0949: winpty.dll name is fixed
Christian Brabandt <cb@256bit.org>
parents:
11914
diff
changeset
|
8726 {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
|
8727 feature on MS-Windows} |
bee3751f3d4e
patch 8.0.0949: winpty.dll name is fixed
Christian Brabandt <cb@256bit.org>
parents:
11914
diff
changeset
|
8728 Specifies the name of the winpty shared library, used for the |
bee3751f3d4e
patch 8.0.0949: winpty.dll name is fixed
Christian Brabandt <cb@256bit.org>
parents:
11914
diff
changeset
|
8729 |:terminal| command. The default depends on whether was build as a |
12254 | 8730 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
|
8731 a fallback. |
bee3751f3d4e
patch 8.0.0949: winpty.dll name is fixed
Christian Brabandt <cb@256bit.org>
parents:
11914
diff
changeset
|
8732 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
|
8733 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
|
8734 security reasons. |
bee3751f3d4e
patch 8.0.0949: winpty.dll name is fixed
Christian Brabandt <cb@256bit.org>
parents:
11914
diff
changeset
|
8735 |
7 | 8736 *'winwidth'* *'wiw'* *E592* |
8737 'winwidth' 'wiw' number (default 20) | |
8738 global | |
2570
71b56b4e7785
Make the references to features in the help more consistent. (Sylvain Hitier)
Bram Moolenaar <bram@vim.org>
parents:
2561
diff
changeset
|
8739 {not available when compiled without the |+vertsplit| |
7 | 8740 feature} |
8741 Minimal number of columns for the current window. This is not a hard | |
8742 minimum, Vim will use fewer columns if there is not enough room. If | |
8743 the current window is smaller, its size is increased, at the cost of | |
8744 the width of other windows. Set it to 999 to make the current window | |
8745 always fill the screen. Set it to a small number for normal editing. | |
8746 The width is not adjusted after one of the commands to change the | |
8747 width of the current window. | |
8748 'winwidth' applies to the current window. Use 'winminwidth' to set | |
8749 the minimal width for other windows. | |
8750 | |
8751 *'wrap'* *'nowrap'* | |
8752 'wrap' boolean (default on) | |
8753 local to window | |
8754 This option changes how text is displayed. It doesn't change the text | |
8755 in the buffer, see 'textwidth' for that. | |
8756 When on, lines longer than the width of the window will wrap and | |
10 | 8757 displaying continues on the next line. When off lines will not wrap |
8758 and only part of long lines will be displayed. When the cursor is | |
7 | 8759 moved to a part that is not shown, the screen will scroll |
8760 horizontally. | |
8761 The line will be broken in the middle of a word if necessary. See | |
8762 'linebreak' to get the break at a word boundary. | |
8763 To make scrolling horizontally a bit more useful, try this: > | |
8764 :set sidescroll=5 | |
8765 :set listchars+=precedes:<,extends:> | |
8766 < See 'sidescroll', 'listchars' and |wrap-off|. | |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
8767 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
|
8768 on. |
7 | 8769 |
8770 *'wrapmargin'* *'wm'* | |
8771 'wrapmargin' 'wm' number (default 0) | |
8772 local to buffer | |
8773 Number of characters from the right window border where wrapping | |
8774 starts. When typing text beyond this limit, an <EOL> will be inserted | |
8775 and inserting continues on the next line. | |
8776 Options that add a margin, such as 'number' and 'foldcolumn', cause | |
8777 the text width to be further reduced. This is Vi compatible. | |
8778 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
|
8779 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
|
8780 is reset. |
16610 | 8781 See also 'formatoptions' and |ins-textwidth|. |
7 | 8782 |
8783 *'wrapscan'* *'ws'* *'nowrapscan'* *'nows'* | |
8784 'wrapscan' 'ws' boolean (default on) *E384* *E385* | |
8785 global | |
500 | 8786 Searches wrap around the end of the file. Also applies to |]s| and |
8787 |[s|, searching for spelling mistakes. | |
7 | 8788 |
8789 *'write'* *'nowrite'* | |
8790 'write' boolean (default on) | |
8791 global | |
8792 Allows writing files. When not set, writing a file is not allowed. | |
8793 Can be used for a view-only mode, where modifications to the text are | |
10 | 8794 still allowed. Can be reset with the |-m| or |-M| command line |
7 | 8795 argument. Filtering text is still possible, even though this requires |
8796 writing a temporary file. | |
8797 | |
8798 *'writeany'* *'wa'* *'nowriteany'* *'nowa'* | |
8799 'writeany' 'wa' boolean (default off) | |
8800 global | |
8801 Allows writing to any file with no need for "!" override. | |
8802 | |
8803 *'writebackup'* *'wb'* *'nowritebackup'* *'nowb'* | |
8804 'writebackup' 'wb' boolean (default on with |+writebackup| feature, off | |
8805 otherwise) | |
8806 global | |
8807 Make a backup before overwriting a file. The backup is removed after | |
8808 the file was successfully written, unless the 'backup' option is | |
3513 | 8809 also on. |
8810 WARNING: Switching this option off means that when Vim fails to write | |
8811 your buffer correctly and then, for whatever reason, Vim exits, you | |
8812 lose both the original file and what you were writing. Only reset | |
8813 this option if your file system is almost full and it makes the write | |
8814 fail (and make sure not to exit Vim until the write was successful). | |
8815 See |backup-table| for another explanation. | |
7 | 8816 When the 'backupskip' pattern matches, a backup is not made anyway. |
8817 NOTE: This option is set to the default value when 'compatible' is | |
8818 set. | |
8819 | |
8820 *'writedelay'* *'wd'* | |
8821 'writedelay' 'wd' number (default 0) | |
8822 global | |
9344
33c1b85d408c
commit https://github.com/vim/vim/commit/802a0d902fca423acb15f835d7b09183883d79a0
Christian Brabandt <cb@256bit.org>
parents:
9286
diff
changeset
|
8823 The number of milliseconds to wait for each character sent to the |
7 | 8824 screen. When non-zero, characters are sent to the terminal one by |
8825 one. For MS-DOS pcterm this does not work. For debugging purposes. | |
8826 | |
14421 | 8827 vim:tw=78:ts=8:noet:ft=help:norl: |