Mercurial > vim
annotate runtime/doc/options.txt @ 12254:8d76a56861ec
Update runtime files
commit https://github.com/vim/vim/commit/c572da5f67aa5cdbbc127fc6f1d0a42e38468325
Author: Bram Moolenaar <Bram@vim.org>
Date: Sun Aug 27 16:52:01 2017 +0200
Update runtime files
author | Christian Brabandt <cb@256bit.org> |
---|---|
date | Sun, 27 Aug 2017 17:00:05 +0200 |
parents | bee3751f3d4e |
children | 1ff5e5dfa9b0 |
rev | line source |
---|---|
12254 | 1 *options.txt* For Vim version 8.0. Last change: 2017 Aug 27 |
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 |
45 :se[t] inv{option} Toggle option: Invert value. {not in Vi} | |
46 | |
47 *:set-default* *:set-&* *:set-&vi* *:set-&vim* | |
48 :se[t] {option}& Reset option to its default value. May depend on the | |
49 current value of 'compatible'. {not in Vi} | |
50 :se[t] {option}&vi Reset option to its Vi default value. {not in Vi} | |
51 :se[t] {option}&vim Reset option to its Vim default value. {not in Vi} | |
52 | |
7051
eff26a8620ce
commit https://github.com/vim/vim/commit/88774fdd23f08355297bb8cda78856859051d3c7
Christian Brabandt <cb@256bit.org>
parents:
6949
diff
changeset
|
53 :se[t] all& Set all options to their default value. The values of |
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. |
eff26a8620ce
commit https://github.com/vim/vim/commit/88774fdd23f08355297bb8cda78856859051d3c7
Christian Brabandt <cb@256bit.org>
parents:
6949
diff
changeset
|
65 {not in Vi} |
7 | 66 |
67 *:set-args* *E487* *E521* | |
68 :se[t] {option}={value} or | |
69 :se[t] {option}:{value} | |
70 Set string or number option to {value}. | |
71 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
|
72 hex (preceded with 0x) or octal (preceded with '0'). |
7 | 73 The old value can be inserted by typing 'wildchar' (by |
74 default this is a <Tab> or CTRL-E if 'compatible' is | |
75 set). See |cmdline-completion|. | |
76 White space between {option} and '=' is allowed and | |
77 will be ignored. White space between '=' and {value} | |
78 is not allowed. | |
79 See |option-backslash| for using white space and | |
80 backslashes in {value}. | |
81 | |
82 :se[t] {option}+={value} *:set+=* | |
83 Add the {value} to a number option, or append the | |
84 {value} to a string option. When the option is a | |
85 comma separated list, a comma is added, unless the | |
86 value was empty. | |
87 If the option is a list of flags, superfluous flags | |
557 | 88 are removed. When adding a flag that was already |
89 present the option value doesn't change. | |
809 | 90 Also see |:set-args| above. |
7 | 91 {not in Vi} |
92 | |
93 :se[t] {option}^={value} *:set^=* | |
94 Multiply the {value} to a number option, or prepend | |
95 the {value} to a string option. When the option is a | |
96 comma separated list, a comma is added, unless the | |
97 value was empty. | |
98 Also see |:set-args| above. | |
99 {not in Vi} | |
100 | |
101 :se[t] {option}-={value} *:set-=* | |
102 Subtract the {value} from a number option, or remove | |
103 the {value} from a string option, if it is there. | |
104 If the {value} is not found in a string option, there | |
105 is no error or warning. When the option is a comma | |
106 separated list, a comma is deleted, unless the option | |
107 becomes empty. | |
108 When the option is a list of flags, {value} must be | |
109 exactly as they appear in the option. Remove flags | |
110 one by one to avoid problems. | |
111 Also see |:set-args| above. | |
112 {not in Vi} | |
113 | |
114 The {option} arguments to ":set" may be repeated. For example: > | |
115 :set ai nosi sw=3 ts=3 | |
116 If you make an error in one of the arguments, an error message will be given | |
117 and the following arguments will be ignored. | |
118 | |
119 *:set-verbose* | |
120 When 'verbose' is non-zero, displaying an option value will also tell where it | |
121 was last set. Example: > | |
122 :verbose set shiftwidth cindent? | |
1621 | 123 < shiftwidth=4 ~ |
124 Last set from modeline ~ | |
125 cindent ~ | |
126 Last set from /usr/local/share/vim/vim60/ftplugin/c.vim ~ | |
127 This is only done when specific option values are requested, not for ":verbose | |
128 set all" or ":verbose set" without an argument. | |
129 When the option was set by hand there is no "Last set" message. | |
7 | 130 When the option was set while executing a function, user command or |
131 autocommand, the script in which it was defined is reported. | |
132 Note that an option may also have been set as a side effect of setting | |
133 'compatible'. | |
1621 | 134 A few special texts: |
135 Last set from modeline ~ | |
136 Option was set in a |modeline|. | |
137 Last set from --cmd argument ~ | |
138 Option was set with command line argument |--cmd| or +. | |
139 Last set from -c argument ~ | |
140 Option was set with command line argument |-c|, +, |-S| or | |
141 |-q|. | |
142 Last set from environment variable ~ | |
143 Option was set from an environment variable, $VIMINIT, | |
144 $GVIMINIT or $EXINIT. | |
145 Last set from error handler ~ | |
146 Option was cleared when evaluating it resulted in an error. | |
147 | |
2570
71b56b4e7785
Make the references to features in the help more consistent. (Sylvain Hitier)
Bram Moolenaar <bram@vim.org>
parents:
2561
diff
changeset
|
148 {not available when compiled without the |+eval| feature} |
7 | 149 |
150 *:set-termcap* *E522* | |
667 | 151 For {option} the form "t_xx" may be used to set a terminal option. This will |
7 | 152 override the value from the termcap. You can then use it in a mapping. If |
153 the "xx" part contains special characters, use the <t_xx> form: > | |
154 :set <t_#4>=^[Ot | |
155 This can also be used to translate a special code for a normal key. For | |
156 example, if Alt-b produces <Esc>b, use this: > | |
157 :set <M-b>=^[b | |
158 (the ^[ is a real <Esc> here, use CTRL-V <Esc> to enter it) | |
159 The advantage over a mapping is that it works in all situations. | |
160 | |
2726 | 161 You can define any key codes, e.g.: > |
162 :set t_xy=^[foo; | |
163 There is no warning for using a name that isn't recognized. You can map these | |
164 codes as you like: > | |
165 :map <t_xy> something | |
166 < *E846* | |
167 When a key code is not set, it's like it does not exist. Trying to get its | |
168 value will result in an error: > | |
169 :set t_kb= | |
170 :set t_kb | |
171 E846: Key code not set: t_kb | |
172 | |
36 | 173 The t_xx options cannot be set from a |modeline| or in the |sandbox|, for |
174 security reasons. | |
175 | |
7 | 176 The listing from ":set" looks different from Vi. Long string options are put |
10 | 177 at the end of the list. The number of options is quite large. The output of |
7 | 178 "set all" probably does not fit on the screen, causing Vim to give the |
179 |more-prompt|. | |
180 | |
181 *option-backslash* | |
182 To include white space in a string option value it has to be preceded with a | |
183 backslash. To include a backslash you have to use two. Effectively this | |
184 means that the number of backslashes in an option value is halved (rounded | |
185 down). | |
186 A few examples: > | |
187 :set tags=tags\ /usr/tags results in "tags /usr/tags" | |
188 :set tags=tags\\,file results in "tags\,file" | |
189 :set tags=tags\\\ file results in "tags\ file" | |
190 | |
10 | 191 The "|" character separates a ":set" command from a following command. To |
192 include the "|" in the option value, use "\|" instead. This example sets the | |
7 | 193 'titlestring' option to "hi|there": > |
194 :set titlestring=hi\|there | |
195 This sets the 'titlestring' option to "hi" and 'iconstring' to "there": > | |
196 :set titlestring=hi|set iconstring=there | |
197 | |
642 | 198 Similarly, the double quote character starts a comment. To include the '"' in |
199 the option value, use '\"' instead. This example sets the 'titlestring' | |
200 option to 'hi "there"': > | |
201 :set titlestring=hi\ \"there\" | |
202 | |
10 | 203 For MS-DOS and WIN32 backslashes in file names are mostly not removed. More |
7 | 204 precise: For options that expect a file name (those where environment |
205 variables are expanded) a backslash before a normal file name character is not | |
206 removed. But a backslash before a special character (space, backslash, comma, | |
207 etc.) is used like explained above. | |
208 There is one special situation, when the value starts with "\\": > | |
209 :set dir=\\machine\path results in "\\machine\path" | |
210 :set dir=\\\\machine\\path results in "\\machine\path" | |
211 :set dir=\\path\\file results in "\\path\file" (wrong!) | |
212 For the first one the start is kept, but for the second one the backslashes | |
213 are halved. This makes sure it works both when you expect backslashes to be | |
10 | 214 halved and when you expect the backslashes to be kept. The third gives a |
7 | 215 result which is probably not what you want. Avoid it. |
216 | |
217 *add-option-flags* *remove-option-flags* | |
218 *E539* *E550* *E551* *E552* | |
219 Some options are a list of flags. When you want to add a flag to such an | |
220 option, without changing the existing ones, you can do it like this: > | |
221 :set guioptions+=a | |
222 Remove a flag from an option like this: > | |
223 :set guioptions-=a | |
224 This removes the 'a' flag from 'guioptions'. | |
10 | 225 Note that you should add or remove one flag at a time. If 'guioptions' has |
7 | 226 the value "ab", using "set guioptions-=ba" won't work, because the string "ba" |
227 doesn't appear. | |
228 | |
229 *:set_env* *expand-env* *expand-environment-var* | |
22 | 230 Environment variables in specific string options will be expanded. If the |
7 | 231 environment variable exists the '$' and the following environment variable |
232 name is replaced with its value. If it does not exist the '$' and the name | |
233 are not modified. Any non-id character (not a letter, digit or '_') may | |
234 follow the environment variable name. That character and what follows is | |
235 appended to the value of the environment variable. Examples: > | |
236 :set term=$TERM.new | |
237 :set path=/usr/$INCLUDE,$HOME/include,. | |
238 When adding or removing a string from an option with ":set opt-=val" or ":set | |
239 opt+=val" the expansion is done before the adding or removing. | |
240 | |
241 | |
242 Handling of local options *local-options* | |
243 | |
244 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
|
245 has its own copy of this option, thus each can have its own value. This |
7 | 246 allows you to set 'list' in one window but not in another. And set |
247 'shiftwidth' to 3 in one buffer and 4 in another. | |
248 | |
249 The following explains what happens to these local options in specific | |
250 situations. You don't really need to know all of this, since Vim mostly uses | |
251 the option values you would expect. Unfortunately, doing what the user | |
252 expects is a bit complicated... | |
253 | |
254 When splitting a window, the local options are copied to the new window. Thus | |
255 right after the split the contents of the two windows look the same. | |
256 | |
257 When editing a new buffer, its local option values must be initialized. Since | |
258 the local options of the current buffer might be specifically for that buffer, | |
259 these are not used. Instead, for each buffer-local option there also is a | |
260 global value, which is used for new buffers. With ":set" both the local and | |
261 global value is changed. With "setlocal" only the local value is changed, | |
262 thus this value is not used when editing a new buffer. | |
263 | |
9852
4eea48b76d03
commit https://github.com/vim/vim/commit/95ec9d6a6ab3117d60ff638670a803d43974ba51
Christian Brabandt <cb@256bit.org>
parents:
9737
diff
changeset
|
264 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
|
265 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
|
266 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
|
267 last closed window where the buffer was edited last are used. |
7 | 268 |
269 It's possible to set a local window option specifically for a type of buffer. | |
270 When you edit another buffer in the same window, you don't want to keep | |
271 using these local window options. Therefore Vim keeps a global value of the | |
272 local window options, which is used when editing another buffer. Each window | |
273 has its own copy of these values. Thus these are local to the window, but | |
274 global to all buffers in the window. With this you can do: > | |
275 :e one | |
276 :set list | |
277 :e two | |
278 Now the 'list' option will also be set in "two", since with the ":set list" | |
279 command you have also set the global value. > | |
280 :set nolist | |
281 :e one | |
282 :setlocal list | |
283 :e two | |
284 Now the 'list' option is not set, because ":set nolist" resets the global | |
285 value, ":setlocal list" only changes the local value and ":e two" gets the | |
286 global value. Note that if you do this next: > | |
287 :e one | |
4358 | 288 You will get back the 'list' value as it was the last time you edited "one". |
289 The options local to a window are remembered for each buffer. This also | |
290 happens when the buffer is not loaded, but they are lost when the buffer is | |
291 wiped out |:bwipe|. | |
7 | 292 |
293 *:setl* *:setlocal* | |
294 :setl[ocal] ... Like ":set" but set only the value local to the | |
295 current buffer or window. Not all options have a | |
296 local value. If the option does not have a local | |
297 value the global value is set. | |
2413 | 298 With the "all" argument: display local values for all |
299 local options. | |
300 Without argument: Display local values for all local | |
301 options which are different from the default. | |
7 | 302 When displaying a specific local option, show the |
1621 | 303 local value. For a global/local boolean option, when |
304 the global value is being used, "--" is displayed | |
305 before the option name. | |
306 For a global option the global value is | |
7 | 307 shown (but that might change in the future). |
308 {not in Vi} | |
309 | |
809 | 310 :setl[ocal] {option}< Set the local value of {option} to its global value by |
311 copying the value. | |
312 {not in Vi} | |
313 | |
3281 | 314 :se[t] {option}< For |global-local| options: Remove the local value of |
315 {option}, so that the global value will be used. | |
7 | 316 {not in Vi} |
317 | |
318 *:setg* *:setglobal* | |
319 :setg[lobal] ... Like ":set" but set only the global value for a local | |
320 option without changing the local value. | |
321 When displaying an option, the global value is shown. | |
2413 | 322 With the "all" argument: display global values for all |
323 local options. | |
324 Without argument: display global values for all local | |
325 options which are different from the default. | |
7 | 326 {not in Vi} |
327 | |
328 For buffer-local and window-local options: | |
329 Command global value local value ~ | |
330 :set option=value set set | |
331 :setlocal option=value - set | |
332 :setglobal option=value set - | |
333 :set option? - display | |
334 :setlocal option? - display | |
335 :setglobal option? display - | |
336 | |
337 | |
338 Global options with a local value *global-local* | |
339 | |
40 | 340 Options are global when you mostly use one value for all buffers and windows. |
341 For some global options it's useful to sometimes have a different local value. | |
342 You can set the local value with ":setlocal". That buffer or window will then | |
343 use the local value, while other buffers and windows continue using the global | |
344 value. | |
7 | 345 |
346 For example, you have two windows, both on C source code. They use the global | |
347 'makeprg' option. If you do this in one of the two windows: > | |
348 :set makeprg=gmake | |
349 then the other window will switch to the same value. There is no need to set | |
350 the 'makeprg' option in the other C source window too. | |
351 However, if you start editing a Perl file in a new window, you want to use | |
1152 | 352 another 'makeprg' for it, without changing the value used for the C source |
10 | 353 files. You use this command: > |
7 | 354 :setlocal makeprg=perlmake |
355 You can switch back to using the global value by making the local value empty: > | |
356 :setlocal makeprg= | |
357 This only works for a string option. For a boolean option you need to use the | |
358 "<" flag, like this: > | |
359 :setlocal autoread< | |
360 Note that for non-boolean options using "<" copies the global value to the | |
361 local value, it doesn't switch back to using the global value (that matters | |
809 | 362 when the global value changes later). You can also use: > |
363 :set path< | |
364 This will make the local value of 'path' empty, so that the global value is | |
365 used. Thus it does the same as: > | |
366 :setlocal path= | |
7 | 367 Note: In the future more global options can be made global-local. Using |
368 ":setlocal" on a global option might work differently then. | |
369 | |
370 | |
371 Setting the filetype | |
372 | |
11473 | 373 :setf[iletype] [FALLBACK] {filetype} *:setf* *:setfiletype* |
7 | 374 Set the 'filetype' option to {filetype}, but only if |
375 not done yet in a sequence of (nested) autocommands. | |
376 This is short for: > | |
377 :if !did_filetype() | |
378 : setlocal filetype={filetype} | |
379 :endif | |
380 < This command is used in a filetype.vim file to avoid | |
381 setting the 'filetype' option twice, causing different | |
382 settings and syntax files to be loaded. | |
11473 | 383 |
384 When the optional FALLBACK argument is present, a | |
385 later :setfiletype command will override the | |
386 'filetype'. This is to used for filetype detections | |
387 that are just a guess. |did_filetype()| will return | |
388 false after this command. | |
389 | |
7 | 390 {not in Vi} |
391 | |
2698
b6471224d2af
Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents:
2681
diff
changeset
|
392 *option-window* *optwin* |
7 | 393 :bro[wse] se[t] *:set-browse* *:browse-set* *:opt* *:options* |
394 :opt[ions] Open a window for viewing and setting all options. | |
395 Options are grouped by function. | |
396 Offers short help for each option. Hit <CR> on the | |
397 short help to open a help window with more help for | |
398 the option. | |
399 Modify the value of the option and hit <CR> on the | |
400 "set" line to set the new value. For window and | |
401 buffer specific options, the last accessed window is | |
402 used to set the option value in, unless this is a help | |
403 window, in which case the window below help window is | |
404 used (skipping the option-window). | |
405 {not available when compiled without the |+eval| or | |
406 |+autocmd| features} | |
407 | |
408 *$HOME* | |
409 Using "~" is like using "$HOME", but it is only recognized at the start of an | |
410 option and after a space or comma. | |
411 | |
412 On Unix systems "~user" can be used too. It is replaced by the home directory | |
413 of user "user". Example: > | |
414 :set path=~mool/include,/usr/include,. | |
415 | |
416 On Unix systems the form "${HOME}" can be used too. The name between {} can | |
417 contain non-id characters then. Note that if you want to use this for the | |
418 "gf" command, you need to add the '{' and '}' characters to 'isfname'. | |
419 | |
12254 | 420 NOTE: expanding environment variables and "~/" is only done with the ":set" |
421 command, not when assigning a value to an option with ":let". | |
422 | |
423 *$HOME-windows* | |
3224 | 424 On MS-Windows, if $HOME is not defined as an environment variable, then |
425 at runtime Vim will set it to the expansion of $HOMEDRIVE$HOMEPATH. | |
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 | |
437 (CTRL-? is 0177 octal, 0x7f hex) {not in Vi} | |
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 {not in Vi} | |
654 {only available when compiled with the |+rightleft| | |
655 feature} | |
656 The ASCII code for the first letter of the Hebrew alphabet. The | |
657 routine that maps the keyboard in Hebrew mode, both in Insert mode | |
658 (when hkmap is set) and on the command-line (when hitting CTRL-_) | |
659 outputs the Hebrew characters in the range [aleph..aleph+26]. | |
660 aleph=128 applies to PC code, and aleph=224 applies to ISO 8859-8. | |
661 See |rileft.txt|. | |
662 | |
663 *'allowrevins'* *'ari'* *'noallowrevins'* *'noari'* | |
664 'allowrevins' 'ari' boolean (default off) | |
665 global | |
666 {not in Vi} | |
667 {only available when compiled with the |+rightleft| | |
668 feature} | |
669 Allow CTRL-_ in Insert and Command-line mode. This is default off, to | |
670 avoid that users that accidentally type CTRL-_ instead of SHIFT-_ get | |
671 into reverse Insert mode, and don't know how to get out. See | |
672 'revins'. | |
673 NOTE: This option is reset when 'compatible' is set. | |
674 | |
675 *'altkeymap'* *'akm'* *'noaltkeymap'* *'noakm'* | |
676 'altkeymap' 'akm' boolean (default off) | |
677 global | |
678 {not in Vi} | |
679 {only available when compiled with the |+farsi| | |
680 feature} | |
233 | 681 When on, the second language is Farsi. In editing mode CTRL-_ toggles |
7 | 682 the keyboard map between Farsi and English, when 'allowrevins' set. |
683 | |
233 | 684 When off, the keyboard map toggles between Hebrew and English. This |
7 | 685 is useful to start the Vim in native mode i.e. English (left-to-right |
686 mode) and have default second language Farsi or Hebrew (right-to-left | |
10 | 687 mode). See |farsi.txt|. |
7 | 688 |
689 *'ambiwidth'* *'ambw'* | |
690 'ambiwidth' 'ambw' string (default: "single") | |
691 global | |
692 {not in Vi} | |
693 {only available when compiled with the |+multi_byte| | |
694 feature} | |
695 Only effective when 'encoding' is "utf-8" or another Unicode encoding. | |
696 Tells Vim what to do with characters with East Asian Width Class | |
697 Ambiguous (such as Euro, Registered Sign, Copyright Sign, Greek | |
698 letters, Cyrillic letters). | |
699 | |
700 There are currently two possible values: | |
233 | 701 "single": Use the same width as characters in US-ASCII. This is |
7 | 702 expected by most users. |
703 "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
|
704 *E834* *E835* |
c945fdb34ce3
Disallow setting 'ambiwidth' to "double" when 'listchars' or 'fillchars'
Bram Moolenaar <bram@vim.org>
parents:
2490
diff
changeset
|
705 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
|
706 contains a character that would be double width. |
7 | 707 |
708 There are a number of CJK fonts for which the width of glyphs for | |
709 those characters are solely based on how many octets they take in | |
710 legacy/traditional CJK encodings. In those encodings, Euro, | |
711 Registered sign, Greek/Cyrillic letters are represented by two octets, | |
233 | 712 therefore those fonts have "wide" glyphs for them. This is also |
7 | 713 true of some line drawing characters used to make tables in text |
233 | 714 file. Therefore, when a CJK font is used for GUI Vim or |
7 | 715 Vim is running inside a terminal (emulators) that uses a CJK font |
716 (or Vim is run inside an xterm invoked with "-cjkwidth" option.), | |
717 this option should be set to "double" to match the width perceived | |
718 by Vim with the width of glyphs in the font. Perhaps it also has | |
719 to be set to "double" under CJK Windows 9x/ME or Windows 2k/XP | |
720 when the system locale is set to one of CJK locales. See Unicode | |
721 Standard Annex #11 (http://www.unicode.org/reports/tr11). | |
722 | |
4229 | 723 Vim may set this option automatically at startup time when Vim is |
724 compiled with the |+termresponse| feature and if |t_u7| is set to the | |
4264 | 725 escape sequence to request cursor position report. |
4229 | 726 |
7 | 727 *'antialias'* *'anti'* *'noantialias'* *'noanti'* |
728 'antialias' 'anti' boolean (default: off) | |
729 global | |
730 {not in Vi} | |
731 {only available when compiled with GUI enabled | |
732 on Mac OS X} | |
733 This option only has an effect in the GUI version of Vim on Mac OS X | |
734 v10.2 or later. When on, Vim will use smooth ("antialiased") fonts, | |
735 which can be easier to read at certain sizes on certain displays. | |
736 Setting this option can sometimes cause problems if 'guifont' is set | |
737 to its default (empty string). | |
11160 | 738 NOTE: This option is reset when 'compatible' is set. |
7 | 739 |
740 *'autochdir'* *'acd'* *'noautochdir'* *'noacd'* | |
741 'autochdir' 'acd' boolean (default off) | |
742 global | |
743 {not in Vi} | |
2152 | 744 {only available when compiled with it, use |
745 exists("+autochdir") to check} | |
438 | 746 When on, Vim will change the current working directory whenever you |
747 open a file, switch buffers, delete a buffer or open/close a window. | |
748 It will change to the directory containing the file which was opened | |
749 or selected. | |
819 | 750 Note: When this option is on some plugins may not work. |
7 | 751 |
752 *'arabic'* *'arab'* *'noarabic'* *'noarab'* | |
753 'arabic' 'arab' boolean (default off) | |
754 local to window | |
755 {not in Vi} | |
756 {only available when compiled with the |+arabic| | |
757 feature} | |
758 This option can be set to start editing Arabic text. | |
759 Setting this option will: | |
760 - Set the 'rightleft' option, unless 'termbidi' is set. | |
761 - Set the 'arabicshape' option, unless 'termbidi' is set. | |
762 - Set the 'keymap' option to "arabic"; in Insert mode CTRL-^ toggles | |
763 between typing English and Arabic key mapping. | |
764 - Set the 'delcombine' option | |
765 Note that 'encoding' must be "utf-8" for working with Arabic text. | |
766 | |
767 Resetting this option will: | |
768 - Reset the 'rightleft' option. | |
769 - Disable the use of 'keymap' (without changing its value). | |
770 Note that 'arabicshape' and 'delcombine' are not reset (it is a global | |
3557 | 771 option). |
11160 | 772 NOTE: This option is reset when 'compatible' is set. |
7 | 773 Also see |arabic.txt|. |
774 | |
775 *'arabicshape'* *'arshape'* | |
776 *'noarabicshape'* *'noarshape'* | |
777 'arabicshape' 'arshape' boolean (default on) | |
778 global | |
779 {not in Vi} | |
780 {only available when compiled with the |+arabic| | |
781 feature} | |
782 When on and 'termbidi' is off, the required visual character | |
783 corrections that need to take place for displaying the Arabic language | |
3893 | 784 take effect. Shaping, in essence, gets enabled; the term is a broad |
7 | 785 one which encompasses: |
786 a) the changing/morphing of characters based on their location | |
787 within a word (initial, medial, final and stand-alone). | |
788 b) the enabling of the ability to compose characters | |
789 c) the enabling of the required combining of some characters | |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
790 When disabled the display shows each character's true stand-alone |
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
791 form. |
7 | 792 Arabic is a complex language which requires other settings, for |
793 further details see |arabic.txt|. | |
11160 | 794 NOTE: This option is set when 'compatible' is set. |
7 | 795 |
796 *'autoindent'* *'ai'* *'noautoindent'* *'noai'* | |
797 'autoindent' 'ai' boolean (default off) | |
798 local to buffer | |
799 Copy indent from current line when starting a new line (typing <CR> | |
800 in Insert mode or when using the "o" or "O" command). If you do not | |
801 type anything on the new line except <BS> or CTRL-D and then type | |
1152 | 802 <Esc>, CTRL-O or <CR>, the indent is deleted again. Moving the cursor |
803 to another line has the same effect, unless the 'I' flag is included | |
804 in 'cpoptions'. | |
10 | 805 When autoindent is on, formatting (with the "gq" command or when you |
806 reach 'textwidth' in Insert mode) uses the indentation of the first | |
807 line. | |
7 | 808 When 'smartindent' or 'cindent' is on the indent is changed in |
809 a different way. | |
7147
c590de398af9
commit https://github.com/vim/vim/commit/ca63501fbcd1cf9c8aa9ff12c093c95b62a89ed7
Christian Brabandt <cb@256bit.org>
parents:
7080
diff
changeset
|
810 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
|
811 restored when 'paste' is reset. |
7 | 812 {small difference from Vi: After the indent is deleted when typing |
813 <Esc> or <CR>, the cursor position when moving up or down is after the | |
814 deleted indent; Vi puts the cursor somewhere in the deleted indent}. | |
815 | |
816 *'autoread'* *'ar'* *'noautoread'* *'noar'* | |
817 'autoread' 'ar' boolean (default off) | |
818 global or local to buffer |global-local| | |
819 {not in Vi} | |
820 When a file has been detected to have been changed outside of Vim and | |
821 it has not been changed inside of Vim, automatically read it again. | |
822 When the file has been deleted this is not done. |timestamp| | |
823 If this option has a local value, use this command to switch back to | |
824 using the global value: > | |
825 :set autoread< | |
826 < | |
827 *'autowrite'* *'aw'* *'noautowrite'* *'noaw'* | |
828 'autowrite' 'aw' boolean (default off) | |
829 global | |
830 Write the contents of the file, if it has been modified, on each | |
831 :next, :rewind, :last, :first, :previous, :stop, :suspend, :tag, :!, | |
864 | 832 :make, CTRL-] and CTRL-^ command; and when a :buffer, CTRL-O, CTRL-I, |
7 | 833 '{A-Z0-9}, or `{A-Z0-9} command takes one to another file. |
834 Note that for some commands the 'autowrite' option is not used, see | |
835 'autowriteall' for that. | |
836 | |
837 *'autowriteall'* *'awa'* *'noautowriteall'* *'noawa'* | |
838 'autowriteall' 'awa' boolean (default off) | |
839 global | |
840 {not in Vi} | |
841 Like 'autowrite', but also used for commands ":edit", ":enew", ":quit", | |
842 ":qall", ":exit", ":xit", ":recover" and closing the Vim window. | |
843 Setting this option also implies that Vim behaves like 'autowrite' has | |
844 been set. | |
845 | |
846 *'background'* *'bg'* | |
2826 | 847 'background' 'bg' string (default "dark" or "light", see below) |
7 | 848 global |
849 {not in Vi} | |
850 When set to "dark", Vim will try to use colors that look good on a | |
851 dark background. When set to "light", Vim will try to use colors that | |
852 look good on a light background. Any other value is illegal. | |
853 Vim tries to set the default value according to the terminal used. | |
854 This will not always be correct. | |
855 Setting this option does not change the background color, it tells Vim | |
856 what the background color looks like. For changing the background | |
857 color, see |:hi-normal|. | |
858 | |
859 When 'background' is set Vim will adjust the default color groups for | |
10 | 860 the new value. But the colors used for syntax highlighting will not |
1621 | 861 change. *g:colors_name* |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
862 When a color scheme is loaded (the "g:colors_name" variable is set) |
7 | 863 setting 'background' will cause the color scheme to be reloaded. If |
864 the color scheme adjusts to the value of 'background' this will work. | |
865 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
|
866 be undone. First delete the "g:colors_name" variable when needed. |
7 | 867 |
868 When setting 'background' to the default value with: > | |
869 :set background& | |
870 < Vim will guess the value. In the GUI this should work correctly, | |
871 in other cases Vim might not be able to guess the right value. | |
872 | |
11442 | 873 When the t_BG option is set, Vim will use it to request the background |
874 color from the terminal. If the returned RGB value is dark/light and | |
875 'background' is not dark/light, 'background' will be set and the | |
876 screen is redrawn. This may have side effects, make t_BG empty in | |
877 your .vimrc if you suspect this problem. | |
878 | |
7 | 879 When starting the GUI, the default value for 'background' will be |
880 "light". When the value is not set in the .gvimrc, and Vim detects | |
881 that the background is actually quite dark, 'background' is set to | |
882 "dark". But this happens only AFTER the .gvimrc file has been read | |
883 (because the window needs to be opened to find the actual background | |
884 color). To get around this, force the GUI window to be opened by | |
885 putting a ":gui" command in the .gvimrc file, before where the value | |
886 of 'background' is used (e.g., before ":syntax on"). | |
2826 | 887 |
888 For MS-DOS, Windows and OS/2 the default is "dark". | |
889 For other systems "dark" is used when 'term' is "linux", | |
890 "screen.linux", "cygwin" or "putty", or $COLORFGBG suggests a dark | |
891 background. Otherwise the default is "light". | |
892 | |
12254 | 893 The |:terminal| command and the |term_start()| function use the |
894 'background' value to decide whether the terminal window will start | |
895 with a white or black background. | |
896 | |
7 | 897 Normally this option would be set in the .vimrc file. Possibly |
898 depending on the terminal name. Example: > | |
899 :if &term == "pcterm" | |
900 : set background=dark | |
901 :endif | |
902 < When this option is set, the default settings for the highlight groups | |
903 will change. To use other settings, place ":highlight" commands AFTER | |
904 the setting of the 'background' option. | |
905 This option is also used in the "$VIMRUNTIME/syntax/syntax.vim" file | |
906 to select the colors for syntax highlighting. After changing this | |
907 option, you must load syntax.vim again to see the result. This can be | |
908 done with ":syntax on". | |
909 | |
910 *'backspace'* *'bs'* | |
9669
284b4eb307fc
commit https://github.com/vim/vim/commit/8c08b5b569e2a9e9f63dea514591ecfa2d3bb392
Christian Brabandt <cb@256bit.org>
parents:
9665
diff
changeset
|
911 '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
|
912 in |defaults.vim|) |
7 | 913 global |
914 {not in Vi} | |
915 Influences the working of <BS>, <Del>, CTRL-W and CTRL-U in Insert | |
916 mode. This is a list of items, separated by commas. Each item allows | |
917 a way to backspace over something: | |
918 value effect ~ | |
919 indent allow backspacing over autoindent | |
920 eol allow backspacing over line breaks (join lines) | |
921 start allow backspacing over the start of insert; CTRL-W and CTRL-U | |
922 stop once at the start of insert. | |
923 | |
924 When the value is empty, Vi compatible backspacing is used. | |
925 | |
926 For backwards compatibility with version 5.4 and earlier: | |
927 value effect ~ | |
928 0 same as ":set backspace=" (Vi compatible) | |
929 1 same as ":set backspace=indent,eol" | |
930 2 same as ":set backspace=indent,eol,start" | |
931 | |
932 See |:fixdel| if your <BS> or <Del> key does not do what you want. | |
933 NOTE: This option is set to "" when 'compatible' is set. | |
934 | |
935 *'backup'* *'bk'* *'nobackup'* *'nobk'* | |
936 'backup' 'bk' boolean (default off) | |
937 global | |
938 {not in Vi} | |
939 Make a backup before overwriting a file. Leave it around after the | |
940 file has been successfully written. If you do not want to keep the | |
941 backup file, but you do want a backup while the file is being | |
942 written, reset this option and set the 'writebackup' option (this is | |
943 the default). If you do not want a backup file at all reset both | |
10 | 944 options (use this if your file system is almost full). See the |
7 | 945 |backup-table| for more explanations. |
946 When the 'backupskip' pattern matches, a backup is not made anyway. | |
947 When 'patchmode' is set, the backup may be renamed to become the | |
948 oldest version of a file. | |
949 NOTE: This option is reset when 'compatible' is set. | |
950 | |
951 *'backupcopy'* *'bkc'* | |
952 'backupcopy' 'bkc' string (Vi default for Unix: "yes", otherwise: "auto") | |
6243 | 953 global or local to buffer |global-local| |
7 | 954 {not in Vi} |
955 When writing a file and a backup is made, this option tells how it's | |
956 done. This is a comma separated list of words. | |
957 | |
958 The main values are: | |
959 "yes" make a copy of the file and overwrite the original one | |
960 "no" rename the file and write a new one | |
961 "auto" one of the previous, what works best | |
962 | |
963 Extra values that can be combined with the ones above are: | |
964 "breaksymlink" always break symlinks when writing | |
965 "breakhardlink" always break hardlinks when writing | |
966 | |
967 Making a copy and overwriting the original file: | |
968 - Takes extra time to copy the file. | |
969 + When the file has special attributes, is a (hard/symbolic) link or | |
970 has a resource fork, all this is preserved. | |
971 - When the file is a link the backup will have the name of the link, | |
972 not of the real file. | |
973 | |
974 Renaming the file and writing a new one: | |
975 + It's fast. | |
976 - Sometimes not all attributes of the file can be copied to the new | |
977 file. | |
978 - When the file is a link the new file will not be a link. | |
979 | |
980 The "auto" value is the middle way: When Vim sees that renaming file | |
981 is possible without side effects (the attributes can be passed on and | |
1152 | 982 the file is not a link) that is used. When problems are expected, a |
983 copy will be made. | |
7 | 984 |
985 The "breaksymlink" and "breakhardlink" values can be used in | |
986 combination with any of "yes", "no" and "auto". When included, they | |
987 force Vim to always break either symbolic or hard links by doing | |
988 exactly what the "no" option does, renaming the original file to | |
989 become the backup and writing a new file in its place. This can be | |
990 useful for example in source trees where all the files are symbolic or | |
991 hard links and any changes should stay in the local source tree, not | |
992 be propagated back to the original source. | |
993 *crontab* | |
994 One situation where "no" and "auto" will cause problems: A program | |
995 that opens a file, invokes Vim to edit that file, and then tests if | |
996 the open file was changed (through the file descriptor) will check the | |
10 | 997 backup file instead of the newly created file. "crontab -e" is an |
7 | 998 example. |
999 | |
1000 When a copy is made, the original file is truncated and then filled | |
1001 with the new text. This means that protection bits, owner and | |
1002 symbolic links of the original file are unmodified. The backup file | |
10 | 1003 however, is a new file, owned by the user who edited the file. The |
7 | 1004 group of the backup is set to the group of the original file. If this |
1005 fails, the protection bits for the group are made the same as for | |
1006 others. | |
1007 | |
1008 When the file is renamed this is the other way around: The backup has | |
1009 the same attributes of the original file, and the newly written file | |
1010 is owned by the current user. When the file was a (hard/symbolic) | |
1011 link, the new file will not! That's why the "auto" value doesn't | |
1012 rename when the file is a link. The owner and group of the newly | |
1013 written file will be set to the same ones as the original file, but | |
1014 the system may refuse to do this. In that case the "auto" value will | |
1015 again not rename the file. | |
1016 | |
11160 | 1017 NOTE: This option is set to the Vi default value when 'compatible' is |
1018 set and to the Vim default value when 'compatible' is reset. | |
1019 | |
7 | 1020 *'backupdir'* *'bdir'* |
1021 'backupdir' 'bdir' string (default for Amiga: ".,t:", | |
5555 | 1022 for MS-DOS and Win32: ".,$TEMP,c:/tmp,c:/temp" |
7 | 1023 for Unix: ".,~/tmp,~/") |
1024 global | |
1025 {not in Vi} | |
1026 List of directories for the backup file, separated with commas. | |
1027 - 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
|
1028 where this is possible. The directory must exist, Vim will not |
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
1029 create it for you. |
8629
54ac275e3fc4
commit https://github.com/vim/vim/commit/3848e00e0177abdb31bc600234967863ec487233
Christian Brabandt <cb@256bit.org>
parents:
8560
diff
changeset
|
1030 - Empty means that no backup file will be created ('patchmode' is |
7 | 1031 impossible!). Writing may fail because of this. |
1032 - A directory "." means to put the backup file in the same directory | |
1033 as the edited file. | |
33 | 1034 - A directory starting with "./" (or ".\" for MS-DOS et al.) means to |
7 | 1035 put the backup file relative to where the edited file is. The |
1036 leading "." is replaced with the path name of the edited file. | |
1037 ("." inside a directory name has no special meaning). | |
1038 - Spaces after the comma are ignored, other spaces are considered part | |
1039 of the directory name. To have a space at the start of a directory | |
1040 name, precede it with a backslash. | |
1041 - To include a comma in a directory name precede it with a backslash. | |
1042 - A directory name may end in an '/'. | |
1043 - Environment variables are expanded |:set_env|. | |
1044 - Careful with '\' characters, type one before a space, type two to | |
1045 get one in the option (see |option-backslash|), for example: > | |
1046 :set bdir=c:\\tmp,\ dir\\,with\\,commas,\\\ dir\ with\ spaces | |
1047 < - For backwards compatibility with Vim version 3.0 a '>' at the start | |
1048 of the option is removed. | |
1049 See also 'backup' and 'writebackup' options. | |
1050 If you want to hide your backup files on Unix, consider this value: > | |
1051 :set backupdir=./.backup,~/.backup,.,/tmp | |
1052 < You must create a ".backup" directory in each directory and in your | |
1053 home directory for this to work properly. | |
1054 The use of |:set+=| and |:set-=| is preferred when adding or removing | |
1055 directories from the list. This avoids problems when a future version | |
1056 uses another default. | |
1057 This option cannot be set from a |modeline| or in the |sandbox|, for | |
1058 security reasons. | |
1059 | |
1060 *'backupext'* *'bex'* *E589* | |
1061 'backupext' 'bex' string (default "~", for VMS: "_") | |
1062 global | |
1063 {not in Vi} | |
1064 String which is appended to a file name to make the name of the | |
1065 backup file. The default is quite unusual, because this avoids | |
1066 accidentally overwriting existing files with a backup file. You might | |
1067 prefer using ".bak", but make sure that you don't have files with | |
1068 ".bak" that you want to keep. | |
36 | 1069 Only normal file name characters can be used, "/\*?[|<>" are illegal. |
7 | 1070 |
26 | 1071 If you like to keep a lot of backups, you could use a BufWritePre |
1072 autocommand to change 'backupext' just before writing the file to | |
1073 include a timestamp. > | |
1074 :au BufWritePre * let &bex = '-' . strftime("%Y%b%d%X") . '~' | |
1075 < Use 'backupdir' to put the backup in a different directory. | |
1076 | |
7 | 1077 *'backupskip'* *'bsk'* |
1078 'backupskip' 'bsk' string (default: "/tmp/*,$TMPDIR/*,$TMP/*,$TEMP/*") | |
1079 global | |
1080 {not in Vi} | |
1081 {not available when compiled without the |+wildignore| | |
1082 feature} | |
1083 A list of file patterns. When one of the patterns matches with the | |
1084 name of the file which is written, no backup file is created. Both | |
1085 the specified file name and the full path name of the file are used. | |
1086 The pattern is used like with |:autocmd|, see |autocmd-patterns|. | |
1087 Watch out for special characters, see |option-backslash|. | |
1088 When $TMPDIR, $TMP or $TEMP is not defined, it is not used for the | |
233 | 1089 default value. "/tmp/*" is only used for Unix. |
1152 | 1090 |
3513 | 1091 WARNING: Not having a backup file means that when Vim fails to write |
1092 your buffer correctly and then, for whatever reason, Vim exits, you | |
1093 lose both the original file and what you were writing. Only disable | |
1094 backups if you don't care about losing the file. | |
1095 | |
1152 | 1096 Note that environment variables are not expanded. If you want to use |
1097 $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
|
1098 :let &backupskip = escape(expand('$HOME'), '\') . '/tmp/*' |
1152 | 1099 |
1100 < Note that the default also makes sure that "crontab -e" works (when a | |
557 | 1101 backup would be made by renaming the original file crontab won't see |
1102 the newly created file). Also see 'backupcopy' and |crontab|. | |
7 | 1103 |
1104 *'balloondelay'* *'bdlay'* | |
1105 'balloondelay' 'bdlay' number (default: 600) | |
1106 global | |
1107 {not in Vi} | |
1108 {only available when compiled with the |+balloon_eval| | |
1109 feature} | |
1110 Delay in milliseconds before a balloon may pop up. See |balloon-eval|. | |
1111 | |
1112 *'ballooneval'* *'beval'* *'noballooneval'* *'nobeval'* | |
1113 'ballooneval' 'beval' boolean (default off) | |
1114 global | |
1115 {not in Vi} | |
1116 {only available when compiled with the |+balloon_eval| | |
189 | 1117 feature} |
7 | 1118 Switch on the |balloon-eval| functionality. |
1119 | |
189 | 1120 *'balloonexpr'* *'bexpr'* |
1121 'balloonexpr' 'bexpr' string (default "") | |
790 | 1122 global or local to buffer |global-local| |
189 | 1123 {not in Vi} |
1124 {only available when compiled with the |+balloon_eval| | |
1125 feature} | |
782 | 1126 Expression for text to show in evaluation balloon. It is only used |
1127 when 'ballooneval' is on. These variables can be used: | |
189 | 1128 |
1129 v:beval_bufnr number of the buffer in which balloon is going to show | |
1130 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
|
1131 v:beval_winid ID of the window |
189 | 1132 v:beval_lnum line number |
1133 v:beval_col column number (byte index) | |
1134 v:beval_text word under or after the mouse pointer | |
1135 | |
1136 The evaluation of the expression must not have side effects! | |
1137 Example: > | |
1138 function! MyBalloonExpr() | |
435 | 1139 return 'Cursor is at line ' . v:beval_lnum . |
189 | 1140 \', column ' . v:beval_col . |
1141 \ ' of file ' . bufname(v:beval_bufnr) . | |
1142 \ ' on word "' . v:beval_text . '"' | |
1143 endfunction | |
1144 set bexpr=MyBalloonExpr() | |
1145 set ballooneval | |
1146 < | |
11062 | 1147 Also see |balloon_show()|, can be used if the content of the balloon |
1148 is to be fetched asynchronously. | |
1149 | |
189 | 1150 NOTE: The balloon is displayed only if the cursor is on a text |
1151 character. If the result of evaluating 'balloonexpr' is not empty, | |
1152 Vim does not try to send a message to an external debugger (Netbeans | |
1153 or Sun Workshop). | |
1154 | |
3682 | 1155 The expression will be evaluated in the |sandbox| when set from a |
1156 modeline, see |sandbox-option|. | |
634 | 1157 |
1158 It is not allowed to change text or jump to another window while | |
1159 evaluating 'balloonexpr' |textlock|. | |
1160 | |
446 | 1161 To check whether line breaks in the balloon text work use this check: > |
435 | 1162 if has("balloon_multiline") |
714 | 1163 < When they are supported "\n" characters will start a new line. If the |
1164 expression evaluates to a |List| this is equal to using each List item | |
1165 as a string and putting "\n" in between them. | |
11160 | 1166 NOTE: This option is set to "" when 'compatible' is set. |
714 | 1167 |
6949 | 1168 *'belloff'* *'bo'* |
1169 'belloff' 'bo' string (default "") | |
1170 global | |
1171 {not in Vi} | |
1172 Specifies for which events the bell will not be rung. It is a comma | |
1173 separated list of items. For each item that is present, the bell | |
1174 will be silenced. This is most useful to specify specific events in | |
1175 insert mode to be silenced. | |
1176 | |
1177 item meaning when present ~ | |
1178 all All events. | |
1179 backspace When hitting <BS> or <Del> and deleting results in an | |
1180 error. | |
1181 cursor Fail to move around using the cursor keys or | |
1182 <PageUp>/<PageDown> in |Insert-mode|. | |
1183 complete Error occurred when using |i_CTRL-X_CTRL-K| or | |
1184 |i_CTRL-X_CTRL-T|. | |
1185 copy Cannot copy char from insert mode using |i_CTRL-Y| or | |
1186 |i_CTRL-E|. | |
1187 ctrlg Unknown Char after <C-G> in Insert mode. | |
1188 error Other Error occurred (e.g. try to join last line) | |
1189 (mostly used in |Normal-mode| or |Cmdline-mode|). | |
1190 esc hitting <Esc> in |Normal-mode|. | |
1191 ex In |Visual-mode|, hitting |Q| results in an error. | |
1192 hangul Error occurred when using hangul input. | |
1193 insertmode Pressing <Esc> in 'insertmode'. | |
1194 lang Calling the beep module for Lua/Mzscheme/TCL. | |
1195 mess No output available for |g<|. | |
1196 showmatch Error occurred for 'showmatch' function. | |
1197 operator Empty region error |cpo-E|. | |
1198 register Unknown register after <C-R> in |Insert-mode|. | |
1199 shell Bell from shell output |:!|. | |
1200 spell Error happened on spell suggest. | |
1201 wildmode More matches in |cmdline-completion| available | |
1202 (depends on the 'wildmode' setting). | |
1203 | |
11160 | 1204 This is most useful to fine tune when in Insert mode the bell should |
1205 be rung. For Normal mode and Ex commands, the bell is often rung to | |
6949 | 1206 indicate that an error occurred. It can be silenced by adding the |
1207 "error" keyword. | |
1208 | |
7 | 1209 *'binary'* *'bin'* *'nobinary'* *'nobin'* |
1210 'binary' 'bin' boolean (default off) | |
1211 local to buffer | |
1212 {not in Vi} | |
1213 This option should be set before editing a binary file. You can also | |
1214 use the |-b| Vim argument. When this option is switched on a few | |
1215 options will be changed (also when it already was on): | |
1216 'textwidth' will be set to 0 | |
1217 'wrapmargin' will be set to 0 | |
1218 'modeline' will be off | |
1219 'expandtab' will be off | |
1220 Also, 'fileformat' and 'fileformats' options will not be used, the | |
1221 file is read and written like 'fileformat' was "unix" (a single <NL> | |
1222 separates lines). | |
1223 The 'fileencoding' and 'fileencodings' options will not be used, the | |
1224 file is read without conversion. | |
1225 NOTE: When you start editing a(nother) file while the 'bin' option is | |
1226 on, settings from autocommands may change the settings again (e.g., | |
1227 'textwidth'), causing trouble when editing. You might want to set | |
1228 'bin' again when the file has been loaded. | |
1229 The previous values of these options are remembered and restored when | |
1230 'bin' is switched from on to off. Each buffer has its own set of | |
1231 saved option values. | |
1232 To edit a file with 'binary' set you can use the |++bin| argument. | |
1233 This avoids you have to do ":set bin", which would have effect for all | |
1234 files you edit. | |
1235 When writing a file the <EOL> for the last line is only written if | |
1236 there was one in the original file (normally Vim appends an <EOL> to | |
1237 the last line if there is none; this would make the file longer). See | |
1238 the 'endofline' option. | |
1239 | |
1240 *'bioskey'* *'biosk'* *'nobioskey'* *'nobiosk'* | |
1241 'bioskey' 'biosk' boolean (default on) | |
1242 global | |
1243 {not in Vi} {only for MS-DOS} | |
8246
f16bfe02cef1
commit https://github.com/vim/vim/commit/f391327adbbffb11180cf6038a92af1ed144e907
Christian Brabandt <cb@256bit.org>
parents:
8182
diff
changeset
|
1244 This was for MS-DOS and is no longer supported. |
7 | 1245 |
1246 *'bomb'* *'nobomb'* | |
1247 'bomb' boolean (default off) | |
1248 local to buffer | |
1249 {not in Vi} | |
1250 {only available when compiled with the |+multi_byte| | |
1251 feature} | |
1252 When writing a file and the following conditions are met, a BOM (Byte | |
1253 Order Mark) is prepended to the file: | |
1254 - this option is on | |
1255 - the 'binary' option is off | |
1256 - 'fileencoding' is "utf-8", "ucs-2", "ucs-4" or one of the little/big | |
1257 endian variants. | |
1258 Some applications use the BOM to recognize the encoding of the file. | |
1259 Often used for UCS-2 files on MS-Windows. For other applications it | |
1260 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
|
1261 appear halfway the resulting file. Gcc doesn't accept a BOM. |
7 | 1262 When Vim reads a file and 'fileencodings' starts with "ucs-bom", a |
1263 check for the presence of the BOM is done and 'bomb' set accordingly. | |
1264 Unless 'binary' is set, it is removed from the first line, so that you | |
1265 don't see it when editing. When you don't change the options, the BOM | |
1266 will be restored when writing the file. | |
1267 | |
1268 *'breakat'* *'brk'* | |
1269 'breakat' 'brk' string (default " ^I!@*-+;:,./?") | |
1270 global | |
1271 {not in Vi} | |
2570
71b56b4e7785
Make the references to features in the help more consistent. (Sylvain Hitier)
Bram Moolenaar <bram@vim.org>
parents:
2561
diff
changeset
|
1272 {not available when compiled without the |+linebreak| |
7 | 1273 feature} |
1274 This option lets you choose which characters might cause a line | |
500 | 1275 break if 'linebreak' is on. Only works for ASCII and also for 8-bit |
1276 characters when 'encoding' is an 8-bit encoding. | |
7 | 1277 |
8835
c1a5623cfc86
commit https://github.com/vim/vim/commit/7c1c6dbb6817640fd3956a0d5417da23fde336d8
Christian Brabandt <cb@256bit.org>
parents:
8748
diff
changeset
|
1278 *'breakindent'* *'bri'* *'nobreakindent'* *'nobri'* |
6009 | 1279 'breakindent' 'bri' boolean (default off) |
1280 local to window | |
1281 {not in Vi} | |
1282 {not available when compiled without the |+linebreak| | |
1283 feature} | |
1284 Every wrapped line will continue visually indented (same amount of | |
1285 space as the beginning of that line), thus preserving horizontal blocks | |
1286 of text. | |
11160 | 1287 NOTE: This option is reset when 'compatible' is set. |
6009 | 1288 |
1289 *'breakindentopt'* *'briopt'* | |
1290 'breakindentopt' 'briopt' string (default empty) | |
1291 local to window | |
1292 {not in Vi} | |
1293 {not available when compiled without the |+linebreak| | |
1294 feature} | |
1295 Settings for 'breakindent'. It can consist of the following optional | |
6026 | 1296 items and must be separated by a comma: |
6009 | 1297 min:{n} Minimum text width that will be kept after |
1298 applying 'breakindent', even if the resulting | |
1299 text should normally be narrower. This prevents | |
1300 text indented almost to the right window border | |
1301 occupying lot of vertical space when broken. | |
6026 | 1302 shift:{n} After applying 'breakindent', the wrapped line's |
1303 beginning will be shifted by the given number of | |
1304 characters. It permits dynamic French paragraph | |
6009 | 1305 indentation (negative) or emphasizing the line |
1306 continuation (positive). | |
1307 sbr Display the 'showbreak' value before applying the | |
1308 additional indent. | |
1309 The default value for min is 20 and shift is 0. | |
1310 | |
7 | 1311 *'browsedir'* *'bsdir'* |
29 | 1312 'browsedir' 'bsdir' string (default: "last") |
7 | 1313 global |
1621 | 1314 {not in Vi} {only for Motif, Athena, GTK, Mac and |
1315 Win32 GUI} | |
7 | 1316 Which directory to use for the file browser: |
1621 | 1317 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
|
1318 file was opened or saved. |
7 | 1319 buffer Use the directory of the related buffer. |
1320 current Use the current directory. | |
1321 {path} Use the specified directory | |
1322 | |
1323 *'bufhidden'* *'bh'* | |
1324 'bufhidden' 'bh' string (default: "") | |
1325 local to buffer | |
1326 {not in Vi} | |
1327 This option specifies what happens when a buffer is no longer | |
1328 displayed in a window: | |
1329 <empty> follow the global 'hidden' option | |
1330 hide hide the buffer (don't unload it), also when 'hidden' | |
1331 is not set | |
1332 unload unload the buffer, also when 'hidden' is set or using | |
1333 |:hide| | |
1334 delete delete the buffer from the buffer list, also when | |
1335 'hidden' is set or using |:hide|, like using | |
1336 |:bdelete| | |
1337 wipe wipe out the buffer from the buffer list, also when | |
1338 'hidden' is set or using |:hide|, like using | |
1339 |:bwipeout| | |
1340 | |
82 | 1341 CAREFUL: when "unload", "delete" or "wipe" is used changes in a buffer |
3224 | 1342 are lost without a warning. Also, these values may break autocommands |
1343 that switch between buffers temporarily. | |
7 | 1344 This option is used together with 'buftype' and 'swapfile' to specify |
1345 special kinds of buffers. See |special-buffers|. | |
1346 | |
1347 *'buflisted'* *'bl'* *'nobuflisted'* *'nobl'* *E85* | |
1348 'buflisted' 'bl' boolean (default: on) | |
1349 local to buffer | |
1350 {not in Vi} | |
1351 When this option is set, the buffer shows up in the buffer list. If | |
1352 it is reset it is not used for ":bnext", "ls", the Buffers menu, etc. | |
1353 This option is reset by Vim for buffers that are only used to remember | |
1354 a file name or marks. Vim sets it when starting to edit a buffer. | |
1355 But not when moving to a buffer with ":buffer". | |
1356 | |
1357 *'buftype'* *'bt'* *E382* | |
1358 'buftype' 'bt' string (default: "") | |
1359 local to buffer | |
1360 {not in Vi} | |
1361 The value of this option specifies the type of a buffer: | |
1362 <empty> normal buffer | |
1363 nofile buffer which is not related to a file and will not be | |
1364 written | |
1365 nowrite buffer which will not be written | |
17 | 1366 acwrite buffer which will always be written with BufWriteCmd |
856 | 1367 autocommands. {not available when compiled without the |
17 | 1368 |+autocmd| feature} |
7 | 1369 quickfix quickfix buffer, contains list of errors |:cwindow| |
648 | 1370 or list of locations |:lwindow| |
7 | 1371 help help buffer (you are not supposed to set this |
1372 manually) | |
11757
74abb6c84984
patch 8.0.0761: options not set properly for a terminal buffer
Christian Brabandt <cb@256bit.org>
parents:
11666
diff
changeset
|
1373 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
|
1374 this manually) |
7 | 1375 |
1376 This option is used together with 'bufhidden' and 'swapfile' to | |
1377 specify special kinds of buffers. See |special-buffers|. | |
1378 | |
1379 Be careful with changing this option, it can have many side effects! | |
1380 | |
648 | 1381 A "quickfix" buffer is only used for the error list and the location |
1382 list. This value is set by the |:cwindow| and |:lwindow| commands and | |
1383 you are not supposed to change it. | |
7 | 1384 |
1385 "nofile" and "nowrite" buffers are similar: | |
1386 both: The buffer is not to be written to disk, ":w" doesn't | |
1387 work (":w filename" does work though). | |
1388 both: The buffer is never considered to be |'modified'|. | |
1389 There is no warning when the changes will be lost, for | |
1390 example when you quit Vim. | |
1391 both: A swap file is only created when using too much memory | |
1392 (when 'swapfile' has been reset there is never a swap | |
1393 file). | |
1394 nofile only: The buffer name is fixed, it is not handled like a | |
1395 file name. It is not modified in response to a |:cd| | |
1396 command. | |
6647 | 1397 both: When using ":e bufname" and already editing "bufname" |
1398 the buffer is made empty and autocommands are | |
1399 triggered as usual for |:edit|. | |
17 | 1400 *E676* |
1401 "acwrite" implies that the buffer name is not related to a file, like | |
1402 "nofile", but it will be written. Thus, in contrast to "nofile" and | |
1403 "nowrite", ":w" does work and a modified buffer can't be abandoned | |
1404 without saving. For writing there must be matching |BufWriteCmd|, | |
1405 |FileWriteCmd| or |FileAppendCmd| autocommands. | |
7 | 1406 |
1407 *'casemap'* *'cmp'* | |
1408 'casemap' 'cmp' string (default: "internal,keepascii") | |
1409 global | |
1410 {not in Vi} | |
804 | 1411 {only available when compiled with the |+multi_byte| |
1412 feature} | |
7 | 1413 Specifies details about changing the case of letters. It may contain |
1414 these words, separated by a comma: | |
1415 internal Use internal case mapping functions, the current | |
1416 locale does not change the case mapping. This only | |
493 | 1417 matters when 'encoding' is a Unicode encoding, |
1418 "latin1" or "iso-8859-15". When "internal" is | |
1419 omitted, the towupper() and towlower() system library | |
1420 functions are used when available. | |
7 | 1421 keepascii For the ASCII characters (0x00 to 0x7f) use the US |
1422 case mapping, the current locale is not effective. | |
1423 This probably only matters for Turkish. | |
1424 | |
1425 *'cdpath'* *'cd'* *E344* *E346* | |
1426 'cdpath' 'cd' string (default: equivalent to $CDPATH or ",,") | |
1427 global | |
1428 {not in Vi} | |
1429 {not available when compiled without the | |
1430 |+file_in_path| feature} | |
1431 This is a list of directories which will be searched when using the | |
1432 |:cd| and |:lcd| commands, provided that the directory being searched | |
1668 | 1433 for has a relative path, not an absolute part starting with "/", "./" |
1434 or "../", the 'cdpath' option is not used then. | |
7 | 1435 The 'cdpath' option's value has the same form and semantics as |
1436 |'path'|. Also see |file-searching|. | |
1437 The default value is taken from $CDPATH, with a "," prepended to look | |
1438 in the current directory first. | |
1439 If the default value taken from $CDPATH is not what you want, include | |
1440 a modified version of the following command in your vimrc file to | |
1441 override it: > | |
1442 :let &cdpath = ',' . substitute(substitute($CDPATH, '[, ]', '\\\0', 'g'), ':', ',', 'g') | |
1443 < This option cannot be set from a |modeline| or in the |sandbox|, for | |
1444 security reasons. | |
1445 (parts of 'cdpath' can be passed to the shell to expand file names). | |
1446 | |
1447 *'cedit'* | |
1448 'cedit' string (Vi default: "", Vim default: CTRL-F) | |
1449 global | |
1450 {not in Vi} | |
1451 {not available when compiled without the |+vertsplit| | |
1452 feature} | |
1453 The key used in Command-line Mode to open the command-line window. | |
1454 The default is CTRL-F when 'compatible' is off. | |
1455 Only non-printable keys are allowed. | |
1456 The key can be specified as a single character, but it is difficult to | |
1457 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
|
1458 :exe "set cedit=\<C-Y>" |
619a98a67f67
commit https://github.com/vim/vim/commit/e18dbe865d190e74fb5d43ac8bc6ac22507d0223
Christian Brabandt <cb@256bit.org>
parents:
9344
diff
changeset
|
1459 :exe "set cedit=\<Esc>" |
7 | 1460 < |Nvi| also has this option, but it only uses the first character. |
1461 See |cmdwin|. | |
11160 | 1462 NOTE: This option is set to the Vim default value when 'compatible' |
1463 is reset. | |
7 | 1464 |
1465 *'charconvert'* *'ccv'* *E202* *E214* *E513* | |
1466 'charconvert' 'ccv' string (default "") | |
1467 global | |
1468 {only available when compiled with the |+multi_byte| | |
2570
71b56b4e7785
Make the references to features in the help more consistent. (Sylvain Hitier)
Bram Moolenaar <bram@vim.org>
parents:
2561
diff
changeset
|
1469 and |+eval| features} |
7 | 1470 {not in Vi} |
1471 An expression that is used for character encoding conversion. It is | |
1472 evaluated when a file that is to be read or has been written has a | |
1473 different encoding from what is desired. | |
1474 'charconvert' is not used when the internal iconv() function is | |
1475 supported and is able to do the conversion. Using iconv() is | |
1476 preferred, because it is much faster. | |
1477 'charconvert' is not used when reading stdin |--|, because there is no | |
1478 file to convert from. You will have to save the text in a file first. | |
1479 The expression must return zero or an empty string for success, | |
1480 non-zero for failure. | |
1481 The possible encoding names encountered are in 'encoding'. | |
1482 Additionally, names given in 'fileencodings' and 'fileencoding' are | |
1483 used. | |
1484 Conversion between "latin1", "unicode", "ucs-2", "ucs-4" and "utf-8" | |
1485 is done internally by Vim, 'charconvert' is not used for this. | |
1486 'charconvert' is also used to convert the viminfo file, if the 'c' | |
1487 flag is present in 'viminfo'. Also used for Unicode conversion. | |
1488 Example: > | |
1489 set charconvert=CharConvert() | |
1490 fun CharConvert() | |
1491 system("recode " | |
1492 \ . v:charconvert_from . ".." . v:charconvert_to | |
1493 \ . " <" . v:fname_in . " >" v:fname_out) | |
1494 return v:shell_error | |
1495 endfun | |
1496 < The related Vim variables are: | |
1497 v:charconvert_from name of the current encoding | |
1498 v:charconvert_to name of the desired encoding | |
1499 v:fname_in name of the input file | |
1500 v:fname_out name of the output file | |
1501 Note that v:fname_in and v:fname_out will never be the same. | |
1502 Note that v:charconvert_from and v:charconvert_to may be different | |
1503 from 'encoding'. Vim internally uses UTF-8 instead of UCS-2 or UCS-4. | |
1504 Encryption is not done by Vim when using 'charconvert'. If you want | |
1505 to encrypt the file after conversion, 'charconvert' should take care | |
1506 of this. | |
1507 This option cannot be set from a |modeline| or in the |sandbox|, for | |
1508 security reasons. | |
1509 | |
1510 *'cindent'* *'cin'* *'nocindent'* *'nocin'* | |
1511 'cindent' 'cin' boolean (default off) | |
1512 local to buffer | |
1513 {not in Vi} | |
1514 {not available when compiled without the |+cindent| | |
1515 feature} | |
1621 | 1516 Enables automatic C program indenting. See 'cinkeys' to set the keys |
7 | 1517 that trigger reindenting in insert mode and 'cinoptions' to set your |
1518 preferred indent style. | |
1519 If 'indentexpr' is not empty, it overrules 'cindent'. | |
1520 If 'lisp' is not on and both 'indentexpr' and 'equalprg' are empty, | |
1521 the "=" operator indents using this algorithm rather than calling an | |
1522 external program. | |
1523 See |C-indenting|. | |
1524 When you don't like the way 'cindent' works, try the 'smartindent' | |
1525 option or 'indentexpr'. | |
1526 This option is not used when 'paste' is set. | |
1527 NOTE: This option is reset when 'compatible' is set. | |
1528 | |
1529 *'cinkeys'* *'cink'* | |
1530 'cinkeys' 'cink' string (default "0{,0},0),:,0#,!^F,o,O,e") | |
1531 local to buffer | |
1532 {not in Vi} | |
1533 {not available when compiled without the |+cindent| | |
1534 feature} | |
1535 A list of keys that, when typed in Insert mode, cause reindenting of | |
1536 the current line. Only used if 'cindent' is on and 'indentexpr' is | |
1537 empty. | |
1538 For the format of this option see |cinkeys-format|. | |
1539 See |C-indenting|. | |
1540 | |
1541 *'cinoptions'* *'cino'* | |
1542 'cinoptions' 'cino' string (default "") | |
1543 local to buffer | |
1544 {not in Vi} | |
1545 {not available when compiled without the |+cindent| | |
1546 feature} | |
1547 The 'cinoptions' affect the way 'cindent' reindents lines in a C | |
1548 program. See |cinoptions-values| for the values of this option, and | |
1549 |C-indenting| for info on C indenting in general. | |
1550 | |
1551 | |
1552 *'cinwords'* *'cinw'* | |
1553 'cinwords' 'cinw' string (default "if,else,while,do,for,switch") | |
1554 local to buffer | |
1555 {not in Vi} | |
1556 {not available when compiled without both the | |
1557 |+cindent| and the |+smartindent| features} | |
1558 These keywords start an extra indent in the next line when | |
1559 'smartindent' or 'cindent' is set. For 'cindent' this is only done at | |
1560 an appropriate place (inside {}). | |
1561 Note that 'ignorecase' isn't used for 'cinwords'. If case doesn't | |
1562 matter, include the keyword both the uppercase and lowercase: | |
1563 "if,If,IF". | |
1564 | |
1565 *'clipboard'* *'cb'* | |
1566 'clipboard' 'cb' string (default "autoselect,exclude:cons\|linux" | |
1567 for X-windows, "" otherwise) | |
1568 global | |
1569 {not in Vi} | |
1570 {only in GUI versions or when the |+xterm_clipboard| | |
1571 feature is included} | |
1572 This option is a list of comma separated names. | |
1573 These names are recognized: | |
1574 | |
3674 | 1575 *clipboard-unnamed* |
7 | 1576 unnamed When included, Vim will use the clipboard register '*' |
1577 for all yank, delete, change and put operations which | |
1578 would normally go to the unnamed register. When a | |
1579 register is explicitly specified, it will always be | |
1580 used regardless of whether "unnamed" is in 'clipboard' | |
1581 or not. The clipboard register can always be | |
1582 explicitly accessed using the "* notation. Also see | |
1583 |gui-clipboard|. | |
1584 | |
3682 | 1585 *clipboard-unnamedplus* |
4119 | 1586 unnamedplus A variant of the "unnamed" flag which uses the |
1587 clipboard register '+' (|quoteplus|) instead of | |
1588 register '*' for all yank, delete, change and put | |
1589 operations which would normally go to the unnamed | |
1590 register. When "unnamed" is also included to the | |
1591 option, yank operations (but not delete, change or | |
1592 put) will additionally copy the text into register | |
1593 '*'. | |
2662 | 1594 Only available with the |+X11| feature. |
2654 | 1595 Availability can be checked with: > |
1596 if has('unnamedplus') | |
1597 < | |
3682 | 1598 *clipboard-autoselect* |
7 | 1599 autoselect Works like the 'a' flag in 'guioptions': If present, |
1600 then whenever Visual mode is started, or the Visual | |
1601 area extended, Vim tries to become the owner of the | |
1602 windowing system's global selection or put the | |
1603 selected text on the clipboard used by the selection | |
1604 register "*. See |guioptions_a| and |quotestar| for | |
1605 details. When the GUI is active, the 'a' flag in | |
1606 'guioptions' is used, when the GUI is not active, this | |
1607 "autoselect" flag is used. | |
1608 Also applies to the modeless selection. | |
1609 | |
3674 | 1610 *clipboard-autoselectplus* |
1611 autoselectplus Like "autoselect" but using the + register instead of | |
1612 the * register. Compare to the 'P' flag in | |
1613 'guioptions'. | |
1614 | |
1615 *clipboard-autoselectml* | |
7 | 1616 autoselectml Like "autoselect", but for the modeless selection |
1617 only. Compare to the 'A' flag in 'guioptions'. | |
1618 | |
3674 | 1619 *clipboard-html* |
1904 | 1620 html When the clipboard contains HTML, use this when |
1621 pasting. When putting text on the clipboard, mark it | |
1622 as HTML. This works to copy rendered HTML from | |
1623 Firefox, paste it as raw HTML in Vim, select the HTML | |
1624 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
|
1625 You probably want to add this only temporarily, |
6b4879aea261
Add test for gettabvar() and settabvar().
Bram Moolenaar <bram@vim.org>
parents:
2220
diff
changeset
|
1626 possibly use BufEnter autocommands. |
1904 | 1627 Only supported for GTK version 2 and later. |
1628 Only available with the |+multi_byte| feature. | |
1629 | |
3674 | 1630 *clipboard-exclude* |
7 | 1631 exclude:{pattern} |
1632 Defines a pattern that is matched against the name of | |
1633 the terminal 'term'. If there is a match, no | |
1634 connection will be made to the X server. This is | |
1635 useful in this situation: | |
1636 - Running Vim in a console. | |
1637 - $DISPLAY is set to start applications on another | |
1638 display. | |
1639 - You do not want to connect to the X server in the | |
1640 console, but do want this in a terminal emulator. | |
1641 To never connect to the X server use: > | |
1642 exclude:.* | |
1643 < This has the same effect as using the |-X| argument. | |
1644 Note that when there is no connection to the X server | |
1645 the window title won't be restored and the clipboard | |
1646 cannot be accessed. | |
1647 The value of 'magic' is ignored, {pattern} is | |
1648 interpreted as if 'magic' was on. | |
1649 The rest of the option value will be used for | |
1650 {pattern}, this must be the last entry. | |
1651 | |
1652 *'cmdheight'* *'ch'* | |
1653 'cmdheight' 'ch' number (default 1) | |
1654 global | |
1655 {not in Vi} | |
1656 Number of screen lines to use for the command-line. Helps avoiding | |
1657 |hit-enter| prompts. | |
824 | 1658 The value of this option is stored with the tab page, so that each tab |
1659 page can have a different value. | |
7 | 1660 |
1661 *'cmdwinheight'* *'cwh'* | |
1662 'cmdwinheight' 'cwh' number (default 7) | |
1663 global | |
1664 {not in Vi} | |
1665 {not available when compiled without the |+vertsplit| | |
1666 feature} | |
1667 Number of screen lines to use for the command-line window. |cmdwin| | |
1668 | |
2608
7d8af31066c8
Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents:
2607
diff
changeset
|
1669 *'colorcolumn'* *'cc'* |
7d8af31066c8
Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents:
2607
diff
changeset
|
1670 'colorcolumn' 'cc' string (default "") |
7d8af31066c8
Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents:
2607
diff
changeset
|
1671 local to window |
7d8af31066c8
Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents:
2607
diff
changeset
|
1672 {not in Vi} |
7d8af31066c8
Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents:
2607
diff
changeset
|
1673 {not available when compiled without the |+syntax| |
7d8af31066c8
Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents:
2607
diff
changeset
|
1674 feature} |
7d8af31066c8
Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents:
2607
diff
changeset
|
1675 '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
|
1676 highlighted with ColorColumn |hl-ColorColumn|. Useful to align |
7d8af31066c8
Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents:
2607
diff
changeset
|
1677 text. Will make screen redrawing slower. |
7d8af31066c8
Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents:
2607
diff
changeset
|
1678 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
|
1679 '+' or '-', which is added to or subtracted from 'textwidth'. > |
7d8af31066c8
Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents:
2607
diff
changeset
|
1680 |
7d8af31066c8
Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents:
2607
diff
changeset
|
1681 :set cc=+1 " highlight column after 'textwidth' |
7d8af31066c8
Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents:
2607
diff
changeset
|
1682 :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
|
1683 :hi ColorColumn ctermbg=lightgrey guibg=lightgrey |
7d8af31066c8
Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents:
2607
diff
changeset
|
1684 < |
7d8af31066c8
Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents:
2607
diff
changeset
|
1685 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
|
1686 A maximum of 256 columns are highlighted. |
7d8af31066c8
Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents:
2607
diff
changeset
|
1687 |
7 | 1688 *'columns'* *'co'* *E594* |
1689 'columns' 'co' number (default 80 or terminal width) | |
1690 global | |
1691 {not in Vi} | |
1692 Number of columns of the screen. Normally this is set by the terminal | |
161 | 1693 initialization and does not have to be set by hand. Also see |
1694 |posix-screen-size|. | |
7 | 1695 When Vim is running in the GUI or in a resizable window, setting this |
1696 option will cause the window size to be changed. When you only want | |
1697 to use the size for the GUI, put the command in your |gvimrc| file. | |
1698 When you set this option and Vim is unable to change the physical | |
1152 | 1699 number of columns of the display, the display may be messed up. For |
1700 the GUI it is always possible and Vim limits the number of columns to | |
1701 what fits on the screen. You can use this command to get the widest | |
1702 window possible: > | |
1703 :set columns=9999 | |
1704 < Minimum value is 12, maximum value is 10000. | |
7 | 1705 |
1706 *'comments'* *'com'* *E524* *E525* | |
1707 'comments' 'com' string (default | |
1708 "s1:/*,mb:*,ex:*/,://,b:#,:%,:XCOMM,n:>,fb:-") | |
1709 local to buffer | |
1710 {not in Vi} | |
1711 {not available when compiled without the |+comments| | |
1712 feature} | |
1713 A comma separated list of strings that can start a comment line. See | |
1714 |format-comments|. See |option-backslash| about using backslashes to | |
1715 insert a space. | |
1716 | |
1717 *'commentstring'* *'cms'* *E537* | |
1718 'commentstring' 'cms' string (default "/*%s*/") | |
1719 local to buffer | |
1720 {not in Vi} | |
1721 {not available when compiled without the |+folding| | |
1722 feature} | |
1723 A template for a comment. The "%s" in the value is replaced with the | |
1724 comment text. Currently only used to add markers for folding, see | |
1725 |fold-marker|. | |
1726 | |
1727 *'compatible'* *'cp'* *'nocompatible'* *'nocp'* | |
819 | 1728 '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
|
1729 file is found, reset in |defaults.vim|) |
7 | 1730 global |
1731 {not in Vi} | |
1732 This option has the effect of making Vim either more Vi-compatible, or | |
1733 make Vim behave in a more useful way. | |
11062 | 1734 |
7 | 1735 This is a special kind of option, because when it's set or reset, |
11062 | 1736 other options are also changed as a side effect. |
1737 NOTE: Setting or resetting this option can have a lot of unexpected | |
1738 effects: Mappings are interpreted in another way, undo behaves | |
1739 differently, etc. If you set this option in your vimrc file, you | |
1740 should probably put it at the very start. | |
1741 | |
7 | 1742 By default this option is on and the Vi defaults are used for the |
1743 options. This default was chosen for those people who want to use Vim | |
1744 just like Vi, and don't even (want to) know about the 'compatible' | |
1745 option. | |
819 | 1746 When a |vimrc| or |gvimrc| file is found while Vim is starting up, |
378 | 1747 this option is switched off, and all options that have not been |
1748 modified will be set to the Vim defaults. Effectively, this means | |
819 | 1749 that when a |vimrc| or |gvimrc| file exists, Vim will use the Vim |
378 | 1750 defaults, otherwise it will use the Vi defaults. (Note: This doesn't |
1152 | 1751 happen for the system-wide vimrc or gvimrc file, nor for a file given |
1752 with the |-u| argument). Also see |compatible-default| and | |
1753 |posix-compliance|. | |
7 | 1754 You can also set this option with the "-C" argument, and reset it with |
1755 "-N". See |-C| and |-N|. | |
11062 | 1756 See 'cpoptions' for more fine tuning of Vi compatibility. |
1757 | |
1758 When this option is set, numerous other options are set to make Vim as | |
1759 Vi-compatible as possible. When this option is unset, various options | |
1760 are set to make Vim more useful. The table below lists all the | |
1761 options affected. | |
1762 The {?} column indicates when the options are affected: | |
1763 + Means that the option is set to the value given in {set value} when | |
1764 'compatible' is set. | |
1765 & Means that the option is set to the value given in {set value} when | |
1766 'compatible' is set AND is set to its Vim default value when | |
1767 'compatible' is unset. | |
1768 - Means the option is NOT changed when setting 'compatible' but IS | |
1769 set to its Vim default when 'compatible' is unset. | |
1770 The {effect} column summarises the change when 'compatible' is set. | |
1771 | |
11160 | 1772 option ? set value effect ~ |
11062 | 1773 |
1774 'allowrevins' + off no CTRL-_ command | |
1775 'antialias' + off don't use antialiased fonts | |
1776 'arabic' + off reset arabic-related options | |
1777 'arabicshape' + on correct character shapes | |
1778 'backspace' + "" normal backspace | |
1779 'backup' + off no backup file | |
1780 'backupcopy' & Unix: "yes" backup file is a copy | |
1781 else: "auto" copy or rename backup file | |
1782 'balloonexpr' + "" text to show in evaluation balloon | |
1783 'breakindent' + off don't indent when wrapping lines | |
1784 'cedit' - {unchanged} {set vim default only on resetting 'cp'} | |
1785 'cindent' + off no C code indentation | |
1786 'compatible' - {unchanged} {set vim default only on resetting 'cp'} | |
1787 'copyindent' + off don't copy indent structure | |
1788 'cpoptions' & (all flags) Vi-compatible flags | |
1789 'cscopepathcomp'+ 0 don't show directories in tags list | |
1790 'cscoperelative'+ off | |
1791 'cscopetag' + off don't use cscope for ":tag" | |
11160 | 1792 'cscopetagorder'+ 0 see |cscopetagorder| |
11062 | 1793 'cscopeverbose' + off see |cscopeverbose| |
1794 'delcombine' + off unicode: delete whole char combination | |
1795 'digraph' + off no digraphs | |
1796 'esckeys' & off no <Esc>-keys in Insert mode | |
1797 'expandtab' + off tabs not expanded to spaces | |
1798 'fileformats' & "" no automatic file format detection, | |
7 | 1799 "dos,unix" except for DOS, Windows and OS/2 |
11062 | 1800 'formatexpr' + "" use 'formatprg' for auto-formatting |
1801 'formatoptions' & "vt" Vi compatible formatting | |
1802 'gdefault' + off no default 'g' flag for ":s" | |
1803 'history' & 0 no commandline history | |
1804 'hkmap' + off no Hebrew keyboard mapping | |
1805 'hkmapp' + off no phonetic Hebrew keyboard mapping | |
1806 'hlsearch' + off no highlighting of search matches | |
1807 'incsearch' + off no incremental searching | |
1808 'indentexpr' + "" no indenting by expression | |
1809 'insertmode' + off do not start in Insert mode | |
1810 'iskeyword' & "@,48-57,_" keywords contain alphanumeric | |
7 | 1811 characters and '_' |
11062 | 1812 'joinspaces' + on insert 2 spaces after period |
1813 'modeline' & off no modelines | |
1814 'more' & off no pauses in listings | |
1815 'mzquantum' - {unchanged} {set vim default only on resetting 'cp'} | |
1816 'numberwidth' & 8 min number of columns for line number | |
1817 'preserveindent'+ off don't preserve current indent structure | |
1818 when changing it | |
1819 'revins' + off no reverse insert | |
1820 'ruler' + off no ruler | |
1821 'scrolljump' + 1 no jump scroll | |
1822 'scrolloff' + 0 no scroll offset | |
1823 'shelltemp' - {unchanged} {set vim default only on resetting 'cp'} | |
1824 'shiftround' + off indent not rounded to shiftwidth | |
1825 'shortmess' & "" no shortening of messages | |
1826 'showcmd' & off command characters not shown | |
1827 'showmode' & off current mode not shown | |
1828 'sidescrolloff' + 0 cursor moves to edge of screen in scroll | |
1829 'smartcase' + off no automatic ignore case switch | |
1830 'smartindent' + off no smart indentation | |
1831 'smarttab' + off no smart tab size | |
1832 'softtabstop' + 0 tabs are always 'tabstop' positions | |
1833 'startofline' + on goto startofline with some commands | |
1834 'tagcase' & "followic" 'ignorecase' when searching tags file | |
1835 'tagrelative' & off tag file names are not relative | |
1836 'termguicolors' + off don't use highlight-(guifg|guibg) | |
1837 'textauto' & off no automatic textmode detection | |
1838 'textwidth' + 0 no automatic line wrap | |
1839 'tildeop' + off tilde is not an operator | |
1840 'ttimeout' + off no terminal timeout | |
1841 'undofile' + off don't use an undo file | |
11160 | 1842 'viminfo' - {unchanged} {set Vim default only on resetting 'cp'} |
11062 | 1843 'virtualedit' + "" cursor can only be placed on characters |
1844 'whichwrap' & "" left-right movements don't wrap | |
1845 'wildchar' & CTRL-E only when the current value is <Tab> | |
7 | 1846 use CTRL-E for cmdline completion |
11062 | 1847 'writebackup' + on or off depends on the |+writebackup| feature |
7 | 1848 |
1849 *'complete'* *'cpt'* *E535* | |
1850 'complete' 'cpt' string (default: ".,w,b,u,t,i") | |
1851 local to buffer | |
1852 {not in Vi} | |
1853 This option specifies how keyword completion |ins-completion| works | |
1854 when CTRL-P or CTRL-N are used. It is also used for whole-line | |
1855 completion |i_CTRL-X_CTRL-L|. It indicates the type of completion | |
1856 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
|
1857 . scan the current buffer ('wrapscan' is ignored) |
7 | 1858 w scan buffers from other windows |
1859 b scan other loaded buffers that are in the buffer list | |
1860 u scan the unloaded buffers that are in the buffer list | |
1861 U scan the buffers that are not in the buffer list | |
1862 k scan the files given with the 'dictionary' option | |
703 | 1863 kspell use the currently active spell checking |spell| |
7 | 1864 k{dict} scan the file {dict}. Several "k" flags can be given, |
1865 patterns are valid too. For example: > | |
1866 :set cpt=k/usr/dict/*,k~/spanish | |
1867 < s scan the files given with the 'thesaurus' option | |
1868 s{tsr} scan the file {tsr}. Several "s" flags can be given, patterns | |
1869 are valid too. | |
1870 i scan current and included files | |
1871 d scan current and included files for defined name or macro | |
1872 |i_CTRL-X_CTRL-D| | |
1873 ] tag completion | |
1874 t same as "]" | |
1875 | |
1876 Unloaded buffers are not loaded, thus their autocmds |:autocmd| are | |
1877 not executed, this may lead to unexpected completions from some files | |
1878 (gzipped files for example). Unloaded buffers are not scanned for | |
1879 whole-line completion. | |
1880 | |
1881 The default is ".,w,b,u,t,i", which means to scan: | |
1882 1. the current buffer | |
1883 2. buffers in other windows | |
1884 3. other loaded buffers | |
1885 4. unloaded buffers | |
1886 5. tags | |
1887 6. included files | |
1888 | |
1889 As you can see, CTRL-N and CTRL-P can be used to do any 'iskeyword'- | |
233 | 1890 based expansion (e.g., dictionary |i_CTRL-X_CTRL-K|, included patterns |
1891 |i_CTRL-X_CTRL-I|, tags |i_CTRL-X_CTRL-]| and normal expansions). | |
7 | 1892 |
12 | 1893 *'completefunc'* *'cfu'* |
1894 'completefunc' 'cfu' string (default: empty) | |
1895 local to buffer | |
1896 {not in Vi} | |
2570
71b56b4e7785
Make the references to features in the help more consistent. (Sylvain Hitier)
Bram Moolenaar <bram@vim.org>
parents:
2561
diff
changeset
|
1897 {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
|
1898 or |+insert_expand| features} |
623 | 1899 This option specifies a function to be used for Insert mode completion |
1900 with CTRL-X CTRL-U. |i_CTRL-X_CTRL-U| | |
648 | 1901 See |complete-functions| for an explanation of how the function is |
1902 invoked and what it should return. | |
2642 | 1903 This option cannot be set from a |modeline| or in the |sandbox|, for |
1904 security reasons. | |
14 | 1905 |
540 | 1906 *'completeopt'* *'cot'* |
730 | 1907 'completeopt' 'cot' string (default: "menu,preview") |
540 | 1908 global |
766 | 1909 {not available when compiled without the |
1910 |+insert_expand| feature} | |
540 | 1911 {not in Vi} |
665 | 1912 A comma separated list of options for Insert mode completion |
1913 |ins-completion|. The supported values are: | |
540 | 1914 |
1915 menu Use a popup menu to show the possible completions. The | |
1916 menu is only shown when there is more than one match and | |
1917 sufficient colors are available. |ins-completion-menu| | |
1918 | |
707 | 1919 menuone Use the popup menu also when there is only one match. |
856 | 1920 Useful when there is additional information about the |
707 | 1921 match, e.g., what file it comes from. |
1922 | |
836 | 1923 longest Only insert the longest common text of the matches. If |
1924 the menu is displayed you can use CTRL-L to add more | |
1925 characters. Whether case is ignored depends on the kind | |
1926 of completion. For buffer text the 'ignorecase' option is | |
1927 used. | |
665 | 1928 |
730 | 1929 preview Show extra information about the currently selected |
1152 | 1930 completion in the preview window. Only works in |
1931 combination with "menu" or "menuone". | |
1932 | |
6911 | 1933 noinsert Do not insert any text for a match until the user selects |
1934 a match from the menu. Only works in combination with | |
1935 "menu" or "menuone". No effect if "longest" is present. | |
1936 | |
1937 noselect Do not select a match in the menu, force the user to | |
1938 select one from the menu. Only works in combination with | |
1939 "menu" or "menuone". | |
1940 | |
730 | 1941 |
2378
85b7dc8da5eb
Add the 'concealcursor' option to decide when the cursor line is to be
Bram Moolenaar <bram@vim.org>
parents:
2365
diff
changeset
|
1942 *'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
|
1943 '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
|
1944 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
|
1945 {not in Vi} |
85b7dc8da5eb
Add the 'concealcursor' option to decide when the cursor line is to be
Bram Moolenaar <bram@vim.org>
parents:
2365
diff
changeset
|
1946 {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
|
1947 feature} |
85b7dc8da5eb
Add the 'concealcursor' option to decide when the cursor line is to be
Bram Moolenaar <bram@vim.org>
parents:
2365
diff
changeset
|
1948 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
|
1949 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
|
1950 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
|
1951 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
|
1952 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
|
1953 i Insert mode |
2382
3a5ededa240a
Add the 'c' flag to 'concealcursor'.
Bram Moolenaar <bram@vim.org>
parents:
2380
diff
changeset
|
1954 c Command line editing, for 'incsearch' |
3a5ededa240a
Add the 'c' flag to 'concealcursor'.
Bram Moolenaar <bram@vim.org>
parents:
2380
diff
changeset
|
1955 |
2400
e6f1424dd66a
Let 'v' flag in 'concealcursor' apply to all lines in the Visual area.
Bram Moolenaar <bram@vim.org>
parents:
2394
diff
changeset
|
1956 '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
|
1957 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
|
1958 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
|
1959 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
|
1960 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
|
1961 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
|
1962 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
|
1963 |
85b7dc8da5eb
Add the 'concealcursor' option to decide when the cursor line is to be
Bram Moolenaar <bram@vim.org>
parents:
2365
diff
changeset
|
1964 |
85b7dc8da5eb
Add the 'concealcursor' option to decide when the cursor line is to be
Bram Moolenaar <bram@vim.org>
parents:
2365
diff
changeset
|
1965 'conceallevel' 'cole' *'conceallevel'* *'cole'* |
2250
1bac28a53fae
Add the conceal patch from Vince Negri.
Bram Moolenaar <bram@vim.org>
parents:
2249
diff
changeset
|
1966 number (default 0) |
1bac28a53fae
Add the conceal patch from Vince Negri.
Bram Moolenaar <bram@vim.org>
parents:
2249
diff
changeset
|
1967 local to window |
1bac28a53fae
Add the conceal patch from Vince Negri.
Bram Moolenaar <bram@vim.org>
parents:
2249
diff
changeset
|
1968 {not in Vi} |
1bac28a53fae
Add the conceal patch from Vince Negri.
Bram Moolenaar <bram@vim.org>
parents:
2249
diff
changeset
|
1969 {not available when compiled without the |+conceal| |
1bac28a53fae
Add the conceal patch from Vince Negri.
Bram Moolenaar <bram@vim.org>
parents:
2249
diff
changeset
|
1970 feature} |
2340
99c1eba60b2d
Make automatic prototype generation work with more interfaces.
Bram Moolenaar <bram@vim.org>
parents:
2337
diff
changeset
|
1971 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
|
1972 is shown: |
99c1eba60b2d
Make automatic prototype generation work with more interfaces.
Bram Moolenaar <bram@vim.org>
parents:
2337
diff
changeset
|
1973 |
99c1eba60b2d
Make automatic prototype generation work with more interfaces.
Bram Moolenaar <bram@vim.org>
parents:
2337
diff
changeset
|
1974 Value Effect ~ |
2250
1bac28a53fae
Add the conceal patch from Vince Negri.
Bram Moolenaar <bram@vim.org>
parents:
2249
diff
changeset
|
1975 0 Text is shown normally |
2426 | 1976 1 Each block of concealed text is replaced with one |
1977 character. If the syntax item does not have a custom | |
1978 replacement character defined (see |:syn-cchar|) the | |
1979 character defined in 'listchars' is used (default is a | |
1980 space). | |
1981 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
|
1982 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
|
1983 custom replacement character defined (see |
2426 | 1984 |: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
|
1985 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
|
1986 |
586a459f3980
Never hide text for conceal in cursor line. Do hide when there is
Bram Moolenaar <bram@vim.org>
parents:
2348
diff
changeset
|
1987 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
|
1988 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
|
1989 option. |
2250
1bac28a53fae
Add the conceal patch from Vince Negri.
Bram Moolenaar <bram@vim.org>
parents:
2249
diff
changeset
|
1990 |
7 | 1991 *'confirm'* *'cf'* *'noconfirm'* *'nocf'* |
1992 'confirm' 'cf' boolean (default off) | |
1993 global | |
1994 {not in Vi} | |
1995 When 'confirm' is on, certain operations that would normally | |
1996 fail because of unsaved changes to a buffer, e.g. ":q" and ":e", | |
1997 instead raise a |dialog| asking if you wish to save the current | |
1998 file(s). You can still use a ! to unconditionally |abandon| a buffer. | |
1999 If 'confirm' is off you can still activate confirmation for one | |
2000 command only (this is most useful in mappings) with the |:confirm| | |
2001 command. | |
2002 Also see the |confirm()| function and the 'v' flag in 'guioptions'. | |
2003 | |
2004 *'conskey'* *'consk'* *'noconskey'* *'noconsk'* | |
2005 'conskey' 'consk' boolean (default off) | |
2006 global | |
2007 {not in Vi} {only for MS-DOS} | |
8246
f16bfe02cef1
commit https://github.com/vim/vim/commit/f391327adbbffb11180cf6038a92af1ed144e907
Christian Brabandt <cb@256bit.org>
parents:
8182
diff
changeset
|
2008 This was for MS-DOS and is no longer supported. |
7 | 2009 |
2010 *'copyindent'* *'ci'* *'nocopyindent'* *'noci'* | |
2011 'copyindent' 'ci' boolean (default off) | |
2012 local to buffer | |
2013 {not in Vi} | |
2014 Copy the structure of the existing lines indent when autoindenting a | |
2015 new line. Normally the new indent is reconstructed by a series of | |
2016 tabs followed by spaces as required (unless |'expandtab'| is enabled, | |
2017 in which case only spaces are used). Enabling this option makes the | |
2018 new line copy whatever characters were used for indenting on the | |
1621 | 2019 existing line. 'expandtab' has no effect on these characters, a Tab |
2020 remains a Tab. If the new indent is greater than on the existing | |
7 | 2021 line, the remaining space is filled in the normal manner. |
11160 | 2022 NOTE: This option is reset when 'compatible' is set. |
7 | 2023 Also see 'preserveindent'. |
2024 | |
8148
f5da459c5698
commit https://github.com/vim/vim/commit/e0fa3742ead676a3074a10edadbc955e1a89153d
Christian Brabandt <cb@256bit.org>
parents:
8061
diff
changeset
|
2025 *'cpoptions'* *'cpo'* *cpo* |
7 | 2026 'cpoptions' 'cpo' string (Vim default: "aABceFs", |
2027 Vi default: all flags) | |
2028 global | |
2029 {not in Vi} | |
2030 A sequence of single character flags. When a character is present | |
5340 | 2031 this indicates Vi-compatible behavior. This is used for things where |
2032 not being Vi-compatible is mostly or sometimes preferred. | |
7 | 2033 'cpoptions' stands for "compatible-options". |
2034 Commas can be added for readability. | |
2035 To avoid problems with flags that are added in the future, use the | |
2036 "+=" and "-=" feature of ":set" |add-option-flags|. | |
2037 NOTE: This option is set to the Vi default value when 'compatible' is | |
2038 set and to the Vim default value when 'compatible' is reset. | |
164 | 2039 NOTE: This option is set to the POSIX default value at startup when |
2040 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
|
2041 variable exists |posix|. This means Vim tries to behave like the |
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
2042 POSIX specification. |
7 | 2043 |
2044 contains behavior ~ | |
2045 *cpo-a* | |
2046 a When included, a ":read" command with a file name | |
2047 argument will set the alternate file name for the | |
2048 current window. | |
2049 *cpo-A* | |
2050 A When included, a ":write" command with a file name | |
2051 argument will set the alternate file name for the | |
2052 current window. | |
2053 *cpo-b* | |
2054 b "\|" in a ":map" command is recognized as the end of | |
2055 the map command. The '\' is included in the mapping, | |
2056 the text after the '|' is interpreted as the next | |
2057 command. Use a CTRL-V instead of a backslash to | |
2058 include the '|' in the mapping. Applies to all | |
2059 mapping, abbreviation, menu and autocmd commands. | |
2060 See also |map_bar|. | |
2061 *cpo-B* | |
2062 B A backslash has no special meaning in mappings, | |
2063 abbreviations and the "to" part of the menu commands. | |
2064 Remove this flag to be able to use a backslash like a | |
2065 CTRL-V. For example, the command ":map X \<Esc>" | |
2066 results in X being mapped to: | |
2067 'B' included: "\^[" (^[ is a real <Esc>) | |
2068 'B' excluded: "<Esc>" (5 characters) | |
2069 ('<' excluded in both cases) | |
2070 *cpo-c* | |
2071 c Searching continues at the end of any match at the | |
2072 cursor position, but not further than the start of the | |
2073 next line. When not present searching continues | |
2074 one character from the cursor position. With 'c' | |
2075 "abababababab" only gets three matches when repeating | |
2076 "/abab", without 'c' there are five matches. | |
2077 *cpo-C* | |
2078 C Do not concatenate sourced lines that start with a | |
2079 backslash. See |line-continuation|. | |
2080 *cpo-d* | |
2081 d Using "./" in the 'tags' option doesn't mean to use | |
2082 the tags file relative to the current file, but the | |
2083 tags file in the current directory. | |
2084 *cpo-D* | |
2085 D Can't use CTRL-K to enter a digraph after Normal mode | |
2086 commands with a character argument, like |r|, |f| and | |
2087 |t|. | |
2088 *cpo-e* | |
2089 e When executing a register with ":@r", always add a | |
2090 <CR> to the last line, also when the register is not | |
2091 linewise. If this flag is not present, the register | |
2092 is not linewise and the last line does not end in a | |
2093 <CR>, then the last line is put on the command-line | |
2094 and can be edited before hitting <CR>. | |
2095 *cpo-E* | |
2096 E It is an error when using "y", "d", "c", "g~", "gu" or | |
2097 "gU" on an Empty region. The operators only work when | |
2098 at least one character is to be operate on. Example: | |
2099 This makes "y0" fail in the first column. | |
2100 *cpo-f* | |
2101 f When included, a ":read" command with a file name | |
2102 argument will set the file name for the current buffer, | |
2103 if the current buffer doesn't have a file name yet. | |
2104 *cpo-F* | |
2105 F When included, a ":write" command with a file name | |
2106 argument will set the file name for the current | |
2107 buffer, if the current buffer doesn't have a file name | |
590 | 2108 yet. Also see |cpo-P|. |
7 | 2109 *cpo-g* |
2110 g Goto line 1 when using ":edit" without argument. | |
164 | 2111 *cpo-H* |
2112 H When using "I" on a line with only blanks, insert | |
2113 before the last blank. Without this flag insert after | |
2114 the last blank. | |
7 | 2115 *cpo-i* |
2116 i When included, interrupting the reading of a file will | |
2117 leave it modified. | |
10 | 2118 *cpo-I* |
2119 I When moving the cursor up or down just after inserting | |
2120 indent for 'autoindent', do not delete the indent. | |
7 | 2121 *cpo-j* |
2122 j When joining lines, only add two spaces after a '.', | |
2123 not after '!' or '?'. Also see 'joinspaces'. | |
2124 *cpo-J* | |
2125 J A |sentence| has to be followed by two spaces after | |
233 | 2126 the '.', '!' or '?'. A <Tab> is not recognized as |
7 | 2127 white space. |
2128 *cpo-k* | |
2129 k Disable the recognition of raw key codes in | |
2130 mappings, abbreviations, and the "to" part of menu | |
2131 commands. For example, if <Key> sends ^[OA (where ^[ | |
2132 is <Esc>), the command ":map X ^[OA" results in X | |
2133 being mapped to: | |
2134 'k' included: "^[OA" (3 characters) | |
2135 'k' excluded: "<Key>" (one key code) | |
2136 Also see the '<' flag below. | |
2137 *cpo-K* | |
2138 K Don't wait for a key code to complete when it is | |
2139 halfway a mapping. This breaks mapping <F1><F1> when | |
2140 only part of the second <F1> has been read. It | |
2141 enables cancelling the mapping by typing <F1><Esc>. | |
2142 *cpo-l* | |
2143 l Backslash in a [] range in a search pattern is taken | |
168 | 2144 literally, only "\]", "\^", "\-" and "\\" are special. |
2145 See |/[]| | |
7 | 2146 'l' included: "/[ \t]" finds <Space>, '\' and 't' |
2147 'l' excluded: "/[ \t]" finds <Space> and <Tab> | |
168 | 2148 Also see |cpo-\|. |
7 | 2149 *cpo-L* |
2150 L When the 'list' option is set, 'wrapmargin', | |
2151 'textwidth', 'softtabstop' and Virtual Replace mode | |
2152 (see |gR|) count a <Tab> as two characters, instead of | |
2153 the normal behavior of a <Tab>. | |
2154 *cpo-m* | |
2155 m When included, a showmatch will always wait half a | |
2156 second. When not included, a showmatch will wait half | |
2157 a second or until a character is typed. |'showmatch'| | |
2158 *cpo-M* | |
2159 M When excluded, "%" matching will take backslashes into | |
2160 account. Thus in "( \( )" and "\( ( \)" the outer | |
2161 parenthesis match. When included "%" ignores | |
2162 backslashes, which is Vi compatible. | |
2163 *cpo-n* | |
2178
c6f1aa1e9f32
Add 'relativenumber' patch from Markus Heidelberg.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2164 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
|
2165 '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
|
2166 lines. |
7 | 2167 *cpo-o* |
2168 o Line offset to search command is not remembered for | |
2169 next search. | |
2170 *cpo-O* | |
2171 O Don't complain if a file is being overwritten, even | |
2172 when it didn't exist when editing it. This is a | |
2173 protection against a file unexpectedly created by | |
2174 someone else. Vi didn't complain about this. | |
2175 *cpo-p* | |
2176 p Vi compatible Lisp indenting. When not present, a | |
2177 slightly better algorithm is used. | |
590 | 2178 *cpo-P* |
2179 P When included, a ":write" command that appends to a | |
2180 file will set the file name for the current buffer, if | |
2181 the current buffer doesn't have a file name yet and | |
2182 the 'F' flag is also included |cpo-F|. | |
164 | 2183 *cpo-q* |
2184 q When joining multiple lines leave the cursor at the | |
2185 position where it would be when joining two lines. | |
7 | 2186 *cpo-r* |
2187 r Redo ("." command) uses "/" to repeat a search | |
2188 command, instead of the actually used search string. | |
2189 *cpo-R* | |
2190 R Remove marks from filtered lines. Without this flag | |
2191 marks are kept like |:keepmarks| was used. | |
2192 *cpo-s* | |
2193 s Set buffer options when entering the buffer for the | |
2194 first time. This is like it is in Vim version 3.0. | |
10 | 2195 And it is the default. If not present the options are |
7 | 2196 set when the buffer is created. |
2197 *cpo-S* | |
2198 S Set buffer options always when entering a buffer | |
2199 (except 'readonly', 'fileformat', 'filetype' and | |
2200 'syntax'). This is the (most) Vi compatible setting. | |
2201 The options are set to the values in the current | |
2202 buffer. When you change an option and go to another | |
2203 buffer, the value is copied. Effectively makes the | |
2204 buffer options global to all buffers. | |
2205 | |
2206 's' 'S' copy buffer options | |
2207 no no when buffer created | |
2208 yes no when buffer first entered (default) | |
2209 X yes each time when buffer entered (vi comp.) | |
2210 *cpo-t* | |
2211 t Search pattern for the tag command is remembered for | |
2212 "n" command. Otherwise Vim only puts the pattern in | |
2213 the history for search pattern, but doesn't change the | |
2214 last used search pattern. | |
2215 *cpo-u* | |
10 | 2216 u Undo is Vi compatible. See |undo-two-ways|. |
7 | 2217 *cpo-v* |
2218 v Backspaced characters remain visible on the screen in | |
2219 Insert mode. Without this flag the characters are | |
2220 erased from the screen right away. With this flag the | |
2221 screen newly typed text overwrites backspaced | |
2222 characters. | |
2223 *cpo-w* | |
2224 w When using "cw" on a blank character, only change one | |
2225 character and not all blanks until the start of the | |
2226 next word. | |
2227 *cpo-W* | |
2228 W Don't overwrite a readonly file. When omitted, ":w!" | |
2229 overwrites a readonly file, if possible. | |
2230 *cpo-x* | |
2231 x <Esc> on the command-line executes the command-line. | |
2232 The default in Vim is to abandon the command-line, | |
2233 because <Esc> normally aborts a command. |c_<Esc>| | |
164 | 2234 *cpo-X* |
2235 X When using a count with "R" the replaced text is | |
2236 deleted only once. Also when repeating "R" with "." | |
2237 and a count. | |
7 | 2238 *cpo-y* |
2239 y A yank command can be redone with ".". | |
164 | 2240 *cpo-Z* |
2241 Z When using "w!" while the 'readonly' option is set, | |
2242 don't reset 'readonly'. | |
7 | 2243 *cpo-!* |
2244 ! When redoing a filter command, use the last used | |
2245 external command, whatever it was. Otherwise the last | |
2246 used -filter- command is used. | |
2247 *cpo-$* | |
2248 $ When making a change to one line, don't redisplay the | |
2249 line, but put a '$' at the end of the changed text. | |
2250 The changed text will be overwritten when you type the | |
2251 new text. The line is redisplayed if you type any | |
2252 command that moves the cursor from the insertion | |
2253 point. | |
2254 *cpo-%* | |
2255 % Vi-compatible matching is done for the "%" command. | |
2256 Does not recognize "#if", "#endif", etc. | |
2257 Does not recognize "/*" and "*/". | |
2258 Parens inside single and double quotes are also | |
2259 counted, causing a string that contains a paren to | |
2260 disturb the matching. For example, in a line like | |
2261 "if (strcmp("foo(", s))" the first paren does not | |
2262 match the last one. When this flag is not included, | |
2263 parens inside single and double quotes are treated | |
2264 specially. When matching a paren outside of quotes, | |
2265 everything inside quotes is ignored. When matching a | |
2266 paren inside quotes, it will find the matching one (if | |
10 | 2267 there is one). This works very well for C programs. |
36 | 2268 This flag is also used for other features, such as |
2269 C-indenting. | |
161 | 2270 *cpo--* |
2271 - When included, a vertical movement command fails when | |
632 | 2272 it would go above the first line or below the last |
2273 line. Without it the cursor moves to the first or | |
2274 last line, unless it already was in that line. | |
161 | 2275 Applies to the commands "-", "k", CTRL-P, "+", "j", |
632 | 2276 CTRL-N, CTRL-J and ":1234". |
39 | 2277 *cpo-+* |
2278 + When included, a ":write file" command will reset the | |
2279 'modified' flag of the buffer, even though the buffer | |
2280 itself may still be different from its file. | |
856 | 2281 *cpo-star* |
7 | 2282 * Use ":*" in the same way as ":@". When not included, |
2283 ":*" is an alias for ":'<,'>", select the Visual area. | |
2284 *cpo-<* | |
2285 < Disable the recognition of special key codes in |<>| | |
2286 form in mappings, abbreviations, and the "to" part of | |
10 | 2287 menu commands. For example, the command |
7 | 2288 ":map X <Tab>" results in X being mapped to: |
2289 '<' included: "<Tab>" (5 characters) | |
2290 '<' excluded: "^I" (^I is a real <Tab>) | |
2291 Also see the 'k' flag above. | |
164 | 2292 *cpo->* |
2293 > When appending to a register, put a line break before | |
2294 the appended text. | |
2925 | 2295 *cpo-;* |
2296 ; When using |,| or |;| to repeat the last |t| search | |
2297 and the cursor is right in front of the searched | |
2298 character, the cursor won't move. When not included, | |
2299 the cursor would skip over it and jump to the | |
3557 | 2300 following occurrence. |
164 | 2301 |
2302 POSIX flags. These are not included in the Vi default value, except | |
2303 when $VIM_POSIX was set on startup. |posix| | |
2304 | |
2305 contains behavior ~ | |
856 | 2306 *cpo-#* |
164 | 2307 # A count before "D", "o" and "O" has no effect. |
168 | 2308 *cpo-&* |
2309 & When ":preserve" was used keep the swap file when | |
2310 exiting normally while this buffer is still loaded. | |
2311 This flag is tested when exiting. | |
2312 *cpo-\* | |
2313 \ Backslash in a [] range in a search pattern is taken | |
2314 literally, only "\]" is special See |/[]| | |
488 | 2315 '\' included: "/[ \-]" finds <Space>, '\' and '-' |
2316 '\' excluded: "/[ \-]" finds <Space> and '-' | |
2317 Also see |cpo-l|. | |
168 | 2318 *cpo-/* |
2319 / When "%" is used as the replacement string in a |:s| | |
2320 command, use the previous replacement string. |:s%| | |
164 | 2321 *cpo-{* |
2322 { The |{| and |}| commands also stop at a "{" character | |
2323 at the start of a line. | |
168 | 2324 *cpo-.* |
2325 . The ":chdir" and ":cd" commands fail if the current | |
2326 buffer is modified, unless ! is used. Vim doesn't | |
2327 need this, since it remembers the full path of an | |
2328 opened file. | |
164 | 2329 *cpo-bar* |
2330 | The value of the $LINES and $COLUMNS environment | |
2331 variables overrule the terminal size values obtained | |
2332 with system specific functions. | |
2333 | |
7 | 2334 |
2180
f60a0c9cbe6c
Add the blowfish encryption patch from Mohsin Ahmed. Needs more work.
Bram Moolenaar <bram@vim.org>
parents:
2178
diff
changeset
|
2335 *'cryptmethod'* *'cm'* |
6336 | 2336 'cryptmethod' 'cm' string (default "zip") |
2360
d8e4b27cef80
Change 'cryptmethod' from a number to a string option. Make it global-local.
Bram Moolenaar <bram@vim.org>
parents:
2350
diff
changeset
|
2337 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
|
2338 {not in Vi} |
f60a0c9cbe6c
Add the blowfish encryption patch from Mohsin Ahmed. Needs more work.
Bram Moolenaar <bram@vim.org>
parents:
2178
diff
changeset
|
2339 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
|
2340 *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
|
2341 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
|
2342 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
|
2343 *blowfish* |
6122 | 2344 blowfish Blowfish method. Medium strong encryption but it has |
2345 an implementation flaw. Requires Vim 7.3 or later, | |
2346 files can NOT be read by Vim 7.2 and older. This adds | |
2347 a "seed" to the file, every time you write the file | |
2348 the encrypted bytes will be different. | |
2349 *blowfish2* | |
2350 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
|
2351 Vim 7.4.401 or later, files can NOT be read by Vim 7.3 |
6122 | 2352 and older. This adds a "seed" to the file, every time |
2353 you write the file the encrypted bytes will be | |
2354 different. The whole undo file is encrypted, not just | |
2355 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
|
2356 |
8748
b1a19a2f73f0
commit https://github.com/vim/vim/commit/4f3f668c8486444e53163c29d2fc79bf47eb3c82
Christian Brabandt <cb@256bit.org>
parents:
8629
diff
changeset
|
2357 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
|
2358 |
2180
f60a0c9cbe6c
Add the blowfish encryption patch from Mohsin Ahmed. Needs more work.
Bram Moolenaar <bram@vim.org>
parents:
2178
diff
changeset
|
2359 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
|
2360 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
|
2361 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
|
2362 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
|
2363 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
|
2364 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
|
2365 |
d8e4b27cef80
Change 'cryptmethod' from a number to a string option. Make it global-local.
Bram Moolenaar <bram@vim.org>
parents:
2350
diff
changeset
|
2366 When setting the global value to an empty string, it will end up with |
d8e4b27cef80
Change 'cryptmethod' from a number to a string option. Make it global-local.
Bram Moolenaar <bram@vim.org>
parents:
2350
diff
changeset
|
2367 the value "zip". When setting the local value to an empty string the |
d8e4b27cef80
Change 'cryptmethod' from a number to a string option. Make it global-local.
Bram Moolenaar <bram@vim.org>
parents:
2350
diff
changeset
|
2368 buffer will use the global value. |
d8e4b27cef80
Change 'cryptmethod' from a number to a string option. Make it global-local.
Bram Moolenaar <bram@vim.org>
parents:
2350
diff
changeset
|
2369 |
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
|
2370 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
|
2371 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
|
2372 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
|
2373 |
f60a0c9cbe6c
Add the blowfish encryption patch from Mohsin Ahmed. Needs more work.
Bram Moolenaar <bram@vim.org>
parents:
2178
diff
changeset
|
2374 |
7 | 2375 *'cscopepathcomp'* *'cspc'* |
2376 'cscopepathcomp' 'cspc' number (default 0) | |
2377 global | |
2378 {not available when compiled without the |+cscope| | |
2379 feature} | |
2380 {not in Vi} | |
2381 Determines how many components of the path to show in a list of tags. | |
2382 See |cscopepathcomp|. | |
11160 | 2383 NOTE: This option is set to 0 when 'compatible' is set. |
7 | 2384 |
2385 *'cscopeprg'* *'csprg'* | |
2386 'cscopeprg' 'csprg' string (default "cscope") | |
2387 global | |
2388 {not available when compiled without the |+cscope| | |
2389 feature} | |
2390 {not in Vi} | |
2391 Specifies the command to execute cscope. See |cscopeprg|. | |
2392 This option cannot be set from a |modeline| or in the |sandbox|, for | |
2393 security reasons. | |
2394 | |
2395 *'cscopequickfix'* *'csqf'* | |
2396 'cscopequickfix' 'csqf' string (default "") | |
2397 global | |
2398 {not available when compiled without the |+cscope| | |
2399 or |+quickfix| features} | |
2400 {not in Vi} | |
2401 Specifies whether to use quickfix window to show cscope results. | |
2402 See |cscopequickfix|. | |
2403 | |
4869 | 2404 *'cscoperelative'* *'csre'* *'nocscoperelative'* *'nocsre'* |
2873 | 2405 'cscoperelative' 'csre' boolean (default off) |
2406 global | |
2407 {not available when compiled without the |+cscope| | |
2408 feature} | |
2409 {not in Vi} | |
2410 In the absence of a prefix (-P) for cscope. setting this option enables | |
2411 to use the basename of cscope.out path as the prefix. | |
2412 See |cscoperelative|. | |
11160 | 2413 NOTE: This option is reset when 'compatible' is set. |
2873 | 2414 |
7 | 2415 *'cscopetag'* *'cst'* *'nocscopetag'* *'nocst'* |
2416 'cscopetag' 'cst' boolean (default off) | |
2417 global | |
2418 {not available when compiled without the |+cscope| | |
2419 feature} | |
2420 {not in Vi} | |
2421 Use cscope for tag commands. See |cscope-options|. | |
2422 NOTE: This option is reset when 'compatible' is set. | |
2423 | |
2424 *'cscopetagorder'* *'csto'* | |
2425 'cscopetagorder' 'csto' number (default 0) | |
2426 global | |
2427 {not available when compiled without the |+cscope| | |
2428 feature} | |
2429 {not in Vi} | |
2430 Determines the order in which ":cstag" performs a search. See | |
2431 |cscopetagorder|. | |
2432 NOTE: This option is set to 0 when 'compatible' is set. | |
2433 | |
2434 *'cscopeverbose'* *'csverb'* | |
2435 *'nocscopeverbose'* *'nocsverb'* | |
2436 'cscopeverbose' 'csverb' boolean (default off) | |
2437 global | |
2438 {not available when compiled without the |+cscope| | |
2439 feature} | |
2440 {not in Vi} | |
2441 Give messages when adding a cscope database. See |cscopeverbose|. | |
2442 NOTE: This option is reset when 'compatible' is set. | |
2443 | |
2250
1bac28a53fae
Add the conceal patch from Vince Negri.
Bram Moolenaar <bram@vim.org>
parents:
2249
diff
changeset
|
2444 *'cursorbind'* *'crb'* *'nocursorbind'* *'nocrb'* |
1bac28a53fae
Add the conceal patch from Vince Negri.
Bram Moolenaar <bram@vim.org>
parents:
2249
diff
changeset
|
2445 'cursorbind' 'crb' boolean (default off) |
1bac28a53fae
Add the conceal patch from Vince Negri.
Bram Moolenaar <bram@vim.org>
parents:
2249
diff
changeset
|
2446 local to window |
1bac28a53fae
Add the conceal patch from Vince Negri.
Bram Moolenaar <bram@vim.org>
parents:
2249
diff
changeset
|
2447 {not in Vi} |
1bac28a53fae
Add the conceal patch from Vince Negri.
Bram Moolenaar <bram@vim.org>
parents:
2249
diff
changeset
|
2448 {not available when compiled without the |+cursorbind| |
1bac28a53fae
Add the conceal patch from Vince Negri.
Bram Moolenaar <bram@vim.org>
parents:
2249
diff
changeset
|
2449 feature} |
1bac28a53fae
Add the conceal patch from Vince Negri.
Bram Moolenaar <bram@vim.org>
parents:
2249
diff
changeset
|
2450 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
|
2451 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
|
2452 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
|
2453 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
|
2454 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
|
2455 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
|
2456 taken into account. |
2250
1bac28a53fae
Add the conceal patch from Vince Negri.
Bram Moolenaar <bram@vim.org>
parents:
2249
diff
changeset
|
2457 |
743 | 2458 |
2459 *'cursorcolumn'* *'cuc'* *'nocursorcolumn'* *'nocuc'* | |
2460 'cursorcolumn' 'cuc' boolean (default off) | |
2461 local to window | |
2462 {not in Vi} | |
2570
71b56b4e7785
Make the references to features in the help more consistent. (Sylvain Hitier)
Bram Moolenaar <bram@vim.org>
parents:
2561
diff
changeset
|
2463 {not available when compiled without the |+syntax| |
743 | 2464 feature} |
2465 Highlight the screen column of the cursor with CursorColumn | |
2466 |hl-CursorColumn|. Useful to align text. Will make screen redrawing | |
2467 slower. | |
826 | 2468 If you only want the highlighting in the current window you can use |
2469 these autocommands: > | |
2470 au WinLeave * set nocursorline nocursorcolumn | |
2471 au WinEnter * set cursorline cursorcolumn | |
2472 < | |
743 | 2473 |
2474 *'cursorline'* *'cul'* *'nocursorline'* *'nocul'* | |
2475 'cursorline' 'cul' boolean (default off) | |
2476 local to window | |
2477 {not in Vi} | |
2570
71b56b4e7785
Make the references to features in the help more consistent. (Sylvain Hitier)
Bram Moolenaar <bram@vim.org>
parents:
2561
diff
changeset
|
2478 {not available when compiled without the |+syntax| |
743 | 2479 feature} |
2480 Highlight the screen line of the cursor with CursorLine | |
2481 |hl-CursorLine|. Useful to easily spot the cursor. Will make screen | |
2482 redrawing slower. | |
818 | 2483 When Visual mode is active the highlighting isn't used to make it |
825 | 2484 easier to see the selected text. |
743 | 2485 |
2486 | |
7 | 2487 *'debug'* |
2488 'debug' string (default "") | |
2489 global | |
2490 {not in Vi} | |
839 | 2491 These values can be used: |
2492 msg Error messages that would otherwise be omitted will be given | |
2493 anyway. | |
2494 throw Error messages that would otherwise be omitted will be given | |
2495 anyway and also throw an exception and set |v:errmsg|. | |
2496 beep A message will be given when otherwise only a beep would be | |
2497 produced. | |
168 | 2498 The values can be combined, separated by a comma. |
839 | 2499 "msg" and "throw" are useful for debugging 'foldexpr', 'formatexpr' or |
2500 'indentexpr'. | |
7 | 2501 |
2502 *'define'* *'def'* | |
2503 'define' 'def' string (default "^\s*#\s*define") | |
2504 global or local to buffer |global-local| | |
2505 {not in Vi} | |
10 | 2506 Pattern to be used to find a macro definition. It is a search |
7 | 2507 pattern, just like for the "/" command. This option is used for the |
2508 commands like "[i" and "[d" |include-search|. The 'isident' option is | |
2509 used to recognize the defined name after the match: | |
2510 {match with 'define'}{non-ID chars}{defined name}{non-ID char} | |
2511 See |option-backslash| about inserting backslashes to include a space | |
2512 or backslash. | |
2513 The default value is for C programs. For C++ this value would be | |
2514 useful, to include const type declarations: > | |
2515 ^\(#\s*define\|[a-z]*\s*const\s*[a-z]*\) | |
2516 < When using the ":set" command, you need to double the backslashes! | |
2517 | |
2518 *'delcombine'* *'deco'* *'nodelcombine'* *'nodeco'* | |
2519 'delcombine' 'deco' boolean (default off) | |
2520 global | |
2521 {not in Vi} | |
2522 {only available when compiled with the |+multi_byte| | |
2523 feature} | |
2524 If editing Unicode and this option is set, backspace and Normal mode | |
2525 "x" delete each combining character on its own. When it is off (the | |
2526 default) the character along with its combining characters are | |
2527 deleted. | |
2528 Note: When 'delcombine' is set "xx" may work different from "2x"! | |
2529 | |
2530 This is useful for Arabic, Hebrew and many other languages where one | |
2531 may have combining characters overtop of base characters, and want | |
2532 to remove only the combining ones. | |
11160 | 2533 NOTE: This option is reset when 'compatible' is set. |
7 | 2534 |
2535 *'dictionary'* *'dict'* | |
2536 'dictionary' 'dict' string (default "") | |
2537 global or local to buffer |global-local| | |
2538 {not in Vi} | |
2539 List of file names, separated by commas, that are used to lookup words | |
2540 for keyword completion commands |i_CTRL-X_CTRL-K|. Each file should | |
2541 contain a list of words. This can be one word per line, or several | |
2542 words per line, separated by non-keyword characters (white space is | |
2543 preferred). Maximum line length is 510 bytes. | |
703 | 2544 When this option is empty, or an entry "spell" is present, spell |
2545 checking is enabled the currently active spelling is used. |spell| | |
10 | 2546 To include a comma in a file name precede it with a backslash. Spaces |
7 | 2547 after a comma are ignored, otherwise spaces are included in the file |
2548 name. See |option-backslash| about using backslashes. | |
99 | 2549 This has nothing to do with the |Dictionary| variable type. |
7 | 2550 Where to find a list of words? |
2551 - On FreeBSD, there is the file "/usr/share/dict/words". | |
2552 - In the Simtel archive, look in the "msdos/linguist" directory. | |
2553 - In "miscfiles" of the GNU collection. | |
2554 The use of |:set+=| and |:set-=| is preferred when adding or removing | |
2555 directories from the list. This avoids problems when a future version | |
2556 uses another default. | |
2557 Backticks cannot be used in this option for security reasons. | |
2558 | |
2559 *'diff'* *'nodiff'* | |
2560 'diff' boolean (default off) | |
2561 local to window | |
2562 {not in Vi} | |
2563 {not available when compiled without the |+diff| | |
2564 feature} | |
2565 Join the current window in the group of windows that shows differences | |
10 | 2566 between files. See |vimdiff|. |
7 | 2567 |
2568 *'dex'* *'diffexpr'* | |
2569 'diffexpr' 'dex' string (default "") | |
2570 global | |
2571 {not in Vi} | |
2572 {not available when compiled without the |+diff| | |
2573 feature} | |
2574 Expression which is evaluated to obtain an ed-style diff file from two | |
2575 versions of a file. See |diff-diffexpr|. | |
2576 This option cannot be set from a |modeline| or in the |sandbox|, for | |
2577 security reasons. | |
2578 | |
2579 *'dip'* *'diffopt'* | |
2580 'diffopt' 'dip' string (default "filler") | |
2581 global | |
2582 {not in Vi} | |
2583 {not available when compiled without the |+diff| | |
2584 feature} | |
10 | 2585 Option settings for diff mode. It can consist of the following items. |
7 | 2586 All are optional. Items must be separated by a comma. |
2587 | |
2588 filler Show filler lines, to keep the text | |
2589 synchronized with a window that has inserted | |
2590 lines at the same position. Mostly useful | |
2591 when windows are side-by-side and 'scrollbind' | |
2592 is set. | |
2593 | |
2594 context:{n} Use a context of {n} lines between a change | |
2595 and a fold that contains unchanged lines. | |
2596 When omitted a context of six lines is used. | |
2597 See |fold-diff|. | |
2598 | |
2599 icase Ignore changes in case of text. "a" and "A" | |
2600 are considered the same. Adds the "-i" flag | |
2601 to the "diff" command if 'diffexpr' is empty. | |
2602 | |
2603 iwhite Ignore changes in amount of white space. Adds | |
2604 the "-b" flag to the "diff" command if | |
2605 'diffexpr' is empty. Check the documentation | |
2606 of the "diff" command for what this does | |
2607 exactly. It should ignore adding trailing | |
2608 white space, but not leading white space. | |
2609 | |
766 | 2610 horizontal Start diff mode with horizontal splits (unless |
2611 explicitly specified otherwise). | |
2612 | |
2613 vertical Start diff mode with vertical splits (unless | |
2614 explicitly specified otherwise). | |
2615 | |
2616 foldcolumn:{n} Set the 'foldcolumn' option to {n} when | |
2617 starting diff mode. Without this 2 is used. | |
2618 | |
7 | 2619 Examples: > |
2620 | |
2621 :set diffopt=filler,context:4 | |
2622 :set diffopt= | |
766 | 2623 :set diffopt=filler,foldcolumn:3 |
7 | 2624 < |
2625 *'digraph'* *'dg'* *'nodigraph'* *'nodg'* | |
2626 'digraph' 'dg' boolean (default off) | |
2627 global | |
2628 {not in Vi} | |
2629 {not available when compiled without the |+digraphs| | |
2630 feature} | |
2631 Enable the entering of digraphs in Insert mode with {char1} <BS> | |
2632 {char2}. See |digraphs|. | |
2633 NOTE: This option is reset when 'compatible' is set. | |
2634 | |
2635 *'directory'* *'dir'* | |
2636 'directory' 'dir' string (default for Amiga: ".,t:", | |
5555 | 2637 for MS-DOS and Win32: ".,$TEMP,c:\tmp,c:\temp" |
7 | 2638 for Unix: ".,~/tmp,/var/tmp,/tmp") |
2639 global | |
2640 List of directory names for the swap file, separated with commas. | |
2641 - The swap file will be created in the first directory where this is | |
2642 possible. | |
2643 - Empty means that no swap file will be used (recovery is | |
2644 impossible!). | |
2645 - A directory "." means to put the swap file in the same directory as | |
2646 the edited file. On Unix, a dot is prepended to the file name, so | |
2647 it doesn't show in a directory listing. On MS-Windows the "hidden" | |
2648 attribute is set and a dot prepended if possible. | |
33 | 2649 - A directory starting with "./" (or ".\" for MS-DOS et al.) means to |
7 | 2650 put the swap file relative to where the edited file is. The leading |
2651 "." is replaced with the path name of the edited file. | |
459 | 2652 - For Unix and Win32, if a directory ends in two path separators "//" |
2653 or "\\", the swap file name will be built from the complete path to | |
2654 the file with all path separators substituted to percent '%' signs. | |
2655 This will ensure file name uniqueness in the preserve directory. | |
1698 | 2656 On Win32, when a separating comma is following, you must use "//", |
2657 since "\\" will include the comma in the file name. | |
7 | 2658 - Spaces after the comma are ignored, other spaces are considered part |
2659 of the directory name. To have a space at the start of a directory | |
2660 name, precede it with a backslash. | |
2661 - To include a comma in a directory name precede it with a backslash. | |
2662 - A directory name may end in an ':' or '/'. | |
2663 - Environment variables are expanded |:set_env|. | |
2664 - Careful with '\' characters, type one before a space, type two to | |
2665 get one in the option (see |option-backslash|), for example: > | |
2666 :set dir=c:\\tmp,\ dir\\,with\\,commas,\\\ dir\ with\ spaces | |
2667 < - For backwards compatibility with Vim version 3.0 a '>' at the start | |
2668 of the option is removed. | |
2669 Using "." first in the list is recommended. This means that editing | |
2670 the same file twice will result in a warning. Using "/tmp" on Unix is | |
2671 discouraged: When the system crashes you lose the swap file. | |
2672 "/var/tmp" is often not cleared when rebooting, thus is a better | |
2673 choice than "/tmp". But it can contain a lot of files, your swap | |
2674 files get lost in the crowd. That is why a "tmp" directory in your | |
2675 home directory is tried first. | |
2676 The use of |:set+=| and |:set-=| is preferred when adding or removing | |
2677 directories from the list. This avoids problems when a future version | |
2678 uses another default. | |
2679 This option cannot be set from a |modeline| or in the |sandbox|, for | |
2680 security reasons. | |
2681 {Vi: directory to put temp file in, defaults to "/tmp"} | |
2682 | |
2683 *'display'* *'dy'* | |
9737
35ce559b8553
commit https://github.com/vim/vim/commit/bc8801c9317eb721a2ee91322669f2dd5d136380
Christian Brabandt <cb@256bit.org>
parents:
9669
diff
changeset
|
2684 '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
|
2685 |defaults.vim|) |
7 | 2686 global |
2687 {not in Vi} | |
2688 Change the way text is displayed. This is comma separated list of | |
2689 flags: | |
2690 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
|
2691 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
|
2692 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
|
2693 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
|
2694 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
|
2695 column of the last screen line. Overrules "lastline". |
7 | 2696 uhex Show unprintable characters hexadecimal as <xx> |
2697 instead of using ^C and ~C. | |
2698 | |
10211
b7da8d4c594c
commit https://github.com/vim/vim/commit/d07969093a9b3051511c478d71c36de6fc33c0d6
Christian Brabandt <cb@256bit.org>
parents:
10198
diff
changeset
|
2699 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
|
2700 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
|
2701 |
7 | 2702 *'eadirection'* *'ead'* |
2703 'eadirection' 'ead' string (default "both") | |
2704 global | |
2705 {not in Vi} | |
2570
71b56b4e7785
Make the references to features in the help more consistent. (Sylvain Hitier)
Bram Moolenaar <bram@vim.org>
parents:
2561
diff
changeset
|
2706 {not available when compiled without the |+vertsplit| |
7 | 2707 feature} |
2708 Tells when the 'equalalways' option applies: | |
2709 ver vertically, width of windows is not affected | |
2710 hor horizontally, height of windows is not affected | |
2711 both width and height of windows is affected | |
2712 | |
2713 *'ed'* *'edcompatible'* *'noed'* *'noedcompatible'* | |
2714 'edcompatible' 'ed' boolean (default off) | |
2715 global | |
2716 Makes the 'g' and 'c' flags of the ":substitute" command to be | |
2717 toggled each time the flag is given. See |complex-change|. See | |
2718 also 'gdefault' option. | |
11442 | 2719 Switching this option on may break plugins! |
7 | 2720 |
8876
47f17f66da3d
commit https://github.com/vim/vim/commit/03413f44167c4b5cd0012def9bb331e2518c83cf
Christian Brabandt <cb@256bit.org>
parents:
8835
diff
changeset
|
2721 *'emoji'* *'emo'* *'noemoji'* *'noemo'* |
8629
54ac275e3fc4
commit https://github.com/vim/vim/commit/3848e00e0177abdb31bc600234967863ec487233
Christian Brabandt <cb@256bit.org>
parents:
8560
diff
changeset
|
2722 'emoji' 'emo' boolean (default: on) |
54ac275e3fc4
commit https://github.com/vim/vim/commit/3848e00e0177abdb31bc600234967863ec487233
Christian Brabandt <cb@256bit.org>
parents:
8560
diff
changeset
|
2723 global |
54ac275e3fc4
commit https://github.com/vim/vim/commit/3848e00e0177abdb31bc600234967863ec487233
Christian Brabandt <cb@256bit.org>
parents:
8560
diff
changeset
|
2724 {not in Vi} |
54ac275e3fc4
commit https://github.com/vim/vim/commit/3848e00e0177abdb31bc600234967863ec487233
Christian Brabandt <cb@256bit.org>
parents:
8560
diff
changeset
|
2725 {only available when compiled with the |+multi_byte| |
54ac275e3fc4
commit https://github.com/vim/vim/commit/3848e00e0177abdb31bc600234967863ec487233
Christian Brabandt <cb@256bit.org>
parents:
8560
diff
changeset
|
2726 feature} |
54ac275e3fc4
commit https://github.com/vim/vim/commit/3848e00e0177abdb31bc600234967863ec487233
Christian Brabandt <cb@256bit.org>
parents:
8560
diff
changeset
|
2727 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
|
2728 |
54ac275e3fc4
commit https://github.com/vim/vim/commit/3848e00e0177abdb31bc600234967863ec487233
Christian Brabandt <cb@256bit.org>
parents:
8560
diff
changeset
|
2729 |
7 | 2730 *'encoding'* *'enc'* *E543* |
2731 'encoding' 'enc' string (default: "latin1" or value from $LANG) | |
2732 global | |
2733 {only available when compiled with the |+multi_byte| | |
2734 feature} | |
2735 {not in Vi} | |
2736 Sets the character encoding used inside Vim. It applies to text in | |
2737 the buffers, registers, Strings in expressions, text stored in the | |
2738 viminfo file, etc. It sets the kind of characters which Vim can work | |
2739 with. See |encoding-names| for the possible values. | |
2740 | |
2741 NOTE: Changing this option will not change the encoding of the | |
39 | 2742 existing text in Vim. It may cause non-ASCII text to become invalid. |
7 | 2743 It should normally be kept at its default value, or set when Vim |
1152 | 2744 starts up. See |multibyte|. To reload the menus see |:menutrans|. |
7 | 2745 |
2317
2b2cd34569eb
Disallow setting 'enc' in a modeline. (Patrick Texier)
Bram Moolenaar <bram@vim.org>
parents:
2314
diff
changeset
|
2746 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
|
2747 corrupt the text. |
2b2cd34569eb
Disallow setting 'enc' in a modeline. (Patrick Texier)
Bram Moolenaar <bram@vim.org>
parents:
2314
diff
changeset
|
2748 |
10895
c391bfbdb452
Updated runtime files.
Christian Brabandt <cb@256bit.org>
parents:
10734
diff
changeset
|
2749 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
|
2750 to "utf-8". Although care has been taken to allow different values of |
7 | 2751 'encoding', "utf-8" is the natural choice for the environment and |
2752 avoids unnecessary conversion overhead. "utf-8" has not been made | |
10 | 2753 the default to prevent different behavior of the GUI and terminal |
7 | 2754 versions, and to avoid changing the encoding of newly created files |
2755 without your knowledge (in case 'fileencodings' is empty). | |
2756 | |
2757 The character encoding of files can be different from 'encoding'. | |
10 | 2758 This is specified with 'fileencoding'. The conversion is done with |
7 | 2759 iconv() or as specified with 'charconvert'. |
2760 | |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
2761 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
|
2762 can use: > |
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
2763 if has("multi_byte_encoding") |
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
2764 < |
7 | 2765 Normally 'encoding' will be equal to your current locale. This will |
2766 be the default if Vim recognizes your environment settings. If | |
2767 'encoding' is not set to the current locale, 'termencoding' must be | |
2768 set to convert typed and displayed text. See |encoding-table|. | |
2769 | |
2770 When you set this option, it fires the |EncodingChanged| autocommand | |
2771 event so that you can set up fonts if necessary. | |
2772 | |
2773 When the option is set, the value is converted to lowercase. Thus | |
2774 you can set it with uppercase values too. Underscores are translated | |
2775 to '-' signs. | |
2776 When the encoding is recognized, it is changed to the standard name. | |
2777 For example "Latin-1" becomes "latin1", "ISO_88592" becomes | |
2778 "iso-8859-2" and "utf8" becomes "utf-8". | |
2779 | |
2780 Note: "latin1" is also used when the encoding could not be detected. | |
2781 This only works when editing files in the same encoding! When the | |
2782 actual character set is not latin1, make sure 'fileencoding' and | |
2783 'fileencodings' are empty. When conversion is needed, switch to using | |
2784 utf-8. | |
2785 | |
2786 When "unicode", "ucs-2" or "ucs-4" is used, Vim internally uses utf-8. | |
2787 You don't notice this while editing, but it does matter for the | |
2788 |viminfo-file|. And Vim expects the terminal to use utf-8 too. Thus | |
2789 setting 'encoding' to one of these values instead of utf-8 only has | |
2790 effect for encoding used for files when 'fileencoding' is empty. | |
448 | 2791 |
2792 When 'encoding' is set to a Unicode encoding, and 'fileencodings' was | |
2793 not set yet, the default for 'fileencodings' is changed. | |
7 | 2794 |
2795 *'endofline'* *'eol'* *'noendofline'* *'noeol'* | |
2796 'endofline' 'eol' boolean (default on) | |
2797 local to buffer | |
2798 {not in Vi} | |
2799 When writing a file and this option is off and the 'binary' option | |
6933 | 2800 is on, or 'fixeol' option is off, no <EOL> will be written for the |
2801 last line in the file. This option is automatically set or reset when | |
2802 starting to edit a new file, depending on whether file has an <EOL> | |
2803 for the last line in the file. Normally you don't have to set or | |
2804 reset this option. | |
2805 When 'binary' is off and 'fixeol' is on the value is not used when | |
2806 writing the file. When 'binary' is on or 'fixeol' is off it is used | |
2807 to remember the presence of a <EOL> for the last line in the file, so | |
2808 that when you write the file the situation from the original file can | |
2809 be kept. But you can change it if you want to. | |
7 | 2810 |
2811 *'equalalways'* *'ea'* *'noequalalways'* *'noea'* | |
2812 'equalalways' 'ea' boolean (default on) | |
2813 global | |
2814 {not in Vi} | |
2815 When on, all the windows are automatically made the same size after | |
33 | 2816 splitting or closing a window. This also happens the moment the |
2817 option is switched on. When off, splitting a window will reduce the | |
2818 size of the current window and leave the other windows the same. When | |
2819 closing a window the extra lines are given to the window next to it | |
2820 (depending on 'splitbelow' and 'splitright'). | |
7 | 2821 When mixing vertically and horizontally split windows, a minimal size |
2822 is computed and some windows may be larger if there is room. The | |
2823 'eadirection' option tells in which direction the size is affected. | |
1354 | 2824 Changing the height and width of a window can be avoided by setting |
2825 'winfixheight' and 'winfixwidth', respectively. | |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
2826 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
|
2827 currently not equalized (it's complicated, but may be implemented in |
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
2828 the future). |
7 | 2829 |
2830 *'equalprg'* *'ep'* | |
2831 'equalprg' 'ep' string (default "") | |
2832 global or local to buffer |global-local| | |
2833 {not in Vi} | |
2834 External program to use for "=" command. When this option is empty | |
1621 | 2835 the internal formatting functions are used; either 'lisp', 'cindent' |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
2836 or 'indentexpr'. When Vim was compiled without internal formatting, |
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
2837 the "indent" program is used. |
10 | 2838 Environment variables are expanded |:set_env|. See |option-backslash| |
7 | 2839 about including spaces and backslashes. |
2840 This option cannot be set from a |modeline| or in the |sandbox|, for | |
2841 security reasons. | |
2842 | |
2843 *'errorbells'* *'eb'* *'noerrorbells'* *'noeb'* | |
2844 'errorbells' 'eb' boolean (default off) | |
2845 global | |
2846 Ring the bell (beep or screen flash) for error messages. This only | |
2847 makes a difference for error messages, the bell will be used always | |
2848 for a lot of errors without a message (e.g., hitting <Esc> in Normal | |
10 | 2849 mode). See 'visualbell' on how to make the bell behave like a beep, |
6949 | 2850 screen flash or do nothing. See 'belloff' to finetune when to ring the |
2851 bell. | |
7 | 2852 |
2853 *'errorfile'* *'ef'* | |
2854 'errorfile' 'ef' string (Amiga default: "AztecC.Err", | |
2855 others: "errors.err") | |
2856 global | |
2857 {not in Vi} | |
2858 {not available when compiled without the |+quickfix| | |
2859 feature} | |
2860 Name of the errorfile for the QuickFix mode (see |:cf|). | |
2861 When the "-q" command-line argument is used, 'errorfile' is set to the | |
2862 following argument. See |-q|. | |
2863 NOT used for the ":make" command. See 'makeef' for that. | |
2864 Environment variables are expanded |:set_env|. | |
2865 See |option-backslash| about including spaces and backslashes. | |
2866 This option cannot be set from a |modeline| or in the |sandbox|, for | |
2867 security reasons. | |
2868 | |
2869 *'errorformat'* *'efm'* | |
2870 'errorformat' 'efm' string (default is very long) | |
2871 global or local to buffer |global-local| | |
2872 {not in Vi} | |
2873 {not available when compiled without the |+quickfix| | |
2874 feature} | |
2875 Scanf-like description of the format for the lines in the error file | |
2876 (see |errorformat|). | |
2877 | |
2878 *'esckeys'* *'ek'* *'noesckeys'* *'noek'* | |
2879 'esckeys' 'ek' boolean (Vim default: on, Vi default: off) | |
2880 global | |
2881 {not in Vi} | |
2882 Function keys that start with an <Esc> are recognized in Insert | |
2883 mode. When this option is off, the cursor and function keys cannot be | |
2884 used in Insert mode if they start with an <Esc>. The advantage of | |
2885 this is that the single <Esc> is recognized immediately, instead of | |
2886 after one second. Instead of resetting this option, you might want to | |
2887 try changing the values for 'timeoutlen' and 'ttimeoutlen'. Note that | |
2888 when 'esckeys' is off, you can still map anything, but the cursor keys | |
2889 won't work by default. | |
2890 NOTE: This option is set to the Vi default value when 'compatible' is | |
2891 set and to the Vim default value when 'compatible' is reset. | |
2892 | |
2893 *'eventignore'* *'ei'* | |
2894 'eventignore' 'ei' string (default "") | |
2895 global | |
2896 {not in Vi} | |
2897 {not available when compiled without the |+autocmd| | |
2898 feature} | |
2899 A list of autocommand event names, which are to be ignored. | |
844 | 2900 When set to "all" or when "all" is one of the items, all autocommand |
2901 events are ignored, autocommands will not be executed. | |
7 | 2902 Otherwise this is a comma separated list of event names. Example: > |
2903 :set ei=WinEnter,WinLeave | |
2904 < | |
2905 *'expandtab'* *'et'* *'noexpandtab'* *'noet'* | |
2906 'expandtab' 'et' boolean (default off) | |
2907 local to buffer | |
2908 {not in Vi} | |
2909 In Insert mode: Use the appropriate number of spaces to insert a | |
10 | 2910 <Tab>. Spaces are used in indents with the '>' and '<' commands and |
7 | 2911 when 'autoindent' is on. To insert a real tab when 'expandtab' is |
2912 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
|
2913 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
|
2914 the 'paste' option is reset. |
7 | 2915 NOTE: This option is reset when 'compatible' is set. |
2916 | |
2917 *'exrc'* *'ex'* *'noexrc'* *'noex'* | |
2918 'exrc' 'ex' boolean (default off) | |
2919 global | |
2920 {not in Vi} | |
2921 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
|
2922 directory. |
018fead968c1
commit https://github.com/vim/vim/commit/36f44c21da2e912c008683a0c4447fca2a071e9a
Christian Brabandt <cb@256bit.org>
parents:
9975
diff
changeset
|
2923 |
018fead968c1
commit https://github.com/vim/vim/commit/36f44c21da2e912c008683a0c4447fca2a071e9a
Christian Brabandt <cb@256bit.org>
parents:
9975
diff
changeset
|
2924 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
|
2925 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
|
2926 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
|
2927 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
|
2928 matching directory. |
018fead968c1
commit https://github.com/vim/vim/commit/36f44c21da2e912c008683a0c4447fca2a071e9a
Christian Brabandt <cb@256bit.org>
parents:
9975
diff
changeset
|
2929 |
018fead968c1
commit https://github.com/vim/vim/commit/36f44c21da2e912c008683a0c4447fca2a071e9a
Christian Brabandt <cb@256bit.org>
parents:
9975
diff
changeset
|
2930 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
|
2931 'secure' option (see |initialization|). |
018fead968c1
commit https://github.com/vim/vim/commit/36f44c21da2e912c008683a0c4447fca2a071e9a
Christian Brabandt <cb@256bit.org>
parents:
9975
diff
changeset
|
2932 Also see |.vimrc| and |gui-init|. |
7 | 2933 This option cannot be set from a |modeline| or in the |sandbox|, for |
2934 security reasons. | |
2935 | |
2936 *'fileencoding'* *'fenc'* *E213* | |
2937 'fileencoding' 'fenc' string (default: "") | |
2938 local to buffer | |
2939 {only available when compiled with the |+multi_byte| | |
2940 feature} | |
2941 {not in Vi} | |
2942 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
|
2943 |
7 | 2944 When 'fileencoding' is different from 'encoding', conversion will be |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
2945 done when writing the file. For reading see below. |
7 | 2946 When 'fileencoding' is empty, the same value as 'encoding' will be |
2947 used (no conversion when reading or writing a file). | |
11062 | 2948 No error will be given when the value is set, only when it is used, |
2949 only when writing a file. | |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
2950 Conversion will also be done when 'encoding' and 'fileencoding' are |
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
2951 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
|
2952 because internally Unicode is always stored as utf-8. |
7 | 2953 WARNING: Conversion can cause loss of information! When |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
2954 'encoding' is "utf-8" or another Unicode encoding, conversion |
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
2955 is most likely done in a way that the reverse conversion |
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
2956 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
|
2957 characters may be lost! |
2317
2b2cd34569eb
Disallow setting 'enc' in a modeline. (Patrick Texier)
Bram Moolenaar <bram@vim.org>
parents:
2314
diff
changeset
|
2958 |
7 | 2959 See 'encoding' for the possible values. Additionally, values may be |
2960 specified that can be handled by the converter, see | |
2961 |mbyte-conversion|. | |
2317
2b2cd34569eb
Disallow setting 'enc' in a modeline. (Patrick Texier)
Bram Moolenaar <bram@vim.org>
parents:
2314
diff
changeset
|
2962 |
7 | 2963 When reading a file 'fileencoding' will be set from 'fileencodings'. |
2964 To read a file in a certain encoding it won't work by setting | |
1152 | 2965 'fileencoding', use the |++enc| argument. One exception: when |
2966 'fileencodings' is empty the value of 'fileencoding' is used. | |
692 | 2967 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
|
2968 |
7 | 2969 Prepending "8bit-" and "2byte-" has no meaning here, they are ignored. |
2970 When the option is set, the value is converted to lowercase. Thus | |
2971 you can set it with uppercase values too. '_' characters are | |
2972 replaced with '-'. If a name is recognized from the list for | |
2973 'encoding', it is replaced by the standard name. For example | |
2974 "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
|
2975 |
7 | 2976 When this option is set, after starting to edit a file, the 'modified' |
2977 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
|
2978 |
2b2cd34569eb
Disallow setting 'enc' in a modeline. (Patrick Texier)
Bram Moolenaar <bram@vim.org>
parents:
2314
diff
changeset
|
2979 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
|
2980 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
|
2981 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
|
2982 '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
|
2983 |
7 | 2984 This option can not be changed when 'modifiable' is off. |
2985 | |
2986 *'fe'* | |
2987 NOTE: Before version 6.0 this option specified the encoding for the | |
10 | 2988 whole of Vim, this was a mistake. Now use 'encoding' instead. The |
7 | 2989 old short name was 'fe', which is no longer used. |
2990 | |
2991 *'fileencodings'* *'fencs'* | |
39 | 2992 'fileencodings' 'fencs' string (default: "ucs-bom", |
2993 "ucs-bom,utf-8,default,latin1" when | |
2994 'encoding' is set to a Unicode value) | |
7 | 2995 global |
2996 {only available when compiled with the |+multi_byte| | |
2997 feature} | |
2998 {not in Vi} | |
2999 This is a list of character encodings considered when starting to edit | |
3000 an existing file. When a file is read, Vim tries to use the first | |
3001 mentioned character encoding. If an error is detected, the next one | |
3002 in the list is tried. When an encoding is found that works, | |
10 | 3003 'fileencoding' is set to it. If all fail, 'fileencoding' is set to |
7 | 3004 an empty string, which means the value of 'encoding' is used. |
3005 WARNING: Conversion can cause loss of information! When | |
3006 'encoding' is "utf-8" (or one of the other Unicode variants) | |
3007 conversion is most likely done in a way that the reverse | |
3008 conversion results in the same text. When 'encoding' is not | |
596 | 3009 "utf-8" some non-ASCII characters may be lost! You can use |
3010 the |++bad| argument to specify what is done with characters | |
3011 that can't be converted. | |
7 | 3012 For an empty file or a file with only ASCII characters most encodings |
3013 will work and the first entry of 'fileencodings' will be used (except | |
3014 "ucs-bom", which requires the BOM to be present). If you prefer | |
3015 another encoding use an BufReadPost autocommand event to test if your | |
3016 preferred encoding is to be used. Example: > | |
3017 au BufReadPost * if search('\S', 'w') == 0 | | |
3018 \ set fenc=iso-2022-jp | endif | |
3019 < This sets 'fileencoding' to "iso-2022-jp" if the file does not contain | |
3020 non-blank characters. | |
596 | 3021 When the |++enc| argument is used then the value of 'fileencodings' is |
3022 not used. | |
692 | 3023 Note that 'fileencodings' is not used for a new file, the global value |
3024 of 'fileencoding' is used instead. You can set it with: > | |
3025 :setglobal fenc=iso-8859-2 | |
3026 < This means that a non-existing file may get a different encoding than | |
3027 an empty file. | |
7 | 3028 The special value "ucs-bom" can be used to check for a Unicode BOM |
3029 (Byte Order Mark) at the start of the file. It must not be preceded | |
3030 by "utf-8" or another Unicode encoding for this to work properly. | |
3031 An entry for an 8-bit encoding (e.g., "latin1") should be the last, | |
3032 because Vim cannot detect an error, thus the encoding is always | |
3033 accepted. | |
39 | 3034 The special value "default" can be used for the encoding from the |
3035 environment. This is the default value for 'encoding'. It is useful | |
3036 when 'encoding' is set to "utf-8" and your environment uses a | |
3037 non-latin1 encoding, such as Russian. | |
777 | 3038 When 'encoding' is "utf-8" and a file contains an illegal byte |
3039 sequence it won't be recognized as UTF-8. You can use the |8g8| | |
3040 command to find the illegal byte sequence. | |
7 | 3041 WRONG VALUES: WHAT'S WRONG: |
3042 latin1,utf-8 "latin1" will always be used | |
3043 utf-8,ucs-bom,latin1 BOM won't be recognized in an utf-8 | |
3044 file | |
3045 cp1250,latin1 "cp1250" will always be used | |
3046 If 'fileencodings' is empty, 'fileencoding' is not modified. | |
3047 See 'fileencoding' for the possible values. | |
3048 Setting this option does not have an effect until the next time a file | |
3049 is read. | |
3050 | |
3051 *'fileformat'* *'ff'* | |
3052 'fileformat' 'ff' string (MS-DOS, MS-Windows, OS/2 default: "dos", | |
3053 Unix default: "unix", | |
3054 Macintosh default: "mac") | |
3055 local to buffer | |
3056 {not in Vi} | |
3057 This gives the <EOL> of the current buffer, which is used for | |
3058 reading/writing the buffer from/to a file: | |
3059 dos <CR> <NL> | |
3060 unix <NL> | |
3061 mac <CR> | |
3062 When "dos" is used, CTRL-Z at the end of a file is ignored. | |
3063 See |file-formats| and |file-read|. | |
3064 For the character encoding of the file see 'fileencoding'. | |
3065 When 'binary' is set, the value of 'fileformat' is ignored, file I/O | |
4264 | 3066 works like it was set to "unix". |
7 | 3067 This option is set automatically when starting to edit a file and |
3068 'fileformats' is not empty and 'binary' is off. | |
3069 When this option is set, after starting to edit a file, the 'modified' | |
3070 option is set, because the file would be different when written. | |
3071 This option can not be changed when 'modifiable' is off. | |
3072 For backwards compatibility: When this option is set to "dos", | |
3073 'textmode' is set, otherwise 'textmode' is reset. | |
3074 | |
3075 *'fileformats'* *'ffs'* | |
3076 'fileformats' 'ffs' string (default: | |
3077 Vim+Vi MS-DOS, MS-Windows OS/2: "dos,unix", | |
3078 Vim Unix: "unix,dos", | |
3079 Vim Mac: "mac,unix,dos", | |
3080 Vi Cygwin: "unix,dos", | |
3081 Vi others: "") | |
3082 global | |
3083 {not in Vi} | |
3084 This gives the end-of-line (<EOL>) formats that will be tried when | |
3085 starting to edit a new buffer and when reading a file into an existing | |
3086 buffer: | |
3087 - When empty, the format defined with 'fileformat' will be used | |
3088 always. It is not set automatically. | |
3089 - When set to one name, that format will be used whenever a new buffer | |
10 | 3090 is opened. 'fileformat' is set accordingly for that buffer. The |
7 | 3091 'fileformats' name will be used when a file is read into an existing |
3092 buffer, no matter what 'fileformat' for that buffer is set to. | |
3093 - When more than one name is present, separated by commas, automatic | |
3094 <EOL> detection will be done when reading a file. When starting to | |
3095 edit a file, a check is done for the <EOL>: | |
3096 1. If all lines end in <CR><NL>, and 'fileformats' includes "dos", | |
3097 'fileformat' is set to "dos". | |
3098 2. If a <NL> is found and 'fileformats' includes "unix", 'fileformat' | |
10 | 3099 is set to "unix". Note that when a <NL> is found without a |
7 | 3100 preceding <CR>, "unix" is preferred over "dos". |
6647 | 3101 3. If 'fileformat' has not yet been set, and if a <CR> is found, and |
3102 if 'fileformats' includes "mac", 'fileformat' is set to "mac". | |
2587 | 3103 This means that "mac" is only chosen when: |
3104 "unix" is not present or no <NL> is found in the file, and | |
3105 "dos" is not present or no <CR><NL> is found in the file. | |
3106 Except: if "unix" was chosen, but there is a <CR> before | |
3107 the first <NL>, and there appear to be more <CR>s than <NL>s in | |
2642 | 3108 the first few lines, "mac" is used. |
7 | 3109 4. If 'fileformat' is still not set, the first name from |
3110 'fileformats' is used. | |
3111 When reading a file into an existing buffer, the same is done, but | |
3112 this happens like 'fileformat' has been set appropriately for that | |
3113 file only, the option is not changed. | |
3114 When 'binary' is set, the value of 'fileformats' is not used. | |
3115 | |
8748
b1a19a2f73f0
commit https://github.com/vim/vim/commit/4f3f668c8486444e53163c29d2fc79bf47eb3c82
Christian Brabandt <cb@256bit.org>
parents:
8629
diff
changeset
|
3116 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
|
3117 can overrule this by setting 'fileformat' in your .vimrc. |
2662 | 3118 |
7 | 3119 For systems with a Dos-like <EOL> (<CR><NL>), when reading files that |
3120 are ":source"ed and for vimrc files, automatic <EOL> detection may be | |
3121 done: | |
3122 - When 'fileformats' is empty, there is no automatic detection. Dos | |
3123 format will be used. | |
3124 - When 'fileformats' is set to one or more names, automatic detection | |
3125 is done. This is based on the first <NL> in the file: If there is a | |
3126 <CR> in front of it, Dos format is used, otherwise Unix format is | |
3127 used. | |
3128 Also see |file-formats|. | |
3129 For backwards compatibility: When this option is set to an empty | |
3130 string or one format (no comma is included), 'textauto' is reset, | |
3131 otherwise 'textauto' is set. | |
3132 NOTE: This option is set to the Vi default value when 'compatible' is | |
3133 set and to the Vim default value when 'compatible' is reset. | |
3134 | |
4264 | 3135 *'fileignorecase'* *'fic'* *'nofileignorecase'* *'nofic'* |
3136 'fileignorecase' 'fic' boolean (default on for systems where case in file | |
3137 names is normally ignored) | |
4242 | 3138 global |
3139 {not in Vi} | |
3140 When set case is ignored when using file names and directories. | |
3141 See 'wildignorecase' for only ignoring case when doing completion. | |
3142 | |
7 | 3143 *'filetype'* *'ft'* |
3144 'filetype' 'ft' string (default: "") | |
3145 local to buffer | |
3146 {not in Vi} | |
3147 {not available when compiled without the |+autocmd| | |
3148 feature} | |
3149 When this option is set, the FileType autocommand event is triggered. | |
3150 All autocommands that match with the value of this option will be | |
3151 executed. Thus the value of 'filetype' is used in place of the file | |
3152 name. | |
3153 Otherwise this option does not always reflect the current file type. | |
3154 This option is normally set when the file type is detected. To enable | |
3155 this use the ":filetype on" command. |:filetype| | |
3156 Setting this option to a different value is most useful in a modeline, | |
3157 for a file for which the file type is not automatically recognized. | |
782 | 3158 Example, for in an IDL file: |
3159 /* vim: set filetype=idl : */ ~ | |
3160 |FileType| |filetypes| | |
3161 When a dot appears in the value then this separates two filetype | |
3162 names. Example: | |
3163 /* vim: set filetype=c.doxygen : */ ~ | |
3164 This will use the "c" filetype first, then the "doxygen" filetype. | |
3165 This works both for filetype plugins and for syntax files. More than | |
3166 one dot may appear. | |
7 | 3167 This option is not copied to another buffer, independent of the 's' or |
3168 'S' flag in 'cpoptions'. | |
36 | 3169 Only normal file name characters can be used, "/\*?[|<>" are illegal. |
7 | 3170 |
3171 *'fillchars'* *'fcs'* | |
3172 'fillchars' 'fcs' string (default "vert:|,fold:-") | |
3173 global | |
3174 {not in Vi} | |
3175 {not available when compiled without the |+windows| | |
3176 and |+folding| features} | |
3177 Characters to fill the statuslines and vertical separators. | |
3178 It is a comma separated list of items: | |
3179 | |
3180 item default Used for ~ | |
3181 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
|
3182 stlnc:c ' ' or '=' statusline of the non-current windows |
7 | 3183 vert:c '|' vertical separators |:vsplit| |
3184 fold:c '-' filling 'foldtext' | |
3185 diff:c '-' deleted lines of the 'diff' option | |
3186 | |
10 | 3187 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
|
3188 "stlnc" the space will be used when there is highlighting, '^' or '=' |
7 | 3189 otherwise. |
3190 | |
3191 Example: > | |
8061
abd64cf67bcf
commit https://github.com/vim/vim/commit/38a55639d603823efcf2d2fdf542dbffdeb60b75
Christian Brabandt <cb@256bit.org>
parents:
7876
diff
changeset
|
3192 :set fillchars=stl:^,stlnc:=,vert:\|,fold:-,diff:- |
7 | 3193 < This is similar to the default, except that these characters will also |
3194 be used when there is highlighting. | |
3195 | |
819 | 3196 for "stl" and "stlnc" only single-byte values are supported. |
3197 | |
7 | 3198 The highlighting used for these items: |
3199 item highlight group ~ | |
3200 stl:c StatusLine |hl-StatusLine| | |
3201 stlnc:c StatusLineNC |hl-StatusLineNC| | |
3202 vert:c VertSplit |hl-VertSplit| | |
3203 fold:c Folded |hl-Folded| | |
3204 diff:c DiffDelete |hl-DiffDelete| | |
3205 | |
6933 | 3206 *'fixendofline'* *'fixeol'* *'nofixendofline'* *'nofixeol'* |
3207 'fixendofline' 'fixeol' boolean (default on) | |
3208 local to buffer | |
3209 {not in Vi} | |
3210 When writing a file and this option is on, <EOL> at the end of file | |
3211 will be restored if missing. Turn this option off if you want to | |
3212 preserve the situation from the original file. | |
3213 When the 'binary' option is set the value of this option doesn't | |
3214 matter. | |
3215 See the 'endofline' option. | |
3216 | |
7 | 3217 *'fkmap'* *'fk'* *'nofkmap'* *'nofk'* |
3218 'fkmap' 'fk' boolean (default off) *E198* | |
3219 global | |
3220 {not in Vi} | |
3221 {only available when compiled with the |+rightleft| | |
3222 feature} | |
3223 When on, the keyboard is mapped for the Farsi character set. | |
3224 Normally you would set 'allowrevins' and use CTRL-_ in insert mode to | |
10 | 3225 toggle this option |i_CTRL-_|. See |farsi.txt|. |
7 | 3226 |
3227 *'foldclose'* *'fcl'* | |
3228 'foldclose' 'fcl' string (default "") | |
3229 global | |
3230 {not in Vi} | |
3231 {not available when compiled without the |+folding| | |
3232 feature} | |
3233 When set to "all", a fold is closed when the cursor isn't in it and | |
3234 its level is higher than 'foldlevel'. Useful if you want folds to | |
3235 automatically close when moving out of them. | |
3236 | |
3237 *'foldcolumn'* *'fdc'* | |
3238 'foldcolumn' 'fdc' number (default 0) | |
3239 local to window | |
3240 {not in Vi} | |
3241 {not available when compiled without the |+folding| | |
3242 feature} | |
3243 When non-zero, a column with the specified width is shown at the side | |
3244 of the window which indicates open and closed folds. The maximum | |
3245 value is 12. | |
3246 See |folding|. | |
3247 | |
3248 *'foldenable'* *'fen'* *'nofoldenable'* *'nofen'* | |
3249 'foldenable' 'fen' boolean (default on) | |
3250 local to window | |
3251 {not in Vi} | |
3252 {not available when compiled without the |+folding| | |
3253 feature} | |
3254 When off, all folds are open. This option can be used to quickly | |
3255 switch between showing all text unfolded and viewing the text with | |
3256 folds (including manually opened or closed folds). It can be toggled | |
10 | 3257 with the |zi| command. The 'foldcolumn' will remain blank when |
7 | 3258 'foldenable' is off. |
3259 This option is set by commands that create a new fold or close a fold. | |
3260 See |folding|. | |
3261 | |
3262 *'foldexpr'* *'fde'* | |
3263 'foldexpr' 'fde' string (default: "0") | |
3264 local to window | |
3265 {not in Vi} | |
3266 {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
|
3267 or |+eval| features} |
7 | 3268 The expression used for when 'foldmethod' is "expr". It is evaluated |
634 | 3269 for each line to obtain its fold level. See |fold-expr|. |
782 | 3270 |
3682 | 3271 The expression will be evaluated in the |sandbox| if set from a |
3272 modeline, see |sandbox-option|. | |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
3273 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
|
3274 on. |
634 | 3275 |
3276 It is not allowed to change text or jump to another window while | |
3277 evaluating 'foldexpr' |textlock|. | |
7 | 3278 |
3279 *'foldignore'* *'fdi'* | |
3280 'foldignore' 'fdi' string (default: "#") | |
3281 local to window | |
3282 {not in Vi} | |
3283 {not available when compiled without the |+folding| | |
3284 feature} | |
3285 Used only when 'foldmethod' is "indent". Lines starting with | |
3286 characters in 'foldignore' will get their fold level from surrounding | |
10 | 3287 lines. White space is skipped before checking for this character. |
7 | 3288 The default "#" works well for C programs. See |fold-indent|. |
3289 | |
3290 *'foldlevel'* *'fdl'* | |
3291 'foldlevel' 'fdl' number (default: 0) | |
3292 local to window | |
3293 {not in Vi} | |
3294 {not available when compiled without the |+folding| | |
3295 feature} | |
3296 Sets the fold level: Folds with a higher level will be closed. | |
3297 Setting this option to zero will close all folds. Higher numbers will | |
3298 close fewer folds. | |
3299 This option is set by commands like |zm|, |zM| and |zR|. | |
3300 See |fold-foldlevel|. | |
3301 | |
3302 *'foldlevelstart'* *'fdls'* | |
3303 'foldlevelstart' 'fdls' number (default: -1) | |
3304 global | |
3305 {not in Vi} | |
3306 {not available when compiled without the |+folding| | |
3307 feature} | |
3308 Sets 'foldlevel' when starting to edit another buffer in a window. | |
3309 Useful to always start editing with all folds closed (value zero), | |
3310 some folds closed (one) or no folds closed (99). | |
3311 This is done before reading any modeline, thus a setting in a modeline | |
10 | 3312 overrules this option. Starting to edit a file for |diff-mode| also |
7 | 3313 ignores this option and closes all folds. |
3314 It is also done before BufReadPre autocommands, to allow an autocmd to | |
3315 overrule the 'foldlevel' value for specific files. | |
3316 When the value is negative, it is not used. | |
3317 | |
3318 *'foldmarker'* *'fmr'* *E536* | |
3319 'foldmarker' 'fmr' string (default: "{{{,}}}") | |
3320 local to window | |
3321 {not in Vi} | |
3322 {not available when compiled without the |+folding| | |
3323 feature} | |
3324 The start and end marker used when 'foldmethod' is "marker". There | |
3325 must be one comma, which separates the start and end marker. The | |
3326 marker is a literal string (a regular expression would be too slow). | |
3327 See |fold-marker|. | |
3328 | |
3329 *'foldmethod'* *'fdm'* | |
3330 'foldmethod' 'fdm' string (default: "manual") | |
3331 local to window | |
3332 {not in Vi} | |
3333 {not available when compiled without the |+folding| | |
3334 feature} | |
3335 The kind of folding used for the current window. Possible values: | |
3336 |fold-manual| manual Folds are created manually. | |
3337 |fold-indent| indent Lines with equal indent form a fold. | |
3338 |fold-expr| expr 'foldexpr' gives the fold level of a line. | |
3339 |fold-marker| marker Markers are used to specify folds. | |
3340 |fold-syntax| syntax Syntax highlighting items specify folds. | |
3341 |fold-diff| diff Fold text that is not changed. | |
3342 | |
3343 *'foldminlines'* *'fml'* | |
3344 'foldminlines' 'fml' number (default: 1) | |
3345 local to window | |
3346 {not in Vi} | |
3347 {not available when compiled without the |+folding| | |
3348 feature} | |
2709 | 3349 Sets the number of screen lines above which a fold can be displayed |
3350 closed. Also for manually closed folds. With the default value of | |
3351 one a fold can only be closed if it takes up two or more screen lines. | |
3352 Set to zero to be able to close folds of just one screen line. | |
2826 | 3353 Note that this only has an effect on what is displayed. After using |
7 | 3354 "zc" to close a fold, which is displayed open because it's smaller |
3355 than 'foldminlines', a following "zc" may close a containing fold. | |
3356 | |
3357 *'foldnestmax'* *'fdn'* | |
3358 'foldnestmax' 'fdn' number (default: 20) | |
3359 local to window | |
3360 {not in Vi} | |
3361 {not available when compiled without the |+folding| | |
3362 feature} | |
3363 Sets the maximum nesting of folds for the "indent" and "syntax" | |
3364 methods. This avoids that too many folds will be created. Using more | |
3365 than 20 doesn't work, because the internal limit is 20. | |
3366 | |
3367 *'foldopen'* *'fdo'* | |
3368 'foldopen' 'fdo' string (default: "block,hor,mark,percent,quickfix, | |
3369 search,tag,undo") | |
3370 global | |
3371 {not in Vi} | |
3372 {not available when compiled without the |+folding| | |
3373 feature} | |
3374 Specifies for which type of commands folds will be opened, if the | |
3375 command moves the cursor into a closed fold. It is a comma separated | |
3376 list of items. | |
2625 | 3377 NOTE: When the command is part of a mapping this option is not used. |
3378 Add the |zv| command to the mapping to get the same effect. | |
3379 (rationale: the mapping may want to control opening folds itself) | |
3380 | |
7 | 3381 item commands ~ |
3382 all any | |
3383 block "(", "{", "[[", "[{", etc. | |
3384 hor horizontal movements: "l", "w", "fx", etc. | |
3385 insert any command in Insert mode | |
3386 jump far jumps: "G", "gg", etc. | |
3387 mark jumping to a mark: "'m", CTRL-O, etc. | |
3388 percent "%" | |
3389 quickfix ":cn", ":crew", ":make", etc. | |
3390 search search for a pattern: "/", "n", "*", "gd", etc. | |
3391 (not for a search pattern in a ":" command) | |
819 | 3392 Also for |[s| and |]s|. |
7 | 3393 tag jumping to a tag: ":ta", CTRL-T, etc. |
3394 undo undo or redo: "u" and CTRL-R | |
3395 When a movement command is used for an operator (e.g., "dl" or "y%") | |
3396 this option is not used. This means the operator will include the | |
3397 whole closed fold. | |
3398 Note that vertical movements are not here, because it would make it | |
3399 very difficult to move onto a closed fold. | |
3400 In insert mode the folds containing the cursor will always be open | |
3401 when text is inserted. | |
3402 To close folds you can re-apply 'foldlevel' with the |zx| command or | |
3403 set the 'foldclose' option to "all". | |
3404 | |
3405 *'foldtext'* *'fdt'* | |
3406 'foldtext' 'fdt' string (default: "foldtext()") | |
3407 local to window | |
3408 {not in Vi} | |
3409 {not available when compiled without the |+folding| | |
3410 feature} | |
3411 An expression which is used to specify the text displayed for a closed | |
3412 fold. See |fold-foldtext|. | |
3413 | |
3682 | 3414 The expression will be evaluated in the |sandbox| if set from a |
3415 modeline, see |sandbox-option|. | |
634 | 3416 |
3417 It is not allowed to change text or jump to another window while | |
3418 evaluating 'foldtext' |textlock|. | |
3419 | |
9286
64035abb986b
commit https://github.com/vim/vim/commit/c95a302a4c42ec8230473cd4a5e0064d0a143aa8
Christian Brabandt <cb@256bit.org>
parents:
9227
diff
changeset
|
3420 *'formatexpr'* *'fex'* |
64035abb986b
commit https://github.com/vim/vim/commit/c95a302a4c42ec8230473cd4a5e0064d0a143aa8
Christian Brabandt <cb@256bit.org>
parents:
9227
diff
changeset
|
3421 'formatexpr' 'fex' string (default "") |
64035abb986b
commit https://github.com/vim/vim/commit/c95a302a4c42ec8230473cd4a5e0064d0a143aa8
Christian Brabandt <cb@256bit.org>
parents:
9227
diff
changeset
|
3422 local to buffer |
64035abb986b
commit https://github.com/vim/vim/commit/c95a302a4c42ec8230473cd4a5e0064d0a143aa8
Christian Brabandt <cb@256bit.org>
parents:
9227
diff
changeset
|
3423 {not in Vi} |
64035abb986b
commit https://github.com/vim/vim/commit/c95a302a4c42ec8230473cd4a5e0064d0a143aa8
Christian Brabandt <cb@256bit.org>
parents:
9227
diff
changeset
|
3424 {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
|
3425 feature} |
64035abb986b
commit https://github.com/vim/vim/commit/c95a302a4c42ec8230473cd4a5e0064d0a143aa8
Christian Brabandt <cb@256bit.org>
parents:
9227
diff
changeset
|
3426 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
|
3427 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
|
3428 option is empty 'formatprg' is used. |
64035abb986b
commit https://github.com/vim/vim/commit/c95a302a4c42ec8230473cd4a5e0064d0a143aa8
Christian Brabandt <cb@256bit.org>
parents:
9227
diff
changeset
|
3429 |
64035abb986b
commit https://github.com/vim/vim/commit/c95a302a4c42ec8230473cd4a5e0064d0a143aa8
Christian Brabandt <cb@256bit.org>
parents:
9227
diff
changeset
|
3430 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
|
3431 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
|
3432 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
|
3433 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
|
3434 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
|
3435 it yet! |
64035abb986b
commit https://github.com/vim/vim/commit/c95a302a4c42ec8230473cd4a5e0064d0a143aa8
Christian Brabandt <cb@256bit.org>
parents:
9227
diff
changeset
|
3436 |
64035abb986b
commit https://github.com/vim/vim/commit/c95a302a4c42ec8230473cd4a5e0064d0a143aa8
Christian Brabandt <cb@256bit.org>
parents:
9227
diff
changeset
|
3437 Example: > |
64035abb986b
commit https://github.com/vim/vim/commit/c95a302a4c42ec8230473cd4a5e0064d0a143aa8
Christian Brabandt <cb@256bit.org>
parents:
9227
diff
changeset
|
3438 :set formatexpr=mylang#Format() |
64035abb986b
commit https://github.com/vim/vim/commit/c95a302a4c42ec8230473cd4a5e0064d0a143aa8
Christian Brabandt <cb@256bit.org>
parents:
9227
diff
changeset
|
3439 < 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
|
3440 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
|
3441 |
64035abb986b
commit https://github.com/vim/vim/commit/c95a302a4c42ec8230473cd4a5e0064d0a143aa8
Christian Brabandt <cb@256bit.org>
parents:
9227
diff
changeset
|
3442 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
|
3443 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
|
3444 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
|
3445 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
|
3446 return "i" or "R" in this situation. |
64035abb986b
commit https://github.com/vim/vim/commit/c95a302a4c42ec8230473cd4a5e0064d0a143aa8
Christian Brabandt <cb@256bit.org>
parents:
9227
diff
changeset
|
3447 |
64035abb986b
commit https://github.com/vim/vim/commit/c95a302a4c42ec8230473cd4a5e0064d0a143aa8
Christian Brabandt <cb@256bit.org>
parents:
9227
diff
changeset
|
3448 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
|
3449 the internal format mechanism. |
64035abb986b
commit https://github.com/vim/vim/commit/c95a302a4c42ec8230473cd4a5e0064d0a143aa8
Christian Brabandt <cb@256bit.org>
parents:
9227
diff
changeset
|
3450 |
64035abb986b
commit https://github.com/vim/vim/commit/c95a302a4c42ec8230473cd4a5e0064d0a143aa8
Christian Brabandt <cb@256bit.org>
parents:
9227
diff
changeset
|
3451 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
|
3452 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
|
3453 since changing the buffer text is not allowed. |
11160 | 3454 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
|
3455 |
7 | 3456 *'formatoptions'* *'fo'* |
3457 'formatoptions' 'fo' string (Vim default: "tcq", Vi default: "vt") | |
3458 local to buffer | |
3459 {not in Vi} | |
3460 This is a sequence of letters which describes how automatic | |
3461 formatting is to be done. See |fo-table|. When the 'paste' option is | |
3462 on, no formatting is done (like 'formatoptions' is empty). Commas can | |
3463 be inserted for readability. | |
3464 To avoid problems with flags that are added in the future, use the | |
3465 "+=" and "-=" feature of ":set" |add-option-flags|. | |
3466 NOTE: This option is set to the Vi default value when 'compatible' is | |
3467 set and to the Vim default value when 'compatible' is reset. | |
3468 | |
41 | 3469 *'formatlistpat'* *'flp'* |
3470 'formatlistpat' 'flp' string (default: "^\s*\d\+[\]:.)}\t ]\s*") | |
3471 local to buffer | |
3472 {not in Vi} | |
3473 A pattern that is used to recognize a list header. This is used for | |
3474 the "n" flag in 'formatoptions'. | |
3475 The pattern must match exactly the text that will be the indent for | |
140 | 3476 the line below it. You can use |/\ze| to mark the end of the match |
41 | 3477 while still checking more characters. There must be a character |
3478 following the pattern, when it matches the whole line it is handled | |
3479 like there is no match. | |
3480 The default recognizes a number, followed by an optional punctuation | |
3481 character and white space. | |
3482 | |
7 | 3483 *'formatprg'* *'fp'* |
3484 '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
|
3485 global or local to buffer |global-local| |
7 | 3486 {not in Vi} |
3487 The name of an external program that will be used to format the lines | |
667 | 3488 selected with the |gq| operator. The program must take the input on |
7 | 3489 stdin and produce the output on stdout. The Unix program "fmt" is |
557 | 3490 such a program. |
667 | 3491 If the 'formatexpr' option is not empty it will be used instead. |
3492 Otherwise, if 'formatprg' option is an empty string, the internal | |
3493 format function will be used |C-indenting|. | |
557 | 3494 Environment variables are expanded |:set_env|. See |option-backslash| |
3495 about including spaces and backslashes. | |
3682 | 3496 This option cannot be set from a |modeline| or in the |sandbox|, for |
3497 security reasons. | |
667 | 3498 |
7196
42717d048817
commit https://github.com/vim/vim/commit/d94464ee294a351ce7b6ba18e8bd3f24f1bef920
Christian Brabandt <cb@256bit.org>
parents:
7147
diff
changeset
|
3499 *'fsync'* *'fs'* *'nofsync'* *'nofs'* |
36 | 3500 'fsync' 'fs' boolean (default on) |
3501 global | |
3502 {not in Vi} | |
3503 When on, the library function fsync() will be called after writing a | |
3504 file. This will flush a file to disk, ensuring that it is safely | |
3505 written even on filesystems which do metadata-only journaling. This | |
3506 will force the harddrive to spin up on Linux systems running in laptop | |
3507 mode, so it may be undesirable in some situations. Be warned that | |
3508 turning this off increases the chances of data loss after a crash. On | |
3509 systems without an fsync() implementation, this variable is always | |
3510 off. | |
3511 Also see 'swapsync' for controlling fsync() on swap files. | |
3512 | |
7 | 3513 *'gdefault'* *'gd'* *'nogdefault'* *'nogd'* |
3514 'gdefault' 'gd' boolean (default off) | |
3515 global | |
3516 {not in Vi} | |
3517 When on, the ":substitute" flag 'g' is default on. This means that | |
3518 all matches in a line are substituted instead of one. When a 'g' flag | |
3519 is given to a ":substitute" command, this will toggle the substitution | |
3520 of all or one match. See |complex-change|. | |
3521 | |
3522 command 'gdefault' on 'gdefault' off ~ | |
3523 :s/// subst. all subst. one | |
3524 :s///g subst. one subst. all | |
3525 :s///gg subst. all subst. one | |
3526 | |
3527 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
|
3528 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
|
3529 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
|
3530 has the opposite effect of that it normally does. |
7 | 3531 |
3532 *'grepformat'* *'gfm'* | |
6213 | 3533 'grepformat' 'gfm' string (default "%f:%l:%m,%f:%l%m,%f %l%m") |
7 | 3534 global |
3535 {not in Vi} | |
3536 Format to recognize for the ":grep" command output. | |
3537 This is a scanf-like string that uses the same format as the | |
3538 'errorformat' option: see |errorformat|. | |
3539 | |
3540 *'grepprg'* *'gp'* | |
3541 'grepprg' 'gp' string (default "grep -n ", | |
3542 Unix: "grep -n $* /dev/null", | |
3543 Win32: "findstr /n" or "grep -n", | |
3544 VMS: "SEARCH/NUMBERS ") | |
3545 global or local to buffer |global-local| | |
3546 {not in Vi} | |
233 | 3547 Program to use for the |:grep| command. This option may contain '%' |
7 | 3548 and '#' characters, which are expanded like when used in a command- |
3549 line. The placeholder "$*" is allowed to specify where the arguments | |
3550 will be included. Environment variables are expanded |:set_env|. See | |
3551 |option-backslash| about including spaces and backslashes. | |
3552 When your "grep" accepts the "-H" argument, use this to make ":grep" | |
3553 also work well with a single file: > | |
3554 :set grepprg=grep\ -nH | |
161 | 3555 < Special value: When 'grepprg' is set to "internal" the |:grep| command |
657 | 3556 works like |:vimgrep|, |:lgrep| like |:lvimgrep|, |:grepadd| like |
3557 |:vimgrepadd| and |:lgrepadd| like |:lvimgrepadd|. | |
41 | 3558 See also the section |:make_makeprg|, since most of the comments there |
7 | 3559 apply equally to 'grepprg'. |
3560 For Win32, the default is "findstr /n" if "findstr.exe" can be found, | |
3561 otherwise it's "grep -n". | |
3562 This option cannot be set from a |modeline| or in the |sandbox|, for | |
3563 security reasons. | |
3564 | |
3565 *'guicursor'* *'gcr'* *E545* *E546* *E548* *E549* | |
3566 'guicursor' 'gcr' string (default "n-v-c:block-Cursor/lCursor, | |
3567 ve:ver35-Cursor, | |
3568 o:hor50-Cursor, | |
3569 i-ci:ver25-Cursor/lCursor, | |
3570 r-cr:hor20-Cursor/lCursor, | |
3571 sm:block-Cursor | |
3572 -blinkwait175-blinkoff150-blinkon175", | |
3573 for MS-DOS and Win32 console: | |
3574 "n-v-c:block,o:hor50,i-ci:hor15, | |
3575 r-cr:hor30,sm:block") | |
3576 global | |
3577 {not in Vi} | |
3578 {only available when compiled with GUI enabled, and | |
3579 for MS-DOS and Win32 console} | |
3580 This option tells Vim what the cursor should look like in different | |
10 | 3581 modes. It fully works in the GUI. In an MSDOS or Win32 console, only |
7 | 3582 the height of the cursor can be changed. This can be done by |
3583 specifying a block cursor, or a percentage for a vertical or | |
3584 horizontal cursor. | |
6727 | 3585 For a console the 't_SI', 't_SR', and 't_EI' escape sequences are |
3586 used. | |
7 | 3587 |
10 | 3588 The option is a comma separated list of parts. Each part consist of a |
7 | 3589 mode-list and an argument-list: |
3590 mode-list:argument-list,mode-list:argument-list,.. | |
3591 The mode-list is a dash separated list of these modes: | |
3592 n Normal mode | |
3593 v Visual mode | |
3594 ve Visual mode with 'selection' "exclusive" (same as 'v', | |
3595 if not specified) | |
3596 o Operator-pending mode | |
3597 i Insert mode | |
3598 r Replace mode | |
3599 c Command-line Normal (append) mode | |
3600 ci Command-line Insert mode | |
3601 cr Command-line Replace mode | |
3602 sm showmatch in Insert mode | |
3603 a all modes | |
3604 The argument-list is a dash separated list of these arguments: | |
3605 hor{N} horizontal bar, {N} percent of the character height | |
3606 ver{N} vertical bar, {N} percent of the character width | |
3607 block block cursor, fills the whole character | |
3608 [only one of the above three should be present] | |
3609 blinkwait{N} *cursor-blinking* | |
3610 blinkon{N} | |
3611 blinkoff{N} | |
3612 blink times for cursor: blinkwait is the delay before | |
3613 the cursor starts blinking, blinkon is the time that | |
3614 the cursor is shown and blinkoff is the time that the | |
3615 cursor is not shown. The times are in msec. When one | |
3616 of the numbers is zero, there is no blinking. The | |
3617 default is: "blinkwait700-blinkon400-blinkoff250". | |
3618 These numbers are used for a missing entry. This | |
3619 means that blinking is enabled by default. To switch | |
3620 blinking off you can use "blinkon0". The cursor only | |
3621 blinks when Vim is waiting for input, not while | |
3622 executing a command. | |
3623 To make the cursor blink in an xterm, see | |
3624 |xterm-blink|. | |
3625 {group-name} | |
3626 a highlight group name, that sets the color and font | |
3627 for the cursor | |
3628 {group-name}/{group-name} | |
3629 Two highlight group names, the first is used when | |
3630 no language mappings are used, the other when they | |
3631 are. |language-mapping| | |
3632 | |
3633 Examples of parts: | |
3634 n-c-v:block-nCursor in Normal, Command-line and Visual mode, use a | |
3635 block cursor with colors from the "nCursor" | |
3636 highlight group | |
3637 i-ci:ver30-iCursor-blinkwait300-blinkon200-blinkoff150 | |
3638 In Insert and Command-line Insert mode, use a | |
3639 30% vertical bar cursor with colors from the | |
3640 "iCursor" highlight group. Blink a bit | |
3641 faster. | |
3642 | |
3643 The 'a' mode is different. It will set the given argument-list for | |
3644 all modes. It does not reset anything to defaults. This can be used | |
3645 to do a common setting for all modes. For example, to switch off | |
3646 blinking: "a:blinkon0" | |
3647 | |
3648 Examples of cursor highlighting: > | |
3649 :highlight Cursor gui=reverse guifg=NONE guibg=NONE | |
3650 :highlight Cursor gui=NONE guifg=bg guibg=fg | |
3651 < | |
3652 *'guifont'* *'gfn'* | |
2908 | 3653 *E235* *E596* |
7 | 3654 'guifont' 'gfn' string (default "") |
3655 global | |
3656 {not in Vi} | |
3657 {only available when compiled with GUI enabled} | |
3658 This is a list of fonts which will be used for the GUI version of Vim. | |
3659 In its simplest form the value is just one font name. When | |
3660 the font cannot be found you will get an error message. To try other | |
3661 font names a list can be specified, font names separated with commas. | |
3662 The first valid font is used. | |
8 | 3663 |
170 | 3664 On systems where 'guifontset' is supported (X11) and 'guifontset' is |
3665 not empty, then 'guifont' is not used. | |
8 | 3666 |
10895
c391bfbdb452
Updated runtime files.
Christian Brabandt <cb@256bit.org>
parents:
10734
diff
changeset
|
3667 Note: As to the GTK GUIs, no error is given against any invalid names, |
c391bfbdb452
Updated runtime files.
Christian Brabandt <cb@256bit.org>
parents:
10734
diff
changeset
|
3668 and the first element of the list is always picked up and made use of. |
c391bfbdb452
Updated runtime files.
Christian Brabandt <cb@256bit.org>
parents:
10734
diff
changeset
|
3669 This is because, instead of identifying a given name with a font, the |
c391bfbdb452
Updated runtime files.
Christian Brabandt <cb@256bit.org>
parents:
10734
diff
changeset
|
3670 GTK GUIs use it to construct a pattern and try to look up a font which |
c391bfbdb452
Updated runtime files.
Christian Brabandt <cb@256bit.org>
parents:
10734
diff
changeset
|
3671 best matches the pattern among available fonts, and this way, the |
c391bfbdb452
Updated runtime files.
Christian Brabandt <cb@256bit.org>
parents:
10734
diff
changeset
|
3672 matching never fails. An invalid name doesn't matter because a number |
c391bfbdb452
Updated runtime files.
Christian Brabandt <cb@256bit.org>
parents:
10734
diff
changeset
|
3673 of font properties other than name will do to get the matching done. |
c391bfbdb452
Updated runtime files.
Christian Brabandt <cb@256bit.org>
parents:
10734
diff
changeset
|
3674 |
7 | 3675 Spaces after a comma are ignored. To include a comma in a font name |
3676 precede it with a backslash. Setting an option requires an extra | |
3677 backslash before a space and a backslash. See also | |
3678 |option-backslash|. For example: > | |
3679 :set guifont=Screen15,\ 7x13,font\\,with\\,commas | |
8 | 3680 < will make Vim try to use the font "Screen15" first, and if it fails it |
7 | 3681 will try to use "7x13" and then "font,with,commas" instead. |
8 | 3682 |
3683 If none of the fonts can be loaded, Vim will keep the current setting. | |
3684 If an empty font list is given, Vim will try using other resource | |
3685 settings (for X, it will use the Vim.font resource), and finally it | |
3686 will try some builtin default which should always be there ("7x13" in | |
3687 the case of X). The font names given should be "normal" fonts. Vim | |
3688 will try to find the related bold and italic fonts. | |
3689 | |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
3690 For Win32, GTK, Motif, Mac OS and Photon: > |
8 | 3691 :set guifont=* |
3692 < will bring up a font requester, where you can pick the font you want. | |
3693 | |
3694 The font name depends on the GUI used. See |setting-guifont| for a | |
3695 way to set 'guifont' for various systems. | |
3696 | |
10895
c391bfbdb452
Updated runtime files.
Christian Brabandt <cb@256bit.org>
parents:
10734
diff
changeset
|
3697 For the GTK+ 2 and 3 GUIs, the font name looks like this: > |
7 | 3698 :set guifont=Andale\ Mono\ 11 |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
3699 < That's all. XLFDs are not used. For Chinese this is reported to work |
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
3700 well: > |
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
3701 if has("gui_gtk2") |
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
3702 set guifont=Bitstream\ Vera\ Sans\ Mono\ 12,Fixed\ 12 |
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
3703 set guifontwide=Microsoft\ Yahei\ 12,WenQuanYi\ Zen\ Hei\ 12 |
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
3704 endif |
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
3705 < |
10895
c391bfbdb452
Updated runtime files.
Christian Brabandt <cb@256bit.org>
parents:
10734
diff
changeset
|
3706 (Replace gui_gtk2 with gui_gtk3 for the GTK+ 3 GUI) |
c391bfbdb452
Updated runtime files.
Christian Brabandt <cb@256bit.org>
parents:
10734
diff
changeset
|
3707 |
170 | 3708 For Mac OSX you can use something like this: > |
3709 :set guifont=Monaco:h10 | |
853 | 3710 < Also see 'macatsui', it can help fix display problems. |
3711 *E236* | |
7 | 3712 Note that the fonts must be mono-spaced (all characters have the same |
10895
c391bfbdb452
Updated runtime files.
Christian Brabandt <cb@256bit.org>
parents:
10734
diff
changeset
|
3713 width). An exception is GTK: all fonts are accepted, but mono-spaced |
c391bfbdb452
Updated runtime files.
Christian Brabandt <cb@256bit.org>
parents:
10734
diff
changeset
|
3714 fonts look best. |
8 | 3715 |
7 | 3716 To preview a font on X11, you might be able to use the "xfontsel" |
3717 program. The "xlsfonts" program gives a list of all available fonts. | |
8 | 3718 |
7 | 3719 For the Win32 GUI *E244* *E245* |
3720 - takes these options in the font name: | |
3721 hXX - height is XX (points, can be floating-point) | |
3722 wXX - width is XX (points, can be floating-point) | |
3723 b - bold | |
3724 i - italic | |
3725 u - underline | |
3726 s - strikeout | |
233 | 3727 cXX - character set XX. Valid charsets are: ANSI, ARABIC, |
7 | 3728 BALTIC, CHINESEBIG5, DEFAULT, EASTEUROPE, GB2312, GREEK, |
3729 HANGEUL, HEBREW, JOHAB, MAC, OEM, RUSSIAN, SHIFTJIS, | |
3730 SYMBOL, THAI, TURKISH, VIETNAMESE ANSI and BALTIC. | |
22 | 3731 Normally you would use "cDEFAULT". |
8876
47f17f66da3d
commit https://github.com/vim/vim/commit/03413f44167c4b5cd0012def9bb331e2518c83cf
Christian Brabandt <cb@256bit.org>
parents:
8835
diff
changeset
|
3732 qXX - quality XX. Valid quality names are: PROOF, DRAFT, |
9097
071f9da012fb
commit https://github.com/vim/vim/commit/06d2d38ab7564e1f784b1058a4ef4580cd6d1810
Christian Brabandt <cb@256bit.org>
parents:
9027
diff
changeset
|
3733 ANTIALIASED, NONANTIALIASED, CLEARTYPE, DEFAULT. |
8835
c1a5623cfc86
commit https://github.com/vim/vim/commit/7c1c6dbb6817640fd3956a0d5417da23fde336d8
Christian Brabandt <cb@256bit.org>
parents:
8748
diff
changeset
|
3734 Normally you would use "qDEFAULT". |
9887
b4da19b7539f
commit https://github.com/vim/vim/commit/dc1f1645cb495fa6bfbe216d7359f23539a0e25d
Christian Brabandt <cb@256bit.org>
parents:
9877
diff
changeset
|
3735 Some quality values are not supported in legacy OSs. |
7 | 3736 |
3737 Use a ':' to separate the options. | |
3738 - A '_' can be used in the place of a space, so you don't need to use | |
3739 backslashes to escape the spaces. | |
3740 - Examples: > | |
3741 :set guifont=courier_new:h12:w5:b:cRUSSIAN | |
3742 :set guifont=Andale_Mono:h7.5:w4.5 | |
3743 < See also |font-sizes|. | |
3744 | |
3745 *'guifontset'* *'gfs'* | |
3746 *E250* *E252* *E234* *E597* *E598* | |
3747 'guifontset' 'gfs' string (default "") | |
3748 global | |
3749 {not in Vi} | |
3750 {only available when compiled with GUI enabled and | |
3751 with the |+xfontset| feature} | |
10895
c391bfbdb452
Updated runtime files.
Christian Brabandt <cb@256bit.org>
parents:
10734
diff
changeset
|
3752 {not available in the GTK+ GUI} |
7 | 3753 When not empty, specifies two (or more) fonts to be used. The first |
3754 one for normal English, the second one for your special language. See | |
3755 |xfontset|. | |
3756 Setting this option also means that all font names will be handled as | |
3757 a fontset name. Also the ones used for the "font" argument of the | |
3758 |:highlight| command. | |
3759 The fonts must match with the current locale. If fonts for the | |
3760 character sets that the current locale uses are not included, setting | |
3761 'guifontset' will fail. | |
3762 Note the difference between 'guifont' and 'guifontset': In 'guifont' | |
3763 the comma-separated names are alternative names, one of which will be | |
3764 used. In 'guifontset' the whole string is one fontset name, | |
3765 including the commas. It is not possible to specify alternative | |
3766 fontset names. | |
3767 This example works on many X11 systems: > | |
3768 :set guifontset=-*-*-medium-r-normal--16-*-*-*-c-*-*-* | |
3769 < | |
3770 *'guifontwide'* *'gfw'* *E231* *E533* *E534* | |
3771 'guifontwide' 'gfw' string (default "") | |
3772 global | |
3773 {not in Vi} | |
3774 {only available when compiled with GUI enabled} | |
3775 When not empty, specifies a comma-separated list of fonts to be used | |
3776 for double-width characters. The first font that can be loaded is | |
3777 used. | |
3778 Note: The size of these fonts must be exactly twice as wide as the one | |
3779 specified with 'guifont' and the same height. | |
3780 | |
10895
c391bfbdb452
Updated runtime files.
Christian Brabandt <cb@256bit.org>
parents:
10734
diff
changeset
|
3781 All GUI versions but GTK+: |
7 | 3782 |
3783 'guifontwide' is only used when 'encoding' is set to "utf-8" and | |
3784 'guifontset' is empty or invalid. | |
3785 When 'guifont' is set and a valid font is found in it and | |
3786 'guifontwide' is empty Vim will attempt to find a matching | |
3787 double-width font and set 'guifontwide' to it. | |
3788 | |
10895
c391bfbdb452
Updated runtime files.
Christian Brabandt <cb@256bit.org>
parents:
10734
diff
changeset
|
3789 GTK+ GUI only: *guifontwide_gtk* |
7 | 3790 |
3791 If set and valid, 'guifontwide' is always used for double width | |
3792 characters, even if 'encoding' is not set to "utf-8". | |
3793 Vim does not attempt to find an appropriate value for 'guifontwide' | |
10 | 3794 automatically. If 'guifontwide' is empty Pango/Xft will choose the |
7 | 3795 font for characters not available in 'guifont'. Thus you do not need |
3796 to set 'guifontwide' at all unless you want to override the choice | |
3797 made by Pango/Xft. | |
3798 | |
4055 | 3799 Windows +multibyte only: *guifontwide_win_mbyte* |
3800 | |
4073 | 3801 If set and valid, 'guifontwide' is used for IME instead of 'guifont'. |
4055 | 3802 |
7 | 3803 *'guiheadroom'* *'ghr'* |
3804 'guiheadroom' 'ghr' number (default 50) | |
3805 global | |
3806 {not in Vi} {only for GTK and X11 GUI} | |
3807 The number of pixels subtracted from the screen height when fitting | |
3808 the GUI window on the screen. Set this before the GUI is started, | |
3809 e.g., in your |gvimrc| file. When zero, the whole screen height will | |
10 | 3810 be used by the window. When positive, the specified number of pixel |
7 | 3811 lines will be left for window decorations and other items on the |
3812 screen. Set it to a negative value to allow windows taller than the | |
3813 screen. | |
3814 | |
3815 *'guioptions'* *'go'* | |
9669
284b4eb307fc
commit https://github.com/vim/vim/commit/8c08b5b569e2a9e9f63dea514591ecfa2d3bb392
Christian Brabandt <cb@256bit.org>
parents:
9665
diff
changeset
|
3816 'guioptions' 'go' string (default "egmrLtT" (MS-Windows, "t" is |
284b4eb307fc
commit https://github.com/vim/vim/commit/8c08b5b569e2a9e9f63dea514591ecfa2d3bb392
Christian Brabandt <cb@256bit.org>
parents:
9665
diff
changeset
|
3817 removed in |defaults.vim|), |
284b4eb307fc
commit https://github.com/vim/vim/commit/8c08b5b569e2a9e9f63dea514591ecfa2d3bb392
Christian Brabandt <cb@256bit.org>
parents:
9665
diff
changeset
|
3818 "aegimrLtT" (GTK, Motif and Athena), |
284b4eb307fc
commit https://github.com/vim/vim/commit/8c08b5b569e2a9e9f63dea514591ecfa2d3bb392
Christian Brabandt <cb@256bit.org>
parents:
9665
diff
changeset
|
3819 ) |
7 | 3820 global |
3821 {not in Vi} | |
3822 {only available when compiled with GUI enabled} | |
8 | 3823 This option only has an effect in the GUI version of Vim. It is a |
7 | 3824 sequence of letters which describes what components and options of the |
3825 GUI should be used. | |
3826 To avoid problems with flags that are added in the future, use the | |
3827 "+=" and "-=" feature of ":set" |add-option-flags|. | |
3828 | |
3829 Valid letters are as follows: | |
1152 | 3830 *guioptions_a* *'go-a'* |
7 | 3831 'a' Autoselect: If present, then whenever VISUAL mode is started, |
3832 or the Visual area extended, Vim tries to become the owner of | |
3833 the windowing system's global selection. This means that the | |
3834 Visually highlighted text is available for pasting into other | |
3835 applications as well as into Vim itself. When the Visual mode | |
3836 ends, possibly due to an operation on the text, or when an | |
3837 application wants to paste the selection, the highlighted text | |
3838 is automatically yanked into the "* selection register. | |
3839 Thus the selection is still available for pasting into other | |
3840 applications after the VISUAL mode has ended. | |
3841 If not present, then Vim won't become the owner of the | |
3842 windowing system's global selection unless explicitly told to | |
3843 by a yank or delete operation for the "* register. | |
3844 The same applies to the modeless selection. | |
3674 | 3845 *'go-P'* |
3846 '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
|
3847 register. |
1152 | 3848 *'go-A'* |
10 | 3849 'A' Autoselect for the modeless selection. Like 'a', but only |
7 | 3850 applies to the modeless selection. |
3851 | |
3852 'guioptions' autoselect Visual autoselect modeless ~ | |
3853 "" - - | |
3854 "a" yes yes | |
3855 "A" - yes | |
3856 "aA" yes yes | |
3857 | |
1152 | 3858 *'go-c'* |
7 | 3859 'c' Use console dialogs instead of popup dialogs for simple |
3860 choices. | |
1152 | 3861 *'go-e'* |
697 | 3862 'e' Add tab pages when indicated with 'showtabline'. |
688 | 3863 'guitablabel' can be used to change the text in the labels. |
3864 When 'e' is missing a non-GUI tab pages line may be used. | |
857 | 3865 The GUI tabs are only supported on some systems, currently |
1621 | 3866 GTK, Motif, Mac OS/X and MS-Windows. |
1152 | 3867 *'go-f'* |
7 | 3868 'f' Foreground: Don't use fork() to detach the GUI from the shell |
3869 where it was started. Use this for programs that wait for the | |
3870 editor to finish (e.g., an e-mail program). Alternatively you | |
3871 can use "gvim -f" or ":gui -f" to start the GUI in the | |
3872 foreground. |gui-fork| | |
3873 Note: Set this option in the vimrc file. The forking may have | |
819 | 3874 happened already when the |gvimrc| file is read. |
1152 | 3875 *'go-i'* |
7 | 3876 'i' Use a Vim icon. For GTK with KDE it is used in the left-upper |
3877 corner of the window. It's black&white on non-GTK, because of | |
3878 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
|
3879 *'go-m'* |
7 | 3880 'm' Menu bar is present. |
2290
22529abcd646
Fixed ":s" message. Docs updates.
Bram Moolenaar <bram@vim.org>
parents:
2283
diff
changeset
|
3881 *'go-M'* |
10 | 3882 'M' The system menu "$VIMRUNTIME/menu.vim" is not sourced. Note |
7 | 3883 that this flag must be added in the .vimrc file, before |
819 | 3884 switching on syntax or filetype recognition (when the |gvimrc| |
7 | 3885 file is sourced the system menu has already been loaded; the |
3886 ":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
|
3887 *'go-g'* |
7 | 3888 'g' Grey menu items: Make menu items that are not active grey. If |
3889 'g' is not included inactive menu items are not shown at all. | |
3890 Exception: Athena will always use grey menu items. | |
1152 | 3891 *'go-t'* |
7 | 3892 't' Include tearoff menu items. Currently only works for Win32, |
3893 GTK+, and Motif 1.2 GUI. | |
1152 | 3894 *'go-T'* |
236 | 3895 'T' Include Toolbar. Currently only in Win32, GTK+, Motif, Photon |
856 | 3896 and Athena GUIs. |
1152 | 3897 *'go-r'* |
7 | 3898 'r' Right-hand scrollbar is always present. |
2290
22529abcd646
Fixed ":s" message. Docs updates.
Bram Moolenaar <bram@vim.org>
parents:
2283
diff
changeset
|
3899 *'go-R'* |
7 | 3900 'R' Right-hand scrollbar is present when there is a vertically |
3901 split window. | |
2290
22529abcd646
Fixed ":s" message. Docs updates.
Bram Moolenaar <bram@vim.org>
parents:
2283
diff
changeset
|
3902 *'go-l'* |
7 | 3903 'l' Left-hand scrollbar is always present. |
2290
22529abcd646
Fixed ":s" message. Docs updates.
Bram Moolenaar <bram@vim.org>
parents:
2283
diff
changeset
|
3904 *'go-L'* |
7 | 3905 'L' Left-hand scrollbar is present when there is a vertically |
3906 split window. | |
1152 | 3907 *'go-b'* |
7 | 3908 'b' Bottom (horizontal) scrollbar is present. Its size depends on |
3909 the longest visible line, or on the cursor line if the 'h' | |
3910 flag is included. |gui-horiz-scroll| | |
2290
22529abcd646
Fixed ":s" message. Docs updates.
Bram Moolenaar <bram@vim.org>
parents:
2283
diff
changeset
|
3911 *'go-h'* |
7 | 3912 'h' Limit horizontal scrollbar size to the length of the cursor |
3913 line. Reduces computations. |gui-horiz-scroll| | |
3914 | |
3915 And yes, you may even have scrollbars on the left AND the right if | |
3916 you really want to :-). See |gui-scrollbars| for more information. | |
3917 | |
2290
22529abcd646
Fixed ":s" message. Docs updates.
Bram Moolenaar <bram@vim.org>
parents:
2283
diff
changeset
|
3918 *'go-v'* |
7 | 3919 'v' Use a vertical button layout for dialogs. When not included, |
3920 a horizontal layout is preferred, but when it doesn't fit a | |
3921 vertical layout is used anyway. | |
2290
22529abcd646
Fixed ":s" message. Docs updates.
Bram Moolenaar <bram@vim.org>
parents:
2283
diff
changeset
|
3922 *'go-p'* |
7 | 3923 'p' Use Pointer callbacks for X11 GUI. This is required for some |
3924 window managers. If the cursor is not blinking or hollow at | |
3925 the right moment, try adding this flag. This must be done | |
819 | 3926 before starting the GUI. Set it in your |gvimrc|. Adding or |
7 | 3927 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
|
3928 *'go-F'* |
10 | 3929 'F' Add a footer. Only for Motif. See |gui-footer|. |
7 | 3930 |
1152 | 3931 |
7 | 3932 *'guipty'* *'noguipty'* |
3933 'guipty' boolean (default on) | |
3934 global | |
3935 {not in Vi} | |
3936 {only available when compiled with GUI enabled} | |
3937 Only in the GUI: If on, an attempt is made to open a pseudo-tty for | |
3938 I/O to/from shell commands. See |gui-pty|. | |
3939 | |
688 | 3940 *'guitablabel'* *'gtl'* |
3941 'guitablabel' 'gtl' string (default empty) | |
3942 global | |
3943 {not in Vi} | |
692 | 3944 {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
|
3945 with the |+windows| feature} |
688 | 3946 When nonempty describes the text to use in a label of the GUI tab |
857 | 3947 pages line. When empty and when the result is empty Vim will use a |
3948 default label. See |setting-guitablabel| for more info. | |
688 | 3949 |
692 | 3950 The format of this option is like that of 'statusline'. |
839 | 3951 '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
|
3952 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
|
3953 modeline, see |sandbox-option|. |
692 | 3954 |
688 | 3955 Only used when the GUI tab pages line is displayed. 'e' must be |
3956 present in 'guioptions'. For the non-GUI tab pages line 'tabline' is | |
3957 used. | |
3958 | |
839 | 3959 *'guitabtooltip'* *'gtt'* |
3960 'guitabtooltip' 'gtt' string (default empty) | |
3961 global | |
3962 {not in Vi} | |
3963 {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
|
3964 with the |+windows| feature} |
839 | 3965 When nonempty describes the text to use in a tooltip for the GUI tab |
3966 pages line. When empty Vim will use a default tooltip. | |
3967 This option is otherwise just like 'guitablabel' above. | |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
3968 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
|
3969 :let &guitabtooltip = "line one\nline two" |
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
3970 < |
839 | 3971 |
7 | 3972 *'helpfile'* *'hf'* |
3973 'helpfile' 'hf' string (default (MSDOS) "$VIMRUNTIME\doc\help.txt" | |
3974 (others) "$VIMRUNTIME/doc/help.txt") | |
3975 global | |
3976 {not in Vi} | |
3977 Name of the main help file. All distributed help files should be | |
3978 placed together in one directory. Additionally, all "doc" directories | |
3979 in 'runtimepath' will be used. | |
3980 Environment variables are expanded |:set_env|. For example: | |
3981 "$VIMRUNTIME/doc/help.txt". If $VIMRUNTIME is not set, $VIM is also | |
10 | 3982 tried. Also see |$VIMRUNTIME| and |option-backslash| about including |
7 | 3983 spaces and backslashes. |
3984 This option cannot be set from a |modeline| or in the |sandbox|, for | |
3985 security reasons. | |
3986 | |
3987 *'helpheight'* *'hh'* | |
3988 'helpheight' 'hh' number (default 20) | |
3989 global | |
3990 {not in Vi} | |
2570
71b56b4e7785
Make the references to features in the help more consistent. (Sylvain Hitier)
Bram Moolenaar <bram@vim.org>
parents:
2561
diff
changeset
|
3991 {not available when compiled without the |+windows| |
7 | 3992 feature} |
3993 Minimal initial height of the help window when it is opened with the | |
3994 ":help" command. The initial height of the help window is half of the | |
3995 current window, or (when the 'ea' option is on) the same as other | |
3996 windows. When the height is less than 'helpheight', the height is | |
3997 set to 'helpheight'. Set to zero to disable. | |
3998 | |
3999 *'helplang'* *'hlg'* | |
4000 'helplang' 'hlg' string (default: messages language or empty) | |
4001 global | |
4002 {only available when compiled with the |+multi_lang| | |
4003 feature} | |
4004 {not in Vi} | |
4005 Comma separated list of languages. Vim will use the first language | |
4006 for which the desired help can be found. The English help will always | |
4007 be used as a last resort. You can add "en" to prefer English over | |
4008 another language, but that will only find tags that exist in that | |
4009 language and not in the English help. | |
4010 Example: > | |
4011 :set helplang=de,it | |
4012 < This will first search German, then Italian and finally English help | |
4013 files. | |
4014 When using |CTRL-]| and ":help!" in a non-English help file Vim will | |
4015 try to find the tag in the current language before using this option. | |
4016 See |help-translated|. | |
4017 | |
4018 *'hidden'* *'hid'* *'nohidden'* *'nohid'* | |
4019 'hidden' 'hid' boolean (default off) | |
4020 global | |
4021 {not in Vi} | |
4022 When off a buffer is unloaded when it is |abandon|ed. When on a | |
4023 buffer becomes hidden when it is |abandon|ed. If the buffer is still | |
4024 displayed in another window, it does not become hidden, of course. | |
4025 The commands that move through the buffer list sometimes make a buffer | |
4026 hidden although the 'hidden' option is off: When the buffer is | |
4027 modified, 'autowrite' is off or writing is not possible, and the '!' | |
10 | 4028 flag was used. See also |windows.txt|. |
12 | 4029 To only make one buffer hidden use the 'bufhidden' option. |
7 | 4030 This option is set for one command with ":hide {command}" |:hide|. |
4031 WARNING: It's easy to forget that you have changes in hidden buffers. | |
4032 Think twice when using ":q!" or ":qa!". | |
4033 | |
4034 *'highlight'* *'hl'* | |
4035 '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
|
4036 "8:SpecialKey,~:EndOfBuffer,@:NonText, |
7da89d9c744b
commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents:
9860
diff
changeset
|
4037 d:Directory,e:ErrorMsg,i:IncSearch, |
7da89d9c744b
commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents:
9860
diff
changeset
|
4038 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
|
4039 N:CursorLineNr,r:Question,s:StatusLine, |
7da89d9c744b
commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents:
9860
diff
changeset
|
4040 S:StatusLineNC,c:VertSplit,t:Title, |
7da89d9c744b
commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents:
9860
diff
changeset
|
4041 v:Visual,w:WarningMsg,W:WildMenu,f:Folded, |
7da89d9c744b
commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents:
9860
diff
changeset
|
4042 F:FoldColumn,A:DiffAdd,C:DiffChange, |
7da89d9c744b
commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents:
9860
diff
changeset
|
4043 D:DiffDelete,T:DiffText,>:SignColumn, |
7da89d9c744b
commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents:
9860
diff
changeset
|
4044 B:SpellBad,P:SpellCap,R:SpellRare, |
7da89d9c744b
commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents:
9860
diff
changeset
|
4045 L:SpellLocal,-:Conceal,+: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
|
4046 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
|
4047 #:TabLineSel,_:TabLineFill,!:CursorColumn, |
11914 | 4048 .:CursorLine,o:ColorColumn,q:QuickFixLine, |
12254 | 4049 z:StatusLineTerm,Z:StatusLineTermNC") |
7 | 4050 global |
4051 {not in Vi} | |
4052 This option can be used to set highlighting mode for various | |
4053 occasions. It is a comma separated list of character pairs. The | |
4054 first character in a pair gives the occasion, the second the mode to | |
10 | 4055 use for that occasion. The occasions are: |
7 | 4056 |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
|
4057 |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
|
4058 |hl-NonText| @ '@' at the end of the window and |
7 | 4059 characters from 'showbreak' |
4060 |hl-Directory| d directories in CTRL-D listing and other special | |
4061 things in listings | |
4062 |hl-ErrorMsg| e error messages | |
4063 h (obsolete, ignored) | |
4064 |hl-IncSearch| i 'incsearch' highlighting | |
4065 |hl-Search| l last search pattern highlighting (see 'hlsearch') | |
4066 |hl-MoreMsg| m |more-prompt| | |
4067 |hl-ModeMsg| M Mode (e.g., "-- INSERT --") | |
2178
c6f1aa1e9f32
Add 'relativenumber' patch from Markus Heidelberg.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
4068 |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
|
4069 when 'number' or 'relativenumber' option is set. |
4073 | 4070 |hl-CursorLineNr| N like n for when 'cursorline' or 'relativenumber' is |
4071 set. | |
7 | 4072 |hl-Question| r |hit-enter| prompt and yes/no questions |
4073 |hl-StatusLine| s status line of current window |status-line| | |
4074 |hl-StatusLineNC| S status lines of not-current windows | |
4075 |hl-Title| t Titles for output from ":set all", ":autocmd" etc. | |
4076 |hl-VertSplit| c column used to separate vertically split windows | |
4077 |hl-Visual| v Visual mode | |
4078 |hl-VisualNOS| V Visual mode when Vim does is "Not Owning the | |
4079 Selection" Only X11 Gui's |gui-x11| and | |
4080 |xterm-clipboard|. | |
4081 |hl-WarningMsg| w warning messages | |
4082 |hl-WildMenu| W wildcard matches displayed for 'wildmenu' | |
4083 |hl-Folded| f line used for closed folds | |
4084 |hl-FoldColumn| F 'foldcolumn' | |
386 | 4085 |hl-DiffAdd| A added line in diff mode |
4086 |hl-DiffChange| C changed line in diff mode | |
4087 |hl-DiffDelete| D deleted line in diff mode | |
4088 |hl-DiffText| T inserted text in diff mode | |
7 | 4089 |hl-SignColumn| > column used for |signs| |
221 | 4090 |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
|
4091 |hl-SpellCap| P word that should start with capital |spell| |
221 | 4092 |hl-SpellRare| R rare word |spell| |
4093 |hl-SpellLocal| L word from other region |spell| | |
2250
1bac28a53fae
Add the conceal patch from Vince Negri.
Bram Moolenaar <bram@vim.org>
parents:
2249
diff
changeset
|
4094 |hl-Conceal| - the placeholders used for concealed characters |
1bac28a53fae
Add the conceal patch from Vince Negri.
Bram Moolenaar <bram@vim.org>
parents:
2249
diff
changeset
|
4095 (see 'conceallevel') |
540 | 4096 |hl-Pmenu| + popup menu normal line |
4097 |hl-PmenuSel| = popup menu normal line | |
4098 |hl-PmenuSbar| x popup menu scrollbar | |
4099 |hl-PmenuThumb| X popup menu scrollbar thumb | |
7 | 4100 |
4101 The display modes are: | |
4102 r reverse (termcap entry "mr" and "me") | |
4103 i italic (termcap entry "ZH" and "ZR") | |
4104 b bold (termcap entry "md" and "me") | |
4105 s standout (termcap entry "so" and "se") | |
4106 u underline (termcap entry "us" and "ue") | |
205 | 4107 c undercurl (termcap entry "Cs" and "Ce") |
7 | 4108 n no highlighting |
4109 - no highlighting | |
4110 : use a highlight group | |
4111 The default is used for occasions that are not included. | |
4112 If you want to change what the display modes do, see |dos-colors| | |
4113 for an example. | |
4114 When using the ':' display mode, this must be followed by the name of | |
4115 a highlight group. A highlight group can be used to define any type | |
4116 of highlighting, including using color. See |:highlight| on how to | |
4117 define one. The default uses a different group for each occasion. | |
4118 See |highlight-default| for the default highlight groups. | |
4119 | |
4120 *'history'* *'hi'* | |
9669
284b4eb307fc
commit https://github.com/vim/vim/commit/8c08b5b569e2a9e9f63dea514591ecfa2d3bb392
Christian Brabandt <cb@256bit.org>
parents:
9665
diff
changeset
|
4121 '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
|
4122 set to 200 in |defaults.vim|) |
7 | 4123 global |
4124 {not in Vi} | |
4125 A history of ":" commands, and a history of previous search patterns | |
5991 | 4126 is remembered. This option decides how many entries may be stored in |
7 | 4127 each of these histories (see |cmdline-editing|). |
5991 | 4128 The maximum value is 10000. |
7 | 4129 NOTE: This option is set to the Vi default value when 'compatible' is |
4130 set and to the Vim default value when 'compatible' is reset. | |
4131 | |
4132 *'hkmap'* *'hk'* *'nohkmap'* *'nohk'* | |
4133 'hkmap' 'hk' boolean (default off) | |
4134 global | |
4135 {not in Vi} | |
4136 {only available when compiled with the |+rightleft| | |
4137 feature} | |
4138 When on, the keyboard is mapped for the Hebrew character set. | |
4139 Normally you would set 'allowrevins' and use CTRL-_ in insert mode to | |
4140 toggle this option. See |rileft.txt|. | |
4141 NOTE: This option is reset when 'compatible' is set. | |
4142 | |
4143 *'hkmapp'* *'hkp'* *'nohkmapp'* *'nohkp'* | |
4144 'hkmapp' 'hkp' boolean (default off) | |
4145 global | |
4146 {not in Vi} | |
4147 {only available when compiled with the |+rightleft| | |
4148 feature} | |
4149 When on, phonetic keyboard mapping is used. 'hkmap' must also be on. | |
4150 This is useful if you have a non-Hebrew keyboard. | |
4151 See |rileft.txt|. | |
4152 NOTE: This option is reset when 'compatible' is set. | |
4153 | |
11160 | 4154 *'hlsearch'* *'hls'* *'nohlsearch'* *'nohls'* |
4155 'hlsearch' 'hls' boolean (default off) | |
4156 global | |
4157 {not in Vi} | |
4158 {not available when compiled without the | |
4159 |+extra_search| feature} | |
4160 When there is a previous search pattern, highlight all its matches. | |
4161 The type of highlighting used can be set with the 'l' occasion in the | |
4162 'highlight' option. This uses the "Search" highlight group by | |
4163 default. Note that only the matching text is highlighted, any offsets | |
4164 are not applied. | |
4165 See also: 'incsearch' and |:match|. | |
4166 When you get bored looking at the highlighted matches, you can turn it | |
4167 off with |:nohlsearch|. This does not change the option value, as | |
4168 soon as you use a search command, the highlighting comes back. | |
4169 'redrawtime' specifies the maximum time spent on finding matches. | |
4170 When the search pattern can match an end-of-line, Vim will try to | |
4171 highlight all of the matched text. However, this depends on where the | |
4172 search starts. This will be the first line in the window or the first | |
4173 line below a closed fold. A match in a previous line which is not | |
4174 drawn may not continue in a newly drawn line. | |
4175 You can specify whether the highlight status is restored on startup | |
4176 with the 'h' flag in 'viminfo' |viminfo-h|. | |
4177 NOTE: This option is reset when 'compatible' is set. | |
4178 | |
7 | 4179 *'icon'* *'noicon'* |
4180 'icon' boolean (default off, on when title can be restored) | |
4181 global | |
4182 {not in Vi} | |
4183 {not available when compiled without the |+title| | |
4184 feature} | |
4185 When on, the icon text of the window will be set to the value of | |
4186 'iconstring' (if it is not empty), or to the name of the file | |
4187 currently being edited. Only the last part of the name is used. | |
4188 Overridden by the 'iconstring' option. | |
4189 Only works if the terminal supports setting window icons (currently | |
4190 only X11 GUI and terminals with a non-empty 't_IS' option - these are | |
4191 Unix xterm and iris-ansi by default, where 't_IS' is taken from the | |
4192 builtin termcap). | |
4193 When Vim was compiled with HAVE_X11 defined, the original icon will be | |
233 | 4194 restored if possible |X11|. See |X11-icon| for changing the icon on |
7 | 4195 X11. |
6259 | 4196 For MS-Windows the icon can be changed, see |windows-icon|. |
7 | 4197 |
4198 *'iconstring'* | |
4199 'iconstring' string (default "") | |
4200 global | |
4201 {not in Vi} | |
4202 {not available when compiled without the |+title| | |
4203 feature} | |
4204 When this option is not empty, it will be used for the icon text of | |
4205 the window. This happens only when the 'icon' option is on. | |
4206 Only works if the terminal supports setting window icon text | |
4207 (currently only X11 GUI and terminals with a non-empty 't_IS' option). | |
4208 Does not work for MS Windows. | |
4209 When Vim was compiled with HAVE_X11 defined, the original icon will be | |
4210 restored if possible |X11|. | |
4211 When this option contains printf-style '%' items, they will be | |
10 | 4212 expanded according to the rules used for 'statusline'. See |
7 | 4213 'titlestring' for example settings. |
4214 {not available when compiled without the |+statusline| feature} | |
4215 | |
4216 *'ignorecase'* *'ic'* *'noignorecase'* *'noic'* | |
4217 'ignorecase' 'ic' boolean (default off) | |
4218 global | |
4219 Ignore case in search patterns. Also used when searching in the tags | |
4220 file. | |
7266
6ba7182fb7bd
commit https://github.com/vim/vim/commit/0f6562e9036f889185dff49a75c7fc5ffb28b307
Christian Brabandt <cb@256bit.org>
parents:
7245
diff
changeset
|
4221 Also see 'smartcase' and 'tagcase'. |
7 | 4222 Can be overruled by using "\c" or "\C" in the pattern, see |
4223 |/ignorecase|. | |
4224 | |
5008
3717d569027d
updated for version 7.3.1248
Bram Moolenaar <bram@vim.org>
parents:
4869
diff
changeset
|
4225 *'imactivatefunc'* *'imaf'* |
3717d569027d
updated for version 7.3.1248
Bram Moolenaar <bram@vim.org>
parents:
4869
diff
changeset
|
4226 'imactivatefunc' 'imaf' string (default "") |
3717d569027d
updated for version 7.3.1248
Bram Moolenaar <bram@vim.org>
parents:
4869
diff
changeset
|
4227 global |
3717d569027d
updated for version 7.3.1248
Bram Moolenaar <bram@vim.org>
parents:
4869
diff
changeset
|
4228 {not in Vi} |
3717d569027d
updated for version 7.3.1248
Bram Moolenaar <bram@vim.org>
parents:
4869
diff
changeset
|
4229 {only available when compiled with |+xim| and |
3717d569027d
updated for version 7.3.1248
Bram Moolenaar <bram@vim.org>
parents:
4869
diff
changeset
|
4230 |+GUI_GTK|} |
3717d569027d
updated for version 7.3.1248
Bram Moolenaar <bram@vim.org>
parents:
4869
diff
changeset
|
4231 This option specifies a function that will be called to |
3717d569027d
updated for version 7.3.1248
Bram Moolenaar <bram@vim.org>
parents:
4869
diff
changeset
|
4232 activate/inactivate Input Method. |
3717d569027d
updated for version 7.3.1248
Bram Moolenaar <bram@vim.org>
parents:
4869
diff
changeset
|
4233 |
3717d569027d
updated for version 7.3.1248
Bram Moolenaar <bram@vim.org>
parents:
4869
diff
changeset
|
4234 Example: > |
3717d569027d
updated for version 7.3.1248
Bram Moolenaar <bram@vim.org>
parents:
4869
diff
changeset
|
4235 function ImActivateFunc(active) |
3717d569027d
updated for version 7.3.1248
Bram Moolenaar <bram@vim.org>
parents:
4869
diff
changeset
|
4236 if a:active |
3717d569027d
updated for version 7.3.1248
Bram Moolenaar <bram@vim.org>
parents:
4869
diff
changeset
|
4237 ... do something |
3717d569027d
updated for version 7.3.1248
Bram Moolenaar <bram@vim.org>
parents:
4869
diff
changeset
|
4238 else |
3717d569027d
updated for version 7.3.1248
Bram Moolenaar <bram@vim.org>
parents:
4869
diff
changeset
|
4239 ... do something |
3717d569027d
updated for version 7.3.1248
Bram Moolenaar <bram@vim.org>
parents:
4869
diff
changeset
|
4240 endif |
3717d569027d
updated for version 7.3.1248
Bram Moolenaar <bram@vim.org>
parents:
4869
diff
changeset
|
4241 " return value is not used |
3717d569027d
updated for version 7.3.1248
Bram Moolenaar <bram@vim.org>
parents:
4869
diff
changeset
|
4242 endfunction |
3717d569027d
updated for version 7.3.1248
Bram Moolenaar <bram@vim.org>
parents:
4869
diff
changeset
|
4243 set imactivatefunc=ImActivateFunc |
3717d569027d
updated for version 7.3.1248
Bram Moolenaar <bram@vim.org>
parents:
4869
diff
changeset
|
4244 < |
7 | 4245 *'imactivatekey'* *'imak'* |
4246 'imactivatekey' 'imak' string (default "") | |
4247 global | |
4248 {not in Vi} | |
4249 {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
|
4250 |+GUI_GTK|} *E599* |
7 | 4251 Specifies the key that your Input Method in X-Windows uses for |
4252 activation. When this is specified correctly, vim can fully control | |
4253 IM with 'imcmdline', 'iminsert' and 'imsearch'. | |
4254 You can't use this option to change the activation key, the option | |
4255 tells Vim what the key is. | |
4256 Format: | |
4257 [MODIFIER_FLAG-]KEY_STRING | |
4258 | |
4259 These characters can be used for MODIFIER_FLAG (case is ignored): | |
4260 S Shift key | |
4261 L Lock key | |
4262 C Control key | |
4263 1 Mod1 key | |
4264 2 Mod2 key | |
4265 3 Mod3 key | |
4266 4 Mod4 key | |
4267 5 Mod5 key | |
4268 Combinations are allowed, for example "S-C-space" or "SC-space" are | |
4269 both shift+ctrl+space. | |
4270 See <X11/keysymdef.h> and XStringToKeysym for KEY_STRING. | |
4271 | |
4272 Example: > | |
4273 :set imactivatekey=S-space | |
4274 < "S-space" means shift+space. This is the activation key for kinput2 + | |
4275 canna (Japanese), and ami (Korean). | |
4276 | |
4277 *'imcmdline'* *'imc'* *'noimcmdline'* *'noimc'* | |
4278 'imcmdline' 'imc' boolean (default off) | |
4279 global | |
4280 {not in Vi} | |
2570
71b56b4e7785
Make the references to features in the help more consistent. (Sylvain Hitier)
Bram Moolenaar <bram@vim.org>
parents:
2561
diff
changeset
|
4281 {only available when compiled with the |+xim|, |
71b56b4e7785
Make the references to features in the help more consistent. (Sylvain Hitier)
Bram Moolenaar <bram@vim.org>
parents:
2561
diff
changeset
|
4282 |+multi_byte_ime| or |global-ime| features} |
7 | 4283 When set the Input Method is always on when starting to edit a command |
4284 line, unless entering a search pattern (see 'imsearch' for that). | |
4285 Setting this option is useful when your input method allows entering | |
4286 English characters directly, e.g., when it's used to type accented | |
4287 characters with dead keys. | |
4288 | |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
4289 *'imdisable'* *'imd'* *'noimdisable'* *'noimd'* |
7 | 4290 'imdisable' 'imd' boolean (default off, on for some systems (SGI)) |
4291 global | |
4292 {not in Vi} | |
2570
71b56b4e7785
Make the references to features in the help more consistent. (Sylvain Hitier)
Bram Moolenaar <bram@vim.org>
parents:
2561
diff
changeset
|
4293 {only available when compiled with the |+xim|, |
71b56b4e7785
Make the references to features in the help more consistent. (Sylvain Hitier)
Bram Moolenaar <bram@vim.org>
parents:
2561
diff
changeset
|
4294 |+multi_byte_ime| or |global-ime| features} |
7 | 4295 When set the Input Method is never used. This is useful to disable |
4296 the IM when it doesn't work properly. | |
4297 Currently this option is on by default for SGI/IRIX machines. This | |
4298 may change in later releases. | |
4299 | |
4300 *'iminsert'* *'imi'* | |
4301 'iminsert' 'imi' number (default 0, 2 when an input method is supported) | |
4302 local to buffer | |
4303 {not in Vi} | |
4304 Specifies whether :lmap or an Input Method (IM) is to be used in | |
4305 Insert mode. Valid values: | |
4306 0 :lmap is off and IM is off | |
4307 1 :lmap is ON and IM is off | |
4308 2 :lmap is off and IM is ON | |
4309 2 is available only when compiled with the |+multi_byte_ime|, |+xim| | |
4310 or |global-ime|. | |
4311 To always reset the option to zero when leaving Insert mode with <Esc> | |
4312 this can be used: > | |
4313 :inoremap <ESC> <ESC>:set iminsert=0<CR> | |
4314 < This makes :lmap and IM turn off automatically when leaving Insert | |
4315 mode. | |
4316 Note that this option changes when using CTRL-^ in Insert mode | |
4317 |i_CTRL-^|. | |
4318 The value is set to 1 when setting 'keymap' to a valid keymap name. | |
4319 It is also used for the argument of commands like "r" and "f". | |
4320 The value 0 may not work correctly with Athena and Motif with some XIM | |
4321 methods. Use 'imdisable' to disable XIM then. | |
4322 | |
4323 *'imsearch'* *'ims'* | |
4324 'imsearch' 'ims' number (default 0, 2 when an input method is supported) | |
4325 local to buffer | |
4326 {not in Vi} | |
4327 Specifies whether :lmap or an Input Method (IM) is to be used when | |
4328 entering a search pattern. Valid values: | |
4329 -1 the value of 'iminsert' is used, makes it look like | |
4330 'iminsert' is also used when typing a search pattern | |
4331 0 :lmap is off and IM is off | |
4332 1 :lmap is ON and IM is off | |
4333 2 :lmap is off and IM is ON | |
4334 Note that this option changes when using CTRL-^ in Command-line mode | |
4335 |c_CTRL-^|. | |
4336 The value is set to 1 when it is not -1 and setting the 'keymap' | |
4337 option to a valid keymap name. | |
4338 The value 0 may not work correctly with Athena and Motif with some XIM | |
4339 methods. Use 'imdisable' to disable XIM then. | |
4340 | |
5008
3717d569027d
updated for version 7.3.1248
Bram Moolenaar <bram@vim.org>
parents:
4869
diff
changeset
|
4341 *'imstatusfunc'* *'imsf'* |
3717d569027d
updated for version 7.3.1248
Bram Moolenaar <bram@vim.org>
parents:
4869
diff
changeset
|
4342 'imstatusfunc' 'imsf' string (default "") |
3717d569027d
updated for version 7.3.1248
Bram Moolenaar <bram@vim.org>
parents:
4869
diff
changeset
|
4343 global |
3717d569027d
updated for version 7.3.1248
Bram Moolenaar <bram@vim.org>
parents:
4869
diff
changeset
|
4344 {not in Vi} |
3717d569027d
updated for version 7.3.1248
Bram Moolenaar <bram@vim.org>
parents:
4869
diff
changeset
|
4345 {only available when compiled with |+xim| and |
3717d569027d
updated for version 7.3.1248
Bram Moolenaar <bram@vim.org>
parents:
4869
diff
changeset
|
4346 |+GUI_GTK|} |
3717d569027d
updated for version 7.3.1248
Bram Moolenaar <bram@vim.org>
parents:
4869
diff
changeset
|
4347 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
|
4348 of Input Method. It must return a positive number when IME is active. |
3717d569027d
updated for version 7.3.1248
Bram Moolenaar <bram@vim.org>
parents:
4869
diff
changeset
|
4349 |
3717d569027d
updated for version 7.3.1248
Bram Moolenaar <bram@vim.org>
parents:
4869
diff
changeset
|
4350 Example: > |
3717d569027d
updated for version 7.3.1248
Bram Moolenaar <bram@vim.org>
parents:
4869
diff
changeset
|
4351 function ImStatusFunc() |
3717d569027d
updated for version 7.3.1248
Bram Moolenaar <bram@vim.org>
parents:
4869
diff
changeset
|
4352 let is_active = ...do something |
3717d569027d
updated for version 7.3.1248
Bram Moolenaar <bram@vim.org>
parents:
4869
diff
changeset
|
4353 return is_active ? 1 : 0 |
3717d569027d
updated for version 7.3.1248
Bram Moolenaar <bram@vim.org>
parents:
4869
diff
changeset
|
4354 endfunction |
3717d569027d
updated for version 7.3.1248
Bram Moolenaar <bram@vim.org>
parents:
4869
diff
changeset
|
4355 set imstatusfunc=ImStatusFunc |
3717d569027d
updated for version 7.3.1248
Bram Moolenaar <bram@vim.org>
parents:
4869
diff
changeset
|
4356 < |
3717d569027d
updated for version 7.3.1248
Bram Moolenaar <bram@vim.org>
parents:
4869
diff
changeset
|
4357 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
|
4358 |
7 | 4359 *'include'* *'inc'* |
4360 'include' 'inc' string (default "^\s*#\s*include") | |
4361 global or local to buffer |global-local| | |
4362 {not in Vi} | |
4363 {not available when compiled without the | |
4364 |+find_in_path| feature} | |
10 | 4365 Pattern to be used to find an include command. It is a search |
7 | 4366 pattern, just like for the "/" command (See |pattern|). The default |
4367 value is for C programs. This option is used for the commands "[i", | |
532 | 4368 "]I", "[d", etc. |
4369 Normally the 'isfname' option is used to recognize the file name that | |
534 | 4370 comes after the matched pattern. But if "\zs" appears in the pattern |
4371 then the text matched from "\zs" to the end, or until "\ze" if it | |
4372 appears, is used as the file name. Use this to include characters | |
4373 that are not in 'isfname', such as a space. You can then use | |
4374 'includeexpr' to process the matched text. | |
532 | 4375 See |option-backslash| about including spaces and backslashes. |
7 | 4376 |
4377 *'includeexpr'* *'inex'* | |
4378 'includeexpr' 'inex' string (default "") | |
4379 local to buffer | |
4380 {not in Vi} | |
4381 {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
|
4382 |+find_in_path| or |+eval| features} |
7 | 4383 Expression to be used to transform the string found with the 'include' |
10 | 4384 option to a file name. Mostly useful to change "." to "/" for Java: > |
7 | 4385 :set includeexpr=substitute(v:fname,'\\.','/','g') |
4386 < The "v:fname" variable will be set to the file name that was detected. | |
634 | 4387 |
7 | 4388 Also used for the |gf| command if an unmodified file name can't be |
10 | 4389 found. Allows doing "gf" on the name after an 'include' statement. |
7 | 4390 Also used for |<cfile>|. |
4391 | |
3682 | 4392 The expression will be evaluated in the |sandbox| when set from a |
4393 modeline, see |sandbox-option|. | |
634 | 4394 |
4395 It is not allowed to change text or jump to another window while | |
4396 evaluating 'includeexpr' |textlock|. | |
4397 | |
7 | 4398 *'incsearch'* *'is'* *'noincsearch'* *'nois'* |
9669
284b4eb307fc
commit https://github.com/vim/vim/commit/8c08b5b569e2a9e9f63dea514591ecfa2d3bb392
Christian Brabandt <cb@256bit.org>
parents:
9665
diff
changeset
|
4399 '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
|
4400 +reltime feature is supported) |
7 | 4401 global |
4402 {not in Vi} | |
4403 {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
|
4404 |+extra_search| features} |
17 | 4405 While typing a search command, show where the pattern, as it was typed |
4406 so far, matches. The matched string is highlighted. If the pattern | |
4407 is invalid or not found, nothing is shown. The screen will be updated | |
4408 often, this is only useful on fast terminals. | |
4409 Note that the match will be shown, but the cursor will return to its | |
4410 original position when no match is found and when pressing <Esc>. You | |
4411 still need to finish the search command with <Enter> to move the | |
4412 cursor to the match. | |
10261
bdd7fc1a38c0
commit https://github.com/vim/vim/commit/dc08328821a2c11e33dfb1980332e4923ec64fca
Christian Brabandt <cb@256bit.org>
parents:
10244
diff
changeset
|
4413 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
|
4414 previous match. |c_CTRL-G| |c_CTRL-T| |
1521 | 4415 When compiled with the |+reltime| feature Vim only searches for about |
4416 half a second. With a complicated pattern and/or a lot of text the | |
4417 match may not be found. This is to avoid that Vim hangs while you | |
4418 are typing the pattern. | |
17 | 4419 The highlighting can be set with the 'i' flag in 'highlight'. |
4420 See also: 'hlsearch'. | |
772 | 4421 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
|
4422 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
|
4423 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
|
4424 converted to lowercase. |
772 | 4425 CTRL-R CTRL-W can be used to add the word at the end of the current |
4426 match, excluding the characters that were already typed. | |
7 | 4427 NOTE: This option is reset when 'compatible' is set. |
4428 | |
4429 *'indentexpr'* *'inde'* | |
4430 'indentexpr' 'inde' string (default "") | |
4431 local to buffer | |
4432 {not in Vi} | |
4433 {not available when compiled without the |+cindent| | |
4434 or |+eval| features} | |
4435 Expression which is evaluated to obtain the proper indent for a line. | |
4436 It is used when a new line is created, for the |=| operator and | |
4437 in Insert mode as specified with the 'indentkeys' option. | |
4438 When this option is not empty, it overrules the 'cindent' and | |
2833 | 4439 'smartindent' indenting. When 'lisp' is set, this option is |
4440 overridden by the Lisp indentation algorithm. | |
7 | 4441 When 'paste' is set this option is not used for indenting. |
4442 The expression is evaluated with |v:lnum| set to the line number for | |
534 | 4443 which the indent is to be computed. The cursor is also in this line |
7 | 4444 when the expression is evaluated (but it may be moved around). |
4445 The expression must return the number of spaces worth of indent. It | |
4446 can return "-1" to keep the current indent (this means 'autoindent' is | |
4447 used for the indent). | |
4448 Functions useful for computing the indent are |indent()|, |cindent()| | |
4449 and |lispindent()|. | |
4450 The evaluation of the expression must not have side effects! It must | |
4451 not change the text, jump to another window, etc. Afterwards the | |
4452 cursor position is always restored, thus the cursor may be moved. | |
4453 Normally this option would be set to call a function: > | |
4454 :set indentexpr=GetMyIndent() | |
4455 < Error messages will be suppressed, unless the 'debug' option contains | |
4456 "msg". | |
634 | 4457 See |indent-expression|. |
11160 | 4458 NOTE: This option is set to "" when 'compatible' is set. |
7 | 4459 |
3682 | 4460 The expression will be evaluated in the |sandbox| when set from a |
4461 modeline, see |sandbox-option|. | |
634 | 4462 |
4463 It is not allowed to change text or jump to another window while | |
4464 evaluating 'indentexpr' |textlock|. | |
4465 | |
4466 | |
7 | 4467 *'indentkeys'* *'indk'* |
4468 'indentkeys' 'indk' string (default "0{,0},:,0#,!^F,o,O,e") | |
4469 local to buffer | |
4470 {not in Vi} | |
4471 {not available when compiled without the |+cindent| | |
4472 feature} | |
4473 A list of keys that, when typed in Insert mode, cause reindenting of | |
4474 the current line. Only happens if 'indentexpr' isn't empty. | |
4475 The format is identical to 'cinkeys', see |indentkeys-format|. | |
4476 See |C-indenting| and |indent-expression|. | |
4477 | |
4478 *'infercase'* *'inf'* *'noinfercase'* *'noinf'* | |
4479 'infercase' 'inf' boolean (default off) | |
4480 local to buffer | |
4481 {not in Vi} | |
4482 When doing keyword completion in insert mode |ins-completion|, and | |
1621 | 4483 'ignorecase' is also on, the case of the match is adjusted depending |
4484 on the typed text. If the typed text contains a lowercase letter | |
4485 where the match has an upper case letter, the completed part is made | |
4486 lowercase. If the typed text has no lowercase letters and the match | |
4487 has a lowercase letter where the typed text has an uppercase letter, | |
4488 and there is a letter before it, the completed part is made uppercase. | |
4489 With 'noinfercase' the match is used as-is. | |
7 | 4490 |
4491 *'insertmode'* *'im'* *'noinsertmode'* *'noim'* | |
4492 'insertmode' 'im' boolean (default off) | |
4493 global | |
4494 {not in Vi} | |
4495 Makes Vim work in a way that Insert mode is the default mode. Useful | |
4496 if you want to use Vim as a modeless editor. Used for |evim|. | |
4497 These Insert mode commands will be useful: | |
4498 - 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
|
4499 - Use CTRL-O to execute one Normal mode command |i_CTRL-O|. When |
7 | 4500 this is a mapping, it is executed as if 'insertmode' was off. |
4501 Normal mode remains active until the mapping is finished. | |
4502 - Use CTRL-L to execute a number of Normal mode commands, then use | |
477 | 4503 <Esc> to get back to Insert mode. Note that CTRL-L moves the cursor |
4504 left, like <Esc> does when 'insertmode' isn't set. |i_CTRL-L| | |
7 | 4505 |
4506 These items change when 'insertmode' is set: | |
4507 - when starting to edit of a file, Vim goes to Insert mode. | |
4508 - <Esc> in Insert mode is a no-op and beeps. | |
4509 - <Esc> in Normal mode makes Vim go to Insert mode. | |
4510 - CTRL-L in Insert mode is a command, it is not inserted. | |
4511 - CTRL-Z in Insert mode suspends Vim, see |CTRL-Z|. *i_CTRL-Z* | |
4512 However, when <Esc> is used inside a mapping, it behaves like | |
4513 'insertmode' was not set. This was done to be able to use the same | |
4514 mappings with 'insertmode' set or not set. | |
4515 When executing commands with |:normal| 'insertmode' is not used. | |
4516 | |
4517 NOTE: This option is reset when 'compatible' is set. | |
4518 | |
4519 *'isfname'* *'isf'* | |
4520 'isfname' 'isf' string (default for MS-DOS, Win32 and OS/2: | |
4521 "@,48-57,/,\,.,-,_,+,,,#,$,%,{,},[,],:,@-@,!,~,=" | |
4522 for AMIGA: "@,48-57,/,.,-,_,+,,,$,:" | |
4523 for VMS: "@,48-57,/,.,-,_,+,,,#,$,%,<,>,[,],:,;,~" | |
4524 for OS/390: "@,240-249,/,.,-,_,+,,,#,$,%,~,=" | |
4525 otherwise: "@,48-57,/,.,-,_,+,,,#,$,%,~,=") | |
4526 global | |
4527 {not in Vi} | |
4528 The characters specified by this option are included in file names and | |
4529 path names. Filenames are used for commands like "gf", "[i" and in | |
10 | 4530 the tags file. It is also used for "\f" in a |pattern|. |
7 | 4531 Multi-byte characters 256 and above are always included, only the |
4532 characters up to 255 are specified with this option. | |
4533 For UTF-8 the characters 0xa0 to 0xff are included as well. | |
1621 | 4534 Think twice before adding white space to this option. Although a |
4535 space may appear inside a file name, the effect will be that Vim | |
4536 doesn't know where a file name starts or ends when doing completion. | |
4537 It most likely works better without a space in 'isfname'. | |
7 | 4538 |
4539 Note that on systems using a backslash as path separator, Vim tries to | |
4540 do its best to make it work as you would expect. That is a bit | |
4541 tricky, since Vi originally used the backslash to escape special | |
4542 characters. Vim will not remove a backslash in front of a normal file | |
4543 name character on these systems, but it will on Unix and alikes. The | |
4544 '&' and '^' are not included by default, because these are special for | |
4545 cmd.exe. | |
4546 | |
4547 The format of this option is a list of parts, separated with commas. | |
10 | 4548 Each part can be a single character number or a range. A range is two |
4549 character numbers with '-' in between. A character number can be a | |
7 | 4550 decimal number between 0 and 255 or the ASCII character itself (does |
4551 not work for digits). Example: | |
4552 "_,-,128-140,#-43" (include '_' and '-' and the range | |
4553 128 to 140 and '#' to 43) | |
4554 If a part starts with '^', the following character number or range | |
4555 will be excluded from the option. The option is interpreted from left | |
4556 to right. Put the excluded character after the range where it is | |
4557 included. To include '^' itself use it as the last character of the | |
4558 option or the end of a range. Example: | |
4559 "^a-z,#,^" (exclude 'a' to 'z', include '#' and '^') | |
4560 If the character is '@', all characters where isalpha() returns TRUE | |
4561 are included. Normally these are the characters a to z and A to Z, | |
4562 plus accented characters. To include '@' itself use "@-@". Examples: | |
4563 "@,^a-z" All alphabetic characters, excluding lower | |
1621 | 4564 case ASCII letters. |
7 | 4565 "a-z,A-Z,@-@" All letters plus the '@' character. |
4566 A comma can be included by using it where a character number is | |
4567 expected. Example: | |
4568 "48-57,,,_" Digits, comma and underscore. | |
4569 A comma can be excluded by prepending a '^'. Example: | |
4570 " -~,^,,9" All characters from space to '~', excluding | |
4571 comma, plus <Tab>. | |
4572 See |option-backslash| about including spaces and backslashes. | |
4573 | |
4574 *'isident'* *'isi'* | |
4575 'isident' 'isi' string (default for MS-DOS, Win32 and OS/2: | |
4576 "@,48-57,_,128-167,224-235" | |
4577 otherwise: "@,48-57,_,192-255") | |
4578 global | |
4579 {not in Vi} | |
4580 The characters given by this option are included in identifiers. | |
4581 Identifiers are used in recognizing environment variables and after a | |
4582 match of the 'define' option. It is also used for "\i" in a | |
233 | 4583 |pattern|. See 'isfname' for a description of the format of this |
7 | 4584 option. |
4585 Careful: If you change this option, it might break expanding | |
10 | 4586 environment variables. E.g., when '/' is included and Vim tries to |
7 | 4587 expand "$HOME/.viminfo". Maybe you should change 'iskeyword' instead. |
4588 | |
4589 *'iskeyword'* *'isk'* | |
4590 'iskeyword' 'isk' string (Vim default for MS-DOS and Win32: | |
4591 "@,48-57,_,128-167,224-235" | |
4592 otherwise: "@,48-57,_,192-255" | |
4593 Vi default: "@,48-57,_") | |
4594 local to buffer | |
4595 {not in Vi} | |
4596 Keywords are used in searching and recognizing with many commands: | |
10 | 4597 "w", "*", "[i", etc. It is also used for "\k" in a |pattern|. See |
7 | 4598 'isfname' for a description of the format of this option. For C |
4599 programs you could use "a-z,A-Z,48-57,_,.,-,>". | |
4600 For a help file it is set to all non-blank printable characters except | |
4601 '*', '"' and '|' (so that CTRL-] on a command finds the help for that | |
4602 command). | |
4603 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
|
4604 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
|
4605 uses |:syn-iskeyword|. |
7 | 4606 NOTE: This option is set to the Vi default value when 'compatible' is |
4607 set and to the Vim default value when 'compatible' is reset. | |
4608 | |
4609 *'isprint'* *'isp'* | |
4610 'isprint' 'isp' string (default for MS-DOS, Win32, OS/2 and Macintosh: | |
4611 "@,~-255"; otherwise: "@,161-255") | |
4612 global | |
4613 {not in Vi} | |
4614 The characters given by this option are displayed directly on the | |
4615 screen. It is also used for "\p" in a |pattern|. The characters from | |
4616 space (ASCII 32) to '~' (ASCII 126) are always displayed directly, | |
4617 even when they are not included in 'isprint' or excluded. See | |
4618 'isfname' for a description of the format of this option. | |
4619 | |
4620 Non-printable characters are displayed with two characters: | |
4621 0 - 31 "^@" - "^_" | |
4622 32 - 126 always single characters | |
4623 127 "^?" | |
4624 128 - 159 "~@" - "~_" | |
4625 160 - 254 "| " - "|~" | |
4626 255 "~?" | |
4627 When 'encoding' is a Unicode one, illegal bytes from 128 to 255 are | |
4628 displayed as <xx>, with the hexadecimal value of the byte. | |
4629 When 'display' contains "uhex" all unprintable characters are | |
4630 displayed as <xx>. | |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
4631 The SpecialKey highlighting will be used for unprintable characters. |
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
4632 |hl-SpecialKey| |
7 | 4633 |
4634 Multi-byte characters 256 and above are always included, only the | |
4635 characters up to 255 are specified with this option. When a character | |
4636 is printable but it is not available in the current font, a | |
4637 replacement character will be shown. | |
4638 Unprintable and zero-width Unicode characters are displayed as <xxxx>. | |
4639 There is no option to specify these characters. | |
4640 | |
4641 *'joinspaces'* *'js'* *'nojoinspaces'* *'nojs'* | |
4642 'joinspaces' 'js' boolean (default on) | |
4643 global | |
4644 {not in Vi} | |
4645 Insert two spaces after a '.', '?' and '!' with a join command. | |
4646 When 'cpoptions' includes the 'j' flag, only do this after a '.'. | |
4647 Otherwise only one space is inserted. | |
4648 NOTE: This option is set when 'compatible' is set. | |
4649 | |
4650 *'key'* | |
4651 'key' string (default "") | |
4652 local to buffer | |
4653 {not in Vi} | |
2283
7e1bd501306d
Mainly documentation updates.
Bram Moolenaar <bram@vim.org>
parents:
2265
diff
changeset
|
4654 {only available when compiled with the |+cryptv| |
7e1bd501306d
Mainly documentation updates.
Bram Moolenaar <bram@vim.org>
parents:
2265
diff
changeset
|
4655 feature} |
7 | 4656 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
|
4657 See |encryption| and 'cryptmethod'. |
7 | 4658 Careful: Do not set the key value by hand, someone might see the typed |
4659 key. Use the |:X| command. But you can make 'key' empty: > | |
4660 :set key= | |
4661 < It is not possible to get the value of this option with ":set key" or | |
4662 "echo &key". This is to avoid showing it to someone who shouldn't | |
4663 know. It also means you cannot see it yourself once you have set it, | |
4664 be careful not to make a typing error! | |
2698
b6471224d2af
Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents:
2681
diff
changeset
|
4665 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
|
4666 enabled. When 'key' is set it returns "*****" (five stars). |
7 | 4667 |
4668 *'keymap'* *'kmp'* *E544* | |
4669 'keymap' 'kmp' string (default "") | |
4670 local to buffer | |
4671 {not in Vi} | |
4672 {only available when compiled with the |+keymap| | |
4673 feature} | |
4674 Name of a keyboard mapping. See |mbyte-keymap|. | |
4675 Setting this option to a valid keymap name has the side effect of | |
4676 setting 'iminsert' to one, so that the keymap becomes effective. | |
4677 'imsearch' is also set to one, unless it was -1 | |
36 | 4678 Only normal file name characters can be used, "/\*?[|<>" are illegal. |
7 | 4679 |
4680 *'keymodel'* *'km'* | |
4681 'keymodel' 'km' string (default "") | |
4682 global | |
4683 {not in Vi} | |
4684 List of comma separated words, which enable special things that keys | |
4685 can do. These values can be used: | |
4686 startsel Using a shifted special key starts selection (either | |
4687 Select mode or Visual mode, depending on "key" being | |
4688 present in 'selectmode'). | |
4689 stopsel Using a not-shifted special key stops selection. | |
4690 Special keys in this context are the cursor keys, <End>, <Home>, | |
4691 <PageUp> and <PageDown>. | |
4692 The 'keymodel' option is set by the |:behave| command. | |
4693 | |
4694 *'keywordprg'* *'kp'* | |
4695 '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
|
4696 VMS: "help") |
7 | 4697 global or local to buffer |global-local| |
4698 {not in Vi} | |
4699 Program to use for the |K| command. Environment variables are | |
4700 expanded |:set_env|. ":help" may be used to access the Vim internal | |
4701 help. (Note that previously setting the global option to the empty | |
4702 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
|
4703 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
|
4704 Ex command prefixed with [count]. |
0d52ddff8db4
commit https://github.com/vim/vim/commit/2ff8b64679242e73248774a388d54931c9ce49bd
Christian Brabandt <cb@256bit.org>
parents:
9097
diff
changeset
|
4705 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
|
4706 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
|
4707 argument. For "man -s" the "-s" is removed when there is no count. |
7 | 4708 See |option-backslash| about including spaces and backslashes. |
4709 Example: > | |
4710 :set keywordprg=man\ -s | |
4711 < This option cannot be set from a |modeline| or in the |sandbox|, for | |
4712 security reasons. | |
4713 | |
4714 *'langmap'* *'lmap'* *E357* *E358* | |
4715 'langmap' 'lmap' string (default "") | |
4716 global | |
4717 {not in Vi} | |
4718 {only available when compiled with the |+langmap| | |
4719 feature} | |
4720 This option allows switching your keyboard into a special language | |
10 | 4721 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
|
4722 inserted directly. When in Normal mode the 'langmap' option takes |
7 | 4723 care of translating these special characters to the original meaning |
4724 of the key. This means you don't have to change the keyboard mode to | |
4725 be able to execute Normal mode commands. | |
4726 This is the opposite of the 'keymap' option, where characters are | |
4727 mapped in Insert mode. | |
9975
03fa8a51e9dc
commit https://github.com/vim/vim/commit/e4a3bcf28d92d0bde9ca227ccb40d401038185e5
Christian Brabandt <cb@256bit.org>
parents:
9913
diff
changeset
|
4728 Also consider resetting 'langremap' to avoid 'langmap' applies to |
6369 | 4729 characters resulting from a mapping. |
5908 | 4730 This option cannot be set from a |modeline| or in the |sandbox|, for |
4731 security reasons. | |
7 | 4732 |
699 | 4733 Example (for Greek, in UTF-8): *greek* > |
4734 :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 | 4735 < Example (exchanges meaning of z and y for commands): > |
4736 :set langmap=zy,yz,ZY,YZ | |
4737 < | |
4738 The 'langmap' option is a list of parts, separated with commas. Each | |
4739 part can be in one of two forms: | |
4740 1. A list of pairs. Each pair is a "from" character immediately | |
4741 followed by the "to" character. Examples: "aA", "aAbBcC". | |
4742 2. A list of "from" characters, a semi-colon and a list of "to" | |
4743 characters. Example: "abc;ABC" | |
4744 Example: "aA,fgh;FGH,cCdDeE" | |
4745 Special characters need to be preceded with a backslash. These are | |
4746 ";", ',' and backslash itself. | |
4747 | |
4748 This will allow you to activate vim actions without having to switch | |
4749 back and forth between the languages. Your language characters will | |
4750 be understood as normal vim English characters (according to the | |
4751 langmap mappings) in the following cases: | |
4752 o Normal/Visual mode (commands, buffer/register names, user mappings) | |
4753 o Insert/Replace Mode: Register names after CTRL-R | |
4754 o Insert/Replace Mode: Mappings | |
4755 Characters entered in Command-line mode will NOT be affected by | |
4756 this option. Note that this option can be changed at any time | |
4757 allowing to switch between mappings for different languages/encodings. | |
4758 Use a mapping to avoid having to type it each time! | |
4759 | |
4760 *'langmenu'* *'lm'* | |
4761 'langmenu' 'lm' string (default "") | |
4762 global | |
4763 {not in Vi} | |
4764 {only available when compiled with the |+menu| and | |
4765 |+multi_lang| features} | |
4766 Language to use for menu translation. Tells which file is loaded | |
4767 from the "lang" directory in 'runtimepath': > | |
4768 "lang/menu_" . &langmenu . ".vim" | |
4769 < (without the spaces). For example, to always use the Dutch menus, no | |
4770 matter what $LANG is set to: > | |
4771 :set langmenu=nl_NL.ISO_8859-1 | |
4772 < When 'langmenu' is empty, |v:lang| is used. | |
36 | 4773 Only normal file name characters can be used, "/\*?[|<>" are illegal. |
7 | 4774 If your $LANG is set to a non-English language but you do want to use |
4775 the English menus: > | |
4776 :set langmenu=none | |
4777 < This option must be set before loading menus, switching on filetype | |
4778 detection or syntax highlighting. Once the menus are defined setting | |
4779 this option has no effect. But you could do this: > | |
4780 :source $VIMRUNTIME/delmenu.vim | |
4781 :set langmenu=de_DE.ISO_8859-1 | |
4782 :source $VIMRUNTIME/menu.vim | |
4783 < Warning: This deletes all menus that you defined yourself! | |
4784 | |
7196
42717d048817
commit https://github.com/vim/vim/commit/d94464ee294a351ce7b6ba18e8bd3f24f1bef920
Christian Brabandt <cb@256bit.org>
parents:
7147
diff
changeset
|
4785 *'langnoremap'* *'lnr'* *'nolangnoremap'* *'nolnr'* |
9669
284b4eb307fc
commit https://github.com/vim/vim/commit/8c08b5b569e2a9e9f63dea514591ecfa2d3bb392
Christian Brabandt <cb@256bit.org>
parents:
9665
diff
changeset
|
4786 'langnoremap' 'lnr' boolean (default off, set in |defaults.vim|) |
6339 | 4787 global |
4788 {not in Vi} | |
4789 {only available when compiled with the |+langmap| | |
4790 feature} | |
9975
03fa8a51e9dc
commit https://github.com/vim/vim/commit/e4a3bcf28d92d0bde9ca227ccb40d401038185e5
Christian Brabandt <cb@256bit.org>
parents:
9913
diff
changeset
|
4791 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
|
4792 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
|
4793 '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
|
4794 |
03fa8a51e9dc
commit https://github.com/vim/vim/commit/e4a3bcf28d92d0bde9ca227ccb40d401038185e5
Christian Brabandt <cb@256bit.org>
parents:
9913
diff
changeset
|
4795 *'langremap'* *'lrm'* *'nolangremap'* *'nolrm'* |
03fa8a51e9dc
commit https://github.com/vim/vim/commit/e4a3bcf28d92d0bde9ca227ccb40d401038185e5
Christian Brabandt <cb@256bit.org>
parents:
9913
diff
changeset
|
4796 '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
|
4797 global |
03fa8a51e9dc
commit https://github.com/vim/vim/commit/e4a3bcf28d92d0bde9ca227ccb40d401038185e5
Christian Brabandt <cb@256bit.org>
parents:
9913
diff
changeset
|
4798 {not in Vi} |
03fa8a51e9dc
commit https://github.com/vim/vim/commit/e4a3bcf28d92d0bde9ca227ccb40d401038185e5
Christian Brabandt <cb@256bit.org>
parents:
9913
diff
changeset
|
4799 {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
|
4800 feature} |
03fa8a51e9dc
commit https://github.com/vim/vim/commit/e4a3bcf28d92d0bde9ca227ccb40d401038185e5
Christian Brabandt <cb@256bit.org>
parents:
9913
diff
changeset
|
4801 When off, setting 'langmap' does not apply to characters resulting from |
6339 | 4802 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
|
4803 '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
|
4804 This option defaults to on for backwards compatibility. Set it off if |
6339 | 4805 that works for you to avoid mappings to break. |
4806 | |
7 | 4807 *'laststatus'* *'ls'* |
4808 'laststatus' 'ls' number (default 1) | |
4809 global | |
4810 {not in Vi} | |
4811 The value of this option influences when the last window will have a | |
4812 status line: | |
4813 0: never | |
4814 1: only if there are at least two windows | |
4815 2: always | |
4816 The screen looks nicer with a status line if you have several | |
4817 windows, but it takes another screen line. |status-line| | |
4818 | |
4819 *'lazyredraw'* *'lz'* *'nolazyredraw'* *'nolz'* | |
4820 'lazyredraw' 'lz' boolean (default off) | |
4821 global | |
4822 {not in Vi} | |
4823 When this option is set, the screen will not be redrawn while | |
4824 executing macros, registers and other commands that have not been | |
10 | 4825 typed. Also, updating the window title is postponed. To force an |
7 | 4826 update use |:redraw|. |
4827 | |
4828 *'linebreak'* *'lbr'* *'nolinebreak'* *'nolbr'* | |
4829 'linebreak' 'lbr' boolean (default off) | |
4830 local to window | |
4831 {not in Vi} | |
2570
71b56b4e7785
Make the references to features in the help more consistent. (Sylvain Hitier)
Bram Moolenaar <bram@vim.org>
parents:
2561
diff
changeset
|
4832 {not available when compiled without the |+linebreak| |
7 | 4833 feature} |
6009 | 4834 If on, Vim will wrap long lines at a character in 'breakat' rather |
7 | 4835 than at the last character that fits on the screen. Unlike |
4836 'wrapmargin' and 'textwidth', this does not insert <EOL>s in the file, | |
6009 | 4837 it only affects the way the file is displayed, not its contents. |
4838 If 'breakindent' is set, line is visually indented. Then, the value | |
4839 of 'showbreak' is used to put in front of wrapped lines. This option | |
6026 | 4840 is not used when the 'wrap' option is off. |
7 | 4841 Note that <Tab> characters after an <EOL> are mostly not displayed |
4842 with the right amount of white space. | |
4843 | |
4844 *'lines'* *E593* | |
4845 'lines' number (default 24 or terminal height) | |
4846 global | |
4847 Number of lines of the Vim window. | |
4848 Normally you don't need to set this. It is done automatically by the | |
161 | 4849 terminal initialization code. Also see |posix-screen-size|. |
7 | 4850 When Vim is running in the GUI or in a resizable window, setting this |
4851 option will cause the window size to be changed. When you only want | |
4852 to use the size for the GUI, put the command in your |gvimrc| file. | |
4853 Vim limits the number of lines to what fits on the screen. You can | |
4854 use this command to get the tallest window possible: > | |
4855 :set lines=999 | |
571 | 4856 < 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
|
4857 If you get fewer lines than expected, check the 'guiheadroom' option. |
7 | 4858 When you set this option and Vim is unable to change the physical |
4859 number of lines of the display, the display may be messed up. | |
4860 | |
4861 *'linespace'* *'lsp'* | |
4862 'linespace' 'lsp' number (default 0, 1 for Win32 GUI) | |
4863 global | |
4864 {not in Vi} | |
4865 {only in the GUI} | |
4866 Number of pixel lines inserted between characters. Useful if the font | |
4867 uses the full character cell height, making lines touch each other. | |
4868 When non-zero there is room for underlining. | |
180 | 4869 With some fonts there can be too much room between lines (to have |
4870 space for ascents and descents). Then it makes sense to set | |
4871 'linespace' to a negative value. This may cause display problems | |
4872 though! | |
7 | 4873 |
4874 *'lisp'* *'nolisp'* | |
4875 'lisp' boolean (default off) | |
4876 local to buffer | |
4877 {not available when compiled without the |+lispindent| | |
4878 feature} | |
4879 Lisp mode: When <Enter> is typed in insert mode set the indent for | |
4880 the next line to Lisp standards (well, sort of). Also happens with | |
4881 "cc" or "S". 'autoindent' must also be on for this to work. The 'p' | |
4882 flag in 'cpoptions' changes the method of indenting: Vi compatible or | |
4883 better. Also see 'lispwords'. | |
4884 The '-' character is included in keyword characters. Redefines the | |
4885 "=" operator to use this same indentation algorithm rather than | |
4886 calling an external program if 'equalprg' is empty. | |
4887 This option is not used when 'paste' is set. | |
4888 {Vi: Does it a little bit differently} | |
4889 | |
4890 *'lispwords'* *'lw'* | |
4891 'lispwords' 'lw' string (default is very long) | |
5712 | 4892 global or local to buffer |global-local| |
7 | 4893 {not in Vi} |
4894 {not available when compiled without the |+lispindent| | |
4895 feature} | |
4896 Comma separated list of words that influence the Lisp indenting. | |
4897 |'lisp'| | |
4898 | |
4899 *'list'* *'nolist'* | |
4900 'list' boolean (default off) | |
4901 local to window | |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
4902 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
|
4903 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
|
4904 trailing blanks. Further changed by the 'listchars' option. |
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
4905 |
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
4906 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
|
4907 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
|
4908 position while displaying Tabs with spaces, use: > |
5161
f7add3891e95
Updated runtime files. Fix NL translations.
Bram Moolenaar <bram@vim.org>
parents:
5146
diff
changeset
|
4909 :set list lcs=tab:\ \ |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
4910 < |
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
4911 Note that list mode will also affect formatting (set with 'textwidth' |
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
4912 or 'wrapmargin') when 'cpoptions' includes 'L'. See 'listchars' for |
7 | 4913 changing the way tabs are displayed. |
4914 | |
4915 *'listchars'* *'lcs'* | |
4916 'listchars' 'lcs' string (default "eol:$") | |
4917 global | |
4918 {not in Vi} | |
2458 | 4919 Strings to use in 'list' mode and for the |:list| command. It is a |
4920 comma separated list of string settings. | |
6777 | 4921 *lcs-eol* |
7 | 4922 eol:c Character to show at the end of each line. When |
4923 omitted, there is no extra character at the end of the | |
4924 line. | |
6777 | 4925 *lcs-tab* |
1263 | 4926 tab:xy Two characters to be used to show a tab. The first |
7 | 4927 char is used once. The second char is repeated to |
1263 | 4928 fill the space that the tab normally occupies. |
4929 "tab:>-" will show a tab that takes four spaces as | |
4930 ">---". When omitted, a tab is show as ^I. | |
6777 | 4931 *lcs-space* |
4932 space:c Character to show for a space. When omitted, spaces | |
4933 are left blank. | |
4934 *lcs-trail* | |
10 | 4935 trail:c Character to show for trailing spaces. When omitted, |
6777 | 4936 trailing spaces are blank. Overrides the "space" |
4937 setting for trailing spaces. | |
4938 *lcs-extends* | |
7 | 4939 extends:c Character to show in the last column, when 'wrap' is |
4940 off and the line continues beyond the right of the | |
4941 screen. | |
6777 | 4942 *lcs-precedes* |
7 | 4943 precedes:c Character to show in the first column, when 'wrap' |
4944 is off and there is text preceding the character | |
4945 visible in the first column. | |
6777 | 4946 *lcs-conceal* |
2250
1bac28a53fae
Add the conceal patch from Vince Negri.
Bram Moolenaar <bram@vim.org>
parents:
2249
diff
changeset
|
4947 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
|
4948 'conceallevel' is set to 1. |
6777 | 4949 *lcs-nbsp* |
6801 | 4950 nbsp:c Character to show for a non-breakable space character |
4951 (0xA0 (160 decimal) and U+202F). Left blank when | |
4952 omitted. | |
7 | 4953 |
10 | 4954 The characters ':' and ',' should not be used. UTF-8 characters can |
7 | 4955 be used when 'encoding' is "utf-8", otherwise only printable |
819 | 4956 characters are allowed. All characters must be single width. |
7 | 4957 |
4958 Examples: > | |
4959 :set lcs=tab:>-,trail:- | |
12 | 4960 :set lcs=tab:>-,eol:<,nbsp:% |
7 | 4961 :set lcs=extends:>,precedes:< |
4962 < The "NonText" highlighting will be used for "eol", "extends" and | |
6777 | 4963 "precedes". "SpecialKey" for "nbsp", "space", "tab" and "trail". |
1152 | 4964 |hl-NonText| |hl-SpecialKey| |
7 | 4965 |
4966 *'lpl'* *'nolpl'* *'loadplugins'* *'noloadplugins'* | |
4967 'loadplugins' 'lpl' boolean (default on) | |
4968 global | |
4969 {not in Vi} | |
4970 When on the plugin scripts are loaded when starting up |load-plugins|. | |
4971 This option can be reset in your |vimrc| file to disable the loading | |
4972 of plugins. | |
11666
5cd9ba96561d
patch 8.0.0716: not easy to start Vim cleanly
Christian Brabandt <cb@256bit.org>
parents:
11659
diff
changeset
|
4973 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
|
4974 line arguments reset this option. See |-u| and |--noplugin|. |
7 | 4975 |
7196
42717d048817
commit https://github.com/vim/vim/commit/d94464ee294a351ce7b6ba18e8bd3f24f1bef920
Christian Brabandt <cb@256bit.org>
parents:
7147
diff
changeset
|
4976 *'luadll'* |
8629
54ac275e3fc4
commit https://github.com/vim/vim/commit/3848e00e0177abdb31bc600234967863ec487233
Christian Brabandt <cb@256bit.org>
parents:
8560
diff
changeset
|
4977 '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
|
4978 global |
53163e4d9e4f
commit https://github.com/vim/vim/commit/25e4fcde767084d1a79e0926bc301c92987c0cce
Christian Brabandt <cb@256bit.org>
parents:
7477
diff
changeset
|
4979 {not in Vi} |
7196
42717d048817
commit https://github.com/vim/vim/commit/d94464ee294a351ce7b6ba18e8bd3f24f1bef920
Christian Brabandt <cb@256bit.org>
parents:
7147
diff
changeset
|
4980 {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
|
4981 feature} |
7528
53163e4d9e4f
commit https://github.com/vim/vim/commit/25e4fcde767084d1a79e0926bc301c92987c0cce
Christian Brabandt <cb@256bit.org>
parents:
7477
diff
changeset
|
4982 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
|
4983 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
|
4984 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
|
4985 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
|
4986 security reasons. |
42717d048817
commit https://github.com/vim/vim/commit/d94464ee294a351ce7b6ba18e8bd3f24f1bef920
Christian Brabandt <cb@256bit.org>
parents:
7147
diff
changeset
|
4987 |
842 | 4988 *'macatsui'* *'nomacatsui'* |
4989 'macatsui' boolean (default on) | |
4990 global | |
4991 {only available in Mac GUI version} | |
4992 This is a workaround for when drawing doesn't work properly. When set | |
4993 and compiled with multi-byte support ATSUI text drawing is used. When | |
4994 not set ATSUI text drawing is not used. Switch this option off when | |
4995 you experience drawing problems. In a future version the problems may | |
4996 be solved and this option becomes obsolete. Therefore use this method | |
4997 to unset it: > | |
4998 if exists('&macatsui') | |
4999 set nomacatsui | |
5000 endif | |
1152 | 5001 < Another option to check if you have drawing problems is |
5002 'termencoding'. | |
5003 | |
7 | 5004 *'magic'* *'nomagic'* |
5005 'magic' boolean (default on) | |
5006 global | |
5007 Changes the special characters that can be used in search patterns. | |
5008 See |pattern|. | |
10140
b11ceef7116e
commit https://github.com/vim/vim/commit/64d8e25bf6efe5f18b032563521c3ce278c316ab
Christian Brabandt <cb@256bit.org>
parents:
10027
diff
changeset
|
5009 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
|
5010 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
|
5011 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
|
5012 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
|
5013 when you want to |/\M|. |
7 | 5014 |
5015 *'makeef'* *'mef'* | |
5016 'makeef' 'mef' string (default: "") | |
5017 global | |
5018 {not in Vi} | |
5019 {not available when compiled without the |+quickfix| | |
5020 feature} | |
5021 Name of the errorfile for the |:make| command (see |:make_makeprg|) | |
5022 and the |:grep| command. | |
5023 When it is empty, an internally generated temp file will be used. | |
5024 When "##" is included, it is replaced by a number to make the name | |
5025 unique. This makes sure that the ":make" command doesn't overwrite an | |
5026 existing file. | |
5027 NOT used for the ":cf" command. See 'errorfile' for that. | |
5028 Environment variables are expanded |:set_env|. | |
5029 See |option-backslash| about including spaces and backslashes. | |
5030 This option cannot be set from a |modeline| or in the |sandbox|, for | |
5031 security reasons. | |
5032 | |
11063
e71d3bdf3bc3
patch 8.0.0420: text garbled when the system encoding differs from 'encoding'
Christian Brabandt <cb@256bit.org>
parents:
11062
diff
changeset
|
5033 *'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
|
5034 '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
|
5035 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
|
5036 {only available when compiled with the |+multi_byte| |
e71d3bdf3bc3
patch 8.0.0420: text garbled when the system encoding differs from 'encoding'
Christian Brabandt <cb@256bit.org>
parents:
11062
diff
changeset
|
5037 feature} |
e71d3bdf3bc3
patch 8.0.0420: text garbled when the system encoding differs from 'encoding'
Christian Brabandt <cb@256bit.org>
parents:
11062
diff
changeset
|
5038 {not in Vi} |
e71d3bdf3bc3
patch 8.0.0420: text garbled when the system encoding differs from 'encoding'
Christian Brabandt <cb@256bit.org>
parents:
11062
diff
changeset
|
5039 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
|
5040 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
|
5041 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
|
5042 `: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
|
5043 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
|
5044 |
e71d3bdf3bc3
patch 8.0.0420: text garbled when the system encoding differs from 'encoding'
Christian Brabandt <cb@256bit.org>
parents:
11062
diff
changeset
|
5045 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
|
5046 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
|
5047 '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
|
5048 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
|
5049 :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
|
5050 :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
|
5051 < |
7 | 5052 *'makeprg'* *'mp'* |
5053 'makeprg' 'mp' string (default "make", VMS: "MMS") | |
5054 global or local to buffer |global-local| | |
5055 {not in Vi} | |
1152 | 5056 Program to use for the ":make" command. See |:make_makeprg|. |
5690 | 5057 This option may contain '%' and '#' characters (see |:_%| and |:_#|), |
5058 which are expanded to the current and alternate file name. Use |::S| | |
5059 to escape file names in case they contain special characters. | |
1152 | 5060 Environment variables are expanded |:set_env|. See |option-backslash| |
5061 about including spaces and backslashes. | |
5062 Note that a '|' must be escaped twice: once for ":set" and once for | |
5063 the interpretation of a command. When you use a filter called | |
5064 "myfilter" do it like this: > | |
7 | 5065 :set makeprg=gmake\ \\\|\ myfilter |
5066 < The placeholder "$*" can be given (even multiple times) to specify | |
5067 where the arguments will be included, for example: > | |
5068 :set makeprg=latex\ \\\\nonstopmode\ \\\\input\\{$*} | |
5069 < This option cannot be set from a |modeline| or in the |sandbox|, for | |
5070 security reasons. | |
5071 | |
5072 *'matchpairs'* *'mps'* | |
5073 'matchpairs' 'mps' string (default "(:),{:},[:]") | |
5074 local to buffer | |
5075 {not in Vi} | |
5076 Characters that form pairs. The |%| command jumps from one to the | |
4073 | 5077 other. |
5078 Only character pairs are allowed that are different, thus you cannot | |
5079 jump between two double quotes. | |
5080 The characters must be separated by a colon. | |
1152 | 5081 The pairs must be separated by a comma. Example for including '<' and |
5082 '>' (HTML): > | |
7 | 5083 :set mps+=<:> |
5084 | |
5085 < A more exotic example, to jump between the '=' and ';' in an | |
5086 assignment, useful for languages like C and Java: > | |
5087 :au FileType c,cpp,java set mps+==:; | |
5088 | |
5089 < For a more advanced way of using "%", see the matchit.vim plugin in | |
5090 the $VIMRUNTIME/macros directory. |add-local-help| | |
5091 | |
5092 *'matchtime'* *'mat'* | |
5093 'matchtime' 'mat' number (default 5) | |
5094 global | |
5095 {not in Vi}{in Nvi} | |
5096 Tenths of a second to show the matching paren, when 'showmatch' is | |
5097 set. Note that this is not in milliseconds, like other options that | |
5098 set a time. This is to be compatible with Nvi. | |
5099 | |
714 | 5100 *'maxcombine'* *'mco'* |
5101 'maxcombine' 'mco' number (default 2) | |
5102 global | |
5103 {not in Vi} | |
5104 {only available when compiled with the |+multi_byte| | |
5105 feature} | |
5106 The maximum number of combining characters supported for displaying. | |
5107 Only used when 'encoding' is "utf-8". | |
5108 The default is OK for most languages. Hebrew may require 4. | |
5109 Maximum value is 6. | |
5110 Even when this option is set to 2 you can still edit text with more | |
5111 combining characters, you just can't see them. Use |g8| or |ga|. | |
5112 See |mbyte-combining|. | |
5113 | |
7 | 5114 *'maxfuncdepth'* *'mfd'* |
5115 'maxfuncdepth' 'mfd' number (default 100) | |
5116 global | |
5117 {not in Vi} | |
2570
71b56b4e7785
Make the references to features in the help more consistent. (Sylvain Hitier)
Bram Moolenaar <bram@vim.org>
parents:
2561
diff
changeset
|
5118 {not available when compiled without the |+eval| |
1152 | 5119 feature} |
7 | 5120 Maximum depth of function calls for user functions. This normally |
5121 catches endless recursion. When using a recursive function with | |
5122 more depth, set 'maxfuncdepth' to a bigger number. But this will use | |
5123 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
|
5124 Increasing this limit above 200 also changes the maximum for Ex |
883396809b45
commit https://github.com/vim/vim/commit/bc2eada5424bff06f7eb77c032ecc067da52b846
Christian Brabandt <cb@256bit.org>
parents:
10449
diff
changeset
|
5125 command resursion, see |E169|. |
7 | 5126 See also |:function|. |
5127 | |
5128 *'maxmapdepth'* *'mmd'* *E223* | |
5129 'maxmapdepth' 'mmd' number (default 1000) | |
5130 global | |
5131 {not in Vi} | |
5132 Maximum number of times a mapping is done without resulting in a | |
5133 character to be used. This normally catches endless mappings, like | |
5134 ":map x y" with ":map y x". It still does not catch ":map g wg", | |
5135 because the 'w' is used before the next mapping is done. See also | |
5136 |key-mapping|. | |
5137 | |
5138 *'maxmem'* *'mm'* | |
5139 'maxmem' 'mm' number (default between 256 to 5120 (system | |
5140 dependent) or half the amount of memory | |
5141 available) | |
5142 global | |
5143 {not in Vi} | |
5144 Maximum amount of memory (in Kbyte) to use for one buffer. When this | |
5145 limit is reached allocating extra memory for a buffer will cause | |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
5146 other memory to be freed. The maximum usable value is about 2000000. |
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
5147 Use this to work without a limit. Also see 'maxmemtot'. |
7 | 5148 |
189 | 5149 *'maxmempattern'* *'mmp'* |
5150 'maxmempattern' 'mmp' number (default 1000) | |
5151 global | |
5152 {not in Vi} | |
5153 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
|
5154 The maximum value is about 2000000. Use this to work without a limit. |
189 | 5155 *E363* |
1152 | 5156 When Vim runs into the limit it gives an error message and mostly |
5157 behaves like CTRL-C was typed. | |
189 | 5158 Running into the limit often means that the pattern is very |
5159 inefficient or too complex. This may already happen with the pattern | |
5160 "\(.\)*" on a very long line. ".*" works much better. | |
5161 Vim may run out of memory before hitting the 'maxmempattern' limit. | |
5162 | |
7 | 5163 *'maxmemtot'* *'mmt'* |
5164 'maxmemtot' 'mmt' number (default between 2048 and 10240 (system | |
5165 dependent) or half the amount of memory | |
5166 available) | |
5167 global | |
5168 {not in Vi} | |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
5169 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
|
5170 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
|
5171 without a limit. |
05cf4cc72a9f
commit https://github.com/vim/vim/commit/fa7353428f705f7a13465a1943dddeede4083023
Christian Brabandt <cb@256bit.org>
parents:
7272
diff
changeset
|
5172 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
|
5173 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
|
5174 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
|
5175 need the memory to store undo info. |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
5176 Also see 'maxmem'. |
7 | 5177 |
5178 *'menuitems'* *'mis'* | |
5179 'menuitems' 'mis' number (default 25) | |
5180 global | |
5181 {not in Vi} | |
5182 {not available when compiled without the |+menu| | |
5183 feature} | |
5184 Maximum number of items to use in a menu. Used for menus that are | |
5185 generated from a list of items, e.g., the Buffers menu. Changing this | |
5186 option has no direct effect, the menu must be refreshed first. | |
5187 | |
484 | 5188 *'mkspellmem'* *'msm'* |
5189 'mkspellmem' 'msm' string (default "460000,2000,500") | |
5190 global | |
5191 {not in Vi} | |
5192 {not available when compiled without the |+syntax| | |
5193 feature} | |
5194 Parameters for |:mkspell|. This tunes when to start compressing the | |
5195 word tree. Compression can be slow when there are many words, but | |
5196 it's needed to avoid running out of memory. The amount of memory used | |
5197 per word depends very much on how similar the words are, that's why | |
5198 this tuning is complicated. | |
5199 | |
5200 There are three numbers, separated by commas: | |
5201 {start},{inc},{added} | |
5202 | |
5203 For most languages the uncompressed word tree fits in memory. {start} | |
5204 gives the amount of memory in Kbyte that can be used before any | |
5205 compression is done. It should be a bit smaller than the amount of | |
5206 memory that is available to Vim. | |
5207 | |
5208 When going over the {start} limit the {inc} number specifies the | |
5209 amount of memory in Kbyte that can be allocated before another | |
5210 compression is done. A low number means compression is done after | |
5211 less words are added, which is slow. A high number means more memory | |
5212 will be allocated. | |
5213 | |
5214 After doing compression, {added} times 1024 words can be added before | |
5215 the {inc} limit is ignored and compression is done when any extra | |
5216 amount of memory is needed. A low number means there is a smaller | |
5217 chance of hitting the {inc} limit, less memory is used but it's | |
5218 slower. | |
5219 | |
5220 The languages for which these numbers are important are Italian and | |
5221 Hungarian. The default works for when you have about 512 Mbyte. If | |
5222 you have 1 Gbyte you could use: > | |
5223 :set mkspellmem=900000,3000,800 | |
5224 < If you have less than 512 Mbyte |:mkspell| may fail for some | |
5225 languages, no matter what you set 'mkspellmem' to. | |
5226 | |
7 | 5227 *'modeline'* *'ml'* *'nomodeline'* *'noml'* |
1111 | 5228 'modeline' 'ml' boolean (Vim default: on (off for root), |
5229 Vi default: off) | |
7 | 5230 local to buffer |
5231 *'modelines'* *'mls'* | |
5232 'modelines' 'mls' number (default 5) | |
5233 global | |
5234 {not in Vi} | |
5235 If 'modeline' is on 'modelines' gives the number of lines that is | |
5236 checked for set commands. If 'modeline' is off or 'modelines' is zero | |
5237 no lines are checked. See |modeline|. | |
5238 NOTE: 'modeline' is set to the Vi default value when 'compatible' is | |
5239 set and to the Vim default value when 'compatible' is reset. | |
5240 | |
5241 *'modifiable'* *'ma'* *'nomodifiable'* *'noma'* | |
5242 'modifiable' 'ma' boolean (default on) | |
5243 local to buffer | |
5244 {not in Vi} *E21* | |
5245 When off the buffer contents cannot be changed. The 'fileformat' and | |
5246 'fileencoding' options also can't be changed. | |
10617 | 5247 Can be reset on startup with the |-M| command line argument. |
7 | 5248 |
5249 *'modified'* *'mod'* *'nomodified'* *'nomod'* | |
5250 'modified' 'mod' boolean (default off) | |
5251 local to buffer | |
5252 {not in Vi} | |
5253 When on, the buffer is considered to be modified. This option is set | |
5254 when: | |
5255 1. A change was made to the text since it was last written. Using the | |
5256 |undo| command to go back to the original text will reset the | |
5257 option. But undoing changes that were made before writing the | |
5258 buffer will set the option again, since the text is different from | |
5259 when it was written. | |
5260 2. 'fileformat' or 'fileencoding' is different from its original | |
5261 value. The original value is set when the buffer is read or | |
5262 written. A ":set nomodified" command also resets the original | |
5263 values to the current values and the 'modified' option will be | |
5264 reset. | |
8748
b1a19a2f73f0
commit https://github.com/vim/vim/commit/4f3f668c8486444e53163c29d2fc79bf47eb3c82
Christian Brabandt <cb@256bit.org>
parents:
8629
diff
changeset
|
5265 Similarly for 'eol' and 'bomb'. |
3082 | 5266 This option is not set when a change is made to the buffer as the |
5267 result of a BufNewFile, BufRead/BufReadPost, BufWritePost, | |
5268 FileAppendPost or VimLeave autocommand event. See |gzip-example| for | |
5269 an explanation. | |
7 | 5270 When 'buftype' is "nowrite" or "nofile" this option may be set, but |
5271 will be ignored. | |
5272 | |
5273 *'more'* *'nomore'* | |
5274 'more' boolean (Vim default: on, Vi default: off) | |
5275 global | |
5276 {not in Vi} | |
5277 When on, listings pause when the whole screen is filled. You will get | |
5278 the |more-prompt|. When this option is off there are no pauses, the | |
5279 listing continues until finished. | |
5280 NOTE: This option is set to the Vi default value when 'compatible' is | |
5281 set and to the Vim default value when 'compatible' is reset. | |
5282 | |
5283 *'mouse'* *E538* | |
9669
284b4eb307fc
commit https://github.com/vim/vim/commit/8c08b5b569e2a9e9f63dea514591ecfa2d3bb392
Christian Brabandt <cb@256bit.org>
parents:
9665
diff
changeset
|
5284 '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
|
5285 set to "a" in |defaults.vim|) |
7 | 5286 global |
5287 {not in Vi} | |
5288 Enable the use of the mouse. Only works for certain terminals | |
1621 | 5289 (xterm, MS-DOS, Win32 |win32-mouse|, QNX pterm, *BSD console with |
5290 sysmouse and Linux console with gpm). For using the mouse in the | |
5291 GUI, see |gui-mouse|. | |
7 | 5292 The mouse can be enabled for different modes: |
5293 n Normal mode | |
5294 v Visual mode | |
5295 i Insert mode | |
5296 c Command-line mode | |
5297 h all previous modes when editing a help file | |
5298 a all previous modes | |
5299 r for |hit-enter| and |more-prompt| prompt | |
5300 Normally you would enable the mouse in all four modes with: > | |
5301 :set mouse=a | |
5302 < When the mouse is not enabled, the GUI will still use the mouse for | |
5303 modeless selection. This doesn't move the text cursor. | |
5304 | |
5305 See |mouse-using|. Also see |'clipboard'|. | |
5306 | |
5307 Note: When enabling the mouse in a terminal, copy/paste will use the | |
10 | 5308 "* register if there is access to an X-server. The xterm handling of |
7 | 5309 the mouse buttons can still be used by keeping the shift key pressed. |
5310 Also see the 'clipboard' option. | |
5311 | |
5312 *'mousefocus'* *'mousef'* *'nomousefocus'* *'nomousef'* | |
5313 'mousefocus' 'mousef' boolean (default off) | |
5314 global | |
5315 {not in Vi} | |
5316 {only works in the GUI} | |
5317 The window that the mouse pointer is on is automatically activated. | |
5318 When changing the window layout or window focus in another way, the | |
5319 mouse pointer is moved to the window with keyboard focus. Off is the | |
5320 default because it makes using the pull down menus a little goofy, as | |
5321 a pointer transit may activate a window unintentionally. | |
5322 | |
5323 *'mousehide'* *'mh'* *'nomousehide'* *'nomh'* | |
5324 'mousehide' 'mh' boolean (default on) | |
5325 global | |
5326 {not in Vi} | |
5327 {only works in the GUI} | |
5328 When on, the mouse pointer is hidden when characters are typed. | |
5329 The mouse pointer is restored when the mouse is moved. | |
5330 | |
5331 *'mousemodel'* *'mousem'* | |
5332 'mousemodel' 'mousem' string (default "extend", "popup" for MS-DOS and Win32) | |
5333 global | |
5334 {not in Vi} | |
5335 Sets the model to use for the mouse. The name mostly specifies what | |
5336 the right mouse button is used for: | |
5337 extend Right mouse button extends a selection. This works | |
5338 like in an xterm. | |
5339 popup Right mouse button pops up a menu. The shifted left | |
5340 mouse button extends a selection. This works like | |
233 | 5341 with Microsoft Windows. |
7 | 5342 popup_setpos Like "popup", but the cursor will be moved to the |
5343 position where the mouse was clicked, and thus the | |
5344 selected operation will act upon the clicked object. | |
5345 If clicking inside a selection, that selection will | |
233 | 5346 be acted upon, i.e. no cursor move. This implies of |
7 | 5347 course, that right clicking outside a selection will |
5348 end Visual mode. | |
5349 Overview of what button does what for each model: | |
5350 mouse extend popup(_setpos) ~ | |
5351 left click place cursor place cursor | |
5352 left drag start selection start selection | |
5353 shift-left search word extend selection | |
5354 right click extend selection popup menu (place cursor) | |
5355 right drag extend selection - | |
5356 middle click paste paste | |
5357 | |
5358 In the "popup" model the right mouse button produces a pop-up menu. | |
5359 You need to define this first, see |popup-menu|. | |
5360 | |
5361 Note that you can further refine the meaning of buttons with mappings. | |
5362 See |gui-mouse-mapping|. But mappings are NOT used for modeless | |
5363 selection (because that's handled in the GUI code directly). | |
5364 | |
5365 The 'mousemodel' option is set by the |:behave| command. | |
5366 | |
5367 *'mouseshape'* *'mouses'* *E547* | |
5368 'mouseshape' 'mouses' string (default "i:beam,r:beam,s:updown,sd:cross, | |
233 | 5369 m:no,ml:up-arrow,v:rightup-arrow") |
7 | 5370 global |
5371 {not in Vi} | |
5372 {only available when compiled with the |+mouseshape| | |
5373 feature} | |
5374 This option tells Vim what the mouse pointer should look like in | |
5375 different modes. The option is a comma separated list of parts, much | |
5376 like used for 'guicursor'. Each part consist of a mode/location-list | |
5377 and an argument-list: | |
5378 mode-list:shape,mode-list:shape,.. | |
5379 The mode-list is a dash separated list of these modes/locations: | |
5380 In a normal window: ~ | |
5381 n Normal mode | |
5382 v Visual mode | |
5383 ve Visual mode with 'selection' "exclusive" (same as 'v', | |
5384 if not specified) | |
5385 o Operator-pending mode | |
5386 i Insert mode | |
5387 r Replace mode | |
5388 | |
5389 Others: ~ | |
5390 c appending to the command-line | |
5391 ci inserting in the command-line | |
5392 cr replacing in the command-line | |
5393 m at the 'Hit ENTER' or 'More' prompts | |
5394 ml idem, but cursor in the last line | |
5395 e any mode, pointer below last window | |
5396 s any mode, pointer on a status line | |
5397 sd any mode, while dragging a status line | |
5398 vs any mode, pointer on a vertical separator line | |
5399 vd any mode, while dragging a vertical separator line | |
5400 a everywhere | |
5401 | |
5402 The shape is one of the following: | |
5403 avail name looks like ~ | |
5404 w x arrow Normal mouse pointer | |
5405 w x blank no pointer at all (use with care!) | |
5406 w x beam I-beam | |
5407 w x updown up-down sizing arrows | |
5408 w x leftright left-right sizing arrows | |
5409 w x busy The system's usual busy pointer | |
5410 w x no The system's usual 'no input' pointer | |
5411 x udsizing indicates up-down resizing | |
5412 x lrsizing indicates left-right resizing | |
5413 x crosshair like a big thin + | |
5414 x hand1 black hand | |
5415 x hand2 white hand | |
5416 x pencil what you write with | |
5417 x question big ? | |
5418 x rightup-arrow arrow pointing right-up | |
5419 w x up-arrow arrow pointing up | |
5420 x <number> any X11 pointer number (see X11/cursorfont.h) | |
5421 | |
5422 The "avail" column contains a 'w' if the shape is available for Win32, | |
5423 x for X11. | |
5424 Any modes not specified or shapes not available use the normal mouse | |
5425 pointer. | |
5426 | |
5427 Example: > | |
5428 :set mouseshape=s:udsizing,m:no | |
5429 < will make the mouse turn to a sizing arrow over the status lines and | |
5430 indicate no input when the hit-enter prompt is displayed (since | |
5431 clicking the mouse has no effect in this state.) | |
5432 | |
5433 *'mousetime'* *'mouset'* | |
5434 'mousetime' 'mouset' number (default 500) | |
5435 global | |
5436 {not in Vi} | |
5437 Only for GUI, MS-DOS, Win32 and Unix with xterm. Defines the maximum | |
5438 time in msec between two mouse clicks for the second click to be | |
5439 recognized as a multi click. | |
5440 | |
14 | 5441 *'mzquantum'* *'mzq'* |
5442 'mzquantum' 'mzq' number (default 100) | |
5443 global | |
5444 {not in Vi} | |
5445 {not available when compiled without the |+mzscheme| | |
5446 feature} | |
5447 The number of milliseconds between polls for MzScheme threads. | |
5448 Negative or zero value means no thread scheduling. | |
11160 | 5449 NOTE: This option is set to the Vim default value when 'compatible' |
5450 is reset. | |
14 | 5451 |
7 | 5452 *'nrformats'* *'nf'* |
9669
284b4eb307fc
commit https://github.com/vim/vim/commit/8c08b5b569e2a9e9f63dea514591ecfa2d3bb392
Christian Brabandt <cb@256bit.org>
parents:
9665
diff
changeset
|
5453 '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
|
5454 set to "bin,hex" in |defaults.vim|) |
7 | 5455 local to buffer |
5456 {not in Vi} | |
5457 This defines what bases Vim will consider for numbers when using the | |
5458 CTRL-A and CTRL-X commands for adding to and subtracting from a number | |
5459 respectively; see |CTRL-A| for more info on these commands. | |
625 | 5460 alpha If included, single alphabetical characters will be |
7 | 5461 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
|
5462 letter index a), b), etc. *octal-nrformats* |
625 | 5463 octal If included, numbers that start with a zero will be considered |
7 | 5464 to be octal. Example: Using CTRL-A on "007" results in "010". |
625 | 5465 hex If included, numbers starting with "0x" or "0X" will be |
7 | 5466 considered to be hexadecimal. Example: Using CTRL-X on |
5467 "0x100" results in "0x0ff". | |
7528
53163e4d9e4f
commit https://github.com/vim/vim/commit/25e4fcde767084d1a79e0926bc301c92987c0cce
Christian Brabandt <cb@256bit.org>
parents:
7477
diff
changeset
|
5468 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
|
5469 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
|
5470 "0b1000" subtracts one, resulting in "0b0111". |
7 | 5471 Numbers which simply begin with a digit in the range 1-9 are always |
5472 considered decimal. This also happens for numbers that are not | |
5473 recognized as octal or hex. | |
5474 | |
5475 *'number'* *'nu'* *'nonumber'* *'nonu'* | |
5476 'number' 'nu' boolean (default off) | |
5477 local to window | |
5478 Print the line number in front of each line. When the 'n' option is | |
5479 excluded from 'cpoptions' a wrapped line will not use the column of | |
5480 line numbers (this is the default when 'compatible' isn't set). | |
13 | 5481 The 'numberwidth' option can be used to set the room used for the line |
5482 number. | |
7 | 5483 When a long, wrapped line doesn't start with the first character, '-' |
5484 characters are put before the number. | |
3445 | 5485 See |hl-LineNr| and |hl-CursorLineNr| for the highlighting used for |
5486 the number. | |
4780 | 5487 *number_relativenumber* |
5488 The 'relativenumber' option changes the displayed number to be | |
5489 relative to the cursor. Together with 'number' there are these | |
5490 four combinations (cursor in line 3): | |
5491 | |
8629
54ac275e3fc4
commit https://github.com/vim/vim/commit/3848e00e0177abdb31bc600234967863ec487233
Christian Brabandt <cb@256bit.org>
parents:
8560
diff
changeset
|
5492 'nonu' 'nu' 'nonu' 'nu' |
4780 | 5493 'nornu' 'nornu' 'rnu' 'rnu' |
5494 | |
5495 |apple | 1 apple | 2 apple | 2 apple | |
5496 |pear | 2 pear | 1 pear | 1 pear | |
5497 |nobody | 3 nobody | 0 nobody |3 nobody | |
5498 |there | 4 there | 1 there | 1 there | |
7 | 5499 |
13 | 5500 *'numberwidth'* *'nuw'* |
5501 'numberwidth' 'nuw' number (Vim default: 4 Vi default: 8) | |
5502 local to window | |
14 | 5503 {not in Vi} |
5504 {only available when compiled with the |+linebreak| | |
5505 feature} | |
13 | 5506 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
|
5507 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
|
5508 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
|
5509 the text, there is one less character for the number itself. |
13 | 5510 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
|
5511 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
|
5512 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
|
5513 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
|
5514 up to 999. When the buffer has 1000 lines five columns will be used. |
13 | 5515 The minimum value is 1, the maximum value is 10. |
11160 | 5516 NOTE: This option is set to the Vi default value when 'compatible' is |
5517 set and to the Vim default value when 'compatible' is reset. | |
13 | 5518 |
523 | 5519 *'omnifunc'* *'ofu'* |
5520 'omnifunc' 'ofu' string (default: empty) | |
502 | 5521 local to buffer |
5522 {not in Vi} | |
2570
71b56b4e7785
Make the references to features in the help more consistent. (Sylvain Hitier)
Bram Moolenaar <bram@vim.org>
parents:
2561
diff
changeset
|
5523 {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
|
5524 or |+insert_expand| features} |
623 | 5525 This option specifies a function to be used for Insert mode omni |
5526 completion with CTRL-X CTRL-O. |i_CTRL-X_CTRL-O| | |
648 | 5527 See |complete-functions| for an explanation of how the function is |
5528 invoked and what it should return. | |
1004 | 5529 This option is usually set by a filetype plugin: |
859 | 5530 |:filetype-plugin-on| |
3682 | 5531 This option cannot be set from a |modeline| or in the |sandbox|, for |
5532 security reasons. | |
502 | 5533 |
5534 | |
1152 | 5535 *'opendevice'* *'odev'* *'noopendevice'* *'noodev'* |
1004 | 5536 'opendevice' 'odev' boolean (default off) |
5537 global | |
5538 {not in Vi} | |
5539 {only for MS-DOS, MS-Windows and OS/2} | |
5540 Enable reading and writing from devices. This may get Vim stuck on a | |
5541 device that can be opened but doesn't actually do the I/O. Therefore | |
5542 it is off by default. | |
5543 Note that on MS-Windows editing "aux.h", "lpt1.txt" and the like also | |
5544 result in editing a device. | |
5545 | |
5546 | |
593 | 5547 *'operatorfunc'* *'opfunc'* |
5548 'operatorfunc' 'opfunc' string (default: empty) | |
5549 global | |
5550 {not in Vi} | |
5551 This option specifies a function to be called by the |g@| operator. | |
5552 See |:map-operator| for more info and an example. | |
5553 | |
5554 This option cannot be set from a |modeline| or in the |sandbox|, for | |
5555 security reasons. | |
5556 | |
5557 | |
2908 | 5558 *'osfiletype'* *'oft'* |
5559 'osfiletype' 'oft' string (default: "") | |
7 | 5560 local to buffer |
5561 {not in Vi} | |
2908 | 5562 This option was supported on RISC OS, which has been removed. |
5563 | |
7 | 5564 |
8182
95d59081580f
commit https://github.com/vim/vim/commit/f6fee0e2d4341c0c2f5339c1268e5877fafd07cf
Christian Brabandt <cb@256bit.org>
parents:
8148
diff
changeset
|
5565 *'packpath'* *'pp'* |
95d59081580f
commit https://github.com/vim/vim/commit/f6fee0e2d4341c0c2f5339c1268e5877fafd07cf
Christian Brabandt <cb@256bit.org>
parents:
8148
diff
changeset
|
5566 'packpath' 'pp' string (default: see 'runtimepath') |
95d59081580f
commit https://github.com/vim/vim/commit/f6fee0e2d4341c0c2f5339c1268e5877fafd07cf
Christian Brabandt <cb@256bit.org>
parents:
8148
diff
changeset
|
5567 {not in Vi} |
95d59081580f
commit https://github.com/vim/vim/commit/f6fee0e2d4341c0c2f5339c1268e5877fafd07cf
Christian Brabandt <cb@256bit.org>
parents:
8148
diff
changeset
|
5568 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
|
5569 |
95d59081580f
commit https://github.com/vim/vim/commit/f6fee0e2d4341c0c2f5339c1268e5877fafd07cf
Christian Brabandt <cb@256bit.org>
parents:
8148
diff
changeset
|
5570 |
7 | 5571 *'paragraphs'* *'para'* |
1564 | 5572 'paragraphs' 'para' string (default "IPLPPPQPP TPHPLIPpLpItpplpipbp") |
7 | 5573 global |
5574 Specifies the nroff macros that separate paragraphs. These are pairs | |
5575 of two letters (see |object-motions|). | |
5576 | |
5577 *'paste'* *'nopaste'* | |
5578 'paste' boolean (default off) | |
5579 global | |
5580 {not in Vi} | |
10 | 5581 Put Vim in Paste mode. This is useful if you want to cut or copy |
5582 some text from one window and paste it in Vim. This will avoid | |
7 | 5583 unexpected effects. |
5584 Setting this option is useful when using Vim in a terminal, where Vim | |
10 | 5585 cannot distinguish between typed text and pasted text. In the GUI, Vim |
7 | 5586 knows about pasting and will mostly do the right thing without 'paste' |
5587 being set. The same is true for a terminal where Vim handles the | |
5588 mouse clicks itself. | |
148 | 5589 This option is reset when starting the GUI. Thus if you set it in |
5590 your .vimrc it will work in a terminal, but not in the GUI. Setting | |
5591 'paste' in the GUI has side effects: e.g., the Paste toolbar button | |
5592 will no longer work in Insert mode, because it uses a mapping. | |
7 | 5593 When the 'paste' option is switched on (also when it was already on): |
5594 - mapping in Insert mode and Command-line mode is disabled | |
5595 - abbreviations are disabled | |
5596 - 'autoindent' is reset | |
7147
c590de398af9
commit https://github.com/vim/vim/commit/ca63501fbcd1cf9c8aa9ff12c093c95b62a89ed7
Christian Brabandt <cb@256bit.org>
parents:
7080
diff
changeset
|
5597 - 'expandtab' is reset |
c590de398af9
commit https://github.com/vim/vim/commit/ca63501fbcd1cf9c8aa9ff12c093c95b62a89ed7
Christian Brabandt <cb@256bit.org>
parents:
7080
diff
changeset
|
5598 - 'formatoptions' is used like it is empty |
7 | 5599 - 'revins' is reset |
5600 - 'ruler' is reset | |
5601 - 'showmatch' is reset | |
7147
c590de398af9
commit https://github.com/vim/vim/commit/ca63501fbcd1cf9c8aa9ff12c093c95b62a89ed7
Christian Brabandt <cb@256bit.org>
parents:
7080
diff
changeset
|
5602 - 'smartindent' is reset |
c590de398af9
commit https://github.com/vim/vim/commit/ca63501fbcd1cf9c8aa9ff12c093c95b62a89ed7
Christian Brabandt <cb@256bit.org>
parents:
7080
diff
changeset
|
5603 - 'smarttab' is reset |
c590de398af9
commit https://github.com/vim/vim/commit/ca63501fbcd1cf9c8aa9ff12c093c95b62a89ed7
Christian Brabandt <cb@256bit.org>
parents:
7080
diff
changeset
|
5604 - 'softtabstop' is set to 0 |
c590de398af9
commit https://github.com/vim/vim/commit/ca63501fbcd1cf9c8aa9ff12c093c95b62a89ed7
Christian Brabandt <cb@256bit.org>
parents:
7080
diff
changeset
|
5605 - 'textwidth' is set to 0 |
c590de398af9
commit https://github.com/vim/vim/commit/ca63501fbcd1cf9c8aa9ff12c093c95b62a89ed7
Christian Brabandt <cb@256bit.org>
parents:
7080
diff
changeset
|
5606 - 'wrapmargin' is set to 0 |
7 | 5607 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
|
5608 - 'cindent' |
c590de398af9
commit https://github.com/vim/vim/commit/ca63501fbcd1cf9c8aa9ff12c093c95b62a89ed7
Christian Brabandt <cb@256bit.org>
parents:
7080
diff
changeset
|
5609 - 'indentexpr' |
7 | 5610 - 'lisp' |
5611 NOTE: When you start editing another file while the 'paste' option is | |
5612 on, settings from the modelines or autocommands may change the | |
5613 settings again, causing trouble when pasting text. You might want to | |
5614 set the 'paste' option again. | |
5615 When the 'paste' option is reset the mentioned options are restored to | |
5616 the value before the moment 'paste' was switched from off to on. | |
5617 Resetting 'paste' before ever setting it does not have any effect. | |
5618 Since mapping doesn't work while 'paste' is active, you need to use | |
5619 the 'pastetoggle' option to toggle the 'paste' option with some key. | |
5620 | |
5621 *'pastetoggle'* *'pt'* | |
5622 'pastetoggle' 'pt' string (default "") | |
5623 global | |
5624 {not in Vi} | |
5625 When non-empty, specifies the key sequence that toggles the 'paste' | |
5626 option. This is like specifying a mapping: > | |
5627 :map {keys} :set invpaste<CR> | |
5628 < Where {keys} is the value of 'pastetoggle'. | |
5629 The difference is that it will work even when 'paste' is set. | |
5630 'pastetoggle' works in Insert mode and Normal mode, but not in | |
5631 Command-line mode. | |
5632 Mappings are checked first, thus overrule 'pastetoggle'. However, | |
5633 when 'paste' is on mappings are ignored in Insert mode, thus you can do | |
5634 this: > | |
5635 :map <F10> :set paste<CR> | |
5636 :map <F11> :set nopaste<CR> | |
5637 :imap <F10> <C-O>:set paste<CR> | |
5638 :imap <F11> <nop> | |
5639 :set pastetoggle=<F11> | |
5640 < This will make <F10> start paste mode and <F11> stop paste mode. | |
5641 Note that typing <F10> in paste mode inserts "<F10>", since in paste | |
5642 mode everything is inserted literally, except the 'pastetoggle' key | |
5643 sequence. | |
1621 | 5644 When the value has several bytes 'ttimeoutlen' applies. |
7 | 5645 |
5646 *'pex'* *'patchexpr'* | |
5647 'patchexpr' 'pex' string (default "") | |
5648 global | |
5649 {not in Vi} | |
5650 {not available when compiled without the |+diff| | |
5651 feature} | |
5652 Expression which is evaluated to apply a patch to a file and generate | |
10 | 5653 the resulting new version of the file. See |diff-patchexpr|. |
7 | 5654 |
6091
7090d7f160f7
Update runtime files. Add vroom file support.
Bram Moolenaar <bram@vim.org>
parents:
6032
diff
changeset
|
5655 *'patchmode'* *'pm'* *E205* *E206* |
7 | 5656 'patchmode' 'pm' string (default "") |
5657 global | |
5658 {not in Vi} | |
5659 When non-empty the oldest version of a file is kept. This can be used | |
5660 to keep the original version of a file if you are changing files in a | |
5661 source distribution. Only the first time that a file is written a | |
5662 copy of the original file will be kept. The name of the copy is the | |
5663 name of the original file with the string in the 'patchmode' option | |
5664 appended. This option should start with a dot. Use a string like | |
5665 ".org". 'backupdir' must not be empty for this to work (Detail: The | |
5666 backup file is renamed to the patchmode file after the new file has | |
5667 been successfully written, that's why it must be possible to write a | |
5668 backup file). If there was no file to be backed up, an empty file is | |
5669 created. | |
5670 When the 'backupskip' pattern matches, a patchmode file is not made. | |
5671 Using 'patchmode' for compressed files appends the extension at the | |
5672 end (e.g., "file.gz.orig"), thus the resulting name isn't always | |
5673 recognized as a compressed file. | |
36 | 5674 Only normal file name characters can be used, "/\*?[|<>" are illegal. |
7 | 5675 |
3224 | 5676 *'path'* *'pa'* *E343* *E345* *E347* *E854* |
7 | 5677 'path' 'pa' string (default on Unix: ".,/usr/include,," |
5678 on OS/2: ".,/emx/include,," | |
5679 other systems: ".,,") | |
5680 global or local to buffer |global-local| | |
5681 {not in Vi} | |
5682 This is a list of directories which will be searched when using the | |
1668 | 5683 |gf|, [f, ]f, ^Wf, |:find|, |:sfind|, |:tabfind| and other commands, |
5684 provided that the file being searched for has a relative path (not | |
5685 starting with "/", "./" or "../"). The directories in the 'path' | |
5686 option may be relative or absolute. | |
7 | 5687 - Use commas to separate directory names: > |
5688 :set path=.,/usr/local/include,/usr/include | |
5689 < - Spaces can also be used to separate directory names (for backwards | |
5690 compatibility with version 3.0). To have a space in a directory | |
5691 name, precede it with an extra backslash, and escape the space: > | |
5692 :set path=.,/dir/with\\\ space | |
5693 < - To include a comma in a directory name precede it with an extra | |
5694 backslash: > | |
5695 :set path=.,/dir/with\\,comma | |
5696 < - To search relative to the directory of the current file, use: > | |
5697 :set path=. | |
5698 < - To search in the current directory use an empty string between two | |
5699 commas: > | |
5700 :set path=,, | |
5701 < - A directory name may end in a ':' or '/'. | |
5702 - Environment variables are expanded |:set_env|. | |
5703 - When using |netrw.vim| URLs can be used. For example, adding | |
5704 "http://www.vim.org" will make ":find index.html" work. | |
1668 | 5705 - Search upwards and downwards in a directory tree using "*", "**" and |
5706 ";". See |file-searching| for info and syntax. | |
7 | 5707 {not available when compiled without the |+path_extra| feature} |
5708 - Careful with '\' characters, type two to get one in the option: > | |
5709 :set path=.,c:\\include | |
5710 < Or just use '/' instead: > | |
5711 :set path=.,c:/include | |
5712 < Don't forget "." or files won't even be found in the same directory as | |
5713 the file! | |
10 | 5714 The maximum length is limited. How much depends on the system, mostly |
7 | 5715 it is something like 256 or 1024 characters. |
5716 You can check if all the include files are found, using the value of | |
5717 'path', see |:checkpath|. | |
5718 The use of |:set+=| and |:set-=| is preferred when adding or removing | |
5719 directories from the list. This avoids problems when a future version | |
5720 uses another default. To remove the current directory use: > | |
5721 :set path-= | |
5722 < To add the current directory use: > | |
5723 :set path+= | |
5724 < To use an environment variable, you probably need to replace the | |
5725 separator. Here is an example to append $INCL, in which directory | |
5726 names are separated with a semi-colon: > | |
5727 :let &path = &path . "," . substitute($INCL, ';', ',', 'g') | |
5728 < Replace the ';' with a ':' or whatever separator is used. Note that | |
5729 this doesn't work when $INCL contains a comma or white space. | |
5730 | |
5731 *'preserveindent'* *'pi'* *'nopreserveindent'* *'nopi'* | |
5732 'preserveindent' 'pi' boolean (default off) | |
5733 local to buffer | |
5734 {not in Vi} | |
5735 When changing the indent of the current line, preserve as much of the | |
5736 indent structure as possible. Normally the indent is replaced by a | |
5737 series of tabs followed by spaces as required (unless |'expandtab'| is | |
5738 enabled, in which case only spaces are used). Enabling this option | |
5739 means the indent will preserve as many existing characters as possible | |
5740 for indenting, and only add additional tabs or spaces as required. | |
1621 | 5741 'expandtab' does not apply to the preserved white space, a Tab remains |
5742 a Tab. | |
7 | 5743 NOTE: When using ">>" multiple times the resulting indent is a mix of |
5744 tabs and spaces. You might not like this. | |
11160 | 5745 NOTE: This option is reset when 'compatible' is set. |
7 | 5746 Also see 'copyindent'. |
5747 Use |:retab| to clean up white space. | |
5748 | |
5749 *'previewheight'* *'pvh'* | |
5750 'previewheight' 'pvh' number (default 12) | |
5751 global | |
5752 {not in Vi} | |
5753 {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
|
5754 |+quickfix| features} |
7 | 5755 Default height for a preview window. Used for |:ptag| and associated |
5756 commands. Used for |CTRL-W_}| when no count is given. | |
5757 | |
5758 *'previewwindow'* *'nopreviewwindow'* | |
5759 *'pvw'* *'nopvw'* *E590* | |
5760 'previewwindow' 'pvw' boolean (default off) | |
5761 local to window | |
5762 {not in Vi} | |
5763 {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
|
5764 |+quickfix| features} |
10 | 5765 Identifies the preview window. Only one window can have this option |
7 | 5766 set. It's normally not set directly, but by using one of the commands |
5767 |:ptag|, |:pedit|, etc. | |
5768 | |
5769 *'printdevice'* *'pdev'* | |
5770 'printdevice' 'pdev' string (default empty) | |
5771 global | |
5772 {not in Vi} | |
5773 {only available when compiled with the |+printer| | |
5774 feature} | |
15 | 5775 The name of the printer to be used for |:hardcopy|. |
5776 See |pdev-option|. | |
36 | 5777 This option cannot be set from a |modeline| or in the |sandbox|, for |
5778 security reasons. | |
15 | 5779 |
5780 *'printencoding'* *'penc'* | |
5781 'printencoding' 'penc' String (default empty, except for some systems) | |
7 | 5782 global |
5783 {not in Vi} | |
5784 {only available when compiled with the |+printer| | |
5785 and |+postscript| features} | |
15 | 5786 Sets the character encoding used when printing. |
5787 See |penc-option|. | |
7 | 5788 |
5789 *'printexpr'* *'pexpr'* | |
5790 'printexpr' 'pexpr' String (default: see below) | |
5791 global | |
5792 {not in Vi} | |
5793 {only available when compiled with the |+printer| | |
5794 and |+postscript| features} | |
15 | 5795 Expression used to print the PostScript produced with |:hardcopy|. |
5796 See |pexpr-option|. | |
10449
222b1432814e
commit https://github.com/vim/vim/commit/5162822914372fc916a93f85848c0c82209e7cec
Christian Brabandt <cb@256bit.org>
parents:
10272
diff
changeset
|
5797 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
|
5798 security reasons. |
15 | 5799 |
5800 *'printfont'* *'pfn'* | |
7 | 5801 'printfont' 'pfn' string (default "courier") |
5802 global | |
5803 {not in Vi} | |
5804 {only available when compiled with the |+printer| | |
5805 feature} | |
15 | 5806 The name of the font that will be used for |:hardcopy|. |
5807 See |pfn-option|. | |
7 | 5808 |
5809 *'printheader'* *'pheader'* | |
5810 'printheader' 'pheader' string (default "%<%f%h%m%=Page %N") | |
5811 global | |
5812 {not in Vi} | |
5813 {only available when compiled with the |+printer| | |
5814 feature} | |
15 | 5815 The format of the header produced in |:hardcopy| output. |
5816 See |pheader-option|. | |
5817 | |
5818 *'printmbcharset'* *'pmbcs'* | |
5819 'printmbcharset' 'pmbcs' string (default "") | |
5820 global | |
5821 {not in Vi} | |
180 | 5822 {only available when compiled with the |+printer|, |
5823 |+postscript| and |+multi_byte| features} | |
15 | 5824 The CJK character set to be used for CJK output from |:hardcopy|. |
5825 See |pmbcs-option|. | |
5826 | |
5827 *'printmbfont'* *'pmbfn'* | |
5828 'printmbfont' 'pmbfn' string (default "") | |
5829 global | |
5830 {not in Vi} | |
180 | 5831 {only available when compiled with the |+printer|, |
5832 |+postscript| and |+multi_byte| features} | |
15 | 5833 List of font names to be used for CJK output from |:hardcopy|. |
5834 See |pmbfn-option|. | |
7 | 5835 |
5836 *'printoptions'* *'popt'* | |
5837 'printoptions' 'popt' string (default "") | |
5838 global | |
5839 {not in Vi} | |
5840 {only available when compiled with |+printer| feature} | |
15 | 5841 List of items that control the format of the output of |:hardcopy|. |
5842 See |popt-option|. | |
5843 | |
168 | 5844 *'prompt'* *'noprompt'* |
5845 'prompt' boolean (default on) | |
5846 global | |
5847 When on a ":" prompt is used in Ex mode. | |
5848 | |
766 | 5849 *'pumheight'* *'ph'* |
5850 'pumheight' 'ph' number (default 0) | |
5851 global | |
5852 {not available when compiled without the | |
5853 |+insert_expand| feature} | |
5854 {not in Vi} | |
853 | 5855 Determines the maximum number of items to show in the popup menu for |
5856 Insert mode completion. When zero as much space as available is used. | |
766 | 5857 |ins-completion-menu|. |
5858 | |
7228
873eae260c97
commit https://github.com/vim/vim/commit/b4ff518d95aa57c2f8c0568c915035bef849581b
Christian Brabandt <cb@256bit.org>
parents:
7218
diff
changeset
|
5859 *'pythondll'* |
8629
54ac275e3fc4
commit https://github.com/vim/vim/commit/3848e00e0177abdb31bc600234967863ec487233
Christian Brabandt <cb@256bit.org>
parents:
8560
diff
changeset
|
5860 '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
|
5861 global |
53163e4d9e4f
commit https://github.com/vim/vim/commit/25e4fcde767084d1a79e0926bc301c92987c0cce
Christian Brabandt <cb@256bit.org>
parents:
7477
diff
changeset
|
5862 {not in Vi} |
7228
873eae260c97
commit https://github.com/vim/vim/commit/b4ff518d95aa57c2f8c0568c915035bef849581b
Christian Brabandt <cb@256bit.org>
parents:
7218
diff
changeset
|
5863 {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
|
5864 feature} |
7528
53163e4d9e4f
commit https://github.com/vim/vim/commit/25e4fcde767084d1a79e0926bc301c92987c0cce
Christian Brabandt <cb@256bit.org>
parents:
7477
diff
changeset
|
5865 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
|
5866 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
|
5867 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
|
5868 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
|
5869 security reasons. |
873eae260c97
commit https://github.com/vim/vim/commit/b4ff518d95aa57c2f8c0568c915035bef849581b
Christian Brabandt <cb@256bit.org>
parents:
7218
diff
changeset
|
5870 |
7218
36dc8df8560f
commit https://github.com/vim/vim/commit/0796c0625fa4b9eb2f47fe8c976b78523924e1fb
Christian Brabandt <cb@256bit.org>
parents:
7196
diff
changeset
|
5871 *'pythonthreedll'* |
7528
53163e4d9e4f
commit https://github.com/vim/vim/commit/25e4fcde767084d1a79e0926bc301c92987c0cce
Christian Brabandt <cb@256bit.org>
parents:
7477
diff
changeset
|
5872 '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
|
5873 global |
53163e4d9e4f
commit https://github.com/vim/vim/commit/25e4fcde767084d1a79e0926bc301c92987c0cce
Christian Brabandt <cb@256bit.org>
parents:
7477
diff
changeset
|
5874 {not in Vi} |
7196
42717d048817
commit https://github.com/vim/vim/commit/d94464ee294a351ce7b6ba18e8bd3f24f1bef920
Christian Brabandt <cb@256bit.org>
parents:
7147
diff
changeset
|
5875 {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
|
5876 feature} |
7528
53163e4d9e4f
commit https://github.com/vim/vim/commit/25e4fcde767084d1a79e0926bc301c92987c0cce
Christian Brabandt <cb@256bit.org>
parents:
7477
diff
changeset
|
5877 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
|
5878 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
|
5879 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
|
5880 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
|
5881 security reasons. |
42717d048817
commit https://github.com/vim/vim/commit/d94464ee294a351ce7b6ba18e8bd3f24f1bef920
Christian Brabandt <cb@256bit.org>
parents:
7147
diff
changeset
|
5882 |
10722
7598ce51bf2a
patch 8.0.0251: not easy to select Python 2 or 3
Christian Brabandt <cb@256bit.org>
parents:
10617
diff
changeset
|
5883 *'pyxversion'* *'pyx'* |
7598ce51bf2a
patch 8.0.0251: not easy to select Python 2 or 3
Christian Brabandt <cb@256bit.org>
parents:
10617
diff
changeset
|
5884 '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
|
5885 global |
7598ce51bf2a
patch 8.0.0251: not easy to select Python 2 or 3
Christian Brabandt <cb@256bit.org>
parents:
10617
diff
changeset
|
5886 {not in Vi} |
7598ce51bf2a
patch 8.0.0251: not easy to select Python 2 or 3
Christian Brabandt <cb@256bit.org>
parents:
10617
diff
changeset
|
5887 {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
|
5888 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
|
5889 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
|
5890 |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
|
5891 |
7598ce51bf2a
patch 8.0.0251: not easy to select Python 2 or 3
Christian Brabandt <cb@256bit.org>
parents:
10617
diff
changeset
|
5892 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
|
5893 |+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
|
5894 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
|
5895 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
|
5896 |
7598ce51bf2a
patch 8.0.0251: not easy to select Python 2 or 3
Christian Brabandt <cb@256bit.org>
parents:
10617
diff
changeset
|
5897 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
|
5898 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
|
5899 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
|
5900 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
|
5901 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
|
5902 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
|
5903 |
7598ce51bf2a
patch 8.0.0251: not easy to select Python 2 or 3
Christian Brabandt <cb@256bit.org>
parents:
10617
diff
changeset
|
5904 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
|
5905 '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
|
5906 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
|
5907 |
7598ce51bf2a
patch 8.0.0251: not easy to select Python 2 or 3
Christian Brabandt <cb@256bit.org>
parents:
10617
diff
changeset
|
5908 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
|
5909 security reasons. |
7598ce51bf2a
patch 8.0.0251: not easy to select Python 2 or 3
Christian Brabandt <cb@256bit.org>
parents:
10617
diff
changeset
|
5910 |
140 | 5911 *'quoteescape'* *'qe'* |
12 | 5912 'quoteescape' 'qe' string (default "\") |
5913 local to buffer | |
5914 {not in Vi} | |
5915 The characters that are used to escape quotes in a string. Used for | |
5916 objects like a', a" and a` |a'|. | |
5917 When one of the characters in this option is found inside a string, | |
5918 the following character will be skipped. The default value makes the | |
5919 text "foo\"bar\\" considered to be one string. | |
5920 | |
7 | 5921 *'readonly'* *'ro'* *'noreadonly'* *'noro'* |
5922 'readonly' 'ro' boolean (default off) | |
5923 local to buffer | |
5924 If on, writes fail unless you use a '!'. Protects you from | |
5925 accidentally overwriting a file. Default on when Vim is started | |
5926 in read-only mode ("vim -R") or when the executable is called "view". | |
164 | 5927 When using ":w!" the 'readonly' option is reset for the current |
5928 buffer, unless the 'Z' flag is in 'cpoptions'. | |
7 | 5929 {not in Vi:} When using the ":view" command the 'readonly' option is |
164 | 5930 set for the newly edited buffer. |
10617 | 5931 See 'modifiable' for disallowing changes to the buffer. |
7 | 5932 |
1521 | 5933 *'redrawtime'* *'rdt'* |
5934 'redrawtime' 'rdt' number (default 2000) | |
5935 global | |
5936 {not in Vi} | |
5937 {only available when compiled with the |+reltime| | |
5938 feature} | |
5939 The time in milliseconds for redrawing the display. This applies to | |
11529
998d2cf59caa
patch 8.0.0647: syntax highlighting can make cause a freeze
Christian Brabandt <cb@256bit.org>
parents:
11516
diff
changeset
|
5940 searching for patterns for 'hlsearch', |:match| highlighting an syntax |
998d2cf59caa
patch 8.0.0647: syntax highlighting can make cause a freeze
Christian Brabandt <cb@256bit.org>
parents:
11516
diff
changeset
|
5941 highlighting. |
1521 | 5942 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
|
5943 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
|
5944 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
|
5945 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
|
5946 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
|
5947 pattern. |
1521 | 5948 |
4681
2eb30f341e8d
Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents:
4502
diff
changeset
|
5949 *'regexpengine'* *'re'* |
4502
605c9ce57ec3
Updated runtime files, language files and translations.
Bram Moolenaar <bram@vim.org>
parents:
4358
diff
changeset
|
5950 'regexpengine' 're' number (default 0) |
605c9ce57ec3
Updated runtime files, language files and translations.
Bram Moolenaar <bram@vim.org>
parents:
4358
diff
changeset
|
5951 global |
605c9ce57ec3
Updated runtime files, language files and translations.
Bram Moolenaar <bram@vim.org>
parents:
4358
diff
changeset
|
5952 {not in Vi} |
605c9ce57ec3
Updated runtime files, language files and translations.
Bram Moolenaar <bram@vim.org>
parents:
4358
diff
changeset
|
5953 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
|
5954 The possible values are: |
605c9ce57ec3
Updated runtime files, language files and translations.
Bram Moolenaar <bram@vim.org>
parents:
4358
diff
changeset
|
5955 0 automatic selection |
605c9ce57ec3
Updated runtime files, language files and translations.
Bram Moolenaar <bram@vim.org>
parents:
4358
diff
changeset
|
5956 1 old engine |
605c9ce57ec3
Updated runtime files, language files and translations.
Bram Moolenaar <bram@vim.org>
parents:
4358
diff
changeset
|
5957 2 NFA engine |
605c9ce57ec3
Updated runtime files, language files and translations.
Bram Moolenaar <bram@vim.org>
parents:
4358
diff
changeset
|
5958 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
|
5959 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
|
5960 for debugging the regexp engine. |
6328 | 5961 Using automatic selection enables Vim to switch the engine, if the |
5962 default engine becomes too costly. E.g., when the NFA engine uses too | |
5963 many states. This should prevent Vim from hanging on a combination of | |
5964 a complex pattern with long text. | |
4502
605c9ce57ec3
Updated runtime files, language files and translations.
Bram Moolenaar <bram@vim.org>
parents:
4358
diff
changeset
|
5965 |
2178
c6f1aa1e9f32
Add 'relativenumber' patch from Markus Heidelberg.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
5966 *'relativenumber'* *'rnu'* *'norelativenumber'* *'nornu'* |
c6f1aa1e9f32
Add 'relativenumber' patch from Markus Heidelberg.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
5967 'relativenumber' 'rnu' boolean (default off) |
c6f1aa1e9f32
Add 'relativenumber' patch from Markus Heidelberg.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
5968 local to window |
c6f1aa1e9f32
Add 'relativenumber' patch from Markus Heidelberg.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
5969 {not in Vi} |
c6f1aa1e9f32
Add 'relativenumber' patch from Markus Heidelberg.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
5970 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
|
5971 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
|
5972 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
|
5973 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
|
5974 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
|
5975 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
|
5976 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
|
5977 'compatible' isn't set). |
c6f1aa1e9f32
Add 'relativenumber' patch from Markus Heidelberg.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
5978 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
|
5979 number. |
c6f1aa1e9f32
Add 'relativenumber' patch from Markus Heidelberg.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
5980 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
|
5981 characters are put before the number. |
3445 | 5982 See |hl-LineNr| and |hl-CursorLineNr| for the highlighting used for |
5983 the number. | |
4780 | 5984 |
5985 The number in front of the cursor line also depends on the value of | |
5986 'number', see |number_relativenumber| for all combinations of the two | |
5987 options. | |
2178
c6f1aa1e9f32
Add 'relativenumber' patch from Markus Heidelberg.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
5988 |
7 | 5989 *'remap'* *'noremap'* |
5990 'remap' boolean (default on) | |
5991 global | |
5992 Allows for mappings to work recursively. If you do not want this for | |
5993 a single entry, use the :noremap[!] command. | |
717 | 5994 NOTE: To avoid portability problems with Vim scripts, always keep |
5995 this option at the default "on". Only switch it off when working with | |
5996 old Vi scripts. | |
7 | 5997 |
6110 | 5998 *'renderoptions'* *'rop'* |
5999 'renderoptions' 'rop' string (default: empty) | |
6000 global | |
6001 {not in Vi} | |
6002 {only available when compiled with GUI and DIRECTX on | |
6003 MS-Windows} | |
6004 Select a text renderer and set its options. The options depend on the | |
6005 renderer. | |
6006 | |
6007 Syntax: > | |
6008 set rop=type:{renderer}(,{name}:{value})* | |
6009 < | |
6010 Currently, only one optional renderer is available. | |
6011 | |
6012 render behavior ~ | |
6013 directx Vim will draw text using DirectX (DirectWrite). It makes | |
6014 drawn glyphs more beautiful than default GDI. | |
6015 It requires 'encoding' is "utf-8", and only works on | |
6016 MS-Windows Vista or newer version. | |
6017 | |
6018 Options: | |
6019 name meaning type value ~ | |
6020 gamma gamma float 1.0 - 2.2 (maybe) | |
6021 contrast enhancedContrast float (unknown) | |
6022 level clearTypeLevel float (unknown) | |
6023 geom pixelGeometry int 0 - 2 (see below) | |
6024 renmode renderingMode int 0 - 6 (see below) | |
6025 taamode textAntialiasMode int 0 - 3 (see below) | |
6026 | |
6027 See this URL for detail: | |
6028 http://msdn.microsoft.com/en-us/library/dd368190.aspx | |
6029 | |
6030 For geom: structure of a device pixel. | |
6031 0 - DWRITE_PIXEL_GEOMETRY_FLAT | |
6032 1 - DWRITE_PIXEL_GEOMETRY_RGB | |
6033 2 - DWRITE_PIXEL_GEOMETRY_BGR | |
6034 | |
6035 See this URL for detail: | |
6036 http://msdn.microsoft.com/en-us/library/dd368114.aspx | |
6037 | |
6038 For renmode: method of rendering glyphs. | |
6039 0 - DWRITE_RENDERING_MODE_DEFAULT | |
6040 1 - DWRITE_RENDERING_MODE_ALIASED | |
6041 2 - DWRITE_RENDERING_MODE_GDI_CLASSIC | |
6042 3 - DWRITE_RENDERING_MODE_GDI_NATURAL | |
6043 4 - DWRITE_RENDERING_MODE_NATURAL | |
6044 5 - DWRITE_RENDERING_MODE_NATURAL_SYMMETRIC | |
6045 6 - DWRITE_RENDERING_MODE_OUTLINE | |
6046 | |
6047 See this URL for detail: | |
6048 http://msdn.microsoft.com/en-us/library/dd368118.aspx | |
6049 | |
6050 For taamode: antialiasing mode used for drawing text. | |
6051 0 - D2D1_TEXT_ANTIALIAS_MODE_DEFAULT | |
6052 1 - D2D1_TEXT_ANTIALIAS_MODE_CLEARTYPE | |
6053 2 - D2D1_TEXT_ANTIALIAS_MODE_GRAYSCALE | |
6054 3 - D2D1_TEXT_ANTIALIAS_MODE_ALIASED | |
6055 | |
6056 See this URL for detail: | |
6057 http://msdn.microsoft.com/en-us/library/dd368170.aspx | |
6058 | |
6059 Example: > | |
6060 set encoding=utf-8 | |
6061 set gfn=Ricty_Diminished:h12:cSHIFTJIS | |
6062 set rop=type:directx | |
6063 < | |
6064 If select a raster font (Courier, Terminal or FixedSys) to | |
6065 'guifont', it fallbacks to be drawn by GDI automatically. | |
6066 | |
6067 Other render types are currently not supported. | |
6068 | |
7 | 6069 *'report'* |
6070 'report' number (default 2) | |
6071 global | |
6072 Threshold for reporting number of lines changed. When the number of | |
6073 changed lines is more than 'report' a message will be given for most | |
6074 ":" commands. If you want it always, set 'report' to 0. | |
6075 For the ":substitute" command the number of substitutions is used | |
6076 instead of the number of lines. | |
6077 | |
6078 *'restorescreen'* *'rs'* *'norestorescreen'* *'nors'* | |
6079 'restorescreen' 'rs' boolean (default on) | |
6080 global | |
6081 {not in Vi} {only in Windows 95/NT console version} | |
6082 When set, the screen contents is restored when exiting Vim. This also | |
6083 happens when executing external commands. | |
6084 | |
6085 For non-Windows Vim: You can set or reset the 't_ti' and 't_te' | |
6086 options in your .vimrc. To disable restoring: | |
6087 set t_ti= t_te= | |
6088 To enable restoring (for an xterm): | |
6089 set t_ti=^[7^[[r^[[?47h t_te=^[[?47l^[8 | |
6090 (Where ^[ is an <Esc>, type CTRL-V <Esc> to insert it) | |
6091 | |
6092 *'revins'* *'ri'* *'norevins'* *'nori'* | |
6093 'revins' 'ri' boolean (default off) | |
6094 global | |
6095 {not in Vi} | |
6096 {only available when compiled with the |+rightleft| | |
6097 feature} | |
6098 Inserting characters in Insert mode will work backwards. See "typing | |
6099 backwards" |ins-reverse|. This option can be toggled with the CTRL-_ | |
6100 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
|
6101 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
|
6102 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
|
6103 reset. |
7 | 6104 |
6105 *'rightleft'* *'rl'* *'norightleft'* *'norl'* | |
6106 'rightleft' 'rl' boolean (default off) | |
6107 local to window | |
6108 {not in Vi} | |
6109 {only available when compiled with the |+rightleft| | |
6110 feature} | |
6111 When on, display orientation becomes right-to-left, i.e., characters | |
6112 that are stored in the file appear from the right to the left. | |
6113 Using this option, it is possible to edit files for languages that | |
6114 are written from the right to the left such as Hebrew and Arabic. | |
6115 This option is per window, so it is possible to edit mixed files | |
6116 simultaneously, or to view the same file in both ways (this is | |
6117 useful whenever you have a mixed text file with both right-to-left | |
6118 and left-to-right strings so that both sets are displayed properly | |
6119 in different windows). Also see |rileft.txt|. | |
6120 | |
2341 | 6121 *'rightleftcmd'* *'rlc'* |
7 | 6122 'rightleftcmd' 'rlc' string (default "search") |
6123 local to window | |
6124 {not in Vi} | |
6125 {only available when compiled with the |+rightleft| | |
6126 feature} | |
6127 Each word in this option enables the command line editing to work in | |
6128 right-to-left mode for a group of commands: | |
6129 | |
6130 search "/" and "?" commands | |
6131 | |
6132 This is useful for languages such as Hebrew, Arabic and Farsi. | |
6133 The 'rightleft' option must be set for 'rightleftcmd' to take effect. | |
6134 | |
7196
42717d048817
commit https://github.com/vim/vim/commit/d94464ee294a351ce7b6ba18e8bd3f24f1bef920
Christian Brabandt <cb@256bit.org>
parents:
7147
diff
changeset
|
6135 *'rubydll'* |
8629
54ac275e3fc4
commit https://github.com/vim/vim/commit/3848e00e0177abdb31bc600234967863ec487233
Christian Brabandt <cb@256bit.org>
parents:
8560
diff
changeset
|
6136 '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
|
6137 global |
53163e4d9e4f
commit https://github.com/vim/vim/commit/25e4fcde767084d1a79e0926bc301c92987c0cce
Christian Brabandt <cb@256bit.org>
parents:
7477
diff
changeset
|
6138 {not in Vi} |
7196
42717d048817
commit https://github.com/vim/vim/commit/d94464ee294a351ce7b6ba18e8bd3f24f1bef920
Christian Brabandt <cb@256bit.org>
parents:
7147
diff
changeset
|
6139 {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
|
6140 feature} |
7528
53163e4d9e4f
commit https://github.com/vim/vim/commit/25e4fcde767084d1a79e0926bc301c92987c0cce
Christian Brabandt <cb@256bit.org>
parents:
7477
diff
changeset
|
6141 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
|
6142 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
|
6143 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
|
6144 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
|
6145 security reasons. |
42717d048817
commit https://github.com/vim/vim/commit/d94464ee294a351ce7b6ba18e8bd3f24f1bef920
Christian Brabandt <cb@256bit.org>
parents:
7147
diff
changeset
|
6146 |
7 | 6147 *'ruler'* *'ru'* *'noruler'* *'noru'* |
9669
284b4eb307fc
commit https://github.com/vim/vim/commit/8c08b5b569e2a9e9f63dea514591ecfa2d3bb392
Christian Brabandt <cb@256bit.org>
parents:
9665
diff
changeset
|
6148 'ruler' 'ru' boolean (default off, set in |defaults.vim|) |
7 | 6149 global |
6150 {not in Vi} | |
6151 {not available when compiled without the | |
6152 |+cmdline_info| feature} | |
6153 Show the line and column number of the cursor position, separated by a | |
10 | 6154 comma. When there is room, the relative position of the displayed |
7 | 6155 text in the file is shown on the far right: |
6156 Top first line is visible | |
6157 Bot last line is visible | |
6158 All first and last line are visible | |
6159 45% relative position in the file | |
6160 If 'rulerformat' is set, it will determine the contents of the ruler. | |
10 | 6161 Each window has its own ruler. If a window has a status line, the |
7 | 6162 ruler is shown there. Otherwise it is shown in the last line of the |
233 | 6163 screen. If the statusline is given by 'statusline' (i.e. not empty), |
7 | 6164 this option takes precedence over 'ruler' and 'rulerformat' |
6165 If the number of characters displayed is different from the number of | |
6166 bytes in the text (e.g., for a TAB or a multi-byte character), both | |
6167 the text column (byte number) and the screen column are shown, | |
6168 separated with a dash. | |
6169 For an empty line "0-1" is shown. | |
6170 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
|
6171 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
|
6172 reset. |
7 | 6173 If you don't want to see the ruler all the time but want to know where |
6174 you are, use "g CTRL-G" |g_CTRL-G|. | |
6175 NOTE: This option is reset when 'compatible' is set. | |
6176 | |
6177 *'rulerformat'* *'ruf'* | |
6178 'rulerformat' 'ruf' string (default empty) | |
6179 global | |
6180 {not in Vi} | |
6181 {not available when compiled without the |+statusline| | |
6182 feature} | |
6183 When this option is not empty, it determines the content of the ruler | |
6184 string, as displayed for the 'ruler' option. | |
692 | 6185 The format of this option is like that of 'statusline'. |
7 | 6186 The default ruler width is 17 characters. To make the ruler 15 |
6187 characters wide, put "%15(" at the start and "%)" at the end. | |
6188 Example: > | |
6189 :set rulerformat=%15(%c%V\ %p%%%) | |
6190 < | |
6191 *'runtimepath'* *'rtp'* *vimfiles* | |
6192 'runtimepath' 'rtp' string (default: | |
6193 Unix: "$HOME/.vim, | |
6194 $VIM/vimfiles, | |
6195 $VIMRUNTIME, | |
6196 $VIM/vimfiles/after, | |
6197 $HOME/.vim/after" | |
6198 Amiga: "home:vimfiles, | |
6199 $VIM/vimfiles, | |
6200 $VIMRUNTIME, | |
6201 $VIM/vimfiles/after, | |
6202 home:vimfiles/after" | |
6203 PC, OS/2: "$HOME/vimfiles, | |
6204 $VIM/vimfiles, | |
6205 $VIMRUNTIME, | |
6206 $VIM/vimfiles/after, | |
6207 $HOME/vimfiles/after" | |
6208 Macintosh: "$VIM:vimfiles, | |
6209 $VIMRUNTIME, | |
6210 $VIM:vimfiles:after" | |
6211 RISC-OS: "Choices:vimfiles, | |
6212 $VIMRUNTIME, | |
6213 Choices:vimfiles/after" | |
6214 VMS: "sys$login:vimfiles, | |
6215 $VIM/vimfiles, | |
6216 $VIMRUNTIME, | |
6217 $VIM/vimfiles/after, | |
233 | 6218 sys$login:vimfiles/after") |
7 | 6219 global |
6220 {not in Vi} | |
6221 This is a list of directories which will be searched for runtime | |
6222 files: | |
6223 filetype.vim filetypes by file name |new-filetype| | |
6224 scripts.vim filetypes by file contents |new-filetype-scripts| | |
164 | 6225 autoload/ automatically loaded scripts |autoload-functions| |
7 | 6226 colors/ color scheme files |:colorscheme| |
6227 compiler/ compiler files |:compiler| | |
6228 doc/ documentation |write-local-help| | |
6229 ftplugin/ filetype plugins |write-filetype-plugin| | |
6230 indent/ indent scripts |indent-expression| | |
6231 keymap/ key mapping files |mbyte-keymap| | |
6232 lang/ menu translations |:menutrans| | |
6233 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
|
6234 pack/ packages |:packadd| |
7 | 6235 plugin/ plugin scripts |write-plugin| |
6236 print/ files for printing |postscript-print-encoding| | |
650 | 6237 spell/ spell checking files |spell| |
7 | 6238 syntax/ syntax files |mysyntaxfile| |
6239 tutor/ files for vimtutor |tutor| | |
6240 | |
6241 And any other file searched for with the |:runtime| command. | |
6242 | |
6243 The defaults for most systems are setup to search five locations: | |
6244 1. In your home directory, for your personal preferences. | |
6245 2. In a system-wide Vim directory, for preferences from the system | |
6246 administrator. | |
6247 3. In $VIMRUNTIME, for files distributed with Vim. | |
6248 *after-directory* | |
6249 4. In the "after" directory in the system-wide Vim directory. This is | |
6250 for the system administrator to overrule or add to the distributed | |
6251 defaults (rarely needed) | |
6252 5. In the "after" directory in your home directory. This is for | |
6253 personal preferences to overrule or add to the distributed defaults | |
6254 or system-wide settings (rarely needed). | |
6255 | |
10211
b7da8d4c594c
commit https://github.com/vim/vim/commit/d07969093a9b3051511c478d71c36de6fc33c0d6
Christian Brabandt <cb@256bit.org>
parents:
10198
diff
changeset
|
6256 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
|
6257 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
|
6258 string. |
9116
bc38030aec7d
commit https://github.com/vim/vim/commit/26852128a2b713ef49341a0c18daba928444e7eb
Christian Brabandt <cb@256bit.org>
parents:
9098
diff
changeset
|
6259 |
7 | 6260 Note that, unlike 'path', no wildcards like "**" are allowed. Normal |
6261 wildcards are allowed, but can significantly slow down searching for | |
10 | 6262 runtime files. For speed, use as few items as possible and avoid |
7 | 6263 wildcards. |
6264 See |:runtime|. | |
6265 Example: > | |
6266 :set runtimepath=~/vimruntime,/mygroup/vim,$VIMRUNTIME | |
6267 < This will use the directory "~/vimruntime" first (containing your | |
6268 personal Vim runtime files), then "/mygroup/vim" (shared between a | |
6269 group of people) and finally "$VIMRUNTIME" (the distributed runtime | |
6270 files). | |
6271 You probably should always include $VIMRUNTIME somewhere, to use the | |
6272 distributed runtime files. You can put a directory before $VIMRUNTIME | |
6273 to find files which replace a distributed runtime files. You can put | |
6274 a directory after $VIMRUNTIME to find files which add to distributed | |
6275 runtime files. | |
6276 This option cannot be set from a |modeline| or in the |sandbox|, for | |
6277 security reasons. | |
6278 | |
6279 *'scroll'* *'scr'* | |
6280 'scroll' 'scr' number (default: half the window height) | |
6281 local to window | |
6282 Number of lines to scroll with CTRL-U and CTRL-D commands. Will be | |
6283 set to half the number of lines in the window when the window size | |
6284 changes. If you give a count to the CTRL-U or CTRL-D command it will | |
10 | 6285 be used as the new value for 'scroll'. Reset to half the window |
7 | 6286 height with ":set scroll=0". {Vi is a bit different: 'scroll' gives |
6287 the number of screen lines instead of file lines, makes a difference | |
6288 when lines wrap} | |
6289 | |
6290 *'scrollbind'* *'scb'* *'noscrollbind'* *'noscb'* | |
6291 'scrollbind' 'scb' boolean (default off) | |
6292 local to window | |
6293 {not in Vi} | |
6294 {not available when compiled without the |+scrollbind| | |
6295 feature} | |
6296 See also |scroll-binding|. When this option is set, the current | |
6297 window scrolls as other scrollbind windows (windows that also have | |
6298 this option set) scroll. This option is useful for viewing the | |
6299 differences between two versions of a file, see 'diff'. | |
6300 See |'scrollopt'| for options that determine how this option should be | |
6301 interpreted. | |
6302 This option is mostly reset when splitting a window to edit another | |
6303 file. This means that ":split | edit file" results in two windows | |
6304 with scroll-binding, but ":split file" does not. | |
6305 | |
6306 *'scrolljump'* *'sj'* | |
6307 'scrolljump' 'sj' number (default 1) | |
6308 global | |
6309 {not in Vi} | |
6310 Minimal number of lines to scroll when the cursor gets off the | |
6311 screen (e.g., with "j"). Not used for scroll commands (e.g., CTRL-E, | |
6312 CTRL-D). Useful if your terminal scrolls very slowly. | |
532 | 6313 When set to a negative number from -1 to -100 this is used as the |
6314 percentage of the window height. Thus -50 scrolls half the window | |
6315 height. | |
7 | 6316 NOTE: This option is set to 1 when 'compatible' is set. |
6317 | |
6318 *'scrolloff'* *'so'* | |
10218
584c835a2de1
commit https://github.com/vim/vim/commit/50ba526fbf3e9e5e0e6b0b3086a4d5df581ebc7e
Christian Brabandt <cb@256bit.org>
parents:
10211
diff
changeset
|
6319 'scrolloff' 'so' number (default 0, set to 5 in |defaults.vim|) |
7 | 6320 global |
6321 {not in Vi} | |
6322 Minimal number of screen lines to keep above and below the cursor. | |
6323 This will make some context visible around where you are working. If | |
6324 you set it to a very large value (999) the cursor line will always be | |
6325 in the middle of the window (except at the start or end of the file or | |
6326 when long lines wrap). | |
6327 For scrolling horizontally see 'sidescrolloff'. | |
6328 NOTE: This option is set to 0 when 'compatible' is set. | |
6329 | |
6330 *'scrollopt'* *'sbo'* | |
6331 'scrollopt' 'sbo' string (default "ver,jump") | |
6332 global | |
6333 {not available when compiled without the |+scrollbind| | |
6334 feature} | |
6335 {not in Vi} | |
6336 This is a comma-separated list of words that specifies how | |
236 | 6337 'scrollbind' windows should behave. 'sbo' stands for ScrollBind |
6338 Options. | |
7 | 6339 The following words are available: |
6340 ver Bind vertical scrolling for 'scrollbind' windows | |
6341 hor Bind horizontal scrolling for 'scrollbind' windows | |
6342 jump Applies to the offset between two windows for vertical | |
6343 scrolling. This offset is the difference in the first | |
6344 displayed line of the bound windows. When moving | |
6345 around in a window, another 'scrollbind' window may | |
6346 reach a position before the start or after the end of | |
6347 the buffer. The offset is not changed though, when | |
6348 moving back the 'scrollbind' window will try to scroll | |
6349 to the desired position when possible. | |
6350 When now making that window the current one, two | |
6351 things can be done with the relative offset: | |
6352 1. When "jump" is not included, the relative offset is | |
6353 adjusted for the scroll position in the new current | |
6354 window. When going back to the other window, the | |
1152 | 6355 new relative offset will be used. |
7 | 6356 2. When "jump" is included, the other windows are |
6357 scrolled to keep the same relative offset. When | |
6358 going back to the other window, it still uses the | |
6359 same relative offset. | |
6360 Also see |scroll-binding|. | |
819 | 6361 When 'diff' mode is active there always is vertical scroll binding, |
6362 even when "ver" isn't there. | |
7 | 6363 |
6364 *'sections'* *'sect'* | |
6365 'sections' 'sect' string (default "SHNHH HUnhsh") | |
6366 global | |
6367 Specifies the nroff macros that separate sections. These are pairs of | |
6368 two letters (See |object-motions|). The default makes a section start | |
6369 at the nroff macros ".SH", ".NH", ".H", ".HU", ".nh" and ".sh". | |
6370 | |
6371 *'secure'* *'nosecure'* *E523* | |
6372 'secure' boolean (default off) | |
6373 global | |
6374 {not in Vi} | |
6375 When on, ":autocmd", shell and write commands are not allowed in | |
6376 ".vimrc" and ".exrc" in the current directory and map commands are | |
6377 displayed. Switch it off only if you know that you will not run into | |
6378 problems, or when the 'exrc' option is off. On Unix this option is | |
6379 only used if the ".vimrc" or ".exrc" is not owned by you. This can be | |
10 | 6380 dangerous if the systems allows users to do a "chown". You better set |
7 | 6381 'secure' at the end of your ~/.vimrc then. |
6382 This option cannot be set from a |modeline| or in the |sandbox|, for | |
6383 security reasons. | |
6384 | |
6385 *'selection'* *'sel'* | |
6386 'selection' 'sel' string (default "inclusive") | |
6387 global | |
6388 {not in Vi} | |
6389 This option defines the behavior of the selection. It is only used | |
6390 in Visual and Select mode. | |
6391 Possible values: | |
6392 value past line inclusive ~ | |
6393 old no yes | |
6394 inclusive yes yes | |
6395 exclusive yes no | |
6396 "past line" means that the cursor is allowed to be positioned one | |
6397 character past the line. | |
6398 "inclusive" means that the last character of the selection is included | |
6399 in an operation. For example, when "x" is used to delete the | |
6400 selection. | |
9975
03fa8a51e9dc
commit https://github.com/vim/vim/commit/e4a3bcf28d92d0bde9ca227ccb40d401038185e5
Christian Brabandt <cb@256bit.org>
parents:
9913
diff
changeset
|
6401 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
|
6402 the end of line the line break still isn't included. |
7 | 6403 Note that when "exclusive" is used and selecting from the end |
6404 backwards, you cannot include the last character of a line, when | |
6405 starting in Normal mode and 'virtualedit' empty. | |
6406 | |
6407 The 'selection' option is set by the |:behave| command. | |
6408 | |
6409 *'selectmode'* *'slm'* | |
6410 'selectmode' 'slm' string (default "") | |
6411 global | |
6412 {not in Vi} | |
6413 This is a comma separated list of words, which specifies when to start | |
6414 Select mode instead of Visual mode, when a selection is started. | |
6415 Possible values: | |
6416 mouse when using the mouse | |
6417 key when using shifted special keys | |
6418 cmd when using "v", "V" or CTRL-V | |
6419 See |Select-mode|. | |
6420 The 'selectmode' option is set by the |:behave| command. | |
6421 | |
6422 *'sessionoptions'* *'ssop'* | |
6423 'sessionoptions' 'ssop' string (default: "blank,buffers,curdir,folds, | |
827 | 6424 help,options,tabpages,winsize") |
7 | 6425 global |
6426 {not in Vi} | |
2570
71b56b4e7785
Make the references to features in the help more consistent. (Sylvain Hitier)
Bram Moolenaar <bram@vim.org>
parents:
2561
diff
changeset
|
6427 {not available when compiled without the |+mksession| |
7 | 6428 feature} |
6429 Changes the effect of the |:mksession| command. It is a comma | |
6430 separated list of words. Each word enables saving and restoring | |
6431 something: | |
6432 word save and restore ~ | |
6433 blank empty windows | |
6434 buffers hidden and unloaded buffers, not just those in windows | |
6435 curdir the current directory | |
6436 folds manually created folds, opened/closed folds and local | |
6437 fold options | |
6438 globals global variables that start with an uppercase letter | |
75 | 6439 and contain at least one lowercase letter. Only |
6440 String and Number types are stored. | |
7 | 6441 help the help window |
6442 localoptions options and mappings local to a window or buffer (not | |
6443 global values for local options) | |
6444 options all options and mappings (also global values for local | |
6445 options) | |
6446 resize size of the Vim window: 'lines' and 'columns' | |
6447 sesdir the directory in which the session file is located | |
6448 will become the current directory (useful with | |
6449 projects accessed over a network from different | |
6450 systems) | |
6451 slash backslashes in file names replaced with forward | |
6452 slashes | |
827 | 6453 tabpages all tab pages; without this only the current tab page |
6454 is restored, so that you can make a session for each | |
6455 tab page separately | |
7 | 6456 unix with Unix end-of-line format (single <NL>), even when |
6457 on Windows or DOS | |
6458 winpos position of the whole Vim window | |
6459 winsize window sizes | |
6460 | |
6461 Don't include both "curdir" and "sesdir". | |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
6462 When neither "curdir" nor "sesdir" is included, file names are stored |
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
6463 with absolute paths. |
7 | 6464 "slash" and "unix" are useful on Windows when sharing session files |
6465 with Unix. The Unix version of Vim cannot source dos format scripts, | |
6466 but the Windows version of Vim can source unix format scripts. | |
6467 | |
6468 *'shell'* *'sh'* *E91* | |
6469 'shell' 'sh' string (default $SHELL or "sh", | |
6470 MS-DOS and Win32: "command.com" or | |
6471 "cmd.exe", OS/2: "cmd") | |
6472 global | |
6473 Name of the shell to use for ! and :! commands. When changing the | |
6474 value also check these options: 'shelltype', 'shellpipe', 'shellslash' | |
6475 'shellredir', 'shellquote', 'shellxquote' and 'shellcmdflag'. | |
10 | 6476 It is allowed to give an argument to the command, e.g. "csh -f". |
7 | 6477 See |option-backslash| about including spaces and backslashes. |
6478 Environment variables are expanded |:set_env|. | |
6479 If the name of the shell contains a space, you might need to enclose | |
6480 it in quotes. Example: > | |
6481 :set shell=\"c:\program\ files\unix\sh.exe\"\ -f | |
6482 < Note the backslash before each quote (to avoid starting a comment) and | |
10 | 6483 each space (to avoid ending the option value). Also note that the |
7 | 6484 "-f" is not inside the quotes, because it is not part of the command |
6485 name. And Vim automagically recognizes the backslashes that are path | |
6486 separators. | |
6487 Under MS-Windows, when the executable ends in ".com" it must be | |
6488 included. Thus setting the shell to "command.com" or "4dos.com" | |
6489 works, but "command" and "4dos" do not work for all commands (e.g., | |
6490 filtering). | |
6491 For unknown reasons, when using "4dos.com" the current directory is | |
6492 changed to "C:\". To avoid this set 'shell' like this: > | |
6493 :set shell=command.com\ /c\ 4dos | |
6494 < This option cannot be set from a |modeline| or in the |sandbox|, for | |
6495 security reasons. | |
6496 | |
6497 *'shellcmdflag'* *'shcf'* | |
3356 | 6498 'shellcmdflag' 'shcf' string (default: "-c"; |
3371 | 6499 MS-DOS and Win32, when 'shell' does not |
6500 contain "sh" somewhere: "/c") | |
7 | 6501 global |
6502 {not in Vi} | |
6503 Flag passed to the shell to execute "!" and ":!" commands; e.g., | |
6504 "bash.exe -c ls" or "command.com /c dir". For the MS-DOS-like | |
6505 systems, the default is set according to the value of 'shell', to | |
11262 | 6506 reduce the need to set this option by the user. |
3082 | 6507 On Unix it can have more than one flag. Each white space separated |
6508 part is passed as an argument to the shell command. | |
6509 See |option-backslash| about including spaces and backslashes. | |
6510 Also see |dos-shell| for MS-DOS and MS-Windows. | |
7 | 6511 This option cannot be set from a |modeline| or in the |sandbox|, for |
6512 security reasons. | |
6513 | |
6514 *'shellpipe'* *'sp'* | |
6515 'shellpipe' 'sp' string (default ">", "| tee", "|& tee" or "2>&1| tee") | |
6516 global | |
6517 {not in Vi} | |
6518 {not available when compiled without the |+quickfix| | |
6519 feature} | |
6520 String to be used to put the output of the ":make" command in the | |
10 | 6521 error file. See also |:make_makeprg|. See |option-backslash| about |
7 | 6522 including spaces and backslashes. |
6523 The name of the temporary file can be represented by "%s" if necessary | |
6524 (the file name is appended automatically if no %s appears in the value | |
6525 of this option). | |
6526 For the Amiga and MS-DOS the default is ">". The output is directly | |
6527 saved in a file and not echoed to the screen. | |
6528 For Unix the default it "| tee". The stdout of the compiler is saved | |
6529 in a file and echoed to the screen. If the 'shell' option is "csh" or | |
6530 "tcsh" after initializations, the default becomes "|& tee". If the | |
2788 | 6531 'shell' option is "sh", "ksh", "mksh", "pdksh", "zsh" or "bash" the |
6532 default becomes "2>&1| tee". This means that stderr is also included. | |
6533 Before using the 'shell' option a path is removed, thus "/bin/sh" uses | |
6534 "sh". | |
7 | 6535 The initialization of this option is done after reading the ".vimrc" |
6536 and the other initializations, so that when the 'shell' option is set | |
6537 there, the 'shellpipe' option changes automatically, unless it was | |
6538 explicitly set before. | |
6539 When 'shellpipe' is set to an empty string, no redirection of the | |
6540 ":make" output will be done. This is useful if you use a 'makeprg' | |
6541 that writes to 'makeef' by itself. If you want no piping, but do | |
6542 want to include the 'makeef', set 'shellpipe' to a single space. | |
6543 Don't forget to precede the space with a backslash: ":set sp=\ ". | |
6544 In the future pipes may be used for filtering and this option will | |
6545 become obsolete (at least for Unix). | |
6546 This option cannot be set from a |modeline| or in the |sandbox|, for | |
6547 security reasons. | |
6548 | |
6549 *'shellquote'* *'shq'* | |
6550 'shellquote' 'shq' string (default: ""; MS-DOS and Win32, when 'shell' | |
6551 contains "sh" somewhere: "\"") | |
6552 global | |
6553 {not in Vi} | |
6554 Quoting character(s), put around the command passed to the shell, for | |
6555 the "!" and ":!" commands. The redirection is kept outside of the | |
6556 quoting. See 'shellxquote' to include the redirection. It's | |
6557 probably not useful to set both options. | |
6558 This is an empty string by default. Only known to be useful for | |
6559 third-party shells on MS-DOS-like systems, such as the MKS Korn Shell | |
6560 or bash, where it should be "\"". The default is adjusted according | |
6561 the value of 'shell', to reduce the need to set this option by the | |
6562 user. See |dos-shell|. | |
6563 This option cannot be set from a |modeline| or in the |sandbox|, for | |
6564 security reasons. | |
6565 | |
6566 *'shellredir'* *'srr'* | |
6567 'shellredir' 'srr' string (default ">", ">&" or ">%s 2>&1") | |
6568 global | |
6569 {not in Vi} | |
6570 String to be used to put the output of a filter command in a temporary | |
6571 file. See also |:!|. See |option-backslash| about including spaces | |
6572 and backslashes. | |
6573 The name of the temporary file can be represented by "%s" if necessary | |
6574 (the file name is appended automatically if no %s appears in the value | |
6575 of this option). | |
6576 The default is ">". For Unix, if the 'shell' option is "csh", "tcsh" | |
6577 or "zsh" during initializations, the default becomes ">&". If the | |
6578 'shell' option is "sh", "ksh" or "bash" the default becomes | |
6579 ">%s 2>&1". This means that stderr is also included. | |
6580 For Win32, the Unix checks are done and additionally "cmd" is checked | |
6581 for, which makes the default ">%s 2>&1". Also, the same names with | |
6582 ".exe" appended are checked for. | |
6583 The initialization of this option is done after reading the ".vimrc" | |
6584 and the other initializations, so that when the 'shell' option is set | |
6585 there, the 'shellredir' option changes automatically unless it was | |
6586 explicitly set before. | |
6587 In the future pipes may be used for filtering and this option will | |
6588 become obsolete (at least for Unix). | |
6589 This option cannot be set from a |modeline| or in the |sandbox|, for | |
6590 security reasons. | |
6591 | |
6592 *'shellslash'* *'ssl'* *'noshellslash'* *'nossl'* | |
6593 'shellslash' 'ssl' boolean (default off) | |
6594 global | |
6595 {not in Vi} {only for MSDOS, MS-Windows and OS/2} | |
6596 When set, a forward slash is used when expanding file names. This is | |
6597 useful when a Unix-like shell is used instead of command.com or | |
6598 cmd.exe. Backward slashes can still be typed, but they are changed to | |
6599 forward slashes by Vim. | |
6600 Note that setting or resetting this option has no effect for some | |
6601 existing file names, thus this option needs to be set before opening | |
6602 any file for best results. This might change in the future. | |
6603 'shellslash' only works when a backslash can be used as a path | |
6604 separator. To test if this is so use: > | |
6605 if exists('+shellslash') | |
6606 < | |
168 | 6607 *'shelltemp'* *'stmp'* *'noshelltemp'* *'nostmp'* |
6608 'shelltemp' 'stmp' boolean (Vi default off, Vim default on) | |
6609 global | |
6610 {not in Vi} | |
6611 When on, use temp files for shell commands. When off use a pipe. | |
6612 When using a pipe is not possible temp files are used anyway. | |
2965 | 6613 Currently a pipe is only supported on Unix and MS-Windows 2K and |
6614 later. You can check it with: > | |
168 | 6615 :if has("filterpipe") |
6616 < The advantage of using a pipe is that nobody can read the temp file | |
6617 and the 'shell' command does not need to support redirection. | |
6618 The advantage of using a temp file is that the file type and encoding | |
6619 can be detected. | |
6620 The |FilterReadPre|, |FilterReadPost| and |FilterWritePre|, | |
6621 |FilterWritePost| autocommands event are not triggered when | |
6622 'shelltemp' is off. | |
9533
9f921133ee90
commit https://github.com/vim/vim/commit/269f595f9eef584937e7eae70fde68cdd7da5bcf
Christian Brabandt <cb@256bit.org>
parents:
9464
diff
changeset
|
6623 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
|
6624 temp files. |
11160 | 6625 NOTE: This option is set to the Vim default value when 'compatible' |
6626 is reset. | |
168 | 6627 |
7 | 6628 *'shelltype'* *'st'* |
6629 'shelltype' 'st' number (default 0) | |
6630 global | |
6631 {not in Vi} {only for the Amiga} | |
6632 On the Amiga this option influences the way how the commands work | |
6633 which use a shell. | |
6634 0 and 1: always use the shell | |
6635 2 and 3: use the shell only to filter lines | |
6636 4 and 5: use shell only for ':sh' command | |
6637 When not using the shell, the command is executed directly. | |
6638 | |
6639 0 and 2: use "shell 'shellcmdflag' cmd" to start external commands | |
6640 1 and 3: use "shell cmd" to start external commands | |
6641 | |
3371 | 6642 *'shellxescape'* *'sxe'* |
6643 'shellxescape' 'sxe' string (default: ""; | |
6644 for MS-DOS and MS-Windows: "\"&|<>()@^") | |
6645 global | |
6646 {not in Vi} | |
6647 When 'shellxquote' is set to "(" then the characters listed in this | |
6648 option will be escaped with a '^' character. This makes it possible | |
6649 to execute most external commands with cmd.exe. | |
6650 | |
7 | 6651 *'shellxquote'* *'sxq'* |
6652 'shellxquote' 'sxq' string (default: ""; | |
3359 | 6653 for Win32, when 'shell' is cmd.exe: "(" |
6654 for Win32, when 'shell' contains "sh" | |
6655 somewhere: "\"" | |
7 | 6656 for Unix, when using system(): "\"") |
6657 global | |
6658 {not in Vi} | |
6659 Quoting character(s), put around the command passed to the shell, for | |
6660 the "!" and ":!" commands. Includes the redirection. See | |
6661 'shellquote' to exclude the redirection. It's probably not useful | |
6662 to set both options. | |
3359 | 6663 When the value is '(' then ')' is appended. When the value is '"(' |
6664 then ')"' is appended. | |
6665 When the value is '(' then also see 'shellxescape'. | |
3352 | 6666 This is an empty string by default on most systems, but is known to be |
6667 useful for on Win32 version, either for cmd.exe which automatically | |
6668 strips off the first and last quote on a command, or 3rd-party shells | |
6669 such as the MKS Korn Shell or bash, where it should be "\"". The | |
6670 default is adjusted according the value of 'shell', to reduce the need | |
6671 to set this option by the user. See |dos-shell|. | |
7 | 6672 This option cannot be set from a |modeline| or in the |sandbox|, for |
6673 security reasons. | |
6674 | |
6675 *'shiftround'* *'sr'* *'noshiftround'* *'nosr'* | |
6676 'shiftround' 'sr' boolean (default off) | |
6677 global | |
6678 {not in Vi} | |
6679 Round indent to multiple of 'shiftwidth'. Applies to > and < | |
6680 commands. CTRL-T and CTRL-D in Insert mode always round the indent to | |
6681 a multiple of 'shiftwidth' (this is Vi compatible). | |
6682 NOTE: This option is reset when 'compatible' is set. | |
6683 | |
6684 *'shiftwidth'* *'sw'* | |
6685 'shiftwidth' 'sw' number (default 8) | |
6686 local to buffer | |
10 | 6687 Number of spaces to use for each step of (auto)indent. Used for |
7 | 6688 |'cindent'|, |>>|, |<<|, etc. |
3893 | 6689 When zero the 'ts' value will be used. Use the |shiftwidth()| |
6690 function to get the effective shiftwidth value. | |
7 | 6691 |
6692 *'shortmess'* *'shm'* | |
168 | 6693 'shortmess' 'shm' string (Vim default "filnxtToO", Vi default: "", |
6694 POSIX default: "A") | |
7 | 6695 global |
6696 {not in Vi} | |
6697 This option helps to avoid all the |hit-enter| prompts caused by file | |
6698 messages, for example with CTRL-G, and to avoid some other messages. | |
6699 It is a list of flags: | |
6700 flag meaning when present ~ | |
6701 f use "(3 of 5)" instead of "(file 3 of 5)" | |
6702 i use "[noeol]" instead of "[Incomplete last line]" | |
6703 l use "999L, 888C" instead of "999 lines, 888 characters" | |
6704 m use "[+]" instead of "[Modified]" | |
6705 n use "[New]" instead of "[New File]" | |
6706 r use "[RO]" instead of "[readonly]" | |
6707 w use "[w]" instead of "written" for file write message | |
6708 and "[a]" instead of "appended" for ':w >> file' command | |
6709 x use "[dos]" instead of "[dos format]", "[unix]" instead of | |
6710 "[unix format]" and "[mac]" instead of "[mac format]". | |
6711 a all of the above abbreviations | |
6712 | |
6713 o overwrite message for writing a file with subsequent message | |
6714 for reading a file (useful for ":wn" or when 'autowrite' on) | |
6715 O message for reading a file overwrites any previous message. | |
6716 Also for quickfix message (e.g., ":cn"). | |
6717 s don't give "search hit BOTTOM, continuing at TOP" or "search | |
6718 hit TOP, continuing at BOTTOM" messages | |
6719 t truncate file message at the start if it is too long to fit | |
6720 on the command-line, "<" will appear in the left most column. | |
6721 Ignored in Ex mode. | |
6722 T truncate other messages in the middle if they are too long to | |
233 | 6723 fit on the command line. "..." will appear in the middle. |
7 | 6724 Ignored in Ex mode. |
6725 W don't give "written" or "[w]" when writing a file | |
6726 A don't give the "ATTENTION" message when an existing swap file | |
6727 is found. | |
6728 I don't give the intro message when starting Vim |:intro|. | |
5946 | 6729 c don't give |ins-completion-menu| messages. For example, |
6730 "-- XXX completion (YYY)", "match 1 of 2", "The only match", | |
6731 "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
|
6732 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
|
6733 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
|
6734 was used for the command |
7 | 6735 |
6736 This gives you the opportunity to avoid that a change between buffers | |
6737 requires you to hit <Enter>, but still gives as useful a message as | |
6738 possible for the space available. To get the whole message that you | |
6739 would have got with 'shm' empty, use ":file!" | |
6740 Useful values: | |
6741 shm= No abbreviation of message. | |
6742 shm=a Abbreviation, but no loss of information. | |
6743 shm=at Abbreviation, and truncate message when necessary. | |
6744 | |
6745 NOTE: This option is set to the Vi default value when 'compatible' is | |
6746 set and to the Vim default value when 'compatible' is reset. | |
6747 | |
6748 *'shortname'* *'sn'* *'noshortname'* *'nosn'* | |
6749 'shortname' 'sn' boolean (default off) | |
6750 local to buffer | |
6751 {not in Vi, not in MS-DOS versions} | |
6752 Filenames are assumed to be 8 characters plus one extension of 3 | |
6753 characters. Multiple dots in file names are not allowed. When this | |
6754 option is on, dots in file names are replaced with underscores when | |
6755 adding an extension (".~" or ".swp"). This option is not available | |
6756 for MS-DOS, because then it would always be on. This option is useful | |
6757 when editing files on an MS-DOS compatible filesystem, e.g., messydos | |
6758 or crossdos. When running the Win32 GUI version under Win32s, this | |
6759 option is always on by default. | |
6760 | |
6761 *'showbreak'* *'sbr'* *E595* | |
6762 'showbreak' 'sbr' string (default "") | |
6763 global | |
6764 {not in Vi} | |
2570
71b56b4e7785
Make the references to features in the help more consistent. (Sylvain Hitier)
Bram Moolenaar <bram@vim.org>
parents:
2561
diff
changeset
|
6765 {not available when compiled without the |+linebreak| |
7 | 6766 feature} |
6767 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
|
6768 values are "> " or "+++ ": > |
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
6769 :set showbreak=>\ |
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
6770 < 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
|
6771 this: > |
2314
233eb4412f5d
Added 'colorcolumn' option. Partly by Gregor Uhlenheuer.
Bram Moolenaar <bram@vim.org>
parents:
2302
diff
changeset
|
6772 :let &showbreak = '+++ ' |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
6773 < Only printable single-cell characters are allowed, excluding <Tab> and |
7 | 6774 comma (in a future version the comma might be used to separate the |
6775 part that is shown at the end and at the start of a line). | |
6776 The characters are highlighted according to the '@' flag in | |
6777 'highlight'. | |
6778 Note that tabs after the showbreak will be displayed differently. | |
6779 If you want the 'showbreak' to appear in between line numbers, add the | |
6780 "n" flag to 'cpoptions'. | |
6781 | |
6782 *'showcmd'* *'sc'* *'noshowcmd'* *'nosc'* | |
9669
284b4eb307fc
commit https://github.com/vim/vim/commit/8c08b5b569e2a9e9f63dea514591ecfa2d3bb392
Christian Brabandt <cb@256bit.org>
parents:
9665
diff
changeset
|
6783 '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
|
6784 Vi default: off, set in |defaults.vim|) |
7 | 6785 global |
6786 {not in Vi} | |
6787 {not available when compiled without the | |
6788 |+cmdline_info| feature} | |
1152 | 6789 Show (partial) command in the last line of the screen. Set this |
6790 option off if your terminal is slow. | |
7 | 6791 In Visual mode the size of the selected area is shown: |
6792 - 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
|
6793 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
|
6794 means two characters and six bytes. |
7 | 6795 - When selecting more than one line, the number of lines. |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
6796 - When selecting a block, the size in screen characters: |
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
6797 {lines}x{columns}. |
7 | 6798 NOTE: This option is set to the Vi default value when 'compatible' is |
6799 set and to the Vim default value when 'compatible' is reset. | |
6800 | |
6801 *'showfulltag'* *'sft'* *'noshowfulltag'* *'nosft'* | |
6802 'showfulltag' 'sft' boolean (default off) | |
6803 global | |
6804 {not in Vi} | |
6805 When completing a word in insert mode (see |ins-completion|) from the | |
6806 tags file, show both the tag name and a tidied-up form of the search | |
10 | 6807 pattern (if there is one) as possible matches. Thus, if you have |
7 | 6808 matched a C function, you can see a template for what arguments are |
6809 required (coding style permitting). | |
1621 | 6810 Note that this doesn't work well together with having "longest" in |
6811 'completeopt', because the completion from the search pattern may not | |
6812 match the typed text. | |
7 | 6813 |
6814 *'showmatch'* *'sm'* *'noshowmatch'* *'nosm'* | |
6815 'showmatch' 'sm' boolean (default off) | |
6816 global | |
6817 When a bracket is inserted, briefly jump to the matching one. The | |
6818 jump is only done if the match can be seen on the screen. The time to | |
6819 show the match can be set with 'matchtime'. | |
6820 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
|
6821 seen or not). |
c590de398af9
commit https://github.com/vim/vim/commit/ca63501fbcd1cf9c8aa9ff12c093c95b62a89ed7
Christian Brabandt <cb@256bit.org>
parents:
7080
diff
changeset
|
6822 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
|
6823 reset. |
7 | 6824 When the 'm' flag is not included in 'cpoptions', typing a character |
6825 will immediately move the cursor back to where it belongs. | |
6826 See the "sm" field in 'guicursor' for setting the cursor shape and | |
6827 blinking when showing the match. | |
6828 The 'matchpairs' option can be used to specify the characters to show | |
6829 matches for. 'rightleft' and 'revins' are used to look for opposite | |
6830 matches. | |
699 | 6831 Also see the matchparen plugin for highlighting the match when moving |
6832 around |pi_paren.txt|. | |
6833 Note: Use of the short form is rated PG. | |
7 | 6834 |
6835 *'showmode'* *'smd'* *'noshowmode'* *'nosmd'* | |
6836 'showmode' 'smd' boolean (Vim default: on, Vi default: off) | |
6837 global | |
6838 If in Insert, Replace or Visual mode put a message on the last line. | |
6839 Use the 'M' flag in 'highlight' to set the type of highlighting for | |
6840 this message. | |
10 | 6841 When |XIM| may be used the message will include "XIM". But this |
7 | 6842 doesn't mean XIM is really active, especially when 'imactivatekey' is |
6843 not set. | |
6844 NOTE: This option is set to the Vi default value when 'compatible' is | |
6845 set and to the Vim default value when 'compatible' is reset. | |
6846 | |
677 | 6847 *'showtabline'* *'stal'* |
6848 'showtabline' 'stal' number (default 1) | |
6849 global | |
6850 {not in Vi} | |
2570
71b56b4e7785
Make the references to features in the help more consistent. (Sylvain Hitier)
Bram Moolenaar <bram@vim.org>
parents:
2561
diff
changeset
|
6851 {not available when compiled without the |+windows| |
677 | 6852 feature} |
6853 The value of this option specifies when the line with tab page labels | |
6854 will be displayed: | |
6855 0: never | |
6856 1: only if there are at least two tab pages | |
6857 2: always | |
6858 This is both for the GUI and non-GUI implementation of the tab pages | |
6859 line. | |
6860 See |tab-page| for more information about tab pages. | |
6861 | |
7 | 6862 *'sidescroll'* *'ss'* |
6863 'sidescroll' 'ss' number (default 0) | |
6864 global | |
6865 {not in Vi} | |
6866 The minimal number of columns to scroll horizontally. Used only when | |
6867 the 'wrap' option is off and the cursor is moved off of the screen. | |
6868 When it is zero the cursor will be put in the middle of the screen. | |
6869 When using a slow terminal set it to a large number or 0. When using | |
6870 a fast terminal use a small number or 1. Not used for "zh" and "zl" | |
6871 commands. | |
6872 | |
6873 *'sidescrolloff'* *'siso'* | |
6874 'sidescrolloff' 'siso' number (default 0) | |
6875 global | |
6876 {not in Vi} | |
6877 The minimal number of screen columns to keep to the left and to the | |
534 | 6878 right of the cursor if 'nowrap' is set. Setting this option to a |
6879 value greater than 0 while having |'sidescroll'| also at a non-zero | |
6880 value makes some context visible in the line you are scrolling in | |
6881 horizontally (except at beginning of the line). Setting this option | |
6882 to a large value (like 999) has the effect of keeping the cursor | |
6883 horizontally centered in the window, as long as one does not come too | |
6884 close to the beginning of the line. | |
7 | 6885 NOTE: This option is set to 0 when 'compatible' is set. |
6886 | |
6887 Example: Try this together with 'sidescroll' and 'listchars' as | |
6888 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
|
6889 onto the "extends" character: > |
7 | 6890 |
6891 :set nowrap sidescroll=1 listchars=extends:>,precedes:< | |
6892 :set sidescrolloff=1 | |
9852
4eea48b76d03
commit https://github.com/vim/vim/commit/95ec9d6a6ab3117d60ff638670a803d43974ba51
Christian Brabandt <cb@256bit.org>
parents:
9737
diff
changeset
|
6893 < |
4eea48b76d03
commit https://github.com/vim/vim/commit/95ec9d6a6ab3117d60ff638670a803d43974ba51
Christian Brabandt <cb@256bit.org>
parents:
9737
diff
changeset
|
6894 *'signcolumn'* *'scl'* |
4eea48b76d03
commit https://github.com/vim/vim/commit/95ec9d6a6ab3117d60ff638670a803d43974ba51
Christian Brabandt <cb@256bit.org>
parents:
9737
diff
changeset
|
6895 'signcolumn' 'scl' string (default "auto") |
4eea48b76d03
commit https://github.com/vim/vim/commit/95ec9d6a6ab3117d60ff638670a803d43974ba51
Christian Brabandt <cb@256bit.org>
parents:
9737
diff
changeset
|
6896 local to window |
4eea48b76d03
commit https://github.com/vim/vim/commit/95ec9d6a6ab3117d60ff638670a803d43974ba51
Christian Brabandt <cb@256bit.org>
parents:
9737
diff
changeset
|
6897 {not in Vi} |
4eea48b76d03
commit https://github.com/vim/vim/commit/95ec9d6a6ab3117d60ff638670a803d43974ba51
Christian Brabandt <cb@256bit.org>
parents:
9737
diff
changeset
|
6898 {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
|
6899 feature} |
9860
9eaf8ef656e9
commit https://github.com/vim/vim/commit/0952131376a517fc12dc5ae908a97018b4ee23f0
Christian Brabandt <cb@256bit.org>
parents:
9852
diff
changeset
|
6900 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
|
6901 "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
|
6902 "no" never |
9eaf8ef656e9
commit https://github.com/vim/vim/commit/0952131376a517fc12dc5ae908a97018b4ee23f0
Christian Brabandt <cb@256bit.org>
parents:
9852
diff
changeset
|
6903 "yes" always |
7 | 6904 |
6905 | |
6906 *'smartcase'* *'scs'* *'nosmartcase'* *'noscs'* | |
6907 'smartcase' 'scs' boolean (default off) | |
6908 global | |
6909 {not in Vi} | |
6910 Override the 'ignorecase' option if the search pattern contains upper | |
6911 case characters. Only used when the search pattern is typed and | |
6912 'ignorecase' option is on. Used for the commands "/", "?", "n", "N", | |
3557 | 6913 ":g" and ":s". Not used for "*", "#", "gd", tag search, etc. After |
7 | 6914 "*" and "#" you can make 'smartcase' used by doing a "/" command, |
6915 recalling the search pattern from history and hitting <Enter>. | |
6916 NOTE: This option is reset when 'compatible' is set. | |
6917 | |
6918 *'smartindent'* *'si'* *'nosmartindent'* *'nosi'* | |
6919 'smartindent' 'si' boolean (default off) | |
6920 local to buffer | |
6921 {not in Vi} | |
6922 {not available when compiled without the | |
6923 |+smartindent| feature} | |
6924 Do smart autoindenting when starting a new line. Works for C-like | |
6925 programs, but can also be used for other languages. 'cindent' does | |
6926 something like this, works better in most cases, but is more strict, | |
2662 | 6927 see |C-indenting|. When 'cindent' is on or 'indentexpr' is set, |
2642 | 6928 setting 'si' has no effect. 'indentexpr' is a more advanced |
6929 alternative. | |
7 | 6930 Normally 'autoindent' should also be on when using 'smartindent'. |
6931 An indent is automatically inserted: | |
6932 - After a line ending in '{'. | |
6933 - After a line starting with a keyword from 'cinwords'. | |
6934 - Before a line starting with '}' (only with the "O" command). | |
6935 When typing '}' as the first character in a new line, that line is | |
6936 given the same indent as the matching '{'. | |
6937 When typing '#' as the first character in a new line, the indent for | |
6938 that line is removed, the '#' is put in the first column. The indent | |
10 | 6939 is restored for the next line. If you don't want this, use this |
7 | 6940 mapping: ":inoremap # X^H#", where ^H is entered with CTRL-V CTRL-H. |
6941 When using the ">>" command, lines starting with '#' are not shifted | |
6942 right. | |
11160 | 6943 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
|
6944 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
|
6945 reset. |
7 | 6946 |
6947 *'smarttab'* *'sta'* *'nosmarttab'* *'nosta'* | |
6948 'smarttab' 'sta' boolean (default off) | |
6949 global | |
6950 {not in Vi} | |
6951 When on, a <Tab> in front of a line inserts blanks according to | |
648 | 6952 'shiftwidth'. 'tabstop' or 'softtabstop' is used in other places. A |
6953 <BS> will delete a 'shiftwidth' worth of space at the start of the | |
6954 line. | |
650 | 6955 When off, a <Tab> always inserts blanks according to 'tabstop' or |
648 | 6956 'softtabstop'. 'shiftwidth' is only used for shifting text left or |
6957 right |shift-left-right|. | |
1263 | 6958 What gets inserted (a <Tab> or spaces) depends on the 'expandtab' |
7 | 6959 option. Also see |ins-expandtab|. When 'expandtab' is not set, the |
11 | 6960 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
|
6961 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
|
6962 reset. |
7 | 6963 NOTE: This option is reset when 'compatible' is set. |
6964 | |
6965 *'softtabstop'* *'sts'* | |
6966 'softtabstop' 'sts' number (default 0) | |
6967 local to buffer | |
6968 {not in Vi} | |
6969 Number of spaces that a <Tab> counts for while performing editing | |
6970 operations, like inserting a <Tab> or using <BS>. It "feels" like | |
6971 <Tab>s are being inserted, while in fact a mix of spaces and <Tab>s is | |
6972 used. This is useful to keep the 'ts' setting at its standard value | |
6973 of 8, while being able to edit like it is set to 'sts'. However, | |
6974 commands like "x" still work on the actual characters. | |
6975 When 'sts' is zero, this feature is off. | |
3893 | 6976 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
|
6977 '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
|
6978 when 'paste' is reset. |
7 | 6979 See also |ins-expandtab|. When 'expandtab' is not set, the number of |
6980 spaces is minimized by using <Tab>s. | |
6981 The 'L' flag in 'cpoptions' changes how tabs are used when 'list' is | |
6982 set. | |
6983 NOTE: This option is set to 0 when 'compatible' is set. | |
6984 | |
221 | 6985 *'spell'* *'nospell'* |
6986 'spell' boolean (default off) | |
6987 local to window | |
6988 {not in Vi} | |
6989 {not available when compiled without the |+syntax| | |
6990 feature} | |
6991 When on spell checking will be done. See |spell|. | |
236 | 6992 The languages are specified with 'spelllang'. |
221 | 6993 |
386 | 6994 *'spellcapcheck'* *'spc'* |
389 | 6995 'spellcapcheck' 'spc' string (default "[.?!]\_[\])'" \t]\+") |
386 | 6996 local to buffer |
6997 {not in Vi} | |
6998 {not available when compiled without the |+syntax| | |
6999 feature} | |
7000 Pattern to locate the end of a sentence. The following word will be | |
7001 checked to start with a capital letter. If not then it is highlighted | |
484 | 7002 with SpellCap |hl-SpellCap| (unless the word is also badly spelled). |
386 | 7003 When this check is not wanted make this option empty. |
7004 Only used when 'spell' is set. | |
389 | 7005 Be careful with special characters, see |option-backslash| about |
7006 including spaces and backslashes. | |
480 | 7007 To set this option automatically depending on the language, see |
7008 |set-spc-auto|. | |
386 | 7009 |
314 | 7010 *'spellfile'* *'spf'* |
7011 'spellfile' 'spf' string (default empty) | |
7012 local to buffer | |
7013 {not in Vi} | |
7014 {not available when compiled without the |+syntax| | |
7015 feature} | |
7016 Name of the word list file where words are added for the |zg| and |zw| | |
401 | 7017 commands. It must end in ".{encoding}.add". You need to include the |
7018 path, otherwise the file is placed in the current directory. | |
386 | 7019 *E765* |
7020 It may also be a comma separated list of names. A count before the | |
7021 |zg| and |zw| commands can be used to access each. This allows using | |
7022 a personal word list file and a project word list file. | |
314 | 7023 When a word is added while this option is empty Vim will set it for |
819 | 7024 you: Using the first directory in 'runtimepath' that is writable. If |
7025 there is no "spell" directory yet it will be created. For the file | |
7026 name the first language name that appears in 'spelllang' is used, | |
353 | 7027 ignoring the region. |
7028 The resulting ".spl" file will be used for spell checking, it does not | |
7029 have to appear in 'spelllang'. | |
7030 Normally one file is used for all regions, but you can add the region | |
7031 name if you want to. However, it will then only be used when | |
7032 'spellfile' is set to it, for entries in 'spelllang' only files | |
7033 without region name will be found. | |
336 | 7034 This option cannot be set from a |modeline| or in the |sandbox|, for |
7035 security reasons. | |
314 | 7036 |
221 | 7037 *'spelllang'* *'spl'* |
314 | 7038 'spelllang' 'spl' string (default "en") |
221 | 7039 local to buffer |
7040 {not in Vi} | |
7041 {not available when compiled without the |+syntax| | |
7042 feature} | |
353 | 7043 A comma separated list of word list names. When the 'spell' option is |
7044 on spellchecking will be done for these languages. Example: > | |
7045 set spelllang=en_us,nl,medical | |
7046 < This means US English, Dutch and medical words are recognized. Words | |
7047 that are not recognized will be highlighted. | |
7048 The word list name must not include a comma or dot. Using a dash is | |
7049 recommended to separate the two letter language name from a | |
7050 specification. Thus "en-rare" is used for rare English words. | |
7051 A region name must come last and have the form "_xx", where "xx" is | |
7052 the two-letter, lower case region name. You can use more than one | |
7053 region by listing them: "en_us,en_ca" supports both US and Canadian | |
7054 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
|
7055 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
|
7056 en_ca, en_gb and en_us). |
5477 | 7057 If the name "cjk" is included East Asian characters are excluded from |
7058 spell checking. This is useful when editing text that also has Asian | |
7059 words. | |
484 | 7060 *E757* |
419 | 7061 As a special case the name of a .spl file can be given as-is. The |
7062 first "_xx" in the name is removed and used as the region name | |
7063 (_xx is an underscore, two letters and followed by a non-letter). | |
7064 This is mainly for testing purposes. You must make sure the correct | |
7065 encoding is used, Vim doesn't check it. | |
236 | 7066 When 'encoding' is set the word lists are reloaded. Thus it's a good |
419 | 7067 idea to set 'spelllang' after setting 'encoding' to avoid loading the |
7068 files twice. | |
353 | 7069 How the related spell files are found is explained here: |spell-load|. |
221 | 7070 |
653 | 7071 If the |spellfile.vim| plugin is active and you use a language name |
7072 for which Vim cannot find the .spl file in 'runtimepath' the plugin | |
7073 will ask you if you want to download the file. | |
7074 | |
480 | 7075 After this option has been set successfully, Vim will source the files |
7076 "spell/LANG.vim" in 'runtimepath'. "LANG" is the value of 'spelllang' | |
650 | 7077 up to the first comma, dot or underscore. |
7078 Also see |set-spc-auto|. | |
480 | 7079 |
7080 | |
344 | 7081 *'spellsuggest'* *'sps'* |
7082 'spellsuggest' 'sps' string (default "best") | |
7083 global | |
7084 {not in Vi} | |
7085 {not available when compiled without the |+syntax| | |
7086 feature} | |
593 | 7087 Methods used for spelling suggestions. Both for the |z=| command and |
374 | 7088 the |spellsuggest()| function. This is a comma-separated list of |
7089 items: | |
7090 | |
7091 best Internal method that works best for English. Finds | |
7092 changes like "fast" and uses a bit of sound-a-like | |
7093 scoring to improve the ordering. | |
7094 | |
7095 double Internal method that uses two methods and mixes the | |
7096 results. The first method is "fast", the other method | |
344 | 7097 computes how much the suggestion sounds like the bad |
374 | 7098 word. That only works when the language specifies |
7099 sound folding. Can be slow and doesn't always give | |
7100 better results. | |
7101 | |
7102 fast Internal method that only checks for simple changes: | |
7103 character inserts/deletes/swaps. Works well for | |
7104 simple typing mistakes. | |
7105 | |
593 | 7106 {number} The maximum number of suggestions listed for |z=|. |
484 | 7107 Not used for |spellsuggest()|. The number of |
7108 suggestions is never more than the value of 'lines' | |
7109 minus two. | |
7110 | |
374 | 7111 file:{filename} Read file {filename}, which must have two columns, |
7112 separated by a slash. The first column contains the | |
7113 bad word, the second column the suggested good word. | |
7114 Example: | |
7115 theribal/terrible ~ | |
7116 Use this for common mistakes that do not appear at the | |
7117 top of the suggestion list with the internal methods. | |
7118 Lines without a slash are ignored, use this for | |
7119 comments. | |
5862 | 7120 The word in the second column must be correct, |
7121 otherwise it will not be used. Add the word to an | |
7122 ".add" file if it is currently flagged as a spelling | |
7123 mistake. | |
374 | 7124 The file is used for all languages. |
7125 | |
7126 expr:{expr} Evaluate expression {expr}. Use a function to avoid | |
7127 trouble with spaces. |v:val| holds the badly spelled | |
7128 word. The expression must evaluate to a List of | |
7129 Lists, each with a suggestion and a score. | |
7130 Example: | |
11062 | 7131 [['the', 33], ['that', 44]] ~ |
593 | 7132 Set 'verbose' and use |z=| to see the scores that the |
374 | 7133 internal methods use. A lower score is better. |
7134 This may invoke |spellsuggest()| if you temporarily | |
7135 set 'spellsuggest' to exclude the "expr:" part. | |
7136 Errors are silently ignored, unless you set the | |
7137 'verbose' option to a non-zero value. | |
7138 | |
7139 Only one of "best", "double" or "fast" may be used. The others may | |
7140 appear several times in any order. Example: > | |
7141 :set sps=file:~/.vim/sugg,best,expr:MySuggest() | |
7142 < | |
7143 This option cannot be set from a |modeline| or in the |sandbox|, for | |
7144 security reasons. | |
344 | 7145 |
7146 | |
7 | 7147 *'splitbelow'* *'sb'* *'nosplitbelow'* *'nosb'* |
7148 'splitbelow' 'sb' boolean (default off) | |
7149 global | |
7150 {not in Vi} | |
2570
71b56b4e7785
Make the references to features in the help more consistent. (Sylvain Hitier)
Bram Moolenaar <bram@vim.org>
parents:
2561
diff
changeset
|
7151 {not available when compiled without the |+windows| |
7 | 7152 feature} |
7153 When on, splitting a window will put the new window below the current | |
7154 one. |:split| | |
7155 | |
7156 *'splitright'* *'spr'* *'nosplitright'* *'nospr'* | |
7157 'splitright' 'spr' boolean (default off) | |
7158 global | |
7159 {not in Vi} | |
2570
71b56b4e7785
Make the references to features in the help more consistent. (Sylvain Hitier)
Bram Moolenaar <bram@vim.org>
parents:
2561
diff
changeset
|
7160 {not available when compiled without the |+vertsplit| |
7 | 7161 feature} |
7162 When on, splitting a window will put the new window right of the | |
7163 current one. |:vsplit| | |
7164 | |
7165 *'startofline'* *'sol'* *'nostartofline'* *'nosol'* | |
7166 'startofline' 'sol' boolean (default on) | |
7167 global | |
7168 {not in Vi} | |
7169 When "on" the commands listed below move the cursor to the first | |
11 | 7170 non-blank of the line. When off the cursor is kept in the same column |
10 | 7171 (if possible). This applies to the commands: CTRL-D, CTRL-U, CTRL-B, |
11 | 7172 CTRL-F, "G", "H", "M", "L", gg, and to the commands "d", "<<" and ">>" |
7 | 7173 with a linewise operator, with "%" with a count and to buffer changing |
7174 commands (CTRL-^, :bnext, :bNext, etc.). Also for an Ex command that | |
7175 only has a line number, e.g., ":25" or ":+". | |
7176 In case of buffer changing commands the cursor is placed at the column | |
7177 where it was the last time the buffer was edited. | |
7178 NOTE: This option is set when 'compatible' is set. | |
7179 | |
2709 | 7180 *'statusline'* *'stl'* *E540* *E542* |
7 | 7181 'statusline' 'stl' string (default empty) |
40 | 7182 global or local to window |global-local| |
7 | 7183 {not in Vi} |
7184 {not available when compiled without the |+statusline| | |
7185 feature} | |
7186 When nonempty, this option determines the content of the status line. | |
7187 Also see |status-line|. | |
7188 | |
7189 The option consists of printf style '%' items interspersed with | |
7190 normal text. Each status line item is of the form: | |
7191 %-0{minwid}.{maxwid}{item} | |
7876
93f747af7b58
commit https://github.com/vim/vim/commit/5e9b2fa9bb0e6061cf18457c173cd141a5dc9c92
Christian Brabandt <cb@256bit.org>
parents:
7687
diff
changeset
|
7192 All fields except the {item} are optional. A single percent sign can |
2709 | 7193 be given as "%%". Up to 80 items can be specified. *E541* |
7 | 7194 |
680 | 7195 When the option starts with "%!" then it is used as an expression, |
7196 evaluated and the result is used as the option value. Example: > | |
7197 :set statusline=%!MyStatusLine() | |
7198 < The result can contain %{} items that will be evaluated too. | |
3445 | 7199 Note that the "%!" expression is evaluated in the context of the |
7200 current window and buffer, while %{} items are evaluated in the | |
7201 context of the window that the statusline belongs to. | |
680 | 7202 |
7203 When there is error while evaluating the option then it will be made | |
7204 empty to avoid further errors. Otherwise screen updating would loop. | |
7205 | |
7 | 7206 Note that the only effect of 'ruler' when this option is set (and |
7207 'laststatus' is 2) is controlling the output of |CTRL-G|. | |
7208 | |
7209 field meaning ~ | |
233 | 7210 - Left justify the item. The default is right justified |
7 | 7211 when minwid is larger than the length of the item. |
233 | 7212 0 Leading zeroes in numeric items. Overridden by '-'. |
7 | 7213 minwid Minimum width of the item, padding as set by '-' & '0'. |
7214 Value must be 50 or less. | |
10 | 7215 maxwid Maximum width of the item. Truncation occurs with a '<' |
7 | 7216 on the left for text items. Numeric items will be |
7217 shifted down to maxwid-2 digits followed by '>'number | |
7218 where number is the amount of missing digits, much like | |
7219 an exponential notation. | |
7220 item A one letter code as described below. | |
7221 | |
7222 Following is a description of the possible statusline items. The | |
7223 second character in "item" is the type: | |
7224 N for number | |
7225 S for string | |
7226 F for flags as described below | |
7227 - not applicable | |
7228 | |
7229 item meaning ~ | |
1152 | 7230 f S Path to the file in the buffer, as typed or relative to current |
7231 directory. | |
7 | 7232 F S Full path to the file in the buffer. |
7233 t S File name (tail) of file in the buffer. | |
1698 | 7234 m F Modified flag, text is "[+]"; "[-]" if 'modifiable' is off. |
7 | 7235 M F Modified flag, text is ",+" or ",-". |
1698 | 7236 r F Readonly flag, text is "[RO]". |
7 | 7237 R F Readonly flag, text is ",RO". |
1698 | 7238 h F Help buffer flag, text is "[help]". |
7 | 7239 H F Help buffer flag, text is ",HLP". |
1698 | 7240 w F Preview window flag, text is "[Preview]". |
7 | 7241 W F Preview window flag, text is ",PRV". |
1698 | 7242 y F Type of file in the buffer, e.g., "[vim]". See 'filetype'. |
7 | 7243 Y F Type of file in the buffer, e.g., ",VIM". See 'filetype'. |
7244 {not available when compiled without |+autocmd| feature} | |
2411
68e394361ca3
Add "q" item for 'statusline'. Add w:quickfix_title. (Lech Lorens)
Bram Moolenaar <bram@vim.org>
parents:
2400
diff
changeset
|
7245 q S "[Quickfix List]", "[Location List]" or empty. |
7 | 7246 k S Value of "b:keymap_name" or 'keymap' when |:lmap| mappings are |
7247 being used: "<keymap>" | |
7248 n N Buffer number. | |
2709 | 7249 b N Value of character under cursor. |
7 | 7250 B N As above, in hexadecimal. |
7251 o N Byte number in file of byte under cursor, first byte is 1. | |
7252 Mnemonic: Offset from start of file (with one added) | |
7253 {not available when compiled without |+byte_offset| feature} | |
7254 O N As above, in hexadecimal. | |
233 | 7255 N N Printer page number. (Only works in the 'printheader' option.) |
7 | 7256 l N Line number. |
7257 L N Number of lines in buffer. | |
7258 c N Column number. | |
7259 v N Virtual column number. | |
10 | 7260 V N Virtual column number as -{num}. Not displayed if equal to 'c'. |
7 | 7261 p N Percentage through file in lines as in |CTRL-G|. |
7262 P S Percentage through file of displayed window. This is like the | |
5055 | 7263 percentage described for 'ruler'. Always 3 in length, unless |
7264 translated. | |
233 | 7265 a S Argument list status as in default title. ({current} of {max}) |
7 | 7266 Empty if the argument file count is zero or one. |
680 | 7267 { NF Evaluate expression between '%{' and '}' and substitute result. |
625 | 7268 Note that there is no '%' before the closing '}'. |
7 | 7269 ( - Start of item group. Can be used for setting the width and |
7270 alignment of a section. Must be followed by %) somewhere. | |
7271 ) - End of item group. No width fields allowed. | |
681 | 7272 T N For 'tabline': start of tab page N label. Use %T after the last |
7273 label. This information is used for mouse clicks. | |
7274 X N For 'tabline': start of close tab N label. Use %X after the | |
7275 label, e.g.: %3Xclose%X. Use %999X for a "close current tab" | |
7276 mark. This information is used for mouse clicks. | |
7 | 7277 < - Where to truncate line if too long. Default is at the start. |
7278 No width fields allowed. | |
7279 = - Separation point between left and right aligned items. | |
7280 No width fields allowed. | |
680 | 7281 # - Set highlight group. The name must follow and then a # again. |
7282 Thus use %#HLname# for highlight group HLname. The same | |
7283 highlighting is used, also for the statusline of non-current | |
7284 windows. | |
7 | 7285 * - Set highlight group to User{N}, where {N} is taken from the |
233 | 7286 minwid field, e.g. %1*. Restore normal highlight with %* or %0*. |
7 | 7287 The difference between User{N} and StatusLine will be applied |
7288 to StatusLineNC for the statusline of non-current windows. | |
7289 The number N must be between 1 and 9. See |hl-User1..9| | |
7290 | |
1698 | 7291 When displaying a flag, Vim removes the leading comma, if any, when |
7292 that flag comes right after plaintext. This will make a nice display | |
7293 when flags are used like in the examples below. | |
7 | 7294 |
233 | 7295 When all items in a group becomes an empty string (i.e. flags that are |
7 | 7296 not set) and a minwid is not set for the group, the whole group will |
7297 become empty. This will make a group like the following disappear | |
7298 completely from the statusline when none of the flags are set. > | |
7299 :set statusline=...%(\ [%M%R%H]%)... | |
7245
8896150aba23
commit https://github.com/vim/vim/commit/e392eb41f8dfc01bd13634e534ac6b4d505326f4
Christian Brabandt <cb@256bit.org>
parents:
7233
diff
changeset
|
7300 < *g:actual_curbuf* |
7 | 7301 Beware that an expression is evaluated each and every time the status |
7302 line is displayed. The current buffer and current window will be set | |
7303 temporarily to that of the window (and buffer) whose statusline is | |
233 | 7304 currently being drawn. The expression will evaluate in this context. |
7 | 7305 The variable "actual_curbuf" is set to the 'bufnr()' number of the |
634 | 7306 real current buffer. |
7307 | |
3682 | 7308 The 'statusline' option will be evaluated in the |sandbox| if set from |
7309 a modeline, see |sandbox-option|. | |
634 | 7310 |
7311 It is not allowed to change text or jump to another window while | |
7312 evaluating 'statusline' |textlock|. | |
7 | 7313 |
7314 If the statusline is not updated when you want it (e.g., after setting | |
7315 a variable that's used in an expression), you can force an update by | |
7316 setting an option without changing its value. Example: > | |
7317 :let &ro = &ro | |
7318 | |
7319 < A result of all digits is regarded a number for display purposes. | |
7320 Otherwise the result is taken as flag text and applied to the rules | |
7321 described above. | |
7322 | |
199 | 7323 Watch out for errors in expressions. They may render Vim unusable! |
7 | 7324 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
|
7325 edit your .vimrc or whatever with "vim --clean" to get it right. |
7 | 7326 |
7327 Examples: | |
7328 Emulate standard status line with 'ruler' set > | |
7329 :set statusline=%<%f\ %h%m%r%=%-14.(%l,%c%V%)\ %P | |
7330 < Similar, but add ASCII value of char under the cursor (like "ga") > | |
7331 :set statusline=%<%f%h%m%r%=%b\ 0x%B\ \ %l,%c%V\ %P | |
7332 < Display byte count and byte value, modified flag in red. > | |
7333 :set statusline=%<%f%=\ [%1*%M%*%n%R%H]\ %-19(%3l,%02c%03V%)%O'%02b' | |
7334 :hi User1 term=inverse,bold cterm=inverse,bold ctermfg=red | |
7335 < Display a ,GZ flag if a compressed file is loaded > | |
7336 :set statusline=...%r%{VarExists('b:gzflag','\ [GZ]')}%h... | |
7337 < In the |:autocmd|'s: > | |
7338 :let b:gzflag = 1 | |
7339 < And: > | |
7340 :unlet b:gzflag | |
7341 < And define this function: > | |
7342 :function VarExists(var, val) | |
7343 : if exists(a:var) | return a:val | else | return '' | endif | |
7344 :endfunction | |
7345 < | |
7346 *'suffixes'* *'su'* | |
7347 'suffixes' 'su' string (default ".bak,~,.o,.h,.info,.swp,.obj") | |
7348 global | |
7349 {not in Vi} | |
7350 Files with these suffixes get a lower priority when multiple files | |
7351 match a wildcard. See |suffixes|. Commas can be used to separate the | |
10 | 7352 suffixes. Spaces after the comma are ignored. A dot is also seen as |
7353 the start of a suffix. To avoid a dot or comma being recognized as a | |
7 | 7354 separator, precede it with a backslash (see |option-backslash| about |
7355 including spaces and backslashes). | |
7356 See 'wildignore' for completely ignoring files. | |
7357 The use of |:set+=| and |:set-=| is preferred when adding or removing | |
7358 suffixes from the list. This avoids problems when a future version | |
7359 uses another default. | |
7360 | |
7361 *'suffixesadd'* *'sua'* | |
7362 'suffixesadd' 'sua' string (default "") | |
7363 local to buffer | |
7364 {not in Vi} | |
7365 {not available when compiled without the | |
7366 |+file_in_path| feature} | |
7367 Comma separated list of suffixes, which are used when searching for a | |
7368 file for the "gf", "[I", etc. commands. Example: > | |
7369 :set suffixesadd=.java | |
7370 < | |
7371 *'swapfile'* *'swf'* *'noswapfile'* *'noswf'* | |
7372 'swapfile' 'swf' boolean (default on) | |
7373 local to buffer | |
7374 {not in Vi} | |
10 | 7375 Use a swapfile for the buffer. This option can be reset when a |
7 | 7376 swapfile is not wanted for a specific buffer. For example, with |
7377 confidential information that even root must not be able to access. | |
7378 Careful: All text will be in memory: | |
7379 - Don't use this for big files. | |
7380 - Recovery will be impossible! | |
7381 A swapfile will only be present when |'updatecount'| is non-zero and | |
7382 'swapfile' is set. | |
7383 When 'swapfile' is reset, the swap file for the current buffer is | |
7384 immediately deleted. When 'swapfile' is set, and 'updatecount' is | |
7385 non-zero, a swap file is immediately created. | |
7386 Also see |swap-file| and |'swapsync'|. | |
5763 | 7387 If you want to open a new buffer without creating a swap file for it, |
7388 use the |:noswapfile| modifier. | |
7 | 7389 |
7390 This option is used together with 'bufhidden' and 'buftype' to | |
7391 specify special kinds of buffers. See |special-buffers|. | |
7392 | |
7393 *'swapsync'* *'sws'* | |
7394 'swapsync' 'sws' string (default "fsync") | |
7395 global | |
7396 {not in Vi} | |
7397 When this option is not empty a swap file is synced to disk after | |
10 | 7398 writing to it. This takes some time, especially on busy unix systems. |
7 | 7399 When this option is empty parts of the swap file may be in memory and |
7400 not written to disk. When the system crashes you may lose more work. | |
7401 On Unix the system does a sync now and then without Vim asking for it, | |
7402 so the disadvantage of setting this option off is small. On some | |
7403 systems the swap file will not be written at all. For a unix system | |
7404 setting it to "sync" will use the sync() call instead of the default | |
7405 fsync(), which may work better on some systems. | |
36 | 7406 The 'fsync' option is used for the actual file. |
7 | 7407 |
7408 *'switchbuf'* *'swb'* | |
7409 'switchbuf' 'swb' string (default "") | |
7410 global | |
7411 {not in Vi} | |
7412 This option controls the behavior when switching between buffers. | |
7413 Possible values (comma separated list): | |
7414 useopen If included, jump to the first open window that | |
7415 contains the specified buffer (if there is one). | |
7416 Otherwise: Do not examine other windows. | |
7417 This setting is checked with |quickfix| commands, when | |
7418 jumping to errors (":cc", ":cn", "cp", etc.). It is | |
7419 also used in all buffer related split commands, for | |
7420 example ":sbuffer", ":sbnext", or ":sbrewind". | |
825 | 7421 usetab Like "useopen", but also consider windows in other tab |
856 | 7422 pages. |
7 | 7423 split If included, split the current window before loading |
3153 | 7424 a buffer for a |quickfix| command that display errors. |
7425 Otherwise: do not split, use current window. | |
6843 | 7426 vsplit Just like "split" but split vertically. |
1621 | 7427 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
|
7428 "split" when both are present. |
7 | 7429 |
410 | 7430 *'synmaxcol'* *'smc'* |
7431 'synmaxcol' 'smc' number (default 3000) | |
7432 local to buffer | |
7433 {not in Vi} | |
7434 {not available when compiled without the |+syntax| | |
7435 feature} | |
419 | 7436 Maximum column in which to search for syntax items. In long lines the |
7437 text after this column is not highlighted and following lines may not | |
7438 be highlighted correctly, because the syntax state is cleared. | |
410 | 7439 This helps to avoid very slow redrawing for an XML file that is one |
7440 long line. | |
7441 Set to zero to remove the limit. | |
7442 | |
7 | 7443 *'syntax'* *'syn'* |
7444 'syntax' 'syn' string (default empty) | |
7445 local to buffer | |
7446 {not in Vi} | |
7447 {not available when compiled without the |+syntax| | |
7448 feature} | |
7449 When this option is set, the syntax with this name is loaded, unless | |
7450 syntax highlighting has been switched off with ":syntax off". | |
7451 Otherwise this option does not always reflect the current syntax (the | |
7452 b:current_syntax variable does). | |
7453 This option is most useful in a modeline, for a file which syntax is | |
782 | 7454 not automatically recognized. Example, in an IDL file: |
7455 /* vim: set syntax=idl : */ ~ | |
7456 When a dot appears in the value then this separates two filetype | |
7457 names. Example: | |
7458 /* vim: set syntax=c.doxygen : */ ~ | |
7459 This will use the "c" syntax first, then the "doxygen" syntax. | |
7460 Note that the second one must be prepared to be loaded as an addition, | |
7461 otherwise it will be skipped. More than one dot may appear. | |
7462 To switch off syntax highlighting for the current file, use: > | |
7 | 7463 :set syntax=OFF |
7464 < To switch syntax highlighting on according to the current value of the | |
7465 'filetype' option: > | |
7466 :set syntax=ON | |
7467 < What actually happens when setting the 'syntax' option is that the | |
7468 Syntax autocommand event is triggered with the value as argument. | |
7469 This option is not copied to another buffer, independent of the 's' or | |
7470 'S' flag in 'cpoptions'. | |
36 | 7471 Only normal file name characters can be used, "/\*?[|<>" are illegal. |
7 | 7472 |
699 | 7473 *'tabline'* *'tal'* |
677 | 7474 'tabline' 'tal' string (default empty) |
674 | 7475 global |
7476 {not in Vi} | |
2570
71b56b4e7785
Make the references to features in the help more consistent. (Sylvain Hitier)
Bram Moolenaar <bram@vim.org>
parents:
2561
diff
changeset
|
7477 {not available when compiled without the |+windows| |
674 | 7478 feature} |
677 | 7479 When nonempty, this option determines the content of the tab pages |
7480 line at the top of the Vim window. When empty Vim will use a default | |
681 | 7481 tab pages line. See |setting-tabline| for more info. |
677 | 7482 |
7483 The tab pages line only appears as specified with the 'showtabline' | |
688 | 7484 option and only when there is no GUI tab line. When 'e' is in |
7485 '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
|
7486 instead. Note that the two tab pages lines are very different. |
677 | 7487 |
7488 The value is evaluated like with 'statusline'. You can use | |
7489 |tabpagenr()|, |tabpagewinnr()| and |tabpagebuflist()| to figure out | |
681 | 7490 the text to be displayed. Use "%1T" for the first label, "%2T" for |
7491 the second one, etc. Use "%X" items for closing labels. | |
677 | 7492 |
7493 Keep in mind that only one of the tab pages is the current one, others | |
7494 are invisible and you can't jump to their windows. | |
7495 | |
674 | 7496 |
699 | 7497 *'tabpagemax'* *'tpm'* |
7498 'tabpagemax' 'tpm' number (default 10) | |
7499 global | |
7500 {not in Vi} | |
2570
71b56b4e7785
Make the references to features in the help more consistent. (Sylvain Hitier)
Bram Moolenaar <bram@vim.org>
parents:
2561
diff
changeset
|
7501 {not available when compiled without the |+windows| |
699 | 7502 feature} |
7503 Maximum number of tab pages to be opened by the |-p| command line | |
7504 argument or the ":tab all" command. |tabpage| | |
7505 | |
7506 | |
7507 *'tabstop'* *'ts'* | |
7 | 7508 'tabstop' 'ts' number (default 8) |
7509 local to buffer | |
7510 Number of spaces that a <Tab> in the file counts for. Also see | |
7511 |:retab| command, and 'softtabstop' option. | |
7512 | |
7513 Note: Setting 'tabstop' to any other value than 8 can make your file | |
7514 appear wrong in many places (e.g., when printing it). | |
7515 | |
7516 There are four main ways to use tabs in Vim: | |
7517 1. Always keep 'tabstop' at 8, set 'softtabstop' and 'shiftwidth' to 4 | |
7518 (or 3 or whatever you prefer) and use 'noexpandtab'. Then Vim | |
1263 | 7519 will use a mix of tabs and spaces, but typing <Tab> and <BS> will |
7 | 7520 behave like a tab appears every 4 (or 3) characters. |
7521 2. Set 'tabstop' and 'shiftwidth' to whatever you prefer and use | |
7522 'expandtab'. This way you will always insert spaces. The | |
7523 formatting will never be messed up when 'tabstop' is changed. | |
7524 3. Set 'tabstop' and 'shiftwidth' to whatever you prefer and use a | |
10 | 7525 |modeline| to set these values when editing the file again. Only |
7 | 7526 works when using Vim to edit the file. |
7527 4. Always set 'tabstop' and 'shiftwidth' to the same value, and | |
7528 'noexpandtab'. This should then work (for initial indents only) | |
7529 for any tabstop setting that people use. It might be nice to have | |
7530 tabs after the first non-blank inserted as spaces if you do this | |
7531 though. Otherwise aligned comments will be wrong when 'tabstop' is | |
7532 changed. | |
7533 | |
7534 *'tagbsearch'* *'tbs'* *'notagbsearch'* *'notbs'* | |
7535 'tagbsearch' 'tbs' boolean (default on) | |
7536 global | |
7537 {not in Vi} | |
7538 When searching for a tag (e.g., for the |:ta| command), Vim can either | |
10 | 7539 use a binary search or a linear search in a tags file. Binary |
7 | 7540 searching makes searching for a tag a LOT faster, but a linear search |
7541 will find more tags if the tags file wasn't properly sorted. | |
7542 Vim normally assumes that your tags files are sorted, or indicate that | |
7543 they are not sorted. Only when this is not the case does the | |
7544 'tagbsearch' option need to be switched off. | |
7545 | |
7546 When 'tagbsearch' is on, binary searching is first used in the tags | |
10 | 7547 files. In certain situations, Vim will do a linear search instead for |
7 | 7548 certain files, or retry all files with a linear search. When |
7549 'tagbsearch' is off, only a linear search is done. | |
7550 | |
7551 Linear searching is done anyway, for one file, when Vim finds a line | |
7552 at the start of the file indicating that it's not sorted: > | |
1621 | 7553 !_TAG_FILE_SORTED 0 /some comment/ |
7 | 7554 < [The whitespace before and after the '0' must be a single <Tab>] |
7555 | |
7556 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
|
7557 files listed in 'tags', and case is ignored or a pattern is used |
7 | 7558 instead of a normal tag name, a retry is done with a linear search. |
7559 Tags in unsorted tags files, and matches with different case will only | |
7560 be found in the retry. | |
7561 | |
22 | 7562 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
|
7563 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
|
7564 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
|
7565 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
|
7566 "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
|
7567 (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
|
7568 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
|
7569 |
6ba7182fb7bd
commit https://github.com/vim/vim/commit/0f6562e9036f889185dff49a75c7fc5ffb28b307
Christian Brabandt <cb@256bit.org>
parents:
7245
diff
changeset
|
7570 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
|
7571 '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
|
7572 "ignore". |
9913
bb00c661b3a4
commit https://github.com/vim/vim/commit/66e29d7112e437b2b50efe1f82c7e892736d23e4
Christian Brabandt <cb@256bit.org>
parents:
9887
diff
changeset
|
7573 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
|
7574 '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
|
7575 characters. |
7 | 7576 |
7577 When 'tagbsearch' is off, tags searching is slower when a full match | |
7578 exists, but faster when no full match exists. Tags in unsorted tags | |
7579 files may only be found with 'tagbsearch' off. | |
7580 When the tags file is not sorted, or sorted in a wrong way (not on | |
7581 ASCII byte value), 'tagbsearch' should be off, or the line given above | |
7582 must be included in the tags file. | |
7583 This option doesn't affect commands that find all matching tags (e.g., | |
7584 command-line completion and ":help"). | |
7585 {Vi: always uses binary search in some versions} | |
7586 | |
7266
6ba7182fb7bd
commit https://github.com/vim/vim/commit/0f6562e9036f889185dff49a75c7fc5ffb28b307
Christian Brabandt <cb@256bit.org>
parents:
7245
diff
changeset
|
7587 *'tagcase'* *'tc'* |
6ba7182fb7bd
commit https://github.com/vim/vim/commit/0f6562e9036f889185dff49a75c7fc5ffb28b307
Christian Brabandt <cb@256bit.org>
parents:
7245
diff
changeset
|
7588 'tagcase' 'tc' string (default "followic") |
6ba7182fb7bd
commit https://github.com/vim/vim/commit/0f6562e9036f889185dff49a75c7fc5ffb28b307
Christian Brabandt <cb@256bit.org>
parents:
7245
diff
changeset
|
7589 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
|
7590 {not in Vi} |
6ba7182fb7bd
commit https://github.com/vim/vim/commit/0f6562e9036f889185dff49a75c7fc5ffb28b307
Christian Brabandt <cb@256bit.org>
parents:
7245
diff
changeset
|
7591 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
|
7592 file: |
6ba7182fb7bd
commit https://github.com/vim/vim/commit/0f6562e9036f889185dff49a75c7fc5ffb28b307
Christian Brabandt <cb@256bit.org>
parents:
7245
diff
changeset
|
7593 followic Follow the 'ignorecase' option |
9913
bb00c661b3a4
commit https://github.com/vim/vim/commit/66e29d7112e437b2b50efe1f82c7e892736d23e4
Christian Brabandt <cb@256bit.org>
parents:
9887
diff
changeset
|
7594 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
|
7595 ignore Ignore case |
6ba7182fb7bd
commit https://github.com/vim/vim/commit/0f6562e9036f889185dff49a75c7fc5ffb28b307
Christian Brabandt <cb@256bit.org>
parents:
7245
diff
changeset
|
7596 match Match case |
9913
bb00c661b3a4
commit https://github.com/vim/vim/commit/66e29d7112e437b2b50efe1f82c7e892736d23e4
Christian Brabandt <cb@256bit.org>
parents:
9887
diff
changeset
|
7597 smart Ignore case unless an upper case letter is used |
11160 | 7598 NOTE: This option is set to the Vi default value when 'compatible' is |
7599 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
|
7600 |
7 | 7601 *'taglength'* *'tl'* |
7602 'taglength' 'tl' number (default 0) | |
7603 global | |
7604 If non-zero, tags are significant up to this number of characters. | |
7605 | |
7606 *'tagrelative'* *'tr'* *'notagrelative'* *'notr'* | |
7607 'tagrelative' 'tr' boolean (Vim default: on, Vi default: off) | |
7608 global | |
7609 {not in Vi} | |
824 | 7610 If on and using a tags file in another directory, file names in that |
7611 tags file are relative to the directory where the tags file is. | |
7 | 7612 NOTE: This option is set to the Vi default value when 'compatible' is |
7613 set and to the Vim default value when 'compatible' is reset. | |
7614 | |
7615 *'tags'* *'tag'* *E433* | |
7616 'tags' 'tag' string (default "./tags,tags", when compiled with | |
7617 |+emacs_tags|: "./tags,./TAGS,tags,TAGS") | |
7618 global or local to buffer |global-local| | |
7619 Filenames for the tag command, separated by spaces or commas. To | |
7620 include a space or comma in a file name, precede it with a backslash | |
7621 (see |option-backslash| about including spaces and backslashes). | |
7622 When a file name starts with "./", the '.' is replaced with the path | |
7623 of the current file. But only when the 'd' flag is not included in | |
7624 'cpoptions'. Environment variables are expanded |:set_env|. Also see | |
7625 |tags-option|. | |
7626 "*", "**" 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
|
7627 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
|
7628 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
|
7629 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
|
7630 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
|
7631 |+path_extra| feature} |
515 | 7632 The |tagfiles()| function can be used to get a list of the file names |
7633 actually used. | |
7 | 7634 If Vim was compiled with the |+emacs_tags| feature, Emacs-style tag |
7635 files are also supported. They are automatically recognized. The | |
7636 default value becomes "./tags,./TAGS,tags,TAGS", unless case | |
7637 differences are ignored (MS-Windows). |emacs-tags| | |
7638 The use of |:set+=| and |:set-=| is preferred when adding or removing | |
7639 file names from the list. This avoids problems when a future version | |
7640 uses another default. | |
7641 {Vi: default is "tags /usr/lib/tags"} | |
7642 | |
7643 *'tagstack'* *'tgst'* *'notagstack'* *'notgst'* | |
7644 'tagstack' 'tgst' boolean (default on) | |
7645 global | |
7646 {not in all versions of Vi} | |
7647 When on, the |tagstack| is used normally. When off, a ":tag" or | |
7648 ":tselect" command with an argument will not push the tag onto the | |
7649 tagstack. A following ":tag" without an argument, a ":pop" command or | |
7650 any other command that uses the tagstack will use the unmodified | |
7651 tagstack, but does change the pointer to the active entry. | |
7652 Resetting this option is useful when using a ":tag" command in a | |
7653 mapping which should not change the tagstack. | |
7654 | |
7538
c9fc24b76293
commit https://github.com/vim/vim/commit/8a5115cf18751022387af2085f374d38c60dde83
Christian Brabandt <cb@256bit.org>
parents:
7528
diff
changeset
|
7655 *'tcldll'* |
8629
54ac275e3fc4
commit https://github.com/vim/vim/commit/3848e00e0177abdb31bc600234967863ec487233
Christian Brabandt <cb@256bit.org>
parents:
8560
diff
changeset
|
7656 '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
|
7657 global |
c9fc24b76293
commit https://github.com/vim/vim/commit/8a5115cf18751022387af2085f374d38c60dde83
Christian Brabandt <cb@256bit.org>
parents:
7528
diff
changeset
|
7658 {not in Vi} |
c9fc24b76293
commit https://github.com/vim/vim/commit/8a5115cf18751022387af2085f374d38c60dde83
Christian Brabandt <cb@256bit.org>
parents:
7528
diff
changeset
|
7659 {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
|
7660 feature} |
c9fc24b76293
commit https://github.com/vim/vim/commit/8a5115cf18751022387af2085f374d38c60dde83
Christian Brabandt <cb@256bit.org>
parents:
7528
diff
changeset
|
7661 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
|
7662 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
|
7663 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
|
7664 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
|
7665 security reasons. |
c9fc24b76293
commit https://github.com/vim/vim/commit/8a5115cf18751022387af2085f374d38c60dde83
Christian Brabandt <cb@256bit.org>
parents:
7528
diff
changeset
|
7666 |
7 | 7667 *'term'* *E529* *E530* *E531* |
7668 'term' string (default is $TERM, if that fails: | |
7669 in the GUI: "builtin_gui" | |
7670 on Amiga: "amiga" | |
7671 on BeOS: "beos-ansi" | |
7672 on Mac: "mac-ansi" | |
7673 on MiNT: "vt52" | |
7674 on MS-DOS: "pcterm" | |
7675 on OS/2: "os2ansi" | |
7676 on Unix: "ansi" | |
7677 on VMS: "ansi" | |
7678 on Win 32: "win32") | |
7679 global | |
7680 Name of the terminal. Used for choosing the terminal control | |
7681 characters. Environment variables are expanded |:set_env|. | |
7682 For example: > | |
7683 :set term=$TERM | |
7684 < See |termcap|. | |
7685 | |
7686 *'termbidi'* *'tbidi'* | |
7687 *'notermbidi'* *'notbidi'* | |
7688 'termbidi' 'tbidi' boolean (default off, on for "mlterm") | |
7689 global | |
7690 {not in Vi} | |
7691 {only available when compiled with the |+arabic| | |
7692 feature} | |
7693 The terminal is in charge of Bi-directionality of text (as specified | |
7694 by Unicode). The terminal is also expected to do the required shaping | |
7695 that some languages (such as Arabic) require. | |
7696 Setting this option implies that 'rightleft' will not be set when | |
7697 'arabic' is set and the value of 'arabicshape' will be ignored. | |
7698 Note that setting 'termbidi' has the immediate effect that | |
7699 'arabicshape' is ignored, but 'rightleft' isn't changed automatically. | |
7700 This option is reset when the GUI is started. | |
7701 For further details see |arabic.txt|. | |
7702 | |
7703 *'termencoding'* *'tenc'* | |
10895
c391bfbdb452
Updated runtime files.
Christian Brabandt <cb@256bit.org>
parents:
10734
diff
changeset
|
7704 'termencoding' 'tenc' string (default ""; with GTK+ GUI: "utf-8"; with |
7 | 7705 Macintosh GUI: "macroman") |
7706 global | |
7707 {only available when compiled with the |+multi_byte| | |
7708 feature} | |
7709 {not in Vi} | |
7710 Encoding used for the terminal. This specifies what character | |
7711 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
|
7712 the GUI it only applies to the keyboard ('encoding' is used for the |
1152 | 7713 display). Except for the Mac when 'macatsui' is off, then |
7714 'termencoding' should be "macroman". | |
7 | 7715 *E617* |
10895
c391bfbdb452
Updated runtime files.
Christian Brabandt <cb@256bit.org>
parents:
10734
diff
changeset
|
7716 Note: This does not apply to the GTK+ GUI. After the GUI has been |
7 | 7717 successfully initialized, 'termencoding' is forcibly set to "utf-8". |
7718 Any attempts to set a different value will be rejected, and an error | |
7719 message is shown. | |
7080
1a34f5272977
commit https://github.com/vim/vim/commit/ac360bf2ca293735fc7c6654dc2b3066f4c62488
Christian Brabandt <cb@256bit.org>
parents:
7051
diff
changeset
|
7720 For the Win32 GUI and console versions 'termencoding' is not used, |
7 | 7721 because the Win32 system always passes Unicode characters. |
7722 When empty, the same encoding is used as for the 'encoding' option. | |
7723 This is the normal value. | |
7724 Not all combinations for 'termencoding' and 'encoding' are valid. See | |
7725 |encoding-table|. | |
7726 The value for this option must be supported by internal conversions or | |
7727 iconv(). When this is not possible no conversion will be done and you | |
7728 will probably experience problems with non-ASCII characters. | |
7729 Example: You are working with the locale set to euc-jp (Japanese) and | |
7730 want to edit a UTF-8 file: > | |
7731 :let &termencoding = &encoding | |
7732 :set encoding=utf-8 | |
7733 < You need to do this when your system has no locale support for UTF-8. | |
7734 | |
9027
773d627cac0b
commit https://github.com/vim/vim/commit/61be73bb0f965a895bfb064ea3e55476ac175162
Christian Brabandt <cb@256bit.org>
parents:
8969
diff
changeset
|
7735 *'termguicolors'* *'tgc'* |
773d627cac0b
commit https://github.com/vim/vim/commit/61be73bb0f965a895bfb064ea3e55476ac175162
Christian Brabandt <cb@256bit.org>
parents:
8969
diff
changeset
|
7736 'termguicolors' 'tgc' boolean (default off) |
773d627cac0b
commit https://github.com/vim/vim/commit/61be73bb0f965a895bfb064ea3e55476ac175162
Christian Brabandt <cb@256bit.org>
parents:
8969
diff
changeset
|
7737 global |
773d627cac0b
commit https://github.com/vim/vim/commit/61be73bb0f965a895bfb064ea3e55476ac175162
Christian Brabandt <cb@256bit.org>
parents:
8969
diff
changeset
|
7738 {not in Vi} |
773d627cac0b
commit https://github.com/vim/vim/commit/61be73bb0f965a895bfb064ea3e55476ac175162
Christian Brabandt <cb@256bit.org>
parents:
8969
diff
changeset
|
7739 {not available when compiled without the |
773d627cac0b
commit https://github.com/vim/vim/commit/61be73bb0f965a895bfb064ea3e55476ac175162
Christian Brabandt <cb@256bit.org>
parents:
8969
diff
changeset
|
7740 |+termguicolors| feature} |
773d627cac0b
commit https://github.com/vim/vim/commit/61be73bb0f965a895bfb064ea3e55476ac175162
Christian Brabandt <cb@256bit.org>
parents:
8969
diff
changeset
|
7741 When on, uses |highlight-guifg| and |highlight-guibg| attributes in |
773d627cac0b
commit https://github.com/vim/vim/commit/61be73bb0f965a895bfb064ea3e55476ac175162
Christian Brabandt <cb@256bit.org>
parents:
8969
diff
changeset
|
7742 the terminal (thus using 24-bit color). Requires a ISO-8613-3 |
773d627cac0b
commit https://github.com/vim/vim/commit/61be73bb0f965a895bfb064ea3e55476ac175162
Christian Brabandt <cb@256bit.org>
parents:
8969
diff
changeset
|
7743 compatible terminal. |
773d627cac0b
commit https://github.com/vim/vim/commit/61be73bb0f965a895bfb064ea3e55476ac175162
Christian Brabandt <cb@256bit.org>
parents:
8969
diff
changeset
|
7744 If setting this option does not work (produces a colorless UI) |
773d627cac0b
commit https://github.com/vim/vim/commit/61be73bb0f965a895bfb064ea3e55476ac175162
Christian Brabandt <cb@256bit.org>
parents:
8969
diff
changeset
|
7745 reading |xterm-true-color| might help. |
11473 | 7746 Note that the "cterm" attributes are still used, not the "gui" ones. |
11160 | 7747 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
|
7748 |
11659
49c12c93abf3
Updated runtime files and translations.
Christian Brabandt <cb@256bit.org>
parents:
11529
diff
changeset
|
7749 *'termkey'* *'tk'* |
11914 | 7750 'termkey' 'tk' string (default "") |
11659
49c12c93abf3
Updated runtime files and translations.
Christian Brabandt <cb@256bit.org>
parents:
11529
diff
changeset
|
7751 local to window |
49c12c93abf3
Updated runtime files and translations.
Christian Brabandt <cb@256bit.org>
parents:
11529
diff
changeset
|
7752 {not in Vi} |
11914 | 7753 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
|
7754 are sent to the job running in the window. |
11914 | 7755 The <> notation can be used, e.g.: > |
7756 :set termkey=<C-L> | |
7757 < The string must be one key stroke but can be multiple bytes. | |
7758 When not set CTRL-W is used, so that CTRL-W : gets you to the command | |
7759 line. If 'termkey' is set to CTRL-L then CTRL-L : gets you to the | |
7760 command line. | |
11659
49c12c93abf3
Updated runtime files and translations.
Christian Brabandt <cb@256bit.org>
parents:
11529
diff
changeset
|
7761 |
11757
74abb6c84984
patch 8.0.0761: options not set properly for a terminal buffer
Christian Brabandt <cb@256bit.org>
parents:
11666
diff
changeset
|
7762 *'termsize'* *'tms'* |
11659
49c12c93abf3
Updated runtime files and translations.
Christian Brabandt <cb@256bit.org>
parents:
11529
diff
changeset
|
7763 'termsize' 'tms' string (default "") |
49c12c93abf3
Updated runtime files and translations.
Christian Brabandt <cb@256bit.org>
parents:
11529
diff
changeset
|
7764 local to window |
49c12c93abf3
Updated runtime files and translations.
Christian Brabandt <cb@256bit.org>
parents:
11529
diff
changeset
|
7765 {not in Vi} |
49c12c93abf3
Updated runtime files and translations.
Christian Brabandt <cb@256bit.org>
parents:
11529
diff
changeset
|
7766 Size of the |terminal| window. Format: {rows}x{columns}. |
49c12c93abf3
Updated runtime files and translations.
Christian Brabandt <cb@256bit.org>
parents:
11529
diff
changeset
|
7767 - When empty the terminal gets the size from the window. |
11757
74abb6c84984
patch 8.0.0761: options not set properly for a terminal buffer
Christian Brabandt <cb@256bit.org>
parents:
11666
diff
changeset
|
7768 - When set (e.g., "24x80") the terminal size is not adjusted to the |
74abb6c84984
patch 8.0.0761: options not set properly for a terminal buffer
Christian Brabandt <cb@256bit.org>
parents:
11666
diff
changeset
|
7769 window size. If the window is smaller only the top-left part is |
74abb6c84984
patch 8.0.0761: options not set properly for a terminal buffer
Christian Brabandt <cb@256bit.org>
parents:
11666
diff
changeset
|
7770 displayed. |
74abb6c84984
patch 8.0.0761: options not set properly for a terminal buffer
Christian Brabandt <cb@256bit.org>
parents:
11666
diff
changeset
|
7771 When rows is zero then use the height of the window. |
74abb6c84984
patch 8.0.0761: options not set properly for a terminal buffer
Christian Brabandt <cb@256bit.org>
parents:
11666
diff
changeset
|
7772 When columns is zero then use the width of the window. |
74abb6c84984
patch 8.0.0761: options not set properly for a terminal buffer
Christian Brabandt <cb@256bit.org>
parents:
11666
diff
changeset
|
7773 For example: "30x0" uses 30 rows with the current window width. |
74abb6c84984
patch 8.0.0761: options not set properly for a terminal buffer
Christian Brabandt <cb@256bit.org>
parents:
11666
diff
changeset
|
7774 Using "0x0" is the same as empty. |
74abb6c84984
patch 8.0.0761: options not set properly for a terminal buffer
Christian Brabandt <cb@256bit.org>
parents:
11666
diff
changeset
|
7775 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
|
7776 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
|
7777 adjusted to that size, if possible. |
11659
49c12c93abf3
Updated runtime files and translations.
Christian Brabandt <cb@256bit.org>
parents:
11529
diff
changeset
|
7778 |
7 | 7779 *'terse'* *'noterse'* |
7780 'terse' boolean (default off) | |
7781 global | |
7782 When set: Add 's' flag to 'shortmess' option (this makes the message | |
7783 for a search that hits the start or end of the file not being | |
7784 displayed). When reset: Remove 's' flag from 'shortmess' option. {Vi | |
7785 shortens a lot of messages} | |
7786 | |
7787 *'textauto'* *'ta'* *'notextauto'* *'nota'* | |
7788 'textauto' 'ta' boolean (Vim default: on, Vi default: off) | |
7789 global | |
7790 {not in Vi} | |
7791 This option is obsolete. Use 'fileformats'. | |
7792 For backwards compatibility, when 'textauto' is set, 'fileformats' is | |
7793 set to the default value for the current system. When 'textauto' is | |
7794 reset, 'fileformats' is made empty. | |
7795 NOTE: This option is set to the Vi default value when 'compatible' is | |
7796 set and to the Vim default value when 'compatible' is reset. | |
7797 | |
7798 *'textmode'* *'tx'* *'notextmode'* *'notx'* | |
7799 'textmode' 'tx' boolean (MS-DOS, Win32 and OS/2: default on, | |
7800 others: default off) | |
7801 local to buffer | |
7802 {not in Vi} | |
7803 This option is obsolete. Use 'fileformat'. | |
7804 For backwards compatibility, when 'textmode' is set, 'fileformat' is | |
7805 set to "dos". When 'textmode' is reset, 'fileformat' is set to | |
7806 "unix". | |
7807 | |
7808 *'textwidth'* *'tw'* | |
7809 'textwidth' 'tw' number (default 0) | |
7810 local to buffer | |
7811 {not in Vi} | |
7812 Maximum width of text that is being inserted. A longer line will be | |
7813 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
|
7814 this. |
c590de398af9
commit https://github.com/vim/vim/commit/ca63501fbcd1cf9c8aa9ff12c093c95b62a89ed7
Christian Brabandt <cb@256bit.org>
parents:
7080
diff
changeset
|
7815 '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
|
7816 when 'paste' is reset. |
c590de398af9
commit https://github.com/vim/vim/commit/ca63501fbcd1cf9c8aa9ff12c093c95b62a89ed7
Christian Brabandt <cb@256bit.org>
parents:
7080
diff
changeset
|
7817 When 'textwidth' is zero, 'wrapmargin' may be used. See also |
7 | 7818 'formatoptions' and |ins-textwidth|. |
838 | 7819 When 'formatexpr' is set it will be used to break the line. |
7 | 7820 NOTE: This option is set to 0 when 'compatible' is set. |
7821 | |
7822 *'thesaurus'* *'tsr'* | |
7823 'thesaurus' 'tsr' string (default "") | |
7824 global or local to buffer |global-local| | |
7825 {not in Vi} | |
7826 List of file names, separated by commas, that are used to lookup words | |
10 | 7827 for thesaurus completion commands |i_CTRL-X_CTRL-T|. Each line in |
7 | 7828 the file should contain words with similar meaning, separated by |
7829 non-keyword characters (white space is preferred). Maximum line | |
7830 length is 510 bytes. | |
3496
d1e4abe8342c
Fixed compatible mode in most runtime files.
Bram Moolenaar <bram@vim.org>
parents:
3493
diff
changeset
|
7831 To obtain a file to be used here, check out this ftp site: |
8061
abd64cf67bcf
commit https://github.com/vim/vim/commit/38a55639d603823efcf2d2fdf542dbffdeb60b75
Christian Brabandt <cb@256bit.org>
parents:
7876
diff
changeset
|
7832 [Sorry this link doesn't work anymore, do you know the right one?] |
3496
d1e4abe8342c
Fixed compatible mode in most runtime files.
Bram Moolenaar <bram@vim.org>
parents:
3493
diff
changeset
|
7833 ftp://ftp.ox.ac.uk/pub/wordlists/ First get the README file. |
10 | 7834 To include a comma in a file name precede it with a backslash. Spaces |
7 | 7835 after a comma are ignored, otherwise spaces are included in the file |
7836 name. See |option-backslash| about using backslashes. | |
7837 The use of |:set+=| and |:set-=| is preferred when adding or removing | |
7838 directories from the list. This avoids problems when a future version | |
7839 uses another default. | |
7840 Backticks cannot be used in this option for security reasons. | |
7841 | |
7842 *'tildeop'* *'top'* *'notildeop'* *'notop'* | |
7843 'tildeop' 'top' boolean (default off) | |
7844 global | |
7845 {not in Vi} | |
7846 When on: The tilde command "~" behaves like an operator. | |
7847 NOTE: This option is reset when 'compatible' is set. | |
7848 | |
7849 *'timeout'* *'to'* *'notimeout'* *'noto'* | |
7850 'timeout' 'to' boolean (default on) | |
7851 global | |
7852 *'ttimeout'* *'nottimeout'* | |
11400
0f8713fe20dc
Updated runtime files.
Christian Brabandt <cb@256bit.org>
parents:
11262
diff
changeset
|
7853 'ttimeout' boolean (default off, set in |defaults.vim|) |
7 | 7854 global |
7855 {not in Vi} | |
7856 These two options together determine the behavior when part of a | |
7857 mapped key sequence or keyboard code has been received: | |
7858 | |
7859 'timeout' 'ttimeout' action ~ | |
7860 off off do not time out | |
7861 on on or off time out on :mappings and key codes | |
7862 off on time out on key codes | |
7863 | |
7864 If both options are off, Vim will wait until either the complete | |
7865 mapping or key sequence has been received, or it is clear that there | |
7866 is no mapping or key sequence for the received characters. For | |
7867 example: if you have mapped "vl" and Vim has received 'v', the next | |
7868 character is needed to see if the 'v' is followed by an 'l'. | |
7869 When one of the options is on, Vim will wait for about 1 second for | |
7870 the next character to arrive. After that the already received | |
7871 characters are interpreted as single characters. The waiting time can | |
7872 be changed with the 'timeoutlen' option. | |
7873 On slow terminals or very busy systems timing out may cause | |
7874 malfunctioning cursor keys. If both options are off, Vim waits | |
7875 forever after an entered <Esc> if there are key codes that start | |
7876 with <Esc>. You will have to type <Esc> twice. If you do not have | |
7877 problems with key codes, but would like to have :mapped key | |
7878 sequences not timing out in 1 second, set the 'ttimeout' option and | |
7879 reset the 'timeout' option. | |
7880 | |
7881 NOTE: 'ttimeout' is reset when 'compatible' is set. | |
7882 | |
7883 *'timeoutlen'* *'tm'* | |
7884 'timeoutlen' 'tm' number (default 1000) | |
7885 global | |
7886 {not in all versions of Vi} | |
7887 *'ttimeoutlen'* *'ttm'* | |
11400
0f8713fe20dc
Updated runtime files.
Christian Brabandt <cb@256bit.org>
parents:
11262
diff
changeset
|
7888 'ttimeoutlen' 'ttm' number (default -1, set to 100 in |defaults.vim|) |
7 | 7889 global |
7890 {not in Vi} | |
7891 The time in milliseconds that is waited for a key code or mapped key | |
7892 sequence to complete. Also used for CTRL-\ CTRL-N and CTRL-\ CTRL-G | |
7893 when part of a command has been typed. | |
7894 Normally only 'timeoutlen' is used and 'ttimeoutlen' is -1. When a | |
7895 different timeout value for key codes is desired set 'ttimeoutlen' to | |
7896 a non-negative number. | |
7897 | |
7898 ttimeoutlen mapping delay key code delay ~ | |
7899 < 0 'timeoutlen' 'timeoutlen' | |
7900 >= 0 'timeoutlen' 'ttimeoutlen' | |
7901 | |
7902 The timeout only happens when the 'timeout' and 'ttimeout' options | |
7903 tell so. A useful setting would be > | |
7904 :set timeout timeoutlen=3000 ttimeoutlen=100 | |
7905 < (time out on mapping after three seconds, time out on key codes after | |
7906 a tenth of a second). | |
7907 | |
7908 *'title'* *'notitle'* | |
7909 'title' boolean (default off, on when title can be restored) | |
7910 global | |
7911 {not in Vi} | |
7912 {not available when compiled without the |+title| | |
7913 feature} | |
7914 When on, the title of the window will be set to the value of | |
7915 'titlestring' (if it is not empty), or to: | |
7916 filename [+=-] (path) - VIM | |
7917 Where: | |
7918 filename the name of the file being edited | |
7919 - indicates the file cannot be modified, 'ma' off | |
7920 + indicates the file was modified | |
7921 = indicates the file is read-only | |
7922 =+ indicates the file is read-only and modified | |
7923 (path) is the path of the file being edited | |
7924 - VIM the server name |v:servername| or "VIM" | |
7925 Only works if the terminal supports setting window titles | |
7926 (currently Amiga console, Win32 console, all GUI versions and | |
7927 terminals with a non- empty 't_ts' option - these are Unix xterm and | |
7928 iris-ansi by default, where 't_ts' is taken from the builtin termcap). | |
7929 *X11* | |
7930 When Vim was compiled with HAVE_X11 defined, the original title will | |
7931 be restored if possible. The output of ":version" will include "+X11" | |
7932 when HAVE_X11 was defined, otherwise it will be "-X11". This also | |
7933 works for the icon name |'icon'|. | |
7934 But: When Vim was started with the |-X| argument, restoring the title | |
7935 will not work (except in the GUI). | |
7936 If the title cannot be restored, it is set to the value of 'titleold'. | |
7937 You might want to restore the title outside of Vim then. | |
7938 When using an xterm from a remote machine you can use this command: | |
7939 rsh machine_name xterm -display $DISPLAY & | |
7940 then the WINDOWID environment variable should be inherited and the | |
7941 title of the window should change back to what it should be after | |
7942 exiting Vim. | |
7943 | |
7944 *'titlelen'* | |
7945 'titlelen' number (default 85) | |
7946 global | |
7947 {not in Vi} | |
7948 {not available when compiled without the |+title| | |
7949 feature} | |
7950 Gives the percentage of 'columns' to use for the length of the window | |
10 | 7951 title. When the title is longer, only the end of the path name is |
7952 shown. A '<' character before the path name is used to indicate this. | |
7 | 7953 Using a percentage makes this adapt to the width of the window. But |
7954 it won't work perfectly, because the actual number of characters | |
7955 available also depends on the font used and other things in the title | |
7956 bar. When 'titlelen' is zero the full path is used. Otherwise, | |
7957 values from 1 to 30000 percent can be used. | |
7958 'titlelen' is also used for the 'titlestring' option. | |
7959 | |
7960 *'titleold'* | |
7961 'titleold' string (default "Thanks for flying Vim") | |
7962 global | |
7963 {not in Vi} | |
7964 {only available when compiled with the |+title| | |
7965 feature} | |
7966 This option will be used for the window title when exiting Vim if the | |
7967 original title cannot be restored. Only happens if 'title' is on or | |
7968 'titlestring' is not empty. | |
36 | 7969 This option cannot be set from a |modeline| or in the |sandbox|, for |
7970 security reasons. | |
7 | 7971 *'titlestring'* |
7972 'titlestring' string (default "") | |
7973 global | |
7974 {not in Vi} | |
7975 {not available when compiled without the |+title| | |
7976 feature} | |
7977 When this option is not empty, it will be used for the title of the | |
7978 window. This happens only when the 'title' option is on. | |
7979 Only works if the terminal supports setting window titles (currently | |
7980 Amiga console, Win32 console, all GUI versions and terminals with a | |
7981 non-empty 't_ts' option). | |
7982 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
|
7983 be restored if possible, see |X11|. |
7 | 7984 When this option contains printf-style '%' items, they will be |
7985 expanded according to the rules used for 'statusline'. | |
7986 Example: > | |
7987 :auto BufEnter * let &titlestring = hostname() . "/" . expand("%:p") | |
7988 :set title titlestring=%<%F%=%l/%L-%P titlelen=70 | |
7989 < The value of 'titlelen' is used to align items in the middle or right | |
7990 of the available space. | |
7991 Some people prefer to have the file name first: > | |
7992 :set titlestring=%t%(\ %M%)%(\ (%{expand(\"%:~:.:h\")})%)%(\ %a%) | |
7993 < Note the use of "%{ }" and an expression to get the path of the file, | |
10 | 7994 without the file name. The "%( %)" constructs are used to add a |
7 | 7995 separating space only when needed. |
7996 NOTE: Use of special characters in 'titlestring' may cause the display | |
7997 to be garbled (e.g., when it contains a CR or NL character). | |
7998 {not available when compiled without the |+statusline| feature} | |
7999 | |
8000 *'toolbar'* *'tb'* | |
8001 'toolbar' 'tb' string (default "icons,tooltips") | |
8002 global | |
8003 {only for |+GUI_GTK|, |+GUI_Athena|, |+GUI_Motif| and | |
8004 |+GUI_Photon|} | |
10 | 8005 The contents of this option controls various toolbar settings. The |
7 | 8006 possible values are: |
8007 icons Toolbar buttons are shown with icons. | |
8008 text Toolbar buttons shown with text. | |
8009 horiz Icon and text of a toolbar button are | |
10 | 8010 horizontally arranged. {only in GTK+ 2 GUI} |
7 | 8011 tooltips Tooltips are active for toolbar buttons. |
8012 Tooltips refer to the popup help text which appears after the mouse | |
8013 cursor is placed over a toolbar button for a brief moment. | |
8014 | |
8015 If you want the toolbar to be shown with icons as well as text, do the | |
8016 following: > | |
8017 :set tb=icons,text | |
8018 < Motif and Athena cannot display icons and text at the same time. They | |
8019 will show icons if both are requested. | |
8020 | |
8021 If none of the strings specified in 'toolbar' are valid or if | |
8022 'toolbar' is empty, this option is ignored. If you want to disable | |
8023 the toolbar, you need to set the 'guioptions' option. For example: > | |
8024 :set guioptions-=T | |
8025 < Also see |gui-toolbar|. | |
8026 | |
8027 *'toolbariconsize'* *'tbis'* | |
8028 'toolbariconsize' 'tbis' string (default "small") | |
8029 global | |
8030 {not in Vi} | |
10895
c391bfbdb452
Updated runtime files.
Christian Brabandt <cb@256bit.org>
parents:
10734
diff
changeset
|
8031 {only in the GTK+ GUI} |
7 | 8032 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
|
8033 tiny Use tiny icons. |
da01d5da2cfa
commit https://github.com/vim/vim/commit/77cdfd10382e01cc51f4ba1a9177032351843151
Christian Brabandt <cb@256bit.org>
parents:
8246
diff
changeset
|
8034 small Use small icons (default). |
da01d5da2cfa
commit https://github.com/vim/vim/commit/77cdfd10382e01cc51f4ba1a9177032351843151
Christian Brabandt <cb@256bit.org>
parents:
8246
diff
changeset
|
8035 medium Use medium-sized icons. |
da01d5da2cfa
commit https://github.com/vim/vim/commit/77cdfd10382e01cc51f4ba1a9177032351843151
Christian Brabandt <cb@256bit.org>
parents:
8246
diff
changeset
|
8036 large Use large icons. |
da01d5da2cfa
commit https://github.com/vim/vim/commit/77cdfd10382e01cc51f4ba1a9177032351843151
Christian Brabandt <cb@256bit.org>
parents:
8246
diff
changeset
|
8037 huge Use even larger icons. |
da01d5da2cfa
commit https://github.com/vim/vim/commit/77cdfd10382e01cc51f4ba1a9177032351843151
Christian Brabandt <cb@256bit.org>
parents:
8246
diff
changeset
|
8038 giant Use very big icons. |
7 | 8039 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
|
8040 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
|
8041 large=24x24, medium=24x24, small=20x20 and tiny=16x16. |
7 | 8042 |
8043 If 'toolbariconsize' is empty, the global default size as determined | |
8044 by user preferences or the current theme is used. | |
8045 | |
8046 *'ttybuiltin'* *'tbi'* *'nottybuiltin'* *'notbi'* | |
8047 'ttybuiltin' 'tbi' boolean (default on) | |
8048 global | |
8049 {not in Vi} | |
8050 When on, the builtin termcaps are searched before the external ones. | |
8051 When off the builtin termcaps are searched after the external ones. | |
8052 When this option is changed, you should set the 'term' option next for | |
8053 the change to take effect, for example: > | |
8054 :set notbi term=$TERM | |
8055 < See also |termcap|. | |
8056 Rationale: The default for this option is "on", because the builtin | |
8057 termcap entries are generally better (many systems contain faulty | |
8058 xterm entries...). | |
8059 | |
8060 *'ttyfast'* *'tf'* *'nottyfast'* *'notf'* | |
8061 'ttyfast' 'tf' boolean (default off, on when 'term' is xterm, hpterm, | |
8062 sun-cmd, screen, rxvt, dtterm or | |
8063 iris-ansi; also on when running Vim in | |
8064 a DOS console) | |
8065 global | |
8066 {not in Vi} | |
8067 Indicates a fast terminal connection. More characters will be sent to | |
8068 the screen for redrawing, instead of using insert/delete line | |
8069 commands. Improves smoothness of redrawing when there are multiple | |
8070 windows and the terminal does not support a scrolling region. | |
8071 Also enables the extra writing of characters at the end of each screen | |
8072 line for lines that wrap. This helps when using copy/paste with the | |
8073 mouse in an xterm and other terminals. | |
8074 | |
8075 *'ttymouse'* *'ttym'* | |
8076 'ttymouse' 'ttym' string (default depends on 'term') | |
8077 global | |
8078 {not in Vi} | |
8079 {only in Unix and VMS, doesn't work in the GUI; not | |
8080 available when compiled without |+mouse|} | |
8081 Name of the terminal type for which mouse codes are to be recognized. | |
1213 | 8082 Currently these strings are valid: |
7 | 8083 *xterm-mouse* |
8084 xterm xterm-like mouse handling. The mouse generates | |
8085 "<Esc>[Mscr", where "scr" is three bytes: | |
8086 "s" = button state | |
8087 "c" = column plus 33 | |
8088 "r" = row plus 33 | |
5908 | 8089 This only works up to 223 columns! See "dec", |
8090 "urxvt", and "sgr" for solutions. | |
7 | 8091 xterm2 Works like "xterm", but with the xterm reporting the |
8092 mouse position while the mouse is dragged. This works | |
8093 much faster and more precise. Your xterm must at | |
180 | 8094 least at patchlevel 88 / XFree 3.3.3 for this to |
7 | 8095 work. See below for how Vim detects this |
8096 automatically. | |
8097 *netterm-mouse* | |
8098 netterm NetTerm mouse handling. The mouse generates | |
8099 "<Esc>}r,c<CR>", where "r,c" are two decimal numbers | |
8100 for the row and column. | |
8101 *dec-mouse* | |
8102 dec DEC terminal mouse handling. The mouse generates a | |
8103 rather complex sequence, starting with "<Esc>[". | |
189 | 8104 This is also available for an Xterm, if it was |
8105 configured with "--enable-dec-locator". | |
7 | 8106 *jsbterm-mouse* |
8107 jsbterm JSB term mouse handling. | |
8108 *pterm-mouse* | |
8109 pterm QNX pterm mouse handling. | |
3224 | 8110 *urxvt-mouse* |
8111 urxvt Mouse handling for the urxvt (rxvt-unicode) terminal. | |
5908 | 8112 The mouse works only if the terminal supports this |
8113 encoding style, but it does not have 223 columns limit | |
8114 unlike "xterm" or "xterm2". | |
3750 | 8115 *sgr-mouse* |
8116 sgr Mouse handling for the terminal that emits SGR-styled | |
5908 | 8117 mouse reporting. The mouse works even in columns |
8118 beyond 223. This option is backward compatible with | |
8119 "xterm2" because it can also decode "xterm2" style | |
8120 mouse codes. | |
7 | 8121 |
8122 The mouse handling must be enabled at compile time |+mouse_xterm| | |
5908 | 8123 |+mouse_dec| |+mouse_netterm| |+mouse_jsbterm| |+mouse_urxvt| |
8124 |+mouse_sgr|. | |
7 | 8125 Only "xterm"(2) is really recognized. NetTerm mouse codes are always |
8126 recognized, if enabled at compile time. DEC terminal mouse codes | |
8127 are recognized if enabled at compile time, and 'ttymouse' is not | |
5908 | 8128 "xterm", "xterm2", "urxvt" or "sgr" (because dec mouse codes conflict |
8129 with them). | |
7 | 8130 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
|
8131 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
|
8132 "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
|
8133 already. |
5908 | 8134 Additionally, if vim is compiled with the |+termresponse| feature and |
8135 |t_RV| is set to the escape sequence to request the xterm version | |
8136 number, more intelligent detection process runs. | |
7 | 8137 The "xterm2" value will be set if the xterm version is reported to be |
5908 | 8138 from 95 to 276. The "sgr" value will be set if the xterm version is |
8139 277 or highter. | |
8140 If you do not want 'ttymouse' to be set to "xterm2" or "sgr" | |
8141 automatically, set t_RV to an empty string: > | |
7 | 8142 :set t_RV= |
8143 < | |
8144 *'ttyscroll'* *'tsl'* | |
8145 'ttyscroll' 'tsl' number (default 999) | |
8146 global | |
8147 Maximum number of lines to scroll the screen. If there are more lines | |
8148 to scroll the window is redrawn. For terminals where scrolling is | |
8149 very slow and redrawing is not slow this can be set to a small number, | |
8150 e.g., 3, to speed up displaying. | |
8151 | |
8152 *'ttytype'* *'tty'* | |
8153 'ttytype' 'tty' string (default from $TERM) | |
8154 global | |
8155 Alias for 'term', see above. | |
8156 | |
2214
f8222d1f9a73
Included patch for persistent undo. Lots of changes and added test.
Bram Moolenaar <bram@vim.org>
parents:
2209
diff
changeset
|
8157 *'undodir'* *'udir'* |
f8222d1f9a73
Included patch for persistent undo. Lots of changes and added test.
Bram Moolenaar <bram@vim.org>
parents:
2209
diff
changeset
|
8158 '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
|
8159 global |
f8222d1f9a73
Included patch for persistent undo. Lots of changes and added test.
Bram Moolenaar <bram@vim.org>
parents:
2209
diff
changeset
|
8160 {not in Vi} |
2570
71b56b4e7785
Make the references to features in the help more consistent. (Sylvain Hitier)
Bram Moolenaar <bram@vim.org>
parents:
2561
diff
changeset
|
8161 {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
|
8162 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
|
8163 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
|
8164 "." 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
|
8165 "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
|
8166 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
|
8167 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
|
8168 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
|
8169 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
|
8170 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
|
8171 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
|
8172 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
|
8173 See |undo-persistence|. |
f8222d1f9a73
Included patch for persistent undo. Lots of changes and added test.
Bram Moolenaar <bram@vim.org>
parents:
2209
diff
changeset
|
8174 |
4681
2eb30f341e8d
Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents:
4502
diff
changeset
|
8175 *'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
|
8176 '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
|
8177 local to buffer |
f8222d1f9a73
Included patch for persistent undo. Lots of changes and added test.
Bram Moolenaar <bram@vim.org>
parents:
2209
diff
changeset
|
8178 {not in Vi} |
2570
71b56b4e7785
Make the references to features in the help more consistent. (Sylvain Hitier)
Bram Moolenaar <bram@vim.org>
parents:
2561
diff
changeset
|
8179 {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
|
8180 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
|
8181 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
|
8182 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
|
8183 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
|
8184 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
|
8185 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
|
8186 before a reload to be saved for undo. |
3920 | 8187 When 'undofile' is turned off the undo file is NOT deleted. |
11160 | 8188 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
|
8189 |
7 | 8190 *'undolevels'* *'ul'* |
8191 'undolevels' 'ul' number (default 100, 1000 for Unix, VMS, | |
8192 Win32 and OS/2) | |
5446 | 8193 global or local to buffer |global-local| |
7 | 8194 {not in Vi} |
8195 Maximum number of changes that can be undone. Since undo information | |
8196 is kept in memory, higher numbers will cause more memory to be used | |
8197 (nevertheless, a single change can use an unlimited amount of memory). | |
8198 Set to 0 for Vi compatibility: One level of undo and "u" undoes | |
8199 itself: > | |
8200 set ul=0 | |
8201 < But you can also get Vi compatibility by including the 'u' flag in | |
8202 '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
|
8203 Also see |undo-two-ways|. |
5446 | 8204 Set to -1 for no undo at all. You might want to do this only for the |
8205 current buffer: > | |
8206 setlocal ul=-1 | |
7 | 8207 < This helps when you run out of memory for a single change. |
6336 | 8208 |
8209 The local value is set to -123456 when the global value is to be used. | |
8210 | |
2249
6d3d35ff2c2b
Use full path in undofile(). Updated docs.
Bram Moolenaar <bram@vim.org>
parents:
2240
diff
changeset
|
8211 Also see |clear-undo|. |
7 | 8212 |
2394
a3aca345aafa
Add the 'undoreload' option to be able to undo a file reload.
Bram Moolenaar <bram@vim.org>
parents:
2382
diff
changeset
|
8213 *'undoreload'* *'ur'* |
a3aca345aafa
Add the 'undoreload' option to be able to undo a file reload.
Bram Moolenaar <bram@vim.org>
parents:
2382
diff
changeset
|
8214 '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
|
8215 global |
a3aca345aafa
Add the 'undoreload' option to be able to undo a file reload.
Bram Moolenaar <bram@vim.org>
parents:
2382
diff
changeset
|
8216 {not in Vi} |
a3aca345aafa
Add the 'undoreload' option to be able to undo a file reload.
Bram Moolenaar <bram@vim.org>
parents:
2382
diff
changeset
|
8217 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
|
8218 ":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
|
8219 Vim. |FileChangedShell| |
a3aca345aafa
Add the 'undoreload' option to be able to undo a file reload.
Bram Moolenaar <bram@vim.org>
parents:
2382
diff
changeset
|
8220 The save only happens when this options is negative or when the number |
a3aca345aafa
Add the 'undoreload' option to be able to undo a file reload.
Bram Moolenaar <bram@vim.org>
parents:
2382
diff
changeset
|
8221 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
|
8222 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
|
8223 |
a3aca345aafa
Add the 'undoreload' option to be able to undo a file reload.
Bram Moolenaar <bram@vim.org>
parents:
2382
diff
changeset
|
8224 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
|
8225 |
a3aca345aafa
Add the 'undoreload' option to be able to undo a file reload.
Bram Moolenaar <bram@vim.org>
parents:
2382
diff
changeset
|
8226 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
|
8227 this option to a lower value if you run out of memory. |
7 | 8228 |
8229 *'updatecount'* *'uc'* | |
8230 'updatecount' 'uc' number (default: 200) | |
8231 global | |
8232 {not in Vi} | |
8233 After typing this many characters the swap file will be written to | |
8234 disk. When zero, no swap file will be created at all (see chapter on | |
8235 recovery |crash-recovery|). 'updatecount' is set to zero by starting | |
8236 Vim with the "-n" option, see |startup|. When editing in readonly | |
8237 mode this option will be initialized to 10000. | |
8238 The swapfile can be disabled per buffer with |'swapfile'|. | |
8239 When 'updatecount' is set from zero to non-zero, swap files are | |
8240 created for all buffers that have 'swapfile' set. When 'updatecount' | |
8241 is set to zero, existing swap files are not deleted. | |
8242 Also see |'swapsync'|. | |
8243 This option has no meaning in buffers where |'buftype'| is "nofile" | |
8244 or "nowrite". | |
8245 | |
8246 *'updatetime'* *'ut'* | |
8247 'updatetime' 'ut' number (default 4000) | |
8248 global | |
8249 {not in Vi} | |
8250 If this many milliseconds nothing is typed the swap file will be | |
8251 written to disk (see |crash-recovery|). Also used for the | |
8252 |CursorHold| autocommand event. | |
8253 | |
8254 *'verbose'* *'vbs'* | |
8255 'verbose' 'vbs' number (default 0) | |
8256 global | |
8257 {not in Vi, although some versions have a boolean | |
8258 verbose option} | |
8259 When bigger than zero, Vim will give messages about what it is doing. | |
8260 Currently, these messages are given: | |
8261 >= 1 When the viminfo file is read or written. | |
8262 >= 2 When a file is ":source"'ed. | |
712 | 8263 >= 5 Every searched tags file and include file. |
7 | 8264 >= 8 Files for which a group of autocommands is executed. |
8265 >= 9 Every executed autocommand. | |
8266 >= 12 Every executed function. | |
8267 >= 13 When an exception is thrown, caught, finished, or discarded. | |
8268 >= 14 Anything pending in a ":finally" clause. | |
8269 >= 15 Every executed Ex command (truncated at 200 characters). | |
8270 | |
8271 This option can also be set with the "-V" argument. See |-V|. | |
8272 This option is also set by the |:verbose| command. | |
8273 | |
293 | 8274 When the 'verbosefile' option is set then the verbose messages are not |
8275 displayed. | |
8276 | |
8277 *'verbosefile'* *'vfile'* | |
8278 'verbosefile' 'vfile' string (default empty) | |
8279 global | |
8280 {not in Vi} | |
8281 When not empty all messages are written in a file with this name. | |
8282 When the file exists messages are appended. | |
8283 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
|
8284 empty. Writes are buffered, thus may not show up for some time. |
293 | 8285 Setting 'verbosefile' to a new value is like making it empty first. |
8286 The difference with |:redir| is that verbose messages are not | |
8287 displayed when 'verbosefile' is set. | |
8288 | |
7 | 8289 *'viewdir'* *'vdir'* |
8290 'viewdir' 'vdir' string (default for Amiga, MS-DOS, OS/2 and Win32: | |
8291 "$VIM/vimfiles/view", | |
8292 for Unix: "~/.vim/view", | |
8293 for Macintosh: "$VIM:vimfiles:view" | |
8294 for VMS: "sys$login:vimfiles/view" | |
8295 for RiscOS: "Choices:vimfiles/view") | |
8296 global | |
8297 {not in Vi} | |
2570
71b56b4e7785
Make the references to features in the help more consistent. (Sylvain Hitier)
Bram Moolenaar <bram@vim.org>
parents:
2561
diff
changeset
|
8298 {not available when compiled without the |+mksession| |
7 | 8299 feature} |
8300 Name of the directory where to store files for |:mkview|. | |
8301 This option cannot be set from a |modeline| or in the |sandbox|, for | |
8302 security reasons. | |
8303 | |
8304 *'viewoptions'* *'vop'* | |
8305 'viewoptions' 'vop' string (default: "folds,options,cursor") | |
8306 global | |
8307 {not in Vi} | |
2570
71b56b4e7785
Make the references to features in the help more consistent. (Sylvain Hitier)
Bram Moolenaar <bram@vim.org>
parents:
2561
diff
changeset
|
8308 {not available when compiled without the |+mksession| |
7 | 8309 feature} |
8310 Changes the effect of the |:mkview| command. It is a comma separated | |
10 | 8311 list of words. Each word enables saving and restoring something: |
7 | 8312 word save and restore ~ |
8313 cursor cursor position in file and in window | |
8314 folds manually created folds, opened/closed folds and local | |
8315 fold options | |
8316 options options and mappings local to a window or buffer (not | |
8317 global values for local options) | |
6213 | 8318 localoptions same as "options" |
7 | 8319 slash backslashes in file names replaced with forward |
8320 slashes | |
8321 unix with Unix end-of-line format (single <NL>), even when | |
8322 on Windows or DOS | |
8323 | |
8324 "slash" and "unix" are useful on Windows when sharing view files | |
8325 with Unix. The Unix version of Vim cannot source dos format scripts, | |
8326 but the Windows version of Vim can source unix format scripts. | |
8327 | |
8328 *'viminfo'* *'vi'* *E526* *E527* *E528* | |
8329 'viminfo' 'vi' string (Vi default: "", Vim default for MS-DOS, | |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
8330 Windows and OS/2: '100,<50,s10,h,rA:,rB:, |
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
8331 for Amiga: '100,<50,s10,h,rdf0:,rdf1:,rdf2: |
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
8332 for others: '100,<50,s10,h) |
7 | 8333 global |
8334 {not in Vi} | |
2570
71b56b4e7785
Make the references to features in the help more consistent. (Sylvain Hitier)
Bram Moolenaar <bram@vim.org>
parents:
2561
diff
changeset
|
8335 {not available when compiled without the |+viminfo| |
7 | 8336 feature} |
8337 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
|
8338 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
|
8339 "NONE". |
5cd9ba96561d
patch 8.0.0716: not easy to start Vim cleanly
Christian Brabandt <cb@256bit.org>
parents:
11659
diff
changeset
|
8340 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
|
8341 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
|
8342 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
|
8343 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
|
8344 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
|
8345 identifying characters and the effect of their value. |
7 | 8346 CHAR VALUE ~ |
3224 | 8347 *viminfo-!* |
7 | 8348 ! When included, save and restore global variables that start |
8349 with an uppercase letter, and don't contain a lowercase | |
8350 letter. Thus "KEEPTHIS and "K_L_M" are stored, but "KeepThis" | |
2607 | 8351 and "_K_L_M" are not. Nested List and Dict items may not be |
2642 | 8352 read back correctly, you end up with an empty item. |
3224 | 8353 *viminfo-quote* |
7 | 8354 " Maximum number of lines saved for each register. Old name of |
8355 the '<' item, with the disadvantage that you need to put a | |
8356 backslash before the ", otherwise it will be recognized as the | |
8357 start of a comment! | |
3224 | 8358 *viminfo-%* |
7 | 8359 % When included, save and restore the buffer list. If Vim is |
8360 started with a file name argument, the buffer list is not | |
8361 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
|
8362 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
|
8363 ('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
|
8364 removable media (|viminfo-r|) are not saved. |
23 | 8365 When followed by a number, the number specifies the maximum |
8366 number of buffers that are stored. Without a number all | |
8367 buffers are stored. | |
3224 | 8368 *viminfo-'* |
7 | 8369 ' Maximum number of previously edited files for which the marks |
8370 are remembered. This parameter must always be included when | |
8371 'viminfo' is non-empty. | |
8372 Including this item also means that the |jumplist| and the | |
8373 |changelist| are stored in the viminfo file. | |
3224 | 8374 *viminfo-/* |
7 | 8375 / Maximum number of items in the search pattern history to be |
10 | 8376 saved. If non-zero, then the previous search and substitute |
7 | 8377 patterns are also saved. When not included, the value of |
8378 'history' is used. | |
3224 | 8379 *viminfo-:* |
7 | 8380 : Maximum number of items in the command-line history to be |
10 | 8381 saved. When not included, the value of 'history' is used. |
3224 | 8382 *viminfo-<* |
7 | 8383 < Maximum number of lines saved for each register. If zero then |
8384 registers are not saved. When not included, all lines are | |
8385 saved. '"' is the old name for this item. | |
8386 Also see the 's' item below: limit specified in Kbyte. | |
3224 | 8387 *viminfo-@* |
7 | 8388 @ Maximum number of items in the input-line history to be |
10 | 8389 saved. When not included, the value of 'history' is used. |
3224 | 8390 *viminfo-c* |
7 | 8391 c When included, convert the text in the viminfo file from the |
8392 'encoding' used when writing the file to the current | |
233 | 8393 'encoding'. See |viminfo-encoding|. |
3224 | 8394 *viminfo-f* |
7 | 8395 f Whether file marks need to be stored. If zero, file marks ('0 |
8396 to '9, 'A to 'Z) are not stored. When not present or when | |
10 | 8397 non-zero, they are all stored. '0 is used for the current |
7 | 8398 cursor position (when exiting or when doing ":wviminfo"). |
3224 | 8399 *viminfo-h* |
7 | 8400 h Disable the effect of 'hlsearch' when loading the viminfo |
8401 file. When not included, it depends on whether ":nohlsearch" | |
8402 has been used since the last search command. | |
3224 | 8403 *viminfo-n* |
7 | 8404 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
|
8405 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
|
8406 '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
|
8407 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
|
8408 expanded when opening the file, not when setting the option. |
3224 | 8409 *viminfo-r* |
7 | 8410 r Removable media. The argument is a string (up to the next |
8411 ','). This parameter can be given several times. Each | |
8412 specifies the start of a path for which no marks will be | |
8413 stored. This is to avoid removable media. For MS-DOS you | |
8414 could use "ra:,rb:", for Amiga "rdf0:,rdf1:,rdf2:". You can | |
8415 also use it for temp files, e.g., for Unix: "r/tmp". Case is | |
8416 ignored. Maximum length of each 'r' argument is 50 | |
8417 characters. | |
3224 | 8418 *viminfo-s* |
7 | 8419 s Maximum size of an item in Kbyte. If zero then registers are |
8420 not saved. Currently only applies to registers. The default | |
8421 "s10" will exclude registers with more than 10 Kbyte of text. | |
8422 Also see the '<' item above: line count limit. | |
8423 | |
8424 Example: > | |
8425 :set viminfo='50,<1000,s100,:0,n~/vim/viminfo | |
8426 < | |
8427 '50 Marks will be remembered for the last 50 files you | |
8428 edited. | |
8429 <1000 Contents of registers (up to 1000 lines each) will be | |
8430 remembered. | |
8431 s100 Registers with more than 100 Kbyte text are skipped. | |
8432 :0 Command-line history will not be saved. | |
8433 n~/vim/viminfo The name of the file to use is "~/vim/viminfo". | |
8434 no / Since '/' is not specified, the default will be used, | |
8435 that is, save all of the search history, and also the | |
8436 previous search and substitute patterns. | |
8437 no % The buffer list will not be saved nor read back. | |
8438 no h 'hlsearch' highlighting will be restored. | |
8439 | |
8440 When setting 'viminfo' from an empty value you can use |:rviminfo| to | |
8441 load the contents of the file, this is not done automatically. | |
8442 | |
8443 This option cannot be set from a |modeline| or in the |sandbox|, for | |
8444 security reasons. | |
11160 | 8445 NOTE: This option is set to the Vim default value when 'compatible' |
8446 is reset. | |
7 | 8447 |
11666
5cd9ba96561d
patch 8.0.0716: not easy to start Vim cleanly
Christian Brabandt <cb@256bit.org>
parents:
11659
diff
changeset
|
8448 *'viminfofile'* *'vif'* |
5cd9ba96561d
patch 8.0.0716: not easy to start Vim cleanly
Christian Brabandt <cb@256bit.org>
parents:
11659
diff
changeset
|
8449 'viminfofile' 'vif' string (default: "") |
5cd9ba96561d
patch 8.0.0716: not easy to start Vim cleanly
Christian Brabandt <cb@256bit.org>
parents:
11659
diff
changeset
|
8450 global |
5cd9ba96561d
patch 8.0.0716: not easy to start Vim cleanly
Christian Brabandt <cb@256bit.org>
parents:
11659
diff
changeset
|
8451 {not in Vi} |
5cd9ba96561d
patch 8.0.0716: not easy to start Vim cleanly
Christian Brabandt <cb@256bit.org>
parents:
11659
diff
changeset
|
8452 {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
|
8453 feature} |
5cd9ba96561d
patch 8.0.0716: not easy to start Vim cleanly
Christian Brabandt <cb@256bit.org>
parents:
11659
diff
changeset
|
8454 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
|
8455 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
|
8456 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
|
8457 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
|
8458 |
7 | 8459 *'virtualedit'* *'ve'* |
8460 'virtualedit' 've' string (default "") | |
8461 global | |
8462 {not in Vi} | |
8463 {not available when compiled without the | |
8464 |+virtualedit| feature} | |
8465 A comma separated list of these words: | |
8466 block Allow virtual editing in Visual block mode. | |
8467 insert Allow virtual editing in Insert mode. | |
8468 all Allow virtual editing in all modes. | |
772 | 8469 onemore Allow the cursor to move just past the end of the line |
782 | 8470 |
7 | 8471 Virtual editing means that the cursor can be positioned where there is |
1263 | 8472 no actual character. This can be halfway into a tab or beyond the end |
7 | 8473 of the line. Useful for selecting a rectangle in Visual mode and |
8474 editing a table. | |
772 | 8475 "onemore" is not the same, it will only allow moving the cursor just |
8476 after the last character of the line. This makes some commands more | |
8477 consistent. Previously the cursor was always past the end of the line | |
8478 if the line was empty. But it is far from Vi compatible. It may also | |
782 | 8479 break some plugins or Vim scripts. For example because |l| can move |
8480 the cursor after the last character. Use with care! | |
5220 | 8481 Using the `$` command will move to the last character in the line, not |
782 | 8482 past it. This may actually move the cursor to the left! |
5220 | 8483 The `g$` command will move to the end of the screen line. |
772 | 8484 It doesn't make sense to combine "all" with "onemore", but you will |
8485 not get a warning for it. | |
11160 | 8486 NOTE: This option is set to "" when 'compatible' is set. |
7 | 8487 |
8488 *'visualbell'* *'vb'* *'novisualbell'* *'novb'* *beep* | |
8489 'visualbell' 'vb' boolean (default off) | |
8490 global | |
8491 {not in Vi} | |
11659
49c12c93abf3
Updated runtime files and translations.
Christian Brabandt <cb@256bit.org>
parents:
11529
diff
changeset
|
8492 Use a visual bell instead of beeping. The terminal code to display the |
7 | 8493 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
|
8494 use: > |
49c12c93abf3
Updated runtime files and translations.
Christian Brabandt <cb@256bit.org>
parents:
11529
diff
changeset
|
8495 :set vb t_vb= |
49c12c93abf3
Updated runtime files and translations.
Christian Brabandt <cb@256bit.org>
parents:
11529
diff
changeset
|
8496 < 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
|
8497 :set vb t_vb=[?5h$<100>[?5l |
49c12c93abf3
Updated runtime files and translations.
Christian Brabandt <cb@256bit.org>
parents:
11529
diff
changeset
|
8498 < 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
|
8499 to get a shorter or longer flash. |
49c12c93abf3
Updated runtime files and translations.
Christian Brabandt <cb@256bit.org>
parents:
11529
diff
changeset
|
8500 |
49c12c93abf3
Updated runtime files and translations.
Christian Brabandt <cb@256bit.org>
parents:
11529
diff
changeset
|
8501 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
|
8502 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
|
8503 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
|
8504 set. |
49c12c93abf3
Updated runtime files and translations.
Christian Brabandt <cb@256bit.org>
parents:
11529
diff
changeset
|
8505 |
7 | 8506 In the GUI, 't_vb' defaults to "<Esc>|f", which inverts the display |
8507 for 20 msec. If you want to use a different time, use "<Esc>|40f", | |
8508 where 40 is the time in msec. | |
11659
49c12c93abf3
Updated runtime files and translations.
Christian Brabandt <cb@256bit.org>
parents:
11529
diff
changeset
|
8509 |
49c12c93abf3
Updated runtime files and translations.
Christian Brabandt <cb@256bit.org>
parents:
11529
diff
changeset
|
8510 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
|
8511 might want to set it again in your |gvimrc|. |
49c12c93abf3
Updated runtime files and translations.
Christian Brabandt <cb@256bit.org>
parents:
11529
diff
changeset
|
8512 |
7 | 8513 Does not work on the Amiga, you always get a screen flash. |
8514 Also see 'errorbells'. | |
8515 | |
8516 *'warn'* *'nowarn'* | |
8517 'warn' boolean (default on) | |
8518 global | |
8519 Give a warning message when a shell command is used while the buffer | |
8520 has been changed. | |
8521 | |
8522 *'weirdinvert'* *'wiv'* *'noweirdinvert'* *'nowiv'* | |
8523 'weirdinvert' 'wiv' boolean (default off) | |
8524 global | |
8525 {not in Vi} | |
667 | 8526 This option has the same effect as the 't_xs' terminal option. |
7 | 8527 It is provided for backwards compatibility with version 4.x. |
8528 Setting 'weirdinvert' has the effect of making 't_xs' non-empty, and | |
8529 vice versa. Has no effect when the GUI is running. | |
8530 | |
8531 *'whichwrap'* *'ww'* | |
8532 'whichwrap' 'ww' string (Vim default: "b,s", Vi default: "") | |
8533 global | |
8534 {not in Vi} | |
8535 Allow specified keys that move the cursor left/right to move to the | |
8536 previous/next line when the cursor is on the first/last character in | |
8537 the line. Concatenate characters to allow this for these keys: | |
8538 char key mode ~ | |
8539 b <BS> Normal and Visual | |
8540 s <Space> Normal and Visual | |
712 | 8541 h "h" Normal and Visual (not recommended) |
8542 l "l" Normal and Visual (not recommended) | |
7 | 8543 < <Left> Normal and Visual |
8544 > <Right> Normal and Visual | |
8545 ~ "~" Normal | |
8546 [ <Left> Insert and Replace | |
8547 ] <Right> Insert and Replace | |
8548 For example: > | |
8549 :set ww=<,>,[,] | |
8550 < allows wrap only when cursor keys are used. | |
8551 When the movement keys are used in combination with a delete or change | |
8552 operator, the <EOL> also counts for a character. This makes "3h" | |
8553 different from "3dh" when the cursor crosses the end of a line. This | |
8554 is also true for "x" and "X", because they do the same as "dl" and | |
8555 "dh". If you use this, you may also want to use the mapping | |
8556 ":map <BS> X" to make backspace delete the character in front of the | |
8557 cursor. | |
714 | 8558 When 'l' is included and it is used after an operator at the end of a |
8559 line then it will not move to the next line. This makes "dl", "cl", | |
8560 "yl" etc. work normally. | |
7 | 8561 NOTE: This option is set to the Vi default value when 'compatible' is |
8562 set and to the Vim default value when 'compatible' is reset. | |
8563 | |
8564 *'wildchar'* *'wc'* | |
8565 'wildchar' 'wc' number (Vim default: <Tab>, Vi default: CTRL-E) | |
8566 global | |
8567 {not in Vi} | |
8568 Character you have to type to start wildcard expansion in the | |
8569 command-line, as specified with 'wildmode'. | |
1621 | 8570 More info here: |cmdline-completion|. |
7 | 8571 The character is not recognized when used inside a macro. See |
8572 'wildcharm' for that. | |
8573 Although 'wc' is a number option, you can set it to a special key: > | |
8574 :set wc=<Esc> | |
8575 < NOTE: This option is set to the Vi default value when 'compatible' is | |
8576 set and to the Vim default value when 'compatible' is reset. | |
8577 | |
8578 *'wildcharm'* *'wcm'* | |
8579 'wildcharm' 'wcm' number (default: none (0)) | |
8580 global | |
8581 {not in Vi} | |
8582 'wildcharm' works exactly like 'wildchar', except that it is | |
233 | 8583 recognized when used inside a macro. You can find "spare" command-line |
8584 keys suitable for this option by looking at |ex-edit-index|. Normally | |
7 | 8585 you'll never actually type 'wildcharm', just use it in mappings that |
8586 automatically invoke completion mode, e.g.: > | |
8587 :set wcm=<C-Z> | |
1621 | 8588 :cnoremap ss so $vim/sessions/*.vim<C-Z> |
7 | 8589 < Then after typing :ss you can use CTRL-P & CTRL-N. |
8590 | |
8591 *'wildignore'* *'wig'* | |
8592 'wildignore' 'wig' string (default "") | |
8593 global | |
8594 {not in Vi} | |
8595 {not available when compiled without the |+wildignore| | |
8596 feature} | |
8597 A list of file patterns. A file that matches with one of these | |
3682 | 8598 patterns is ignored when expanding |wildcards|, completing file or |
8599 directory names, and influences the result of |expand()|, |glob()| and | |
8600 |globpath()| unless a flag is passed to disable this. | |
7 | 8601 The pattern is used like with |:autocmd|, see |autocmd-patterns|. |
8602 Also see 'suffixes'. | |
8603 Example: > | |
8604 :set wildignore=*.o,*.obj | |
8605 < The use of |:set+=| and |:set-=| is preferred when adding or removing | |
8606 a pattern from the list. This avoids problems when a future version | |
8607 uses another default. | |
8608 | |
2652 | 8609 |
2662 | 8610 *'wildignorecase'* *'wic'* *'nowildignorecase'* *'nowic'* |
2652 | 8611 'wildignorecase' 'wic' boolean (default off) |
8612 global | |
8613 {not in Vi} | |
8614 When set case is ignored when completing file names and directories. | |
4242 | 8615 Has no effect when 'fileignorecase' is set. |
2652 | 8616 Does not apply when the shell is used to expand wildcards, which |
8617 happens when there are special characters. | |
8618 | |
8619 | |
7 | 8620 *'wildmenu'* *'wmnu'* *'nowildmenu'* *'nowmnu'* |
9669
284b4eb307fc
commit https://github.com/vim/vim/commit/8c08b5b569e2a9e9f63dea514591ecfa2d3bb392
Christian Brabandt <cb@256bit.org>
parents:
9665
diff
changeset
|
8621 'wildmenu' 'wmnu' boolean (default off, set in |defaults.vim|) |
7 | 8622 global |
8623 {not in Vi} | |
8624 {not available if compiled without the |+wildmenu| | |
8625 feature} | |
8626 When 'wildmenu' is on, command-line completion operates in an enhanced | |
8627 mode. On pressing 'wildchar' (usually <Tab>) to invoke completion, | |
8628 the possible matches are shown just above the command line, with the | |
8629 first match highlighted (overwriting the status line, if there is | |
8630 one). Keys that show the previous/next match, such as <Tab> or | |
8631 CTRL-P/CTRL-N, cause the highlight to move to the appropriate match. | |
8632 When 'wildmode' is used, "wildmenu" mode is used where "full" is | |
8633 specified. "longest" and "list" do not start "wildmenu" mode. | |
4159 | 8634 You can check the current mode with |wildmenumode()|. |
7 | 8635 If there are more matches than can fit in the line, a ">" is shown on |
8636 the right and/or a "<" is shown on the left. The status line scrolls | |
8637 as needed. | |
8638 The "wildmenu" mode is abandoned when a key is hit that is not used | |
8639 for selecting a completion. | |
8640 While the "wildmenu" is active the following keys have special | |
8641 meanings: | |
8642 | |
8643 <Left> <Right> - select previous/next match (like CTRL-P/CTRL-N) | |
8644 <Down> - in filename/menu name completion: move into a | |
8645 subdirectory or submenu. | |
8646 <CR> - in menu completion, when the cursor is just after a | |
8647 dot: move into a submenu. | |
8648 <Up> - in filename/menu name completion: move up into | |
8649 parent directory or parent menu. | |
8650 | |
8651 This makes the menus accessible from the console |console-menus|. | |
8652 | |
8653 If you prefer the <Left> and <Right> keys to move the cursor instead | |
8654 of selecting a different match, use this: > | |
8655 :cnoremap <Left> <Space><BS><Left> | |
8656 :cnoremap <Right> <Space><BS><Right> | |
8657 < | |
8658 The "WildMenu" highlighting is used for displaying the current match | |
8659 |hl-WildMenu|. | |
8660 | |
8661 *'wildmode'* *'wim'* | |
8662 'wildmode' 'wim' string (Vim default: "full") | |
8663 global | |
8664 {not in Vi} | |
8665 Completion mode that is used for the character specified with | |
10 | 8666 'wildchar'. It is a comma separated list of up to four parts. Each |
1152 | 8667 part specifies what to do for each consecutive use of 'wildchar'. The |
7 | 8668 first part specifies the behavior for the first use of 'wildchar', |
8669 The second part for the second use, etc. | |
8670 These are the possible values for each part: | |
8671 "" Complete only the first match. | |
8672 "full" Complete the next full match. After the last match, | |
8673 the original string is used and then the first match | |
8674 again. | |
8675 "longest" Complete till longest common string. If this doesn't | |
8676 result in a longer string, use the next part. | |
8677 "longest:full" Like "longest", but also start 'wildmenu' if it is | |
8678 enabled. | |
8679 "list" When more than one match, list all matches. | |
8680 "list:full" When more than one match, list all matches and | |
8681 complete first match. | |
8682 "list:longest" When more than one match, list all matches and | |
8683 complete till longest common string. | |
8684 When there is only a single match, it is fully completed in all cases. | |
8685 | |
8686 Examples: > | |
8687 :set wildmode=full | |
233 | 8688 < Complete first full match, next match, etc. (the default) > |
7 | 8689 :set wildmode=longest,full |
8690 < Complete longest common string, then each full match > | |
8691 :set wildmode=list:full | |
8692 < List all matches and complete each full match > | |
8693 :set wildmode=list,full | |
8694 < List all matches without completing, then each full match > | |
8695 :set wildmode=longest,list | |
8696 < Complete longest common string, then list alternatives. | |
1621 | 8697 More info here: |cmdline-completion|. |
7 | 8698 |
40 | 8699 *'wildoptions'* *'wop'* |
8700 'wildoptions' 'wop' string (default "") | |
8701 global | |
8702 {not in Vi} | |
8703 {not available when compiled without the |+wildignore| | |
8704 feature} | |
8705 A list of words that change how command line completion is done. | |
8706 Currently only one word is allowed: | |
8707 tagfile When using CTRL-D to list matching tags, the kind of | |
856 | 8708 tag and the file of the tag is listed. Only one match |
40 | 8709 is displayed per line. Often used tag kinds are: |
8710 d #define | |
8711 f function | |
8712 Also see |cmdline-completion|. | |
8713 | |
7 | 8714 *'winaltkeys'* *'wak'* |
8715 'winaltkeys' 'wak' string (default "menu") | |
8716 global | |
8717 {not in Vi} | |
8718 {only used in Win32, Motif, GTK and Photon GUI} | |
8719 Some GUI versions allow the access to menu entries by using the ALT | |
8720 key in combination with a character that appears underlined in the | |
8721 menu. This conflicts with the use of the ALT key for mappings and | |
8722 entering special characters. This option tells what to do: | |
8723 no Don't use ALT keys for menus. ALT key combinations can be | |
8724 mapped, but there is no automatic handling. This can then be | |
8725 done with the |:simalt| command. | |
8726 yes ALT key handling is done by the windowing system. ALT key | |
8727 combinations cannot be mapped. | |
8728 menu Using ALT in combination with a character that is a menu | |
10 | 8729 shortcut key, will be handled by the windowing system. Other |
7 | 8730 keys can be mapped. |
8731 If the menu is disabled by excluding 'm' from 'guioptions', the ALT | |
8732 key is never used for the menu. | |
36 | 8733 This option is not used for <F10>; on Win32 and with GTK <F10> will |
8734 select the menu, unless it has been mapped. | |
7 | 8735 |
164 | 8736 *'window'* *'wi'* |
8737 'window' 'wi' number (default screen height - 1) | |
8738 global | |
8739 Window height. Do not confuse this with the height of the Vim window, | |
8740 use 'lines' for that. | |
179 | 8741 Used for |CTRL-F| and |CTRL-B| when there is only one window and the |
8742 value is smaller than 'lines' minus one. The screen will scroll | |
8743 'window' minus two lines, with a minimum of one. | |
164 | 8744 When 'window' is equal to 'lines' minus one CTRL-F and CTRL-B scroll |
8745 in a much smarter way, taking care of wrapping lines. | |
8746 When resizing the Vim window, the value is smaller than 1 or more than | |
8747 or equal to 'lines' it will be set to 'lines' minus 1. | |
8748 {Vi also uses the option to specify the number of displayed lines} | |
8749 | |
7 | 8750 *'winheight'* *'wh'* *E591* |
8751 'winheight' 'wh' number (default 1) | |
8752 global | |
8753 {not in Vi} | |
2570
71b56b4e7785
Make the references to features in the help more consistent. (Sylvain Hitier)
Bram Moolenaar <bram@vim.org>
parents:
2561
diff
changeset
|
8754 {not available when compiled without the |+windows| |
7 | 8755 feature} |
8756 Minimal number of lines for the current window. This is not a hard | |
10 | 8757 minimum, Vim will use fewer lines if there is not enough room. If the |
1621 | 8758 focus goes to a window that is smaller, its size is increased, at the |
8759 cost of the height of other windows. | |
8760 Set 'winheight' to a small number for normal editing. | |
8761 Set it to 999 to make the current window fill most of the screen. | |
8762 Other windows will be only 'winminheight' high. This has the drawback | |
8763 that ":all" will create only two windows. To avoid "vim -o 1 2 3 4" | |
8764 to create only two windows, set the option after startup is done, | |
8765 using the |VimEnter| event: > | |
8766 au VimEnter * set winheight=999 | |
8767 < Minimum value is 1. | |
8768 The height is not adjusted after one of the commands that change the | |
7 | 8769 height of the current window. |
8770 'winheight' applies to the current window. Use 'winminheight' to set | |
8771 the minimal height for other windows. | |
8772 | |
8773 *'winfixheight'* *'wfh'* *'nowinfixheight'* *'nowfh'* | |
8774 'winfixheight' 'wfh' boolean (default off) | |
8775 local to window | |
8776 {not in Vi} | |
2570
71b56b4e7785
Make the references to features in the help more consistent. (Sylvain Hitier)
Bram Moolenaar <bram@vim.org>
parents:
2561
diff
changeset
|
8777 {not available when compiled without the |+windows| |
7 | 8778 feature} |
8779 Keep the window height when windows are opened or closed and | |
1152 | 8780 'equalalways' is set. Also for |CTRL-W_=|. Set by default for the |
8781 |preview-window| and |quickfix-window|. | |
7 | 8782 The height may be changed anyway when running out of room. |
8783 | |
782 | 8784 *'winfixwidth'* *'wfw'* *'nowinfixwidth'* *'nowfw'* |
8785 'winfixwidth' 'wfw' boolean (default off) | |
8786 local to window | |
8787 {not in Vi} | |
2570
71b56b4e7785
Make the references to features in the help more consistent. (Sylvain Hitier)
Bram Moolenaar <bram@vim.org>
parents:
2561
diff
changeset
|
8788 {not available when compiled without the |+windows| |
782 | 8789 feature} |
8790 Keep the window width when windows are opened or closed and | |
1152 | 8791 'equalalways' is set. Also for |CTRL-W_=|. |
782 | 8792 The width may be changed anyway when running out of room. |
8793 | |
7 | 8794 *'winminheight'* *'wmh'* |
8795 'winminheight' 'wmh' number (default 1) | |
8796 global | |
8797 {not in Vi} | |
2570
71b56b4e7785
Make the references to features in the help more consistent. (Sylvain Hitier)
Bram Moolenaar <bram@vim.org>
parents:
2561
diff
changeset
|
8798 {not available when compiled without the |+windows| |
7 | 8799 feature} |
8800 The minimal height of a window, when it's not the current window. | |
8801 This is a hard minimum, windows will never become smaller. | |
8802 When set to zero, windows may be "squashed" to zero lines (i.e. just a | |
8803 status bar) if necessary. They will return to at least one line when | |
8804 they become active (since the cursor has to have somewhere to go.) | |
8805 Use 'winheight' to set the minimal height of the current window. | |
8806 This option is only checked when making a window smaller. Don't use a | |
8807 large number, it will cause errors when opening more than a few | |
8808 windows. A value of 0 to 3 is reasonable. | |
8809 | |
8810 *'winminwidth'* *'wmw'* | |
8811 'winminwidth' 'wmw' number (default 1) | |
8812 global | |
8813 {not in Vi} | |
2570
71b56b4e7785
Make the references to features in the help more consistent. (Sylvain Hitier)
Bram Moolenaar <bram@vim.org>
parents:
2561
diff
changeset
|
8814 {not available when compiled without the |+vertsplit| |
7 | 8815 feature} |
8816 The minimal width of a window, when it's not the current window. | |
8817 This is a hard minimum, windows will never become smaller. | |
8818 When set to zero, windows may be "squashed" to zero columns (i.e. just | |
8819 a vertical separator) if necessary. They will return to at least one | |
8820 line when they become active (since the cursor has to have somewhere | |
8821 to go.) | |
8822 Use 'winwidth' to set the minimal width of the current window. | |
8823 This option is only checked when making a window smaller. Don't use a | |
8824 large number, it will cause errors when opening more than a few | |
8825 windows. A value of 0 to 12 is reasonable. | |
8826 | |
12138
bee3751f3d4e
patch 8.0.0949: winpty.dll name is fixed
Christian Brabandt <cb@256bit.org>
parents:
11914
diff
changeset
|
8827 *'winptydll'* |
bee3751f3d4e
patch 8.0.0949: winpty.dll name is fixed
Christian Brabandt <cb@256bit.org>
parents:
11914
diff
changeset
|
8828 '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
|
8829 global |
bee3751f3d4e
patch 8.0.0949: winpty.dll name is fixed
Christian Brabandt <cb@256bit.org>
parents:
11914
diff
changeset
|
8830 {not in Vi} |
bee3751f3d4e
patch 8.0.0949: winpty.dll name is fixed
Christian Brabandt <cb@256bit.org>
parents:
11914
diff
changeset
|
8831 {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
|
8832 feature on MS-Windows} |
bee3751f3d4e
patch 8.0.0949: winpty.dll name is fixed
Christian Brabandt <cb@256bit.org>
parents:
11914
diff
changeset
|
8833 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
|
8834 |:terminal| command. The default depends on whether was build as a |
12254 | 8835 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
|
8836 a fallback. |
bee3751f3d4e
patch 8.0.0949: winpty.dll name is fixed
Christian Brabandt <cb@256bit.org>
parents:
11914
diff
changeset
|
8837 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
|
8838 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
|
8839 security reasons. |
bee3751f3d4e
patch 8.0.0949: winpty.dll name is fixed
Christian Brabandt <cb@256bit.org>
parents:
11914
diff
changeset
|
8840 |
7 | 8841 *'winwidth'* *'wiw'* *E592* |
8842 'winwidth' 'wiw' number (default 20) | |
8843 global | |
8844 {not in Vi} | |
2570
71b56b4e7785
Make the references to features in the help more consistent. (Sylvain Hitier)
Bram Moolenaar <bram@vim.org>
parents:
2561
diff
changeset
|
8845 {not available when compiled without the |+vertsplit| |
7 | 8846 feature} |
8847 Minimal number of columns for the current window. This is not a hard | |
8848 minimum, Vim will use fewer columns if there is not enough room. If | |
8849 the current window is smaller, its size is increased, at the cost of | |
8850 the width of other windows. Set it to 999 to make the current window | |
8851 always fill the screen. Set it to a small number for normal editing. | |
8852 The width is not adjusted after one of the commands to change the | |
8853 width of the current window. | |
8854 'winwidth' applies to the current window. Use 'winminwidth' to set | |
8855 the minimal width for other windows. | |
8856 | |
8857 *'wrap'* *'nowrap'* | |
8858 'wrap' boolean (default on) | |
8859 local to window | |
8860 {not in Vi} | |
8861 This option changes how text is displayed. It doesn't change the text | |
8862 in the buffer, see 'textwidth' for that. | |
8863 When on, lines longer than the width of the window will wrap and | |
10 | 8864 displaying continues on the next line. When off lines will not wrap |
8865 and only part of long lines will be displayed. When the cursor is | |
7 | 8866 moved to a part that is not shown, the screen will scroll |
8867 horizontally. | |
8868 The line will be broken in the middle of a word if necessary. See | |
8869 'linebreak' to get the break at a word boundary. | |
8870 To make scrolling horizontally a bit more useful, try this: > | |
8871 :set sidescroll=5 | |
8872 :set listchars+=precedes:<,extends:> | |
8873 < See 'sidescroll', 'listchars' and |wrap-off|. | |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
8874 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
|
8875 on. |
7 | 8876 |
8877 *'wrapmargin'* *'wm'* | |
8878 'wrapmargin' 'wm' number (default 0) | |
8879 local to buffer | |
8880 Number of characters from the right window border where wrapping | |
8881 starts. When typing text beyond this limit, an <EOL> will be inserted | |
8882 and inserting continues on the next line. | |
8883 Options that add a margin, such as 'number' and 'foldcolumn', cause | |
8884 the text width to be further reduced. This is Vi compatible. | |
8885 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
|
8886 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
|
8887 is reset. |
7 | 8888 See also 'formatoptions' and |ins-textwidth|. {Vi: works differently |
8889 and less usefully} | |
8890 | |
8891 *'wrapscan'* *'ws'* *'nowrapscan'* *'nows'* | |
8892 'wrapscan' 'ws' boolean (default on) *E384* *E385* | |
8893 global | |
500 | 8894 Searches wrap around the end of the file. Also applies to |]s| and |
8895 |[s|, searching for spelling mistakes. | |
7 | 8896 |
8897 *'write'* *'nowrite'* | |
8898 'write' boolean (default on) | |
8899 global | |
8900 {not in Vi} | |
8901 Allows writing files. When not set, writing a file is not allowed. | |
8902 Can be used for a view-only mode, where modifications to the text are | |
10 | 8903 still allowed. Can be reset with the |-m| or |-M| command line |
7 | 8904 argument. Filtering text is still possible, even though this requires |
8905 writing a temporary file. | |
8906 | |
8907 *'writeany'* *'wa'* *'nowriteany'* *'nowa'* | |
8908 'writeany' 'wa' boolean (default off) | |
8909 global | |
8910 Allows writing to any file with no need for "!" override. | |
8911 | |
8912 *'writebackup'* *'wb'* *'nowritebackup'* *'nowb'* | |
8913 'writebackup' 'wb' boolean (default on with |+writebackup| feature, off | |
8914 otherwise) | |
8915 global | |
8916 {not in Vi} | |
8917 Make a backup before overwriting a file. The backup is removed after | |
8918 the file was successfully written, unless the 'backup' option is | |
3513 | 8919 also on. |
8920 WARNING: Switching this option off means that when Vim fails to write | |
8921 your buffer correctly and then, for whatever reason, Vim exits, you | |
8922 lose both the original file and what you were writing. Only reset | |
8923 this option if your file system is almost full and it makes the write | |
8924 fail (and make sure not to exit Vim until the write was successful). | |
8925 See |backup-table| for another explanation. | |
7 | 8926 When the 'backupskip' pattern matches, a backup is not made anyway. |
8927 NOTE: This option is set to the default value when 'compatible' is | |
8928 set. | |
8929 | |
8930 *'writedelay'* *'wd'* | |
8931 'writedelay' 'wd' number (default 0) | |
8932 global | |
8933 {not in Vi} | |
9344
33c1b85d408c
commit https://github.com/vim/vim/commit/802a0d902fca423acb15f835d7b09183883d79a0
Christian Brabandt <cb@256bit.org>
parents:
9286
diff
changeset
|
8934 The number of milliseconds to wait for each character sent to the |
7 | 8935 screen. When non-zero, characters are sent to the terminal one by |
8936 one. For MS-DOS pcterm this does not work. For debugging purposes. | |
8937 | |
8938 vim:tw=78:ts=8:ft=help:norl: |