Mercurial > vim
annotate runtime/doc/options.txt @ 25978:40b17deb294f v8.2.3522
patch 8.2.3522: cannot use x and u when setting 'listchars'
Commit: https://github.com/vim/vim/commit/93ff6720fe4427341bc426b6d46e6324f226c270
Author: Bram Moolenaar <Bram@vim.org>
Date: Sat Oct 16 17:51:40 2021 +0100
patch 8.2.3522: cannot use \x and \u when setting 'listchars'
Problem: Cannot use \x and \u when setting 'listchars'.
Solution: Support hex and unicode in hex form. (closes https://github.com/vim/vim/issues/9006)
author | Bram Moolenaar <Bram@vim.org> |
---|---|
date | Sat, 16 Oct 2021 19:00:03 +0200 |
parents | 416237f1de22 |
children | aade8ef975d5 |
rev | line source |
---|---|
25836 | 1 *options.txt* For Vim version 8.2. Last change: 2021 Sep 21 |
7 | 2 |
3 | |
4 VIM REFERENCE MANUAL by Bram Moolenaar | |
5 | |
6 | |
7 Options *options* | |
8 | |
9 1. Setting options |set-option| | |
10 2. Automatically setting options |auto-setting| | |
11 3. Options summary |option-summary| | |
12 | |
10244
876fbdd84e52
commit https://github.com/vim/vim/commit/2ec618c9feac4573b154510236ad8121c77d0eca
Christian Brabandt <cb@256bit.org>
parents:
10218
diff
changeset
|
13 For an overview of options see quickref.txt |option-list|. |
7 | 14 |
15 Vim has a number of internal variables and switches which can be set to | |
16 achieve special effects. These options come in three forms: | |
17 boolean can only be on or off *boolean* *toggle* | |
18 number has a numeric value | |
19 string has a string value | |
20 | |
21 ============================================================================== | |
523 | 22 1. Setting options *set-option* *E764* |
7 | 23 |
24 *:se* *:set* | |
19137
69f0e9b5c107
patch 8.2.0128: cannot list options one per line
Bram Moolenaar <Bram@vim.org>
parents:
19116
diff
changeset
|
25 :se[t][!] Show all options that differ from their default value. |
69f0e9b5c107
patch 8.2.0128: cannot list options one per line
Bram Moolenaar <Bram@vim.org>
parents:
19116
diff
changeset
|
26 When [!] is present every option is on a separate |
69f0e9b5c107
patch 8.2.0128: cannot list options one per line
Bram Moolenaar <Bram@vim.org>
parents:
19116
diff
changeset
|
27 line. |
69f0e9b5c107
patch 8.2.0128: cannot list options one per line
Bram Moolenaar <Bram@vim.org>
parents:
19116
diff
changeset
|
28 |
69f0e9b5c107
patch 8.2.0128: cannot list options one per line
Bram Moolenaar <Bram@vim.org>
parents:
19116
diff
changeset
|
29 :se[t][!] all Show all but terminal options. |
69f0e9b5c107
patch 8.2.0128: cannot list options one per line
Bram Moolenaar <Bram@vim.org>
parents:
19116
diff
changeset
|
30 When [!] is present every option is on a separate |
69f0e9b5c107
patch 8.2.0128: cannot list options one per line
Bram Moolenaar <Bram@vim.org>
parents:
19116
diff
changeset
|
31 line. |
7 | 32 |
33 :se[t] termcap Show all terminal options. Note that in the GUI the | |
34 key codes are not shown, because they are generated | |
35 internally and can't be changed. Changing the terminal | |
36 codes in the GUI is not useful either... | |
37 | |
38 *E518* *E519* | |
39 :se[t] {option}? Show value of {option}. | |
40 | |
41 :se[t] {option} Toggle option: set, switch it on. | |
42 Number option: show value. | |
43 String option: show value. | |
44 | |
45 :se[t] no{option} Toggle option: Reset, switch it off. | |
46 | |
2152 | 47 *:set-!* *:set-inv* |
7 | 48 :se[t] {option}! or |
16443
32a543152dc0
patch 8.1.1226: {not in Vi} remarks get in the way of useful help text
Bram Moolenaar <Bram@vim.org>
parents:
16439
diff
changeset
|
49 :se[t] inv{option} Toggle option: Invert value. |
7 | 50 |
51 *:set-default* *:set-&* *:set-&vi* *:set-&vim* | |
52 :se[t] {option}& Reset option to its default value. May depend on the | |
16443
32a543152dc0
patch 8.1.1226: {not in Vi} remarks get in the way of useful help text
Bram Moolenaar <Bram@vim.org>
parents:
16439
diff
changeset
|
53 current value of 'compatible'. |
32a543152dc0
patch 8.1.1226: {not in Vi} remarks get in the way of useful help text
Bram Moolenaar <Bram@vim.org>
parents:
16439
diff
changeset
|
54 :se[t] {option}&vi Reset option to its Vi default value. |
32a543152dc0
patch 8.1.1226: {not in Vi} remarks get in the way of useful help text
Bram Moolenaar <Bram@vim.org>
parents:
16439
diff
changeset
|
55 :se[t] {option}&vim Reset option to its Vim default value. |
7 | 56 |
13341
acd7eaa13d2b
Updated runtime files.
Christian Brabandt <cb@256bit.org>
parents:
13314
diff
changeset
|
57 :se[t] all& Set all options to their default value. The values of |
7051
eff26a8620ce
commit https://github.com/vim/vim/commit/88774fdd23f08355297bb8cda78856859051d3c7
Christian Brabandt <cb@256bit.org>
parents:
6949
diff
changeset
|
58 these options are not changed: |
eff26a8620ce
commit https://github.com/vim/vim/commit/88774fdd23f08355297bb8cda78856859051d3c7
Christian Brabandt <cb@256bit.org>
parents:
6949
diff
changeset
|
59 all terminal options, starting with t_ |
eff26a8620ce
commit https://github.com/vim/vim/commit/88774fdd23f08355297bb8cda78856859051d3c7
Christian Brabandt <cb@256bit.org>
parents:
6949
diff
changeset
|
60 'columns' |
eff26a8620ce
commit https://github.com/vim/vim/commit/88774fdd23f08355297bb8cda78856859051d3c7
Christian Brabandt <cb@256bit.org>
parents:
6949
diff
changeset
|
61 'cryptmethod' |
eff26a8620ce
commit https://github.com/vim/vim/commit/88774fdd23f08355297bb8cda78856859051d3c7
Christian Brabandt <cb@256bit.org>
parents:
6949
diff
changeset
|
62 'encoding' |
eff26a8620ce
commit https://github.com/vim/vim/commit/88774fdd23f08355297bb8cda78856859051d3c7
Christian Brabandt <cb@256bit.org>
parents:
6949
diff
changeset
|
63 'key' |
eff26a8620ce
commit https://github.com/vim/vim/commit/88774fdd23f08355297bb8cda78856859051d3c7
Christian Brabandt <cb@256bit.org>
parents:
6949
diff
changeset
|
64 'lines' |
eff26a8620ce
commit https://github.com/vim/vim/commit/88774fdd23f08355297bb8cda78856859051d3c7
Christian Brabandt <cb@256bit.org>
parents:
6949
diff
changeset
|
65 'term' |
eff26a8620ce
commit https://github.com/vim/vim/commit/88774fdd23f08355297bb8cda78856859051d3c7
Christian Brabandt <cb@256bit.org>
parents:
6949
diff
changeset
|
66 'ttymouse' |
eff26a8620ce
commit https://github.com/vim/vim/commit/88774fdd23f08355297bb8cda78856859051d3c7
Christian Brabandt <cb@256bit.org>
parents:
6949
diff
changeset
|
67 'ttytype' |
eff26a8620ce
commit https://github.com/vim/vim/commit/88774fdd23f08355297bb8cda78856859051d3c7
Christian Brabandt <cb@256bit.org>
parents:
6949
diff
changeset
|
68 Warning: This may have a lot of side effects. |
7 | 69 |
70 *:set-args* *E487* *E521* | |
71 :se[t] {option}={value} or | |
72 :se[t] {option}:{value} | |
73 Set string or number option to {value}. | |
74 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
|
75 hex (preceded with 0x) or octal (preceded with '0'). |
7 | 76 The old value can be inserted by typing 'wildchar' (by |
77 default this is a <Tab> or CTRL-E if 'compatible' is | |
78 set). See |cmdline-completion|. | |
79 White space between {option} and '=' is allowed and | |
80 will be ignored. White space between '=' and {value} | |
81 is not allowed. | |
82 See |option-backslash| for using white space and | |
83 backslashes in {value}. | |
84 | |
85 :se[t] {option}+={value} *:set+=* | |
86 Add the {value} to a number option, or append the | |
87 {value} to a string option. When the option is a | |
88 comma separated list, a comma is added, unless the | |
89 value was empty. | |
90 If the option is a list of flags, superfluous flags | |
557 | 91 are removed. When adding a flag that was already |
92 present the option value doesn't change. | |
809 | 93 Also see |:set-args| above. |
7 | 94 |
95 :se[t] {option}^={value} *:set^=* | |
96 Multiply the {value} to a number option, or prepend | |
97 the {value} to a string option. When the option is a | |
98 comma separated list, a comma is added, unless the | |
99 value was empty. | |
100 Also see |:set-args| above. | |
101 | |
102 :se[t] {option}-={value} *:set-=* | |
103 Subtract the {value} from a number option, or remove | |
104 the {value} from a string option, if it is there. | |
105 If the {value} is not found in a string option, there | |
106 is no error or warning. When the option is a comma | |
107 separated list, a comma is deleted, unless the option | |
108 becomes empty. | |
109 When the option is a list of flags, {value} must be | |
110 exactly as they appear in the option. Remove flags | |
111 one by one to avoid problems. | |
112 Also see |:set-args| above. | |
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? | |
14864 | 123 < shiftwidth=4 ~ |
124 Last set from modeline line 1 ~ | |
125 cindent ~ | |
126 Last set from /usr/local/share/vim/vim60/ftplugin/c.vim line 30 ~ | |
1621 | 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: |
14864 | 135 Last set from modeline line 1 ~ |
1621 | 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 | |
25700 | 198 Similarly, in legacy script the double quote character starts a comment. To |
199 include the '"' in the option value, use '\"' instead. This example sets the | |
200 'titlestring' option to 'hi "there"': > | |
642 | 201 :set titlestring=hi\ \"there\" |
202 | |
25700 | 203 In |Vim9| script it's simpler, comments start with a '#' character, and only |
204 when preceded by white space. A backslash is needed less often: > | |
205 vim9script | |
206 set titlestring=hi\ "there" | |
207 set titlestring=hi#there# | |
208 set titlestring=hi\ \#there# | |
209 | |
18972 | 210 For Win32 backslashes in file names are mostly not removed. More precise: For |
211 options that expect a file name (those where environment variables are | |
212 expanded) a backslash before a normal file name character is not removed. But | |
213 a backslash before a special character (space, backslash, comma, etc.) is used | |
214 like explained above. | |
7 | 215 There is one special situation, when the value starts with "\\": > |
216 :set dir=\\machine\path results in "\\machine\path" | |
217 :set dir=\\\\machine\\path results in "\\machine\path" | |
218 :set dir=\\path\\file results in "\\path\file" (wrong!) | |
219 For the first one the start is kept, but for the second one the backslashes | |
220 are halved. This makes sure it works both when you expect backslashes to be | |
10 | 221 halved and when you expect the backslashes to be kept. The third gives a |
7 | 222 result which is probably not what you want. Avoid it. |
223 | |
224 *add-option-flags* *remove-option-flags* | |
225 *E539* *E550* *E551* *E552* | |
226 Some options are a list of flags. When you want to add a flag to such an | |
227 option, without changing the existing ones, you can do it like this: > | |
228 :set guioptions+=a | |
229 Remove a flag from an option like this: > | |
230 :set guioptions-=a | |
231 This removes the 'a' flag from 'guioptions'. | |
10 | 232 Note that you should add or remove one flag at a time. If 'guioptions' has |
7 | 233 the value "ab", using "set guioptions-=ba" won't work, because the string "ba" |
234 doesn't appear. | |
235 | |
236 *:set_env* *expand-env* *expand-environment-var* | |
22 | 237 Environment variables in specific string options will be expanded. If the |
7 | 238 environment variable exists the '$' and the following environment variable |
239 name is replaced with its value. If it does not exist the '$' and the name | |
240 are not modified. Any non-id character (not a letter, digit or '_') may | |
241 follow the environment variable name. That character and what follows is | |
242 appended to the value of the environment variable. Examples: > | |
243 :set term=$TERM.new | |
244 :set path=/usr/$INCLUDE,$HOME/include,. | |
245 When adding or removing a string from an option with ":set opt-=val" or ":set | |
246 opt+=val" the expansion is done before the adding or removing. | |
247 | |
248 | |
249 Handling of local options *local-options* | |
250 | |
251 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
|
252 has its own copy of this option, thus each can have its own value. This |
7 | 253 allows you to set 'list' in one window but not in another. And set |
254 'shiftwidth' to 3 in one buffer and 4 in another. | |
255 | |
256 The following explains what happens to these local options in specific | |
257 situations. You don't really need to know all of this, since Vim mostly uses | |
258 the option values you would expect. Unfortunately, doing what the user | |
259 expects is a bit complicated... | |
260 | |
261 When splitting a window, the local options are copied to the new window. Thus | |
262 right after the split the contents of the two windows look the same. | |
263 | |
264 When editing a new buffer, its local option values must be initialized. Since | |
265 the local options of the current buffer might be specifically for that buffer, | |
266 these are not used. Instead, for each buffer-local option there also is a | |
267 global value, which is used for new buffers. With ":set" both the local and | |
268 global value is changed. With "setlocal" only the local value is changed, | |
269 thus this value is not used when editing a new buffer. | |
270 | |
9852
4eea48b76d03
commit https://github.com/vim/vim/commit/95ec9d6a6ab3117d60ff638670a803d43974ba51
Christian Brabandt <cb@256bit.org>
parents:
9737
diff
changeset
|
271 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
|
272 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
|
273 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
|
274 last closed window where the buffer was edited last are used. |
7 | 275 |
276 It's possible to set a local window option specifically for a type of buffer. | |
277 When you edit another buffer in the same window, you don't want to keep | |
278 using these local window options. Therefore Vim keeps a global value of the | |
279 local window options, which is used when editing another buffer. Each window | |
280 has its own copy of these values. Thus these are local to the window, but | |
281 global to all buffers in the window. With this you can do: > | |
282 :e one | |
283 :set list | |
284 :e two | |
285 Now the 'list' option will also be set in "two", since with the ":set list" | |
286 command you have also set the global value. > | |
287 :set nolist | |
288 :e one | |
289 :setlocal list | |
290 :e two | |
291 Now the 'list' option is not set, because ":set nolist" resets the global | |
292 value, ":setlocal list" only changes the local value and ":e two" gets the | |
293 global value. Note that if you do this next: > | |
294 :e one | |
4358 | 295 You will get back the 'list' value as it was the last time you edited "one". |
296 The options local to a window are remembered for each buffer. This also | |
297 happens when the buffer is not loaded, but they are lost when the buffer is | |
298 wiped out |:bwipe|. | |
7 | 299 |
300 *:setl* *:setlocal* | |
19137
69f0e9b5c107
patch 8.2.0128: cannot list options one per line
Bram Moolenaar <Bram@vim.org>
parents:
19116
diff
changeset
|
301 :setl[ocal][!] ... Like ":set" but set only the value local to the |
7 | 302 current buffer or window. Not all options have a |
303 local value. If the option does not have a local | |
304 value the global value is set. | |
2413 | 305 With the "all" argument: display local values for all |
306 local options. | |
307 Without argument: Display local values for all local | |
308 options which are different from the default. | |
7 | 309 When displaying a specific local option, show the |
1621 | 310 local value. For a global/local boolean option, when |
311 the global value is being used, "--" is displayed | |
312 before the option name. | |
313 For a global option the global value is | |
7 | 314 shown (but that might change in the future). |
315 | |
809 | 316 :setl[ocal] {option}< Set the local value of {option} to its global value by |
317 copying the value. | |
318 | |
3281 | 319 :se[t] {option}< For |global-local| options: Remove the local value of |
320 {option}, so that the global value will be used. | |
7 | 321 |
322 *:setg* *:setglobal* | |
19137
69f0e9b5c107
patch 8.2.0128: cannot list options one per line
Bram Moolenaar <Bram@vim.org>
parents:
19116
diff
changeset
|
323 :setg[lobal][!] ... Like ":set" but set only the global value for a local |
7 | 324 option without changing the local value. |
325 When displaying an option, the global value is shown. | |
2413 | 326 With the "all" argument: display global values for all |
327 local options. | |
328 Without argument: display global values for all local | |
329 options which are different from the default. | |
7 | 330 |
331 For buffer-local and window-local options: | |
332 Command global value local value ~ | |
333 :set option=value set set | |
334 :setlocal option=value - set | |
335 :setglobal option=value set - | |
336 :set option? - display | |
337 :setlocal option? - display | |
338 :setglobal option? display - | |
339 | |
340 | |
341 Global options with a local value *global-local* | |
342 | |
40 | 343 Options are global when you mostly use one value for all buffers and windows. |
344 For some global options it's useful to sometimes have a different local value. | |
345 You can set the local value with ":setlocal". That buffer or window will then | |
346 use the local value, while other buffers and windows continue using the global | |
347 value. | |
7 | 348 |
349 For example, you have two windows, both on C source code. They use the global | |
350 'makeprg' option. If you do this in one of the two windows: > | |
351 :set makeprg=gmake | |
352 then the other window will switch to the same value. There is no need to set | |
353 the 'makeprg' option in the other C source window too. | |
354 However, if you start editing a Perl file in a new window, you want to use | |
1152 | 355 another 'makeprg' for it, without changing the value used for the C source |
10 | 356 files. You use this command: > |
7 | 357 :setlocal makeprg=perlmake |
358 You can switch back to using the global value by making the local value empty: > | |
359 :setlocal makeprg= | |
15729 | 360 This only works for a string option. For a number or boolean option you need |
361 to use the "<" flag, like this: > | |
7 | 362 :setlocal autoread< |
15729 | 363 Note that for non-boolean and non-number options using "<" copies the global |
364 value to the local value, it doesn't switch back to using the global value | |
365 (that matters when the global value changes later). You can also use: > | |
809 | 366 :set path< |
367 This will make the local value of 'path' empty, so that the global value is | |
368 used. Thus it does the same as: > | |
369 :setlocal path= | |
7 | 370 Note: In the future more global options can be made global-local. Using |
371 ":setlocal" on a global option might work differently then. | |
372 | |
373 | |
374 Setting the filetype | |
375 | |
11473 | 376 :setf[iletype] [FALLBACK] {filetype} *:setf* *:setfiletype* |
7 | 377 Set the 'filetype' option to {filetype}, but only if |
378 not done yet in a sequence of (nested) autocommands. | |
379 This is short for: > | |
380 :if !did_filetype() | |
381 : setlocal filetype={filetype} | |
382 :endif | |
383 < This command is used in a filetype.vim file to avoid | |
384 setting the 'filetype' option twice, causing different | |
385 settings and syntax files to be loaded. | |
11473 | 386 |
387 When the optional FALLBACK argument is present, a | |
388 later :setfiletype command will override the | |
16023 | 389 'filetype'. This is to be used for filetype |
390 detections that are just a guess. |did_filetype()| | |
391 will return false after this command. | |
11473 | 392 |
2698
b6471224d2af
Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents:
2681
diff
changeset
|
393 *option-window* *optwin* |
7 | 394 :bro[wse] se[t] *:set-browse* *:browse-set* *:opt* *:options* |
395 :opt[ions] Open a window for viewing and setting all options. | |
396 Options are grouped by function. | |
397 Offers short help for each option. Hit <CR> on the | |
398 short help to open a help window with more help for | |
399 the option. | |
400 Modify the value of the option and hit <CR> on the | |
401 "set" line to set the new value. For window and | |
402 buffer specific options, the last accessed window is | |
403 used to set the option value in, unless this is a help | |
404 window, in which case the window below help window is | |
405 used (skipping the option-window). | |
13437 | 406 {not available when compiled without the |+eval| |
407 feature} | |
7 | 408 |
409 *$HOME* | |
410 Using "~" is like using "$HOME", but it is only recognized at the start of an | |
411 option and after a space or comma. | |
412 | |
413 On Unix systems "~user" can be used too. It is replaced by the home directory | |
414 of user "user". Example: > | |
415 :set path=~mool/include,/usr/include,. | |
416 | |
417 On Unix systems the form "${HOME}" can be used too. The name between {} can | |
418 contain non-id characters then. Note that if you want to use this for the | |
419 "gf" command, you need to add the '{' and '}' characters to 'isfname'. | |
420 | |
12254 | 421 NOTE: expanding environment variables and "~/" is only done with the ":set" |
422 command, not when assigning a value to an option with ":let". | |
423 | |
424 *$HOME-windows* | |
3224 | 425 On MS-Windows, if $HOME is not defined as an environment variable, then |
426 at runtime Vim will set it to the expansion of $HOMEDRIVE$HOMEPATH. | |
12499 | 427 If $HOMEDRIVE is not set then $USERPROFILE is used. |
428 | |
429 This expanded value is not exported to the environment, this matters when | |
430 running an external command: > | |
431 :echo system('set | findstr ^HOME=') | |
432 and > | |
433 :echo luaeval('os.getenv("HOME")') | |
434 should echo nothing (an empty string) despite exists('$HOME') being true. | |
435 When setting $HOME to a non-empty string it will be exported to the | |
436 subprocesses. | |
3224 | 437 |
7 | 438 |
439 Note the maximum length of an expanded option is limited. How much depends on | |
440 the system, mostly it is something like 256 or 1024 characters. | |
441 | |
442 *:fix* *:fixdel* | |
443 :fix[del] Set the value of 't_kD': | |
444 't_kb' is 't_kD' becomes ~ | |
445 CTRL-? CTRL-H | |
446 not CTRL-? CTRL-? | |
447 | |
23573 | 448 (CTRL-? is 0o177 octal, 0x7f hex) |
7 | 449 |
450 If your delete key terminal code is wrong, but the | |
451 code for backspace is alright, you can put this in | |
452 your .vimrc: > | |
453 :fixdel | |
454 < This works no matter what the actual code for | |
455 backspace is. | |
456 | |
457 If the backspace key terminal code is wrong you can | |
458 use this: > | |
459 :if &term == "termname" | |
460 : set t_kb=^V<BS> | |
461 : fixdel | |
462 :endif | |
463 < Where "^V" is CTRL-V and "<BS>" is the backspace key | |
10 | 464 (don't type four characters!). Replace "termname" |
7 | 465 with your terminal name. |
466 | |
467 If your <Delete> key sends a strange key sequence (not | |
468 CTRL-? or CTRL-H) you cannot use ":fixdel". Then use: > | |
469 :if &term == "termname" | |
470 : set t_kD=^V<Delete> | |
471 :endif | |
472 < Where "^V" is CTRL-V and "<Delete>" is the delete key | |
473 (don't type eight characters!). Replace "termname" | |
474 with your terminal name. | |
475 | |
476 *Linux-backspace* | |
477 Note about Linux: By default the backspace key | |
478 produces CTRL-?, which is wrong. You can fix it by | |
479 putting this line in your rc.local: > | |
480 echo "keycode 14 = BackSpace" | loadkeys | |
481 < | |
482 *NetBSD-backspace* | |
483 Note about NetBSD: If your backspace doesn't produce | |
484 the right code, try this: > | |
485 xmodmap -e "keycode 22 = BackSpace" | |
486 < If this works, add this in your .Xmodmap file: > | |
487 keysym 22 = BackSpace | |
488 < You need to restart for this to take effect. | |
489 | |
490 ============================================================================== | |
491 2. Automatically setting options *auto-setting* | |
492 | |
493 Besides changing options with the ":set" command, there are three alternatives | |
494 to set options automatically for one or more files: | |
495 | |
496 1. When starting Vim initializations are read from various places. See | |
497 |initialization|. Most of them are performed for all editing sessions, | |
498 and some of them depend on the directory where Vim is started. | |
499 You can create an initialization file with |:mkvimrc|, |:mkview| and | |
500 |:mksession|. | |
501 2. If you start editing a new file, the automatic commands are executed. | |
502 This can be used to set options for files matching a particular pattern and | |
503 many other things. See |autocommand|. | |
504 3. If you start editing a new file, and the 'modeline' option is on, a | |
505 number of lines at the beginning and end of the file are checked for | |
506 modelines. This is explained here. | |
507 | |
508 *modeline* *vim:* *vi:* *ex:* *E520* | |
509 There are two forms of modelines. The first form: | |
18831 | 510 [text{white}]{vi:|vim:|ex:}[white]{options} |
511 | |
512 [text{white}] empty or any text followed by at least one blank | |
513 character (<Space> or <Tab>); "ex:" always requires at | |
514 least one blank character | |
5055 | 515 {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
|
516 [white] optional white space |
7a2ffd685c0e
Update runtime files. Remove duplicate tags in help.
Bram Moolenaar <bram@vim.org>
parents:
5008
diff
changeset
|
517 {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
|
518 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
|
519 for a ":set" command (can be empty) |
7 | 520 |
5055 | 521 Examples: |
782 | 522 vi:noai:sw=3 ts=6 ~ |
5055 | 523 vim: tw=77 ~ |
7 | 524 |
525 The second form (this is compatible with some versions of Vi): | |
526 | |
19163 | 527 [text{white}]{vi:|vim:|Vim:|ex:}[white]se[t] {options}:[text] |
528 | |
529 [text{white}] empty or any text followed by at least one blank | |
530 character (<Space> or <Tab>); "ex:" always requires at | |
531 least one blank character | |
5024
7a2ffd685c0e
Update runtime files. Remove duplicate tags in help.
Bram Moolenaar <bram@vim.org>
parents:
5008
diff
changeset
|
532 {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
|
533 [white] optional white space |
5055 | 534 se[t] the string "set " or "se " (note the space); When |
535 "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
|
536 {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
|
537 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
|
538 : a colon |
7a2ffd685c0e
Update runtime files. Remove duplicate tags in help.
Bram Moolenaar <bram@vim.org>
parents:
5008
diff
changeset
|
539 [text] any text or empty |
7 | 540 |
5055 | 541 Examples: |
782 | 542 /* vim: set ai tw=75: */ ~ |
5055 | 543 /* Vim: set ai tw=75: */ ~ |
7 | 544 |
5024
7a2ffd685c0e
Update runtime files. Remove duplicate tags in help.
Bram Moolenaar <bram@vim.org>
parents:
5008
diff
changeset
|
545 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
|
546 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
|
547 "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
|
548 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
|
549 could be short for "example:"). |
7 | 550 |
25696
64fa341cc33b
patch 8.2.3384: cannot disable modeline for an individual file
Bram Moolenaar <Bram@vim.org>
parents:
25487
diff
changeset
|
551 If the modeline is disabled within a modeline, subsequent modelines will be |
64fa341cc33b
patch 8.2.3384: cannot disable modeline for an individual file
Bram Moolenaar <Bram@vim.org>
parents:
25487
diff
changeset
|
552 ignored. This is to allow turning off modeline on a per-file basis. This is |
64fa341cc33b
patch 8.2.3384: cannot disable modeline for an individual file
Bram Moolenaar <Bram@vim.org>
parents:
25487
diff
changeset
|
553 useful when a line looks like a modeline but isn't. For example, it would be |
64fa341cc33b
patch 8.2.3384: cannot disable modeline for an individual file
Bram Moolenaar <Bram@vim.org>
parents:
25487
diff
changeset
|
554 good to start a YAML file containing strings like "vim:" with |
64fa341cc33b
patch 8.2.3384: cannot disable modeline for an individual file
Bram Moolenaar <Bram@vim.org>
parents:
25487
diff
changeset
|
555 # vim: nomodeline ~ |
64fa341cc33b
patch 8.2.3384: cannot disable modeline for an individual file
Bram Moolenaar <Bram@vim.org>
parents:
25487
diff
changeset
|
556 so as to avoid modeline misdetection. Following options on the same line |
64fa341cc33b
patch 8.2.3384: cannot disable modeline for an individual file
Bram Moolenaar <Bram@vim.org>
parents:
25487
diff
changeset
|
557 after modeline deactivation, if any, are still evaluated (but you would |
64fa341cc33b
patch 8.2.3384: cannot disable modeline for an individual file
Bram Moolenaar <Bram@vim.org>
parents:
25487
diff
changeset
|
558 normally not have any). |
64fa341cc33b
patch 8.2.3384: cannot disable modeline for an individual file
Bram Moolenaar <Bram@vim.org>
parents:
25487
diff
changeset
|
559 |
7 | 560 *modeline-local* |
561 The options are set like with ":setlocal": The new value only applies to the | |
11 | 562 buffer and window that contain the file. Although it's possible to set global |
563 options from a modeline, this is unusual. If you have two windows open and | |
564 the files in it set the same global option to a different value, the result | |
565 depends on which one was opened last. | |
7 | 566 |
23 | 567 When editing a file that was already loaded, only the window-local options |
568 from the modeline are used. Thus if you manually changed a buffer-local | |
569 option after opening the file, it won't be changed if you edit the same buffer | |
570 in another window. But window-local options will be set. | |
571 | |
7 | 572 *modeline-version* |
573 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
|
574 number can be specified where "vim:" or "Vim:" is used: |
7 | 575 vim{vers}: version {vers} or later |
576 vim<{vers}: version before {vers} | |
577 vim={vers}: version {vers} | |
578 vim>{vers}: version after {vers} | |
6647 | 579 {vers} is 700 for Vim 7.0 (hundred times the major version plus minor). |
580 For example, to use a modeline only for Vim 7.0: | |
581 /* vim700: set foldmethod=marker */ ~ | |
582 To use a modeline for Vim after version 7.2: | |
583 /* vim>702: set cole=2: */ ~ | |
7 | 584 There can be no blanks between "vim" and the ":". |
585 | |
586 | |
587 The number of lines that are checked can be set with the 'modelines' option. | |
588 If 'modeline' is off or 'modelines' is 0 no lines are checked. | |
589 | |
590 Note that for the first form all of the rest of the line is used, thus a line | |
782 | 591 like: |
592 /* vi:ts=4: */ ~ | |
593 will give an error message for the trailing "*/". This line is OK: | |
594 /* vi:set ts=4: */ ~ | |
7 | 595 |
596 If an error is detected the rest of the line is skipped. | |
597 | |
598 If you want to include a ':' in a set command precede it with a '\'. The | |
782 | 599 backslash in front of the ':' will be removed. Example: |
18928 | 600 /* vi:set fillchars=stl\:^,vert\:\|: */ ~ |
601 This sets the 'fillchars' option to "stl:^,vert:\|". Only a single backslash | |
602 before the ':' is removed. Thus to include "\:" you have to specify "\\:". | |
16728
e55c26aaf484
patch 8.1.1366: using expressions in a modeline is unsafe
Bram Moolenaar <Bram@vim.org>
parents:
16610
diff
changeset
|
603 *E992* |
7 | 604 No other commands than "set" are supported, for security reasons (somebody |
1111 | 605 might create a Trojan horse text file with modelines). And not all options |
16728
e55c26aaf484
patch 8.1.1366: using expressions in a modeline is unsafe
Bram Moolenaar <Bram@vim.org>
parents:
16610
diff
changeset
|
606 can be set. For some options a flag is set, so that when the value is used |
e55c26aaf484
patch 8.1.1366: using expressions in a modeline is unsafe
Bram Moolenaar <Bram@vim.org>
parents:
16610
diff
changeset
|
607 the |sandbox| is effective. Some options can only be set from the modeline |
e55c26aaf484
patch 8.1.1366: using expressions in a modeline is unsafe
Bram Moolenaar <Bram@vim.org>
parents:
16610
diff
changeset
|
608 when 'modelineexpr' is set (the default is off). |
e55c26aaf484
patch 8.1.1366: using expressions in a modeline is unsafe
Bram Moolenaar <Bram@vim.org>
parents:
16610
diff
changeset
|
609 |
e55c26aaf484
patch 8.1.1366: using expressions in a modeline is unsafe
Bram Moolenaar <Bram@vim.org>
parents:
16610
diff
changeset
|
610 Still, there is always a small risk that a modeline causes trouble. E.g., |
e55c26aaf484
patch 8.1.1366: using expressions in a modeline is unsafe
Bram Moolenaar <Bram@vim.org>
parents:
16610
diff
changeset
|
611 when some joker sets 'textwidth' to 5 all your lines are wrapped unexpectedly. |
e55c26aaf484
patch 8.1.1366: using expressions in a modeline is unsafe
Bram Moolenaar <Bram@vim.org>
parents:
16610
diff
changeset
|
612 So disable modelines before editing untrusted text. The mail ftplugin does |
e55c26aaf484
patch 8.1.1366: using expressions in a modeline is unsafe
Bram Moolenaar <Bram@vim.org>
parents:
16610
diff
changeset
|
613 this, for example. |
7 | 614 |
615 Hint: If you would like to do something else than setting an option, you could | |
616 define an autocommand that checks the file for a specific string. For | |
617 example: > | |
618 au BufReadPost * if getline(1) =~ "VAR" | call SetVar() | endif | |
619 And define a function SetVar() that does something with the line containing | |
620 "VAR". | |
621 | |
622 ============================================================================== | |
623 3. Options summary *option-summary* | |
624 | |
625 In the list below all the options are mentioned with their full name and with | |
626 an abbreviation if there is one. Both forms may be used. | |
627 | |
628 In this document when a boolean option is "set" that means that ":set option" | |
629 is entered. When an option is "reset", ":set nooption" is used. | |
630 | |
631 For some options there are two default values: The "Vim default", which is | |
632 used when 'compatible' is not set, and the "Vi default", which is used when | |
633 'compatible' is set. | |
634 | |
635 Most options are the same in all windows and buffers. There are a few that | |
10 | 636 are specific to how the text is presented in a window. These can be set to a |
7 | 637 different value in each window. For example the 'list' option can be set in |
638 one window and reset in another for the same text, giving both types of view | |
639 at the same time. There are a few options that are specific to a certain | |
640 file. These can have a different value for each file or buffer. For example | |
641 the 'textwidth' option can be 78 for a normal text file and 0 for a C | |
642 program. | |
643 | |
644 global one option for all buffers and windows | |
645 local to window each window has its own copy of this option | |
646 local to buffer each buffer has its own copy of this option | |
647 | |
648 When creating a new window the option values from the currently active window | |
649 are used as a default value for the window-specific options. For the | |
650 buffer-specific options this depends on the 's' and 'S' flags in the | |
651 'cpoptions' option. If 's' is included (which is the default) the values for | |
652 buffer options are copied from the currently active buffer when a buffer is | |
10 | 653 first entered. If 'S' is present the options are copied each time the buffer |
654 is entered, this is almost like having global options. If 's' and 'S' are not | |
7 | 655 present, the options are copied from the currently active buffer when the |
656 buffer is created. | |
657 | |
519 | 658 Hidden options *hidden-options* |
659 | |
660 Not all options are supported in all versions. This depends on the supported | |
661 features and sometimes on the system. A remark about this is in curly braces | |
662 below. When an option is not supported it may still be set without getting an | |
663 error, this is called a hidden option. You can't get the value of a hidden | |
664 option though, it is not stored. | |
665 | |
666 To test if option "foo" can be used with ":set" use something like this: > | |
667 if exists('&foo') | |
668 This also returns true for a hidden option. To test if option "foo" is really | |
669 supported use something like this: > | |
670 if exists('+foo') | |
671 < | |
7 | 672 *E355* |
673 A jump table for the options with a short description can be found at |Q_op|. | |
674 | |
675 *'aleph'* *'al'* *aleph* *Aleph* | |
18972 | 676 'aleph' 'al' number (default 128 for MS-Windows, 224 otherwise) |
7 | 677 global |
678 {only available when compiled with the |+rightleft| | |
679 feature} | |
680 The ASCII code for the first letter of the Hebrew alphabet. The | |
681 routine that maps the keyboard in Hebrew mode, both in Insert mode | |
682 (when hkmap is set) and on the command-line (when hitting CTRL-_) | |
683 outputs the Hebrew characters in the range [aleph..aleph+26]. | |
684 aleph=128 applies to PC code, and aleph=224 applies to ISO 8859-8. | |
685 See |rileft.txt|. | |
686 | |
687 *'allowrevins'* *'ari'* *'noallowrevins'* *'noari'* | |
688 'allowrevins' 'ari' boolean (default off) | |
689 global | |
690 {only available when compiled with the |+rightleft| | |
691 feature} | |
692 Allow CTRL-_ in Insert and Command-line mode. This is default off, to | |
693 avoid that users that accidentally type CTRL-_ instead of SHIFT-_ get | |
694 into reverse Insert mode, and don't know how to get out. See | |
695 'revins'. | |
696 NOTE: This option is reset when 'compatible' is set. | |
697 | |
698 *'altkeymap'* *'akm'* *'noaltkeymap'* *'noakm'* | |
699 'altkeymap' 'akm' boolean (default off) | |
700 global | |
701 {only available when compiled with the |+farsi| | |
702 feature} | |
15850
a6ca8cf07a98
patch 8.1.0932: Farsi support is outdated and unused
Bram Moolenaar <Bram@vim.org>
parents:
15840
diff
changeset
|
703 This option was for using Farsi, which has been removed. See |
a6ca8cf07a98
patch 8.1.0932: Farsi support is outdated and unused
Bram Moolenaar <Bram@vim.org>
parents:
15840
diff
changeset
|
704 |farsi.txt|. |
7 | 705 |
706 *'ambiwidth'* *'ambw'* | |
707 'ambiwidth' 'ambw' string (default: "single") | |
708 global | |
709 Only effective when 'encoding' is "utf-8" or another Unicode encoding. | |
710 Tells Vim what to do with characters with East Asian Width Class | |
711 Ambiguous (such as Euro, Registered Sign, Copyright Sign, Greek | |
712 letters, Cyrillic letters). | |
713 | |
714 There are currently two possible values: | |
233 | 715 "single": Use the same width as characters in US-ASCII. This is |
7 | 716 expected by most users. |
717 "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
|
718 *E834* *E835* |
c945fdb34ce3
Disallow setting 'ambiwidth' to "double" when 'listchars' or 'fillchars'
Bram Moolenaar <bram@vim.org>
parents:
2490
diff
changeset
|
719 The value "double" cannot be used if 'listchars' or 'fillchars' |
22171 | 720 contains a character that would be double width. |
21971
0bc43a704f56
patch 8.2.1535: it is not possible to specify cell widths of characters
Bram Moolenaar <Bram@vim.org>
parents:
21825
diff
changeset
|
721 |
0bc43a704f56
patch 8.2.1535: it is not possible to specify cell widths of characters
Bram Moolenaar <Bram@vim.org>
parents:
21825
diff
changeset
|
722 The values are overruled for characters specified with |
0bc43a704f56
patch 8.2.1535: it is not possible to specify cell widths of characters
Bram Moolenaar <Bram@vim.org>
parents:
21825
diff
changeset
|
723 |setcellwidths()|. |
7 | 724 |
725 There are a number of CJK fonts for which the width of glyphs for | |
726 those characters are solely based on how many octets they take in | |
727 legacy/traditional CJK encodings. In those encodings, Euro, | |
728 Registered sign, Greek/Cyrillic letters are represented by two octets, | |
233 | 729 therefore those fonts have "wide" glyphs for them. This is also |
7 | 730 true of some line drawing characters used to make tables in text |
233 | 731 file. Therefore, when a CJK font is used for GUI Vim or |
7 | 732 Vim is running inside a terminal (emulators) that uses a CJK font |
733 (or Vim is run inside an xterm invoked with "-cjkwidth" option.), | |
734 this option should be set to "double" to match the width perceived | |
735 by Vim with the width of glyphs in the font. Perhaps it also has | |
19116 | 736 to be set to "double" under CJK MS-Windows when the system locale is |
737 set to one of CJK locales. See Unicode Standard Annex #11 | |
738 (http://www.unicode.org/reports/tr11). | |
7 | 739 |
4229 | 740 Vim may set this option automatically at startup time when Vim is |
741 compiled with the |+termresponse| feature and if |t_u7| is set to the | |
12499 | 742 escape sequence to request cursor position report. The response can |
743 be found in |v:termu7resp|. | |
4229 | 744 |
7 | 745 *'antialias'* *'anti'* *'noantialias'* *'noanti'* |
746 'antialias' 'anti' boolean (default: off) | |
747 global | |
748 {only available when compiled with GUI enabled | |
21825 | 749 on macOS} |
750 This option only has an effect in the GUI version of Vim on macOS | |
7 | 751 v10.2 or later. When on, Vim will use smooth ("antialiased") fonts, |
752 which can be easier to read at certain sizes on certain displays. | |
753 Setting this option can sometimes cause problems if 'guifont' is set | |
754 to its default (empty string). | |
11160 | 755 NOTE: This option is reset when 'compatible' is set. |
7 | 756 |
757 *'autochdir'* *'acd'* *'noautochdir'* *'noacd'* | |
758 'autochdir' 'acd' boolean (default off) | |
759 global | |
2152 | 760 {only available when compiled with it, use |
761 exists("+autochdir") to check} | |
438 | 762 When on, Vim will change the current working directory whenever you |
763 open a file, switch buffers, delete a buffer or open/close a window. | |
764 It will change to the directory containing the file which was opened | |
765 or selected. | |
819 | 766 Note: When this option is on some plugins may not work. |
7 | 767 |
24268
9257f3980f4a
patch 8.2.2675: directory change in a terminal window shell is not followed
Bram Moolenaar <Bram@vim.org>
parents:
24055
diff
changeset
|
768 *'autoshelldir'* *'asd'* *'noautoshelldir'* *'noasd'* |
9257f3980f4a
patch 8.2.2675: directory change in a terminal window shell is not followed
Bram Moolenaar <Bram@vim.org>
parents:
24055
diff
changeset
|
769 'autoshelldir' 'asd' boolean (default off) |
9257f3980f4a
patch 8.2.2675: directory change in a terminal window shell is not followed
Bram Moolenaar <Bram@vim.org>
parents:
24055
diff
changeset
|
770 global |
9257f3980f4a
patch 8.2.2675: directory change in a terminal window shell is not followed
Bram Moolenaar <Bram@vim.org>
parents:
24055
diff
changeset
|
771 When on, Vim will change the current working directory whenever you |
9257f3980f4a
patch 8.2.2675: directory change in a terminal window shell is not followed
Bram Moolenaar <Bram@vim.org>
parents:
24055
diff
changeset
|
772 change the directory of the shell running in a terminal window. You |
9257f3980f4a
patch 8.2.2675: directory change in a terminal window shell is not followed
Bram Moolenaar <Bram@vim.org>
parents:
24055
diff
changeset
|
773 need proper setting-up, so whenever the shell's pwd changes an OSC 7 |
9257f3980f4a
patch 8.2.2675: directory change in a terminal window shell is not followed
Bram Moolenaar <Bram@vim.org>
parents:
24055
diff
changeset
|
774 escape sequence will be emitted. For example, on Linux, you can source |
9257f3980f4a
patch 8.2.2675: directory change in a terminal window shell is not followed
Bram Moolenaar <Bram@vim.org>
parents:
24055
diff
changeset
|
775 /etc/profile.d/vte.sh in your shell profile if you use bash or zsh. |
9257f3980f4a
patch 8.2.2675: directory change in a terminal window shell is not followed
Bram Moolenaar <Bram@vim.org>
parents:
24055
diff
changeset
|
776 |
7 | 777 *'arabic'* *'arab'* *'noarabic'* *'noarab'* |
778 'arabic' 'arab' boolean (default off) | |
779 local to window | |
780 {only available when compiled with the |+arabic| | |
781 feature} | |
782 This option can be set to start editing Arabic text. | |
783 Setting this option will: | |
784 - Set the 'rightleft' option, unless 'termbidi' is set. | |
785 - Set the 'arabicshape' option, unless 'termbidi' is set. | |
786 - Set the 'keymap' option to "arabic"; in Insert mode CTRL-^ toggles | |
787 between typing English and Arabic key mapping. | |
788 - Set the 'delcombine' option | |
789 Note that 'encoding' must be "utf-8" for working with Arabic text. | |
790 | |
791 Resetting this option will: | |
792 - Reset the 'rightleft' option. | |
793 - Disable the use of 'keymap' (without changing its value). | |
794 Note that 'arabicshape' and 'delcombine' are not reset (it is a global | |
3557 | 795 option). |
11160 | 796 NOTE: This option is reset when 'compatible' is set. |
7 | 797 Also see |arabic.txt|. |
798 | |
799 *'arabicshape'* *'arshape'* | |
800 *'noarabicshape'* *'noarshape'* | |
801 'arabicshape' 'arshape' boolean (default on) | |
802 global | |
803 {only available when compiled with the |+arabic| | |
804 feature} | |
805 When on and 'termbidi' is off, the required visual character | |
806 corrections that need to take place for displaying the Arabic language | |
3893 | 807 take effect. Shaping, in essence, gets enabled; the term is a broad |
7 | 808 one which encompasses: |
809 a) the changing/morphing of characters based on their location | |
810 within a word (initial, medial, final and stand-alone). | |
811 b) the enabling of the ability to compose characters | |
812 c) the enabling of the required combining of some characters | |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
813 When disabled the display shows each character's true stand-alone |
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
814 form. |
7 | 815 Arabic is a complex language which requires other settings, for |
816 further details see |arabic.txt|. | |
11160 | 817 NOTE: This option is set when 'compatible' is set. |
7 | 818 |
819 *'autoindent'* *'ai'* *'noautoindent'* *'noai'* | |
820 'autoindent' 'ai' boolean (default off) | |
821 local to buffer | |
822 Copy indent from current line when starting a new line (typing <CR> | |
823 in Insert mode or when using the "o" or "O" command). If you do not | |
824 type anything on the new line except <BS> or CTRL-D and then type | |
1152 | 825 <Esc>, CTRL-O or <CR>, the indent is deleted again. Moving the cursor |
826 to another line has the same effect, unless the 'I' flag is included | |
827 in 'cpoptions'. | |
10 | 828 When autoindent is on, formatting (with the "gq" command or when you |
829 reach 'textwidth' in Insert mode) uses the indentation of the first | |
830 line. | |
7 | 831 When 'smartindent' or 'cindent' is on the indent is changed in |
832 a different way. | |
7147
c590de398af9
commit https://github.com/vim/vim/commit/ca63501fbcd1cf9c8aa9ff12c093c95b62a89ed7
Christian Brabandt <cb@256bit.org>
parents:
7080
diff
changeset
|
833 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
|
834 restored when 'paste' is reset. |
7 | 835 |
836 *'autoread'* *'ar'* *'noautoread'* *'noar'* | |
837 'autoread' 'ar' boolean (default off) | |
838 global or local to buffer |global-local| | |
839 When a file has been detected to have been changed outside of Vim and | |
840 it has not been changed inside of Vim, automatically read it again. | |
14298
4a588e3afd4a
Update runtime files, add Danish translations.
Christian Brabandt <cb@256bit.org>
parents:
14249
diff
changeset
|
841 When the file has been deleted this is not done, so you have the text |
4a588e3afd4a
Update runtime files, add Danish translations.
Christian Brabandt <cb@256bit.org>
parents:
14249
diff
changeset
|
842 from before it was deleted. When it appears again then it is read. |
4a588e3afd4a
Update runtime files, add Danish translations.
Christian Brabandt <cb@256bit.org>
parents:
14249
diff
changeset
|
843 |timestamp| |
7 | 844 If this option has a local value, use this command to switch back to |
845 using the global value: > | |
846 :set autoread< | |
847 < | |
848 *'autowrite'* *'aw'* *'noautowrite'* *'noaw'* | |
849 'autowrite' 'aw' boolean (default off) | |
850 global | |
851 Write the contents of the file, if it has been modified, on each | |
852 :next, :rewind, :last, :first, :previous, :stop, :suspend, :tag, :!, | |
864 | 853 :make, CTRL-] and CTRL-^ command; and when a :buffer, CTRL-O, CTRL-I, |
7 | 854 '{A-Z0-9}, or `{A-Z0-9} command takes one to another file. |
855 Note that for some commands the 'autowrite' option is not used, see | |
856 'autowriteall' for that. | |
14695 | 857 Some buffers will not be written, specifically when 'buftype' is |
14668 | 858 "nowrite", "nofile", "terminal" or "prompt". |
7 | 859 |
860 *'autowriteall'* *'awa'* *'noautowriteall'* *'noawa'* | |
861 'autowriteall' 'awa' boolean (default off) | |
862 global | |
863 Like 'autowrite', but also used for commands ":edit", ":enew", ":quit", | |
864 ":qall", ":exit", ":xit", ":recover" and closing the Vim window. | |
865 Setting this option also implies that Vim behaves like 'autowrite' has | |
866 been set. | |
867 | |
868 *'background'* *'bg'* | |
2826 | 869 'background' 'bg' string (default "dark" or "light", see below) |
7 | 870 global |
871 When set to "dark", Vim will try to use colors that look good on a | |
872 dark background. When set to "light", Vim will try to use colors that | |
873 look good on a light background. Any other value is illegal. | |
874 Vim tries to set the default value according to the terminal used. | |
875 This will not always be correct. | |
876 Setting this option does not change the background color, it tells Vim | |
877 what the background color looks like. For changing the background | |
878 color, see |:hi-normal|. | |
879 | |
880 When 'background' is set Vim will adjust the default color groups for | |
10 | 881 the new value. But the colors used for syntax highlighting will not |
1621 | 882 change. *g:colors_name* |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
883 When a color scheme is loaded (the "g:colors_name" variable is set) |
7 | 884 setting 'background' will cause the color scheme to be reloaded. If |
885 the color scheme adjusts to the value of 'background' this will work. | |
886 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
|
887 be undone. First delete the "g:colors_name" variable when needed. |
7 | 888 |
889 When setting 'background' to the default value with: > | |
890 :set background& | |
891 < Vim will guess the value. In the GUI this should work correctly, | |
892 in other cases Vim might not be able to guess the right value. | |
18343 | 893 If the GUI supports a dark theme, you can use the "d" flag in |
18078
5ae41d0ea397
patch 8.1.2034: dark them of GTK 3 not supported
Bram Moolenaar <Bram@vim.org>
parents:
18068
diff
changeset
|
894 'guioptions', see 'go-d'. |
7 | 895 |
12499 | 896 When the |t_RB| option is set, Vim will use it to request the background |
11442 | 897 color from the terminal. If the returned RGB value is dark/light and |
898 'background' is not dark/light, 'background' will be set and the | |
899 screen is redrawn. This may have side effects, make t_BG empty in | |
12499 | 900 your .vimrc if you suspect this problem. The response to |t_RB| can |
12756
3b26420fc639
Long overdue runtime update.
Christian Brabandt <cb@256bit.org>
parents:
12744
diff
changeset
|
901 be found in |v:termrbgresp|. |
11442 | 902 |
7 | 903 When starting the GUI, the default value for 'background' will be |
904 "light". When the value is not set in the .gvimrc, and Vim detects | |
905 that the background is actually quite dark, 'background' is set to | |
906 "dark". But this happens only AFTER the .gvimrc file has been read | |
907 (because the window needs to be opened to find the actual background | |
908 color). To get around this, force the GUI window to be opened by | |
909 putting a ":gui" command in the .gvimrc file, before where the value | |
910 of 'background' is used (e.g., before ":syntax on"). | |
2826 | 911 |
18912
ccd16426a1f9
patch 8.2.0017: OS/2 and MS-DOS are still mentioned
Bram Moolenaar <Bram@vim.org>
parents:
18879
diff
changeset
|
912 For MS-Windows the default is "dark". |
2826 | 913 For other systems "dark" is used when 'term' is "linux", |
914 "screen.linux", "cygwin" or "putty", or $COLORFGBG suggests a dark | |
915 background. Otherwise the default is "light". | |
916 | |
12254 | 917 The |:terminal| command and the |term_start()| function use the |
918 'background' value to decide whether the terminal window will start | |
919 with a white or black background. | |
920 | |
7 | 921 Normally this option would be set in the .vimrc file. Possibly |
922 depending on the terminal name. Example: > | |
923 :if &term == "pcterm" | |
924 : set background=dark | |
925 :endif | |
926 < When this option is set, the default settings for the highlight groups | |
927 will change. To use other settings, place ":highlight" commands AFTER | |
928 the setting of the 'background' option. | |
929 This option is also used in the "$VIMRUNTIME/syntax/syntax.vim" file | |
930 to select the colors for syntax highlighting. After changing this | |
931 option, you must load syntax.vim again to see the result. This can be | |
932 done with ":syntax on". | |
933 | |
934 *'backspace'* *'bs'* | |
9669
284b4eb307fc
commit https://github.com/vim/vim/commit/8c08b5b569e2a9e9f63dea514591ecfa2d3bb392
Christian Brabandt <cb@256bit.org>
parents:
9665
diff
changeset
|
935 '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
|
936 in |defaults.vim|) |
7 | 937 global |
938 Influences the working of <BS>, <Del>, CTRL-W and CTRL-U in Insert | |
939 mode. This is a list of items, separated by commas. Each item allows | |
940 a way to backspace over something: | |
941 value effect ~ | |
942 indent allow backspacing over autoindent | |
943 eol allow backspacing over line breaks (join lines) | |
944 start allow backspacing over the start of insert; CTRL-W and CTRL-U | |
945 stop once at the start of insert. | |
20069
9a67d41708d2
patch 8.2.0590: no 'backspace' value allows ignoring the insertion point
Bram Moolenaar <Bram@vim.org>
parents:
19968
diff
changeset
|
946 nostop like start, except CTRL-W and CTRL-U do not stop at the start of |
9a67d41708d2
patch 8.2.0590: no 'backspace' value allows ignoring the insertion point
Bram Moolenaar <Bram@vim.org>
parents:
19968
diff
changeset
|
947 insert. |
7 | 948 |
949 When the value is empty, Vi compatible backspacing is used. | |
950 | |
951 For backwards compatibility with version 5.4 and earlier: | |
952 value effect ~ | |
953 0 same as ":set backspace=" (Vi compatible) | |
954 1 same as ":set backspace=indent,eol" | |
955 2 same as ":set backspace=indent,eol,start" | |
20069
9a67d41708d2
patch 8.2.0590: no 'backspace' value allows ignoring the insertion point
Bram Moolenaar <Bram@vim.org>
parents:
19968
diff
changeset
|
956 3 same as ":set backspace=indent,eol,nostop" |
7 | 957 |
958 See |:fixdel| if your <BS> or <Del> key does not do what you want. | |
959 NOTE: This option is set to "" when 'compatible' is set. | |
960 | |
961 *'backup'* *'bk'* *'nobackup'* *'nobk'* | |
962 'backup' 'bk' boolean (default off) | |
963 global | |
964 Make a backup before overwriting a file. Leave it around after the | |
965 file has been successfully written. If you do not want to keep the | |
966 backup file, but you do want a backup while the file is being | |
967 written, reset this option and set the 'writebackup' option (this is | |
968 the default). If you do not want a backup file at all reset both | |
10 | 969 options (use this if your file system is almost full). See the |
7 | 970 |backup-table| for more explanations. |
971 When the 'backupskip' pattern matches, a backup is not made anyway. | |
972 When 'patchmode' is set, the backup may be renamed to become the | |
973 oldest version of a file. | |
974 NOTE: This option is reset when 'compatible' is set. | |
975 | |
976 *'backupcopy'* *'bkc'* | |
977 'backupcopy' 'bkc' string (Vi default for Unix: "yes", otherwise: "auto") | |
6243 | 978 global or local to buffer |global-local| |
7 | 979 When writing a file and a backup is made, this option tells how it's |
980 done. This is a comma separated list of words. | |
981 | |
982 The main values are: | |
983 "yes" make a copy of the file and overwrite the original one | |
984 "no" rename the file and write a new one | |
985 "auto" one of the previous, what works best | |
986 | |
987 Extra values that can be combined with the ones above are: | |
988 "breaksymlink" always break symlinks when writing | |
989 "breakhardlink" always break hardlinks when writing | |
990 | |
991 Making a copy and overwriting the original file: | |
992 - Takes extra time to copy the file. | |
993 + When the file has special attributes, is a (hard/symbolic) link or | |
994 has a resource fork, all this is preserved. | |
995 - When the file is a link the backup will have the name of the link, | |
996 not of the real file. | |
997 | |
998 Renaming the file and writing a new one: | |
999 + It's fast. | |
1000 - Sometimes not all attributes of the file can be copied to the new | |
1001 file. | |
1002 - When the file is a link the new file will not be a link. | |
1003 | |
1004 The "auto" value is the middle way: When Vim sees that renaming file | |
1005 is possible without side effects (the attributes can be passed on and | |
1152 | 1006 the file is not a link) that is used. When problems are expected, a |
1007 copy will be made. | |
7 | 1008 |
1009 The "breaksymlink" and "breakhardlink" values can be used in | |
1010 combination with any of "yes", "no" and "auto". When included, they | |
1011 force Vim to always break either symbolic or hard links by doing | |
1012 exactly what the "no" option does, renaming the original file to | |
1013 become the backup and writing a new file in its place. This can be | |
1014 useful for example in source trees where all the files are symbolic or | |
1015 hard links and any changes should stay in the local source tree, not | |
1016 be propagated back to the original source. | |
1017 *crontab* | |
1018 One situation where "no" and "auto" will cause problems: A program | |
1019 that opens a file, invokes Vim to edit that file, and then tests if | |
1020 the open file was changed (through the file descriptor) will check the | |
10 | 1021 backup file instead of the newly created file. "crontab -e" is an |
7 | 1022 example. |
1023 | |
1024 When a copy is made, the original file is truncated and then filled | |
1025 with the new text. This means that protection bits, owner and | |
1026 symbolic links of the original file are unmodified. The backup file | |
10 | 1027 however, is a new file, owned by the user who edited the file. The |
7 | 1028 group of the backup is set to the group of the original file. If this |
1029 fails, the protection bits for the group are made the same as for | |
1030 others. | |
1031 | |
1032 When the file is renamed this is the other way around: The backup has | |
1033 the same attributes of the original file, and the newly written file | |
1034 is owned by the current user. When the file was a (hard/symbolic) | |
1035 link, the new file will not! That's why the "auto" value doesn't | |
1036 rename when the file is a link. The owner and group of the newly | |
1037 written file will be set to the same ones as the original file, but | |
1038 the system may refuse to do this. In that case the "auto" value will | |
1039 again not rename the file. | |
1040 | |
11160 | 1041 NOTE: This option is set to the Vi default value when 'compatible' is |
1042 set and to the Vim default value when 'compatible' is reset. | |
1043 | |
7 | 1044 *'backupdir'* *'bdir'* |
1045 'backupdir' 'bdir' string (default for Amiga: ".,t:", | |
18972 | 1046 for Win32: ".,$TEMP,c:/tmp,c:/temp" |
7 | 1047 for Unix: ".,~/tmp,~/") |
1048 global | |
1049 List of directories for the backup file, separated with commas. | |
1050 - 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
|
1051 where this is possible. The directory must exist, Vim will not |
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
1052 create it for you. |
8629
54ac275e3fc4
commit https://github.com/vim/vim/commit/3848e00e0177abdb31bc600234967863ec487233
Christian Brabandt <cb@256bit.org>
parents:
8560
diff
changeset
|
1053 - Empty means that no backup file will be created ('patchmode' is |
7 | 1054 impossible!). Writing may fail because of this. |
1055 - A directory "." means to put the backup file in the same directory | |
1056 as the edited file. | |
19116 | 1057 - A directory starting with "./" (or ".\" for MS-Windows) means to put |
1058 the backup file relative to where the edited file is. The leading | |
1059 "." is replaced with the path name of the edited file. | |
7 | 1060 ("." inside a directory name has no special meaning). |
1061 - Spaces after the comma are ignored, other spaces are considered part | |
1062 of the directory name. To have a space at the start of a directory | |
1063 name, precede it with a backslash. | |
1064 - To include a comma in a directory name precede it with a backslash. | |
1065 - A directory name may end in an '/'. | |
14475
dddba3937532
patch 8.1.0251: using full path is not supported for 'backupdir'
Christian Brabandt <cb@256bit.org>
parents:
14421
diff
changeset
|
1066 - For Unix and Win32, if a directory ends in two path separators "//", |
15033 | 1067 the backup file name will be built from the complete path to the |
1068 file with all path separators changed to percent '%' signs. This | |
1069 will ensure file name uniqueness in the backup directory. | |
14475
dddba3937532
patch 8.1.0251: using full path is not supported for 'backupdir'
Christian Brabandt <cb@256bit.org>
parents:
14421
diff
changeset
|
1070 On Win32, it is also possible to end with "\\". However, When a |
dddba3937532
patch 8.1.0251: using full path is not supported for 'backupdir'
Christian Brabandt <cb@256bit.org>
parents:
14421
diff
changeset
|
1071 separating comma is following, you must use "//", since "\\" will |
dddba3937532
patch 8.1.0251: using full path is not supported for 'backupdir'
Christian Brabandt <cb@256bit.org>
parents:
14421
diff
changeset
|
1072 include the comma in the file name. Therefore it is recommended to |
dddba3937532
patch 8.1.0251: using full path is not supported for 'backupdir'
Christian Brabandt <cb@256bit.org>
parents:
14421
diff
changeset
|
1073 use '//', instead of '\\'. |
7 | 1074 - Environment variables are expanded |:set_env|. |
1075 - Careful with '\' characters, type one before a space, type two to | |
1076 get one in the option (see |option-backslash|), for example: > | |
1077 :set bdir=c:\\tmp,\ dir\\,with\\,commas,\\\ dir\ with\ spaces | |
1078 < - For backwards compatibility with Vim version 3.0 a '>' at the start | |
1079 of the option is removed. | |
1080 See also 'backup' and 'writebackup' options. | |
1081 If you want to hide your backup files on Unix, consider this value: > | |
1082 :set backupdir=./.backup,~/.backup,.,/tmp | |
1083 < You must create a ".backup" directory in each directory and in your | |
1084 home directory for this to work properly. | |
1085 The use of |:set+=| and |:set-=| is preferred when adding or removing | |
1086 directories from the list. This avoids problems when a future version | |
1087 uses another default. | |
1088 This option cannot be set from a |modeline| or in the |sandbox|, for | |
1089 security reasons. | |
1090 | |
1091 *'backupext'* *'bex'* *E589* | |
1092 'backupext' 'bex' string (default "~", for VMS: "_") | |
1093 global | |
1094 String which is appended to a file name to make the name of the | |
1095 backup file. The default is quite unusual, because this avoids | |
1096 accidentally overwriting existing files with a backup file. You might | |
1097 prefer using ".bak", but make sure that you don't have files with | |
1098 ".bak" that you want to keep. | |
36 | 1099 Only normal file name characters can be used, "/\*?[|<>" are illegal. |
7 | 1100 |
26 | 1101 If you like to keep a lot of backups, you could use a BufWritePre |
1102 autocommand to change 'backupext' just before writing the file to | |
1103 include a timestamp. > | |
1104 :au BufWritePre * let &bex = '-' . strftime("%Y%b%d%X") . '~' | |
1105 < Use 'backupdir' to put the backup in a different directory. | |
1106 | |
7 | 1107 *'backupskip'* *'bsk'* |
13664
f64c5e636c9f
patch 8.0.1704: 'backupskip' default doesn't work for Mac
Christian Brabandt <cb@256bit.org>
parents:
13482
diff
changeset
|
1108 'backupskip' 'bsk' string (default: "$TMPDIR/*,$TMP/*,$TEMP/*" |
f64c5e636c9f
patch 8.0.1704: 'backupskip' default doesn't work for Mac
Christian Brabandt <cb@256bit.org>
parents:
13482
diff
changeset
|
1109 Unix: "/tmp/*,$TMPDIR/*,$TMP/*,$TEMP/*" |
f64c5e636c9f
patch 8.0.1704: 'backupskip' default doesn't work for Mac
Christian Brabandt <cb@256bit.org>
parents:
13482
diff
changeset
|
1110 Mac: "/private/tmp/*,$TMPDIR/*,$TMP/*,$TEMP/*") |
7 | 1111 global |
1112 {not available when compiled without the |+wildignore| | |
1113 feature} | |
1114 A list of file patterns. When one of the patterns matches with the | |
1115 name of the file which is written, no backup file is created. Both | |
1116 the specified file name and the full path name of the file are used. | |
1117 The pattern is used like with |:autocmd|, see |autocmd-patterns|. | |
1118 Watch out for special characters, see |option-backslash|. | |
1119 When $TMPDIR, $TMP or $TEMP is not defined, it is not used for the | |
233 | 1120 default value. "/tmp/*" is only used for Unix. |
1152 | 1121 |
3513 | 1122 WARNING: Not having a backup file means that when Vim fails to write |
1123 your buffer correctly and then, for whatever reason, Vim exits, you | |
1124 lose both the original file and what you were writing. Only disable | |
1125 backups if you don't care about losing the file. | |
1126 | |
1152 | 1127 Note that environment variables are not expanded. If you want to use |
1128 $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
|
1129 :let &backupskip = escape(expand('$HOME'), '\') . '/tmp/*' |
1152 | 1130 |
1131 < Note that the default also makes sure that "crontab -e" works (when a | |
557 | 1132 backup would be made by renaming the original file crontab won't see |
1133 the newly created file). Also see 'backupcopy' and |crontab|. | |
7 | 1134 |
1135 *'balloondelay'* *'bdlay'* | |
1136 'balloondelay' 'bdlay' number (default: 600) | |
1137 global | |
1138 {only available when compiled with the |+balloon_eval| | |
1139 feature} | |
1140 Delay in milliseconds before a balloon may pop up. See |balloon-eval|. | |
1141 | |
1142 *'ballooneval'* *'beval'* *'noballooneval'* *'nobeval'* | |
1143 'ballooneval' 'beval' boolean (default off) | |
1144 global | |
1145 {only available when compiled with the |+balloon_eval| | |
189 | 1146 feature} |
12865
ebb4f6c93598
patch 8.0.1309: cannot use 'balloonexpr' in a terminal
Christian Brabandt <cb@256bit.org>
parents:
12826
diff
changeset
|
1147 Switch on the |balloon-eval| functionality for the GUI. |
ebb4f6c93598
patch 8.0.1309: cannot use 'balloonexpr' in a terminal
Christian Brabandt <cb@256bit.org>
parents:
12826
diff
changeset
|
1148 |
ebb4f6c93598
patch 8.0.1309: cannot use 'balloonexpr' in a terminal
Christian Brabandt <cb@256bit.org>
parents:
12826
diff
changeset
|
1149 *'balloonevalterm'* *'bevalterm'* *'noballoonevalterm'* |
ebb4f6c93598
patch 8.0.1309: cannot use 'balloonexpr' in a terminal
Christian Brabandt <cb@256bit.org>
parents:
12826
diff
changeset
|
1150 *'nobevalterm'* |
ebb4f6c93598
patch 8.0.1309: cannot use 'balloonexpr' in a terminal
Christian Brabandt <cb@256bit.org>
parents:
12826
diff
changeset
|
1151 'balloonevalterm' 'bevalterm' boolean (default off) |
ebb4f6c93598
patch 8.0.1309: cannot use 'balloonexpr' in a terminal
Christian Brabandt <cb@256bit.org>
parents:
12826
diff
changeset
|
1152 global |
ebb4f6c93598
patch 8.0.1309: cannot use 'balloonexpr' in a terminal
Christian Brabandt <cb@256bit.org>
parents:
12826
diff
changeset
|
1153 {only available when compiled with the |
ebb4f6c93598
patch 8.0.1309: cannot use 'balloonexpr' in a terminal
Christian Brabandt <cb@256bit.org>
parents:
12826
diff
changeset
|
1154 |+balloon_eval_term| feature} |
ebb4f6c93598
patch 8.0.1309: cannot use 'balloonexpr' in a terminal
Christian Brabandt <cb@256bit.org>
parents:
12826
diff
changeset
|
1155 Switch on the |balloon-eval| functionality for the terminal. |
7 | 1156 |
189 | 1157 *'balloonexpr'* *'bexpr'* |
1158 'balloonexpr' 'bexpr' string (default "") | |
790 | 1159 global or local to buffer |global-local| |
189 | 1160 {only available when compiled with the |+balloon_eval| |
1161 feature} | |
782 | 1162 Expression for text to show in evaluation balloon. It is only used |
16610 | 1163 when 'ballooneval' or 'balloonevalterm' is on. These variables can be |
1164 used: | |
189 | 1165 |
1166 v:beval_bufnr number of the buffer in which balloon is going to show | |
1167 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
|
1168 v:beval_winid ID of the window |
189 | 1169 v:beval_lnum line number |
1170 v:beval_col column number (byte index) | |
1171 v:beval_text word under or after the mouse pointer | |
1172 | |
17571 | 1173 Instead of showing a balloon, which is limited to plain text, consider |
1174 using a popup window, see |popup_beval_example|. A popup window can | |
1175 use highlighting and show a border. | |
1176 | |
189 | 1177 The evaluation of the expression must not have side effects! |
1178 Example: > | |
16610 | 1179 function MyBalloonExpr() |
435 | 1180 return 'Cursor is at line ' . v:beval_lnum . |
189 | 1181 \', column ' . v:beval_col . |
1182 \ ' of file ' . bufname(v:beval_bufnr) . | |
1183 \ ' on word "' . v:beval_text . '"' | |
1184 endfunction | |
1185 set bexpr=MyBalloonExpr() | |
1186 set ballooneval | |
1187 < | |
17372 | 1188 Also see |balloon_show()|, it can be used if the content of the balloon |
1189 is to be fetched asynchronously. In that case evaluating | |
1190 'balloonexpr' should result in an empty string. If you get a balloon | |
1191 with only "0" you probably didn't return anything from your function. | |
11062 | 1192 |
189 | 1193 NOTE: The balloon is displayed only if the cursor is on a text |
1194 character. If the result of evaluating 'balloonexpr' is not empty, | |
1195 Vim does not try to send a message to an external debugger (Netbeans | |
1196 or Sun Workshop). | |
1197 | |
3682 | 1198 The expression will be evaluated in the |sandbox| when set from a |
1199 modeline, see |sandbox-option|. | |
16728
e55c26aaf484
patch 8.1.1366: using expressions in a modeline is unsafe
Bram Moolenaar <Bram@vim.org>
parents:
16610
diff
changeset
|
1200 This option cannot be set in a modeline when 'modelineexpr' is off. |
634 | 1201 |
1202 It is not allowed to change text or jump to another window while | |
17372 | 1203 evaluating 'balloonexpr', see |textlock|. |
634 | 1204 |
446 | 1205 To check whether line breaks in the balloon text work use this check: > |
435 | 1206 if has("balloon_multiline") |
714 | 1207 < When they are supported "\n" characters will start a new line. If the |
1208 expression evaluates to a |List| this is equal to using each List item | |
1209 as a string and putting "\n" in between them. | |
11160 | 1210 NOTE: This option is set to "" when 'compatible' is set. |
714 | 1211 |
6949 | 1212 *'belloff'* *'bo'* |
1213 'belloff' 'bo' string (default "") | |
1214 global | |
1215 Specifies for which events the bell will not be rung. It is a comma | |
1216 separated list of items. For each item that is present, the bell | |
1217 will be silenced. This is most useful to specify specific events in | |
1218 insert mode to be silenced. | |
1219 | |
1220 item meaning when present ~ | |
1221 all All events. | |
1222 backspace When hitting <BS> or <Del> and deleting results in an | |
1223 error. | |
1224 cursor Fail to move around using the cursor keys or | |
1225 <PageUp>/<PageDown> in |Insert-mode|. | |
1226 complete Error occurred when using |i_CTRL-X_CTRL-K| or | |
1227 |i_CTRL-X_CTRL-T|. | |
1228 copy Cannot copy char from insert mode using |i_CTRL-Y| or | |
1229 |i_CTRL-E|. | |
1230 ctrlg Unknown Char after <C-G> in Insert mode. | |
1231 error Other Error occurred (e.g. try to join last line) | |
1232 (mostly used in |Normal-mode| or |Cmdline-mode|). | |
1233 esc hitting <Esc> in |Normal-mode|. | |
1234 ex In |Visual-mode|, hitting |Q| results in an error. | |
18719 | 1235 hangul Ignored. |
6949 | 1236 insertmode Pressing <Esc> in 'insertmode'. |
1237 lang Calling the beep module for Lua/Mzscheme/TCL. | |
1238 mess No output available for |g<|. | |
1239 showmatch Error occurred for 'showmatch' function. | |
1240 operator Empty region error |cpo-E|. | |
1241 register Unknown register after <C-R> in |Insert-mode|. | |
1242 shell Bell from shell output |:!|. | |
1243 spell Error happened on spell suggest. | |
1244 wildmode More matches in |cmdline-completion| available | |
1245 (depends on the 'wildmode' setting). | |
1246 | |
11160 | 1247 This is most useful to fine tune when in Insert mode the bell should |
1248 be rung. For Normal mode and Ex commands, the bell is often rung to | |
6949 | 1249 indicate that an error occurred. It can be silenced by adding the |
1250 "error" keyword. | |
1251 | |
7 | 1252 *'binary'* *'bin'* *'nobinary'* *'nobin'* |
1253 'binary' 'bin' boolean (default off) | |
1254 local to buffer | |
1255 This option should be set before editing a binary file. You can also | |
1256 use the |-b| Vim argument. When this option is switched on a few | |
1257 options will be changed (also when it already was on): | |
1258 'textwidth' will be set to 0 | |
1259 'wrapmargin' will be set to 0 | |
1260 'modeline' will be off | |
1261 'expandtab' will be off | |
1262 Also, 'fileformat' and 'fileformats' options will not be used, the | |
1263 file is read and written like 'fileformat' was "unix" (a single <NL> | |
1264 separates lines). | |
1265 The 'fileencoding' and 'fileencodings' options will not be used, the | |
1266 file is read without conversion. | |
1267 NOTE: When you start editing a(nother) file while the 'bin' option is | |
1268 on, settings from autocommands may change the settings again (e.g., | |
1269 'textwidth'), causing trouble when editing. You might want to set | |
1270 'bin' again when the file has been loaded. | |
1271 The previous values of these options are remembered and restored when | |
1272 'bin' is switched from on to off. Each buffer has its own set of | |
1273 saved option values. | |
1274 To edit a file with 'binary' set you can use the |++bin| argument. | |
1275 This avoids you have to do ":set bin", which would have effect for all | |
1276 files you edit. | |
1277 When writing a file the <EOL> for the last line is only written if | |
1278 there was one in the original file (normally Vim appends an <EOL> to | |
1279 the last line if there is none; this would make the file longer). See | |
1280 the 'endofline' option. | |
1281 | |
1282 *'bioskey'* *'biosk'* *'nobioskey'* *'nobiosk'* | |
1283 'bioskey' 'biosk' boolean (default on) | |
1284 global | |
16443
32a543152dc0
patch 8.1.1226: {not in Vi} remarks get in the way of useful help text
Bram Moolenaar <Bram@vim.org>
parents:
16439
diff
changeset
|
1285 {only for MS-DOS} |
8246
f16bfe02cef1
commit https://github.com/vim/vim/commit/f391327adbbffb11180cf6038a92af1ed144e907
Christian Brabandt <cb@256bit.org>
parents:
8182
diff
changeset
|
1286 This was for MS-DOS and is no longer supported. |
7 | 1287 |
1288 *'bomb'* *'nobomb'* | |
1289 'bomb' boolean (default off) | |
1290 local to buffer | |
1291 When writing a file and the following conditions are met, a BOM (Byte | |
1292 Order Mark) is prepended to the file: | |
1293 - this option is on | |
1294 - the 'binary' option is off | |
1295 - 'fileencoding' is "utf-8", "ucs-2", "ucs-4" or one of the little/big | |
1296 endian variants. | |
1297 Some applications use the BOM to recognize the encoding of the file. | |
1298 Often used for UCS-2 files on MS-Windows. For other applications it | |
1299 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
|
1300 appear halfway the resulting file. Gcc doesn't accept a BOM. |
7 | 1301 When Vim reads a file and 'fileencodings' starts with "ucs-bom", a |
1302 check for the presence of the BOM is done and 'bomb' set accordingly. | |
1303 Unless 'binary' is set, it is removed from the first line, so that you | |
1304 don't see it when editing. When you don't change the options, the BOM | |
1305 will be restored when writing the file. | |
1306 | |
1307 *'breakat'* *'brk'* | |
1308 'breakat' 'brk' string (default " ^I!@*-+;:,./?") | |
1309 global | |
2570
71b56b4e7785
Make the references to features in the help more consistent. (Sylvain Hitier)
Bram Moolenaar <bram@vim.org>
parents:
2561
diff
changeset
|
1310 {not available when compiled without the |+linebreak| |
7 | 1311 feature} |
1312 This option lets you choose which characters might cause a line | |
500 | 1313 break if 'linebreak' is on. Only works for ASCII and also for 8-bit |
1314 characters when 'encoding' is an 8-bit encoding. | |
7 | 1315 |
8835
c1a5623cfc86
commit https://github.com/vim/vim/commit/7c1c6dbb6817640fd3956a0d5417da23fde336d8
Christian Brabandt <cb@256bit.org>
parents:
8748
diff
changeset
|
1316 *'breakindent'* *'bri'* *'nobreakindent'* *'nobri'* |
6009 | 1317 'breakindent' 'bri' boolean (default off) |
1318 local to window | |
1319 {not available when compiled without the |+linebreak| | |
1320 feature} | |
1321 Every wrapped line will continue visually indented (same amount of | |
1322 space as the beginning of that line), thus preserving horizontal blocks | |
1323 of text. | |
11160 | 1324 NOTE: This option is reset when 'compatible' is set. |
6009 | 1325 |
1326 *'breakindentopt'* *'briopt'* | |
1327 'breakindentopt' 'briopt' string (default empty) | |
1328 local to window | |
1329 {not available when compiled without the |+linebreak| | |
1330 feature} | |
1331 Settings for 'breakindent'. It can consist of the following optional | |
6026 | 1332 items and must be separated by a comma: |
6009 | 1333 min:{n} Minimum text width that will be kept after |
1334 applying 'breakindent', even if the resulting | |
1335 text should normally be narrower. This prevents | |
1336 text indented almost to the right window border | |
1337 occupying lot of vertical space when broken. | |
6026 | 1338 shift:{n} After applying 'breakindent', the wrapped line's |
1339 beginning will be shifted by the given number of | |
1340 characters. It permits dynamic French paragraph | |
6009 | 1341 indentation (negative) or emphasizing the line |
1342 continuation (positive). | |
13341
acd7eaa13d2b
Updated runtime files.
Christian Brabandt <cb@256bit.org>
parents:
13314
diff
changeset
|
1343 sbr Display the 'showbreak' value before applying the |
6009 | 1344 additional indent. |
25322
b3d7becabe99
patch 8.2.3198: cannot use 'formatlistpat' for breakindent
Bram Moolenaar <Bram@vim.org>
parents:
25248
diff
changeset
|
1345 list:{n} Adds an additional indent for lines that match a |
25248
cf0774d010b7
patch 8.2.3160: 'breakindent' does not work well for bulleted lists
Bram Moolenaar <Bram@vim.org>
parents:
25084
diff
changeset
|
1346 numbered or bulleted list (using the |
cf0774d010b7
patch 8.2.3160: 'breakindent' does not work well for bulleted lists
Bram Moolenaar <Bram@vim.org>
parents:
25084
diff
changeset
|
1347 'formatlistpat' setting). |
25322
b3d7becabe99
patch 8.2.3198: cannot use 'formatlistpat' for breakindent
Bram Moolenaar <Bram@vim.org>
parents:
25248
diff
changeset
|
1348 list:-1 Uses the length of a match with 'formatlistpat' |
b3d7becabe99
patch 8.2.3198: cannot use 'formatlistpat' for breakindent
Bram Moolenaar <Bram@vim.org>
parents:
25248
diff
changeset
|
1349 for indentation. |
25248
cf0774d010b7
patch 8.2.3160: 'breakindent' does not work well for bulleted lists
Bram Moolenaar <Bram@vim.org>
parents:
25084
diff
changeset
|
1350 The default value for min is 20, shift and list is 0. |
6009 | 1351 |
7 | 1352 *'browsedir'* *'bsdir'* |
29 | 1353 'browsedir' 'bsdir' string (default: "last") |
7 | 1354 global |
16443
32a543152dc0
patch 8.1.1226: {not in Vi} remarks get in the way of useful help text
Bram Moolenaar <Bram@vim.org>
parents:
16439
diff
changeset
|
1355 {only for Motif, Athena, GTK, Mac and Win32 GUI} |
7 | 1356 Which directory to use for the file browser: |
1621 | 1357 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
|
1358 file was opened or saved. |
7 | 1359 buffer Use the directory of the related buffer. |
1360 current Use the current directory. | |
1361 {path} Use the specified directory | |
1362 | |
1363 *'bufhidden'* *'bh'* | |
1364 'bufhidden' 'bh' string (default: "") | |
1365 local to buffer | |
1366 This option specifies what happens when a buffer is no longer | |
1367 displayed in a window: | |
1368 <empty> follow the global 'hidden' option | |
1369 hide hide the buffer (don't unload it), also when 'hidden' | |
1370 is not set | |
1371 unload unload the buffer, also when 'hidden' is set or using | |
1372 |:hide| | |
1373 delete delete the buffer from the buffer list, also when | |
1374 'hidden' is set or using |:hide|, like using | |
1375 |:bdelete| | |
1376 wipe wipe out the buffer from the buffer list, also when | |
1377 'hidden' is set or using |:hide|, like using | |
1378 |:bwipeout| | |
1379 | |
82 | 1380 CAREFUL: when "unload", "delete" or "wipe" is used changes in a buffer |
3224 | 1381 are lost without a warning. Also, these values may break autocommands |
1382 that switch between buffers temporarily. | |
7 | 1383 This option is used together with 'buftype' and 'swapfile' to specify |
1384 special kinds of buffers. See |special-buffers|. | |
1385 | |
1386 *'buflisted'* *'bl'* *'nobuflisted'* *'nobl'* *E85* | |
1387 'buflisted' 'bl' boolean (default: on) | |
1388 local to buffer | |
1389 When this option is set, the buffer shows up in the buffer list. If | |
1390 it is reset it is not used for ":bnext", "ls", the Buffers menu, etc. | |
1391 This option is reset by Vim for buffers that are only used to remember | |
1392 a file name or marks. Vim sets it when starting to edit a buffer. | |
1393 But not when moving to a buffer with ":buffer". | |
1394 | |
1395 *'buftype'* *'bt'* *E382* | |
1396 'buftype' 'bt' string (default: "") | |
1397 local to buffer | |
1398 The value of this option specifies the type of a buffer: | |
1399 <empty> normal buffer | |
1400 nofile buffer which is not related to a file and will not be | |
1401 written | |
1402 nowrite buffer which will not be written | |
17 | 1403 acwrite buffer which will always be written with BufWriteCmd |
13437 | 1404 autocommands. |
7 | 1405 quickfix quickfix buffer, contains list of errors |:cwindow| |
648 | 1406 or list of locations |:lwindow| |
7 | 1407 help help buffer (you are not supposed to set this |
1408 manually) | |
11757
74abb6c84984
patch 8.0.0761: options not set properly for a terminal buffer
Christian Brabandt <cb@256bit.org>
parents:
11666
diff
changeset
|
1409 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
|
1410 this manually) |
14019
dc67449d648c
patch 8.1.0027: difficult to make a plugin that feeds a line to a job
Christian Brabandt <cb@256bit.org>
parents:
14006
diff
changeset
|
1411 prompt buffer where only the last line can be edited, meant |
dc67449d648c
patch 8.1.0027: difficult to make a plugin that feeds a line to a job
Christian Brabandt <cb@256bit.org>
parents:
14006
diff
changeset
|
1412 to be used by a plugin, see |prompt-buffer| |
dc67449d648c
patch 8.1.0027: difficult to make a plugin that feeds a line to a job
Christian Brabandt <cb@256bit.org>
parents:
14006
diff
changeset
|
1413 {only when compiled with the |+channel| feature} |
16778
eda4d65f232c
patch 8.1.1391: no popup window support
Bram Moolenaar <Bram@vim.org>
parents:
16740
diff
changeset
|
1414 popup buffer used in a popup window, see |popup|. |
eda4d65f232c
patch 8.1.1391: no popup window support
Bram Moolenaar <Bram@vim.org>
parents:
16740
diff
changeset
|
1415 {only when compiled with the |+textprop| feature} |
7 | 1416 |
1417 This option is used together with 'bufhidden' and 'swapfile' to | |
1418 specify special kinds of buffers. See |special-buffers|. | |
19404 | 1419 Also see |win_gettype()|, which returns the type of the window. |
7 | 1420 |
1421 Be careful with changing this option, it can have many side effects! | |
1422 | |
648 | 1423 A "quickfix" buffer is only used for the error list and the location |
1424 list. This value is set by the |:cwindow| and |:lwindow| commands and | |
1425 you are not supposed to change it. | |
7 | 1426 |
1427 "nofile" and "nowrite" buffers are similar: | |
1428 both: The buffer is not to be written to disk, ":w" doesn't | |
1429 work (":w filename" does work though). | |
1430 both: The buffer is never considered to be |'modified'|. | |
1431 There is no warning when the changes will be lost, for | |
1432 example when you quit Vim. | |
1433 both: A swap file is only created when using too much memory | |
1434 (when 'swapfile' has been reset there is never a swap | |
1435 file). | |
1436 nofile only: The buffer name is fixed, it is not handled like a | |
1437 file name. It is not modified in response to a |:cd| | |
1438 command. | |
6647 | 1439 both: When using ":e bufname" and already editing "bufname" |
1440 the buffer is made empty and autocommands are | |
1441 triggered as usual for |:edit|. | |
17 | 1442 *E676* |
1443 "acwrite" implies that the buffer name is not related to a file, like | |
1444 "nofile", but it will be written. Thus, in contrast to "nofile" and | |
1445 "nowrite", ":w" does work and a modified buffer can't be abandoned | |
1446 without saving. For writing there must be matching |BufWriteCmd|, | |
1447 |FileWriteCmd| or |FileAppendCmd| autocommands. | |
7 | 1448 |
1449 *'casemap'* *'cmp'* | |
1450 'casemap' 'cmp' string (default: "internal,keepascii") | |
1451 global | |
1452 Specifies details about changing the case of letters. It may contain | |
1453 these words, separated by a comma: | |
1454 internal Use internal case mapping functions, the current | |
1455 locale does not change the case mapping. This only | |
493 | 1456 matters when 'encoding' is a Unicode encoding, |
1457 "latin1" or "iso-8859-15". When "internal" is | |
1458 omitted, the towupper() and towlower() system library | |
1459 functions are used when available. | |
7 | 1460 keepascii For the ASCII characters (0x00 to 0x7f) use the US |
1461 case mapping, the current locale is not effective. | |
1462 This probably only matters for Turkish. | |
1463 | |
1464 *'cdpath'* *'cd'* *E344* *E346* | |
1465 'cdpath' 'cd' string (default: equivalent to $CDPATH or ",,") | |
1466 global | |
1467 {not available when compiled without the | |
1468 |+file_in_path| feature} | |
1469 This is a list of directories which will be searched when using the | |
16427
8c3a1bd270bb
patch 8.1.1218: cannot set a directory for a tab page
Bram Moolenaar <Bram@vim.org>
parents:
16380
diff
changeset
|
1470 |:cd|, |:tcd| and |:lcd| commands, provided that the directory being |
8c3a1bd270bb
patch 8.1.1218: cannot set a directory for a tab page
Bram Moolenaar <Bram@vim.org>
parents:
16380
diff
changeset
|
1471 searched for has a relative path, not an absolute part starting with |
8c3a1bd270bb
patch 8.1.1218: cannot set a directory for a tab page
Bram Moolenaar <Bram@vim.org>
parents:
16380
diff
changeset
|
1472 "/", "./" or "../", the 'cdpath' option is not used then. |
7 | 1473 The 'cdpath' option's value has the same form and semantics as |
1474 |'path'|. Also see |file-searching|. | |
1475 The default value is taken from $CDPATH, with a "," prepended to look | |
1476 in the current directory first. | |
1477 If the default value taken from $CDPATH is not what you want, include | |
1478 a modified version of the following command in your vimrc file to | |
1479 override it: > | |
1480 :let &cdpath = ',' . substitute(substitute($CDPATH, '[, ]', '\\\0', 'g'), ':', ',', 'g') | |
1481 < This option cannot be set from a |modeline| or in the |sandbox|, for | |
1482 security reasons. | |
1483 (parts of 'cdpath' can be passed to the shell to expand file names). | |
1484 | |
1485 *'cedit'* | |
1486 'cedit' string (Vi default: "", Vim default: CTRL-F) | |
1487 global | |
1488 The key used in Command-line Mode to open the command-line window. | |
1489 The default is CTRL-F when 'compatible' is off. | |
1490 Only non-printable keys are allowed. | |
1491 The key can be specified as a single character, but it is difficult to | |
1492 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
|
1493 :exe "set cedit=\<C-Y>" |
619a98a67f67
commit https://github.com/vim/vim/commit/e18dbe865d190e74fb5d43ac8bc6ac22507d0223
Christian Brabandt <cb@256bit.org>
parents:
9344
diff
changeset
|
1494 :exe "set cedit=\<Esc>" |
7 | 1495 < |Nvi| also has this option, but it only uses the first character. |
1496 See |cmdwin|. | |
11160 | 1497 NOTE: This option is set to the Vim default value when 'compatible' |
1498 is reset. | |
7 | 1499 |
1500 *'charconvert'* *'ccv'* *E202* *E214* *E513* | |
1501 'charconvert' 'ccv' string (default "") | |
1502 global | |
15878 | 1503 {only available when compiled with the |+eval| feature} |
7 | 1504 An expression that is used for character encoding conversion. It is |
1505 evaluated when a file that is to be read or has been written has a | |
1506 different encoding from what is desired. | |
1507 'charconvert' is not used when the internal iconv() function is | |
1508 supported and is able to do the conversion. Using iconv() is | |
1509 preferred, because it is much faster. | |
1510 'charconvert' is not used when reading stdin |--|, because there is no | |
1511 file to convert from. You will have to save the text in a file first. | |
1512 The expression must return zero or an empty string for success, | |
1513 non-zero for failure. | |
1514 The possible encoding names encountered are in 'encoding'. | |
1515 Additionally, names given in 'fileencodings' and 'fileencoding' are | |
1516 used. | |
1517 Conversion between "latin1", "unicode", "ucs-2", "ucs-4" and "utf-8" | |
1518 is done internally by Vim, 'charconvert' is not used for this. | |
1519 'charconvert' is also used to convert the viminfo file, if the 'c' | |
1520 flag is present in 'viminfo'. Also used for Unicode conversion. | |
1521 Example: > | |
1522 set charconvert=CharConvert() | |
1523 fun CharConvert() | |
1524 system("recode " | |
1525 \ . v:charconvert_from . ".." . v:charconvert_to | |
1526 \ . " <" . v:fname_in . " >" v:fname_out) | |
1527 return v:shell_error | |
1528 endfun | |
1529 < The related Vim variables are: | |
1530 v:charconvert_from name of the current encoding | |
1531 v:charconvert_to name of the desired encoding | |
1532 v:fname_in name of the input file | |
1533 v:fname_out name of the output file | |
1534 Note that v:fname_in and v:fname_out will never be the same. | |
1535 Note that v:charconvert_from and v:charconvert_to may be different | |
1536 from 'encoding'. Vim internally uses UTF-8 instead of UCS-2 or UCS-4. | |
1537 Encryption is not done by Vim when using 'charconvert'. If you want | |
1538 to encrypt the file after conversion, 'charconvert' should take care | |
1539 of this. | |
1540 This option cannot be set from a |modeline| or in the |sandbox|, for | |
1541 security reasons. | |
1542 | |
1543 *'cindent'* *'cin'* *'nocindent'* *'nocin'* | |
1544 'cindent' 'cin' boolean (default off) | |
1545 local to buffer | |
1546 {not available when compiled without the |+cindent| | |
1547 feature} | |
1621 | 1548 Enables automatic C program indenting. See 'cinkeys' to set the keys |
7 | 1549 that trigger reindenting in insert mode and 'cinoptions' to set your |
1550 preferred indent style. | |
1551 If 'indentexpr' is not empty, it overrules 'cindent'. | |
1552 If 'lisp' is not on and both 'indentexpr' and 'equalprg' are empty, | |
1553 the "=" operator indents using this algorithm rather than calling an | |
1554 external program. | |
1555 See |C-indenting|. | |
1556 When you don't like the way 'cindent' works, try the 'smartindent' | |
1557 option or 'indentexpr'. | |
1558 This option is not used when 'paste' is set. | |
1559 NOTE: This option is reset when 'compatible' is set. | |
1560 | |
1561 *'cinkeys'* *'cink'* | |
15701
9cd11f6beb70
patch 8.1.0858: 'indentkeys' and 'cinkeys' defaults are different
Bram Moolenaar <Bram@vim.org>
parents:
15512
diff
changeset
|
1562 'cinkeys' 'cink' string (default "0{,0},0),0],:,0#,!^F,o,O,e") |
7 | 1563 local to buffer |
1564 {not available when compiled without the |+cindent| | |
1565 feature} | |
1566 A list of keys that, when typed in Insert mode, cause reindenting of | |
1567 the current line. Only used if 'cindent' is on and 'indentexpr' is | |
1568 empty. | |
1569 For the format of this option see |cinkeys-format|. | |
1570 See |C-indenting|. | |
1571 | |
1572 *'cinoptions'* *'cino'* | |
1573 'cinoptions' 'cino' string (default "") | |
1574 local to buffer | |
1575 {not available when compiled without the |+cindent| | |
1576 feature} | |
1577 The 'cinoptions' affect the way 'cindent' reindents lines in a C | |
1578 program. See |cinoptions-values| for the values of this option, and | |
1579 |C-indenting| for info on C indenting in general. | |
1580 | |
1581 | |
1582 *'cinwords'* *'cinw'* | |
1583 'cinwords' 'cinw' string (default "if,else,while,do,for,switch") | |
1584 local to buffer | |
1585 {not available when compiled without both the | |
1586 |+cindent| and the |+smartindent| features} | |
1587 These keywords start an extra indent in the next line when | |
1588 'smartindent' or 'cindent' is set. For 'cindent' this is only done at | |
1589 an appropriate place (inside {}). | |
1590 Note that 'ignorecase' isn't used for 'cinwords'. If case doesn't | |
1591 matter, include the keyword both the uppercase and lowercase: | |
1592 "if,If,IF". | |
1593 | |
1594 *'clipboard'* *'cb'* | |
1595 'clipboard' 'cb' string (default "autoselect,exclude:cons\|linux" | |
1596 for X-windows, "" otherwise) | |
1597 global | |
1598 {only in GUI versions or when the |+xterm_clipboard| | |
1599 feature is included} | |
1600 This option is a list of comma separated names. | |
23931 | 1601 Note: if one of the items is "exclude:", then you can't add an item |
1602 after that. Therefore do append an item with += but use ^= to | |
1603 prepend, e.g.: > | |
1604 set clipboard^=unnamed | |
1605 < These names are recognized: | |
7 | 1606 |
3674 | 1607 *clipboard-unnamed* |
7 | 1608 unnamed When included, Vim will use the clipboard register '*' |
1609 for all yank, delete, change and put operations which | |
1610 would normally go to the unnamed register. When a | |
1611 register is explicitly specified, it will always be | |
1612 used regardless of whether "unnamed" is in 'clipboard' | |
1613 or not. The clipboard register can always be | |
1614 explicitly accessed using the "* notation. Also see | |
1615 |gui-clipboard|. | |
1616 | |
3682 | 1617 *clipboard-unnamedplus* |
4119 | 1618 unnamedplus A variant of the "unnamed" flag which uses the |
1619 clipboard register '+' (|quoteplus|) instead of | |
1620 register '*' for all yank, delete, change and put | |
1621 operations which would normally go to the unnamed | |
1622 register. When "unnamed" is also included to the | |
1623 option, yank operations (but not delete, change or | |
1624 put) will additionally copy the text into register | |
1625 '*'. | |
2662 | 1626 Only available with the |+X11| feature. |
2654 | 1627 Availability can be checked with: > |
1628 if has('unnamedplus') | |
1629 < | |
3682 | 1630 *clipboard-autoselect* |
7 | 1631 autoselect Works like the 'a' flag in 'guioptions': If present, |
1632 then whenever Visual mode is started, or the Visual | |
1633 area extended, Vim tries to become the owner of the | |
1634 windowing system's global selection or put the | |
1635 selected text on the clipboard used by the selection | |
14999 | 1636 register "*. See |'go-a'| and |quotestar| for details. |
1637 When the GUI is active, the 'a' flag in 'guioptions' | |
1638 is used, when the GUI is not active, this "autoselect" | |
1639 flag is used. | |
7 | 1640 Also applies to the modeless selection. |
1641 | |
3674 | 1642 *clipboard-autoselectplus* |
1643 autoselectplus Like "autoselect" but using the + register instead of | |
1644 the * register. Compare to the 'P' flag in | |
1645 'guioptions'. | |
1646 | |
1647 *clipboard-autoselectml* | |
7 | 1648 autoselectml Like "autoselect", but for the modeless selection |
1649 only. Compare to the 'A' flag in 'guioptions'. | |
1650 | |
3674 | 1651 *clipboard-html* |
1904 | 1652 html When the clipboard contains HTML, use this when |
1653 pasting. When putting text on the clipboard, mark it | |
1654 as HTML. This works to copy rendered HTML from | |
1655 Firefox, paste it as raw HTML in Vim, select the HTML | |
1656 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
|
1657 You probably want to add this only temporarily, |
6b4879aea261
Add test for gettabvar() and settabvar().
Bram Moolenaar <bram@vim.org>
parents:
2220
diff
changeset
|
1658 possibly use BufEnter autocommands. |
1904 | 1659 Only supported for GTK version 2 and later. |
1660 | |
3674 | 1661 *clipboard-exclude* |
7 | 1662 exclude:{pattern} |
1663 Defines a pattern that is matched against the name of | |
1664 the terminal 'term'. If there is a match, no | |
1665 connection will be made to the X server. This is | |
1666 useful in this situation: | |
1667 - Running Vim in a console. | |
1668 - $DISPLAY is set to start applications on another | |
1669 display. | |
1670 - You do not want to connect to the X server in the | |
1671 console, but do want this in a terminal emulator. | |
1672 To never connect to the X server use: > | |
1673 exclude:.* | |
1674 < This has the same effect as using the |-X| argument. | |
1675 Note that when there is no connection to the X server | |
1676 the window title won't be restored and the clipboard | |
1677 cannot be accessed. | |
1678 The value of 'magic' is ignored, {pattern} is | |
1679 interpreted as if 'magic' was on. | |
1680 The rest of the option value will be used for | |
1681 {pattern}, this must be the last entry. | |
1682 | |
1683 *'cmdheight'* *'ch'* | |
1684 'cmdheight' 'ch' number (default 1) | |
1685 global | |
1686 Number of screen lines to use for the command-line. Helps avoiding | |
1687 |hit-enter| prompts. | |
824 | 1688 The value of this option is stored with the tab page, so that each tab |
1689 page can have a different value. | |
7 | 1690 |
1691 *'cmdwinheight'* *'cwh'* | |
1692 'cmdwinheight' 'cwh' number (default 7) | |
1693 global | |
1694 Number of screen lines to use for the command-line window. |cmdwin| | |
1695 | |
2608
7d8af31066c8
Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents:
2607
diff
changeset
|
1696 *'colorcolumn'* *'cc'* |
7d8af31066c8
Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents:
2607
diff
changeset
|
1697 'colorcolumn' 'cc' string (default "") |
7d8af31066c8
Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents:
2607
diff
changeset
|
1698 local to window |
7d8af31066c8
Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents:
2607
diff
changeset
|
1699 {not available when compiled without the |+syntax| |
7d8af31066c8
Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents:
2607
diff
changeset
|
1700 feature} |
7d8af31066c8
Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents:
2607
diff
changeset
|
1701 '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
|
1702 highlighted with ColorColumn |hl-ColorColumn|. Useful to align |
7d8af31066c8
Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents:
2607
diff
changeset
|
1703 text. Will make screen redrawing slower. |
7d8af31066c8
Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents:
2607
diff
changeset
|
1704 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
|
1705 '+' or '-', which is added to or subtracted from 'textwidth'. > |
7d8af31066c8
Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents:
2607
diff
changeset
|
1706 |
7d8af31066c8
Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents:
2607
diff
changeset
|
1707 :set cc=+1 " highlight column after 'textwidth' |
7d8af31066c8
Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents:
2607
diff
changeset
|
1708 :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
|
1709 :hi ColorColumn ctermbg=lightgrey guibg=lightgrey |
7d8af31066c8
Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents:
2607
diff
changeset
|
1710 < |
7d8af31066c8
Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents:
2607
diff
changeset
|
1711 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
|
1712 A maximum of 256 columns are highlighted. |
7d8af31066c8
Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents:
2607
diff
changeset
|
1713 |
7 | 1714 *'columns'* *'co'* *E594* |
1715 'columns' 'co' number (default 80 or terminal width) | |
1716 global | |
1717 Number of columns of the screen. Normally this is set by the terminal | |
161 | 1718 initialization and does not have to be set by hand. Also see |
1719 |posix-screen-size|. | |
7 | 1720 When Vim is running in the GUI or in a resizable window, setting this |
1721 option will cause the window size to be changed. When you only want | |
1722 to use the size for the GUI, put the command in your |gvimrc| file. | |
1723 When you set this option and Vim is unable to change the physical | |
1152 | 1724 number of columns of the display, the display may be messed up. For |
1725 the GUI it is always possible and Vim limits the number of columns to | |
1726 what fits on the screen. You can use this command to get the widest | |
1727 window possible: > | |
1728 :set columns=9999 | |
1729 < Minimum value is 12, maximum value is 10000. | |
7 | 1730 |
1731 *'comments'* *'com'* *E524* *E525* | |
1732 'comments' 'com' string (default | |
1733 "s1:/*,mb:*,ex:*/,://,b:#,:%,:XCOMM,n:>,fb:-") | |
1734 local to buffer | |
1735 A comma separated list of strings that can start a comment line. See | |
1736 |format-comments|. See |option-backslash| about using backslashes to | |
1737 insert a space. | |
1738 | |
1739 *'commentstring'* *'cms'* *E537* | |
1740 'commentstring' 'cms' string (default "/*%s*/") | |
1741 local to buffer | |
1742 {not available when compiled without the |+folding| | |
1743 feature} | |
1744 A template for a comment. The "%s" in the value is replaced with the | |
1745 comment text. Currently only used to add markers for folding, see | |
1746 |fold-marker|. | |
1747 | |
1748 *'compatible'* *'cp'* *'nocompatible'* *'nocp'* | |
819 | 1749 '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
|
1750 file is found, reset in |defaults.vim|) |
7 | 1751 global |
1752 This option has the effect of making Vim either more Vi-compatible, or | |
1753 make Vim behave in a more useful way. | |
11062 | 1754 |
7 | 1755 This is a special kind of option, because when it's set or reset, |
11062 | 1756 other options are also changed as a side effect. |
1757 NOTE: Setting or resetting this option can have a lot of unexpected | |
1758 effects: Mappings are interpreted in another way, undo behaves | |
1759 differently, etc. If you set this option in your vimrc file, you | |
1760 should probably put it at the very start. | |
1761 | |
7 | 1762 By default this option is on and the Vi defaults are used for the |
1763 options. This default was chosen for those people who want to use Vim | |
1764 just like Vi, and don't even (want to) know about the 'compatible' | |
1765 option. | |
819 | 1766 When a |vimrc| or |gvimrc| file is found while Vim is starting up, |
378 | 1767 this option is switched off, and all options that have not been |
1768 modified will be set to the Vim defaults. Effectively, this means | |
819 | 1769 that when a |vimrc| or |gvimrc| file exists, Vim will use the Vim |
378 | 1770 defaults, otherwise it will use the Vi defaults. (Note: This doesn't |
1152 | 1771 happen for the system-wide vimrc or gvimrc file, nor for a file given |
1772 with the |-u| argument). Also see |compatible-default| and | |
1773 |posix-compliance|. | |
7 | 1774 You can also set this option with the "-C" argument, and reset it with |
1775 "-N". See |-C| and |-N|. | |
11062 | 1776 See 'cpoptions' for more fine tuning of Vi compatibility. |
1777 | |
1778 When this option is set, numerous other options are set to make Vim as | |
1779 Vi-compatible as possible. When this option is unset, various options | |
1780 are set to make Vim more useful. The table below lists all the | |
1781 options affected. | |
1782 The {?} column indicates when the options are affected: | |
1783 + Means that the option is set to the value given in {set value} when | |
1784 'compatible' is set. | |
1785 & Means that the option is set to the value given in {set value} when | |
1786 'compatible' is set AND is set to its Vim default value when | |
1787 'compatible' is unset. | |
1788 - Means the option is NOT changed when setting 'compatible' but IS | |
1789 set to its Vim default when 'compatible' is unset. | |
1790 The {effect} column summarises the change when 'compatible' is set. | |
1791 | |
11160 | 1792 option ? set value effect ~ |
11062 | 1793 |
1794 'allowrevins' + off no CTRL-_ command | |
1795 'antialias' + off don't use antialiased fonts | |
1796 'arabic' + off reset arabic-related options | |
1797 'arabicshape' + on correct character shapes | |
1798 'backspace' + "" normal backspace | |
1799 'backup' + off no backup file | |
1800 'backupcopy' & Unix: "yes" backup file is a copy | |
1801 else: "auto" copy or rename backup file | |
1802 'balloonexpr' + "" text to show in evaluation balloon | |
1803 'breakindent' + off don't indent when wrapping lines | |
1804 'cedit' - {unchanged} {set vim default only on resetting 'cp'} | |
1805 'cindent' + off no C code indentation | |
1806 'compatible' - {unchanged} {set vim default only on resetting 'cp'} | |
1807 'copyindent' + off don't copy indent structure | |
1808 'cpoptions' & (all flags) Vi-compatible flags | |
1809 'cscopepathcomp'+ 0 don't show directories in tags list | |
13341
acd7eaa13d2b
Updated runtime files.
Christian Brabandt <cb@256bit.org>
parents:
13314
diff
changeset
|
1810 'cscoperelative'+ off don't use basename of path as prefix |
11062 | 1811 'cscopetag' + off don't use cscope for ":tag" |
11160 | 1812 'cscopetagorder'+ 0 see |cscopetagorder| |
11062 | 1813 'cscopeverbose' + off see |cscopeverbose| |
1814 'delcombine' + off unicode: delete whole char combination | |
1815 'digraph' + off no digraphs | |
1816 'esckeys' & off no <Esc>-keys in Insert mode | |
1817 'expandtab' + off tabs not expanded to spaces | |
1818 'fileformats' & "" no automatic file format detection, | |
18912
ccd16426a1f9
patch 8.2.0017: OS/2 and MS-DOS are still mentioned
Bram Moolenaar <Bram@vim.org>
parents:
18879
diff
changeset
|
1819 "dos,unix" except for MS-Windows |
11062 | 1820 'formatexpr' + "" use 'formatprg' for auto-formatting |
1821 'formatoptions' & "vt" Vi compatible formatting | |
1822 'gdefault' + off no default 'g' flag for ":s" | |
1823 'history' & 0 no commandline history | |
1824 'hkmap' + off no Hebrew keyboard mapping | |
1825 'hkmapp' + off no phonetic Hebrew keyboard mapping | |
1826 'hlsearch' + off no highlighting of search matches | |
1827 'incsearch' + off no incremental searching | |
1828 'indentexpr' + "" no indenting by expression | |
1829 'insertmode' + off do not start in Insert mode | |
1830 'iskeyword' & "@,48-57,_" keywords contain alphanumeric | |
7 | 1831 characters and '_' |
11062 | 1832 'joinspaces' + on insert 2 spaces after period |
1833 'modeline' & off no modelines | |
1834 'more' & off no pauses in listings | |
1835 'mzquantum' - {unchanged} {set vim default only on resetting 'cp'} | |
1836 'numberwidth' & 8 min number of columns for line number | |
1837 'preserveindent'+ off don't preserve current indent structure | |
1838 when changing it | |
1839 'revins' + off no reverse insert | |
1840 'ruler' + off no ruler | |
1841 'scrolljump' + 1 no jump scroll | |
1842 'scrolloff' + 0 no scroll offset | |
1843 'shelltemp' - {unchanged} {set vim default only on resetting 'cp'} | |
1844 'shiftround' + off indent not rounded to shiftwidth | |
16533
5e25171e0e75
patch 8.1.1270: cannot see current match position
Bram Moolenaar <Bram@vim.org>
parents:
16447
diff
changeset
|
1845 'shortmess' & "S" no shortening of messages |
11062 | 1846 'showcmd' & off command characters not shown |
1847 'showmode' & off current mode not shown | |
1848 'sidescrolloff' + 0 cursor moves to edge of screen in scroll | |
1849 'smartcase' + off no automatic ignore case switch | |
1850 'smartindent' + off no smart indentation | |
1851 'smarttab' + off no smart tab size | |
1852 'softtabstop' + 0 tabs are always 'tabstop' positions | |
1853 'startofline' + on goto startofline with some commands | |
1854 'tagcase' & "followic" 'ignorecase' when searching tags file | |
1855 'tagrelative' & off tag file names are not relative | |
1856 'termguicolors' + off don't use highlight-(guifg|guibg) | |
1857 'textauto' & off no automatic textmode detection | |
1858 'textwidth' + 0 no automatic line wrap | |
1859 'tildeop' + off tilde is not an operator | |
1860 'ttimeout' + off no terminal timeout | |
1861 'undofile' + off don't use an undo file | |
11160 | 1862 'viminfo' - {unchanged} {set Vim default only on resetting 'cp'} |
11062 | 1863 'virtualedit' + "" cursor can only be placed on characters |
1864 'whichwrap' & "" left-right movements don't wrap | |
1865 'wildchar' & CTRL-E only when the current value is <Tab> | |
7 | 1866 use CTRL-E for cmdline completion |
11062 | 1867 'writebackup' + on or off depends on the |+writebackup| feature |
7 | 1868 |
1869 *'complete'* *'cpt'* *E535* | |
1870 'complete' 'cpt' string (default: ".,w,b,u,t,i") | |
1871 local to buffer | |
1872 This option specifies how keyword completion |ins-completion| works | |
1873 when CTRL-P or CTRL-N are used. It is also used for whole-line | |
1874 completion |i_CTRL-X_CTRL-L|. It indicates the type of completion | |
1875 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
|
1876 . scan the current buffer ('wrapscan' is ignored) |
7 | 1877 w scan buffers from other windows |
1878 b scan other loaded buffers that are in the buffer list | |
1879 u scan the unloaded buffers that are in the buffer list | |
1880 U scan the buffers that are not in the buffer list | |
1881 k scan the files given with the 'dictionary' option | |
703 | 1882 kspell use the currently active spell checking |spell| |
7 | 1883 k{dict} scan the file {dict}. Several "k" flags can be given, |
1884 patterns are valid too. For example: > | |
1885 :set cpt=k/usr/dict/*,k~/spanish | |
1886 < s scan the files given with the 'thesaurus' option | |
1887 s{tsr} scan the file {tsr}. Several "s" flags can be given, patterns | |
1888 are valid too. | |
1889 i scan current and included files | |
1890 d scan current and included files for defined name or macro | |
1891 |i_CTRL-X_CTRL-D| | |
1892 ] tag completion | |
1893 t same as "]" | |
1894 | |
1895 Unloaded buffers are not loaded, thus their autocmds |:autocmd| are | |
1896 not executed, this may lead to unexpected completions from some files | |
1897 (gzipped files for example). Unloaded buffers are not scanned for | |
1898 whole-line completion. | |
1899 | |
1900 The default is ".,w,b,u,t,i", which means to scan: | |
1901 1. the current buffer | |
1902 2. buffers in other windows | |
1903 3. other loaded buffers | |
1904 4. unloaded buffers | |
1905 5. tags | |
1906 6. included files | |
1907 | |
1908 As you can see, CTRL-N and CTRL-P can be used to do any 'iskeyword'- | |
233 | 1909 based expansion (e.g., dictionary |i_CTRL-X_CTRL-K|, included patterns |
1910 |i_CTRL-X_CTRL-I|, tags |i_CTRL-X_CTRL-]| and normal expansions). | |
7 | 1911 |
12 | 1912 *'completefunc'* *'cfu'* |
1913 'completefunc' 'cfu' string (default: empty) | |
1914 local to buffer | |
2570
71b56b4e7785
Make the references to features in the help more consistent. (Sylvain Hitier)
Bram Moolenaar <bram@vim.org>
parents:
2561
diff
changeset
|
1915 {not available when compiled without the |+eval| |
17809
59f8948b7590
patch 8.1.1901: the +insert_expand feature is not always available
Bram Moolenaar <Bram@vim.org>
parents:
17771
diff
changeset
|
1916 feature} |
623 | 1917 This option specifies a function to be used for Insert mode completion |
1918 with CTRL-X CTRL-U. |i_CTRL-X_CTRL-U| | |
648 | 1919 See |complete-functions| for an explanation of how the function is |
1920 invoked and what it should return. | |
2642 | 1921 This option cannot be set from a |modeline| or in the |sandbox|, for |
1922 security reasons. | |
14 | 1923 |
17543
77c3f6428b6c
patch 8.1.1769: 'shellslash' is also used for completion
Bram Moolenaar <Bram@vim.org>
parents:
17433
diff
changeset
|
1924 *'completeslash'* *'csl'* |
77c3f6428b6c
patch 8.1.1769: 'shellslash' is also used for completion
Bram Moolenaar <Bram@vim.org>
parents:
17433
diff
changeset
|
1925 'completeslash' 'csl' string (default: "") |
77c3f6428b6c
patch 8.1.1769: 'shellslash' is also used for completion
Bram Moolenaar <Bram@vim.org>
parents:
17433
diff
changeset
|
1926 local to buffer |
18343 | 1927 {only for MS-Windows} |
17543
77c3f6428b6c
patch 8.1.1769: 'shellslash' is also used for completion
Bram Moolenaar <Bram@vim.org>
parents:
17433
diff
changeset
|
1928 When this option is set it overrules 'shellslash' for completion: |
77c3f6428b6c
patch 8.1.1769: 'shellslash' is also used for completion
Bram Moolenaar <Bram@vim.org>
parents:
17433
diff
changeset
|
1929 - When this option is set to "slash", a forward slash is used for path |
77c3f6428b6c
patch 8.1.1769: 'shellslash' is also used for completion
Bram Moolenaar <Bram@vim.org>
parents:
17433
diff
changeset
|
1930 completion in insert mode. This is useful when editing HTML tag, or |
18912
ccd16426a1f9
patch 8.2.0017: OS/2 and MS-DOS are still mentioned
Bram Moolenaar <Bram@vim.org>
parents:
18879
diff
changeset
|
1931 Makefile with 'noshellslash' on MS-Windows. |
17543
77c3f6428b6c
patch 8.1.1769: 'shellslash' is also used for completion
Bram Moolenaar <Bram@vim.org>
parents:
17433
diff
changeset
|
1932 - When this option is set to "backslash", backslash is used. This is |
18912
ccd16426a1f9
patch 8.2.0017: OS/2 and MS-DOS are still mentioned
Bram Moolenaar <Bram@vim.org>
parents:
18879
diff
changeset
|
1933 useful when editing a batch file with 'shellslash' set on MS-Windows. |
17543
77c3f6428b6c
patch 8.1.1769: 'shellslash' is also used for completion
Bram Moolenaar <Bram@vim.org>
parents:
17433
diff
changeset
|
1934 - When this option is empty, same character is used as for |
77c3f6428b6c
patch 8.1.1769: 'shellslash' is also used for completion
Bram Moolenaar <Bram@vim.org>
parents:
17433
diff
changeset
|
1935 'shellslash'. |
77c3f6428b6c
patch 8.1.1769: 'shellslash' is also used for completion
Bram Moolenaar <Bram@vim.org>
parents:
17433
diff
changeset
|
1936 For Insert mode completion the buffer-local value is used. For |
77c3f6428b6c
patch 8.1.1769: 'shellslash' is also used for completion
Bram Moolenaar <Bram@vim.org>
parents:
17433
diff
changeset
|
1937 command line completion the global value is used. |
77c3f6428b6c
patch 8.1.1769: 'shellslash' is also used for completion
Bram Moolenaar <Bram@vim.org>
parents:
17433
diff
changeset
|
1938 |
540 | 1939 *'completeopt'* *'cot'* |
730 | 1940 'completeopt' 'cot' string (default: "menu,preview") |
540 | 1941 global |
665 | 1942 A comma separated list of options for Insert mode completion |
1943 |ins-completion|. The supported values are: | |
540 | 1944 |
1945 menu Use a popup menu to show the possible completions. The | |
1946 menu is only shown when there is more than one match and | |
1947 sufficient colors are available. |ins-completion-menu| | |
1948 | |
707 | 1949 menuone Use the popup menu also when there is only one match. |
856 | 1950 Useful when there is additional information about the |
707 | 1951 match, e.g., what file it comes from. |
1952 | |
836 | 1953 longest Only insert the longest common text of the matches. If |
1954 the menu is displayed you can use CTRL-L to add more | |
1955 characters. Whether case is ignored depends on the kind | |
1956 of completion. For buffer text the 'ignorecase' option is | |
1957 used. | |
665 | 1958 |
730 | 1959 preview Show extra information about the currently selected |
1152 | 1960 completion in the preview window. Only works in |
1961 combination with "menu" or "menuone". | |
1962 | |
17767
c75da1064e33
patch 8.1.1880: cannot show extra info for completion in a popup window
Bram Moolenaar <Bram@vim.org>
parents:
17571
diff
changeset
|
1963 popup Show extra information about the currently selected |
c75da1064e33
patch 8.1.1880: cannot show extra info for completion in a popup window
Bram Moolenaar <Bram@vim.org>
parents:
17571
diff
changeset
|
1964 completion in a popup window. Only works in combination |
c75da1064e33
patch 8.1.1880: cannot show extra info for completion in a popup window
Bram Moolenaar <Bram@vim.org>
parents:
17571
diff
changeset
|
1965 with "menu" or "menuone". Overrides "preview". |
17771
4bd21046902b
patch 8.1.1882: cannot specify properties of the info popup window
Bram Moolenaar <Bram@vim.org>
parents:
17767
diff
changeset
|
1966 See |'completepopup'| for specifying properties. |
18343 | 1967 {only works when compiled with the |+textprop| feature} |
17767
c75da1064e33
patch 8.1.1880: cannot show extra info for completion in a popup window
Bram Moolenaar <Bram@vim.org>
parents:
17571
diff
changeset
|
1968 |
18396
ba5d8c5d77d7
patch 8.1.2192: cannot easily fill the info popup asynchronously
Bram Moolenaar <Bram@vim.org>
parents:
18372
diff
changeset
|
1969 popuphidden |
18719 | 1970 Just like "popup" but initially hide the popup. Use a |
18396
ba5d8c5d77d7
patch 8.1.2192: cannot easily fill the info popup asynchronously
Bram Moolenaar <Bram@vim.org>
parents:
18372
diff
changeset
|
1971 |CompleteChanged| autocommand to fetch the info and call |
ba5d8c5d77d7
patch 8.1.2192: cannot easily fill the info popup asynchronously
Bram Moolenaar <Bram@vim.org>
parents:
18372
diff
changeset
|
1972 |popup_show()| once the popup has been filled. |
ba5d8c5d77d7
patch 8.1.2192: cannot easily fill the info popup asynchronously
Bram Moolenaar <Bram@vim.org>
parents:
18372
diff
changeset
|
1973 See the example at |complete-popuphidden|. |
ba5d8c5d77d7
patch 8.1.2192: cannot easily fill the info popup asynchronously
Bram Moolenaar <Bram@vim.org>
parents:
18372
diff
changeset
|
1974 {only works when compiled with the |+textprop| feature} |
ba5d8c5d77d7
patch 8.1.2192: cannot easily fill the info popup asynchronously
Bram Moolenaar <Bram@vim.org>
parents:
18372
diff
changeset
|
1975 |
6911 | 1976 noinsert Do not insert any text for a match until the user selects |
1977 a match from the menu. Only works in combination with | |
1978 "menu" or "menuone". No effect if "longest" is present. | |
1979 | |
1980 noselect Do not select a match in the menu, force the user to | |
1981 select one from the menu. Only works in combination with | |
1982 "menu" or "menuone". | |
1983 | |
730 | 1984 |
17771
4bd21046902b
patch 8.1.1882: cannot specify properties of the info popup window
Bram Moolenaar <Bram@vim.org>
parents:
17767
diff
changeset
|
1985 *'completepopup'* *'cpp'* |
4bd21046902b
patch 8.1.1882: cannot specify properties of the info popup window
Bram Moolenaar <Bram@vim.org>
parents:
17767
diff
changeset
|
1986 'completepopup' 'cpp' string (default empty) |
4bd21046902b
patch 8.1.1882: cannot specify properties of the info popup window
Bram Moolenaar <Bram@vim.org>
parents:
17767
diff
changeset
|
1987 global |
4bd21046902b
patch 8.1.1882: cannot specify properties of the info popup window
Bram Moolenaar <Bram@vim.org>
parents:
17767
diff
changeset
|
1988 {not available when compiled without the |+textprop| |
4bd21046902b
patch 8.1.1882: cannot specify properties of the info popup window
Bram Moolenaar <Bram@vim.org>
parents:
17767
diff
changeset
|
1989 or |+quickfix| feature} |
4bd21046902b
patch 8.1.1882: cannot specify properties of the info popup window
Bram Moolenaar <Bram@vim.org>
parents:
17767
diff
changeset
|
1990 When 'completeopt' contains "popup" then this option is used for the |
21373
3d73cdd173ab
patch 8.2.1237: changing 'completepopup' after opening popup has no effect
Bram Moolenaar <Bram@vim.org>
parents:
21250
diff
changeset
|
1991 properties of the info popup when it is created. If an info popup |
3d73cdd173ab
patch 8.2.1237: changing 'completepopup' after opening popup has no effect
Bram Moolenaar <Bram@vim.org>
parents:
21250
diff
changeset
|
1992 window already exists it is closed, so that the option value is |
3d73cdd173ab
patch 8.2.1237: changing 'completepopup' after opening popup has no effect
Bram Moolenaar <Bram@vim.org>
parents:
21250
diff
changeset
|
1993 applied when it is created again. |
3d73cdd173ab
patch 8.2.1237: changing 'completepopup' after opening popup has no effect
Bram Moolenaar <Bram@vim.org>
parents:
21250
diff
changeset
|
1994 You can also use |popup_findinfo()| and then set properties for an |
3d73cdd173ab
patch 8.2.1237: changing 'completepopup' after opening popup has no effect
Bram Moolenaar <Bram@vim.org>
parents:
21250
diff
changeset
|
1995 existing info popup with |popup_setoptions()|. See |complete-popup|. |
17771
4bd21046902b
patch 8.1.1882: cannot specify properties of the info popup window
Bram Moolenaar <Bram@vim.org>
parents:
17767
diff
changeset
|
1996 |
4bd21046902b
patch 8.1.1882: cannot specify properties of the info popup window
Bram Moolenaar <Bram@vim.org>
parents:
17767
diff
changeset
|
1997 |
2378
85b7dc8da5eb
Add the 'concealcursor' option to decide when the cursor line is to be
Bram Moolenaar <bram@vim.org>
parents:
2365
diff
changeset
|
1998 *'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
|
1999 '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
|
2000 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
|
2001 {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
|
2002 feature} |
85b7dc8da5eb
Add the 'concealcursor' option to decide when the cursor line is to be
Bram Moolenaar <bram@vim.org>
parents:
2365
diff
changeset
|
2003 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
|
2004 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
|
2005 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
|
2006 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
|
2007 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
|
2008 i Insert mode |
2382
3a5ededa240a
Add the 'c' flag to 'concealcursor'.
Bram Moolenaar <bram@vim.org>
parents:
2380
diff
changeset
|
2009 c Command line editing, for 'incsearch' |
3a5ededa240a
Add the 'c' flag to 'concealcursor'.
Bram Moolenaar <bram@vim.org>
parents:
2380
diff
changeset
|
2010 |
2400
e6f1424dd66a
Let 'v' flag in 'concealcursor' apply to all lines in the Visual area.
Bram Moolenaar <bram@vim.org>
parents:
2394
diff
changeset
|
2011 '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
|
2012 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
|
2013 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
|
2014 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
|
2015 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
|
2016 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
|
2017 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
|
2018 |
85b7dc8da5eb
Add the 'concealcursor' option to decide when the cursor line is to be
Bram Moolenaar <bram@vim.org>
parents:
2365
diff
changeset
|
2019 |
14864 | 2020 *'conceallevel'* *'cole'* |
2021 'conceallevel' 'cole' number (default 0) | |
2250
1bac28a53fae
Add the conceal patch from Vince Negri.
Bram Moolenaar <bram@vim.org>
parents:
2249
diff
changeset
|
2022 local to window |
1bac28a53fae
Add the conceal patch from Vince Negri.
Bram Moolenaar <bram@vim.org>
parents:
2249
diff
changeset
|
2023 {not available when compiled without the |+conceal| |
1bac28a53fae
Add the conceal patch from Vince Negri.
Bram Moolenaar <bram@vim.org>
parents:
2249
diff
changeset
|
2024 feature} |
2340
99c1eba60b2d
Make automatic prototype generation work with more interfaces.
Bram Moolenaar <bram@vim.org>
parents:
2337
diff
changeset
|
2025 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
|
2026 is shown: |
99c1eba60b2d
Make automatic prototype generation work with more interfaces.
Bram Moolenaar <bram@vim.org>
parents:
2337
diff
changeset
|
2027 |
99c1eba60b2d
Make automatic prototype generation work with more interfaces.
Bram Moolenaar <bram@vim.org>
parents:
2337
diff
changeset
|
2028 Value Effect ~ |
2250
1bac28a53fae
Add the conceal patch from Vince Negri.
Bram Moolenaar <bram@vim.org>
parents:
2249
diff
changeset
|
2029 0 Text is shown normally |
2426 | 2030 1 Each block of concealed text is replaced with one |
2031 character. If the syntax item does not have a custom | |
2032 replacement character defined (see |:syn-cchar|) the | |
2033 character defined in 'listchars' is used (default is a | |
2034 space). | |
2035 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
|
2036 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
|
2037 custom replacement character defined (see |
2426 | 2038 |: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
|
2039 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
|
2040 |
586a459f3980
Never hide text for conceal in cursor line. Do hide when there is
Bram Moolenaar <bram@vim.org>
parents:
2348
diff
changeset
|
2041 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
|
2042 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
|
2043 option. |
2250
1bac28a53fae
Add the conceal patch from Vince Negri.
Bram Moolenaar <bram@vim.org>
parents:
2249
diff
changeset
|
2044 |
7 | 2045 *'confirm'* *'cf'* *'noconfirm'* *'nocf'* |
2046 'confirm' 'cf' boolean (default off) | |
2047 global | |
2048 When 'confirm' is on, certain operations that would normally | |
2049 fail because of unsaved changes to a buffer, e.g. ":q" and ":e", | |
2050 instead raise a |dialog| asking if you wish to save the current | |
2051 file(s). You can still use a ! to unconditionally |abandon| a buffer. | |
2052 If 'confirm' is off you can still activate confirmation for one | |
2053 command only (this is most useful in mappings) with the |:confirm| | |
2054 command. | |
2055 Also see the |confirm()| function and the 'v' flag in 'guioptions'. | |
2056 | |
2057 *'conskey'* *'consk'* *'noconskey'* *'noconsk'* | |
2058 'conskey' 'consk' boolean (default off) | |
2059 global | |
8246
f16bfe02cef1
commit https://github.com/vim/vim/commit/f391327adbbffb11180cf6038a92af1ed144e907
Christian Brabandt <cb@256bit.org>
parents:
8182
diff
changeset
|
2060 This was for MS-DOS and is no longer supported. |
7 | 2061 |
2062 *'copyindent'* *'ci'* *'nocopyindent'* *'noci'* | |
2063 'copyindent' 'ci' boolean (default off) | |
2064 local to buffer | |
2065 Copy the structure of the existing lines indent when autoindenting a | |
2066 new line. Normally the new indent is reconstructed by a series of | |
2067 tabs followed by spaces as required (unless |'expandtab'| is enabled, | |
2068 in which case only spaces are used). Enabling this option makes the | |
2069 new line copy whatever characters were used for indenting on the | |
1621 | 2070 existing line. 'expandtab' has no effect on these characters, a Tab |
2071 remains a Tab. If the new indent is greater than on the existing | |
7 | 2072 line, the remaining space is filled in the normal manner. |
11160 | 2073 NOTE: This option is reset when 'compatible' is set. |
7 | 2074 Also see 'preserveindent'. |
2075 | |
8148
f5da459c5698
commit https://github.com/vim/vim/commit/e0fa3742ead676a3074a10edadbc955e1a89153d
Christian Brabandt <cb@256bit.org>
parents:
8061
diff
changeset
|
2076 *'cpoptions'* *'cpo'* *cpo* |
7 | 2077 'cpoptions' 'cpo' string (Vim default: "aABceFs", |
2078 Vi default: all flags) | |
2079 global | |
2080 A sequence of single character flags. When a character is present | |
5340 | 2081 this indicates Vi-compatible behavior. This is used for things where |
2082 not being Vi-compatible is mostly or sometimes preferred. | |
7 | 2083 'cpoptions' stands for "compatible-options". |
2084 Commas can be added for readability. | |
2085 To avoid problems with flags that are added in the future, use the | |
2086 "+=" and "-=" feature of ":set" |add-option-flags|. | |
2087 NOTE: This option is set to the Vi default value when 'compatible' is | |
2088 set and to the Vim default value when 'compatible' is reset. | |
164 | 2089 NOTE: This option is set to the POSIX default value at startup when |
2090 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
|
2091 variable exists |posix|. This means Vim tries to behave like the |
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
2092 POSIX specification. |
7 | 2093 |
2094 contains behavior ~ | |
2095 *cpo-a* | |
2096 a When included, a ":read" command with a file name | |
2097 argument will set the alternate file name for the | |
2098 current window. | |
2099 *cpo-A* | |
2100 A When included, a ":write" command with a file name | |
2101 argument will set the alternate file name for the | |
2102 current window. | |
2103 *cpo-b* | |
2104 b "\|" in a ":map" command is recognized as the end of | |
2105 the map command. The '\' is included in the mapping, | |
2106 the text after the '|' is interpreted as the next | |
2107 command. Use a CTRL-V instead of a backslash to | |
2108 include the '|' in the mapping. Applies to all | |
2109 mapping, abbreviation, menu and autocmd commands. | |
2110 See also |map_bar|. | |
2111 *cpo-B* | |
2112 B A backslash has no special meaning in mappings, | |
14372 | 2113 abbreviations, user commands and the "to" part of the |
2114 menu commands. Remove this flag to be able to use a | |
2115 backslash like a CTRL-V. For example, the command | |
2116 ":map X \<Esc>" results in X being mapped to: | |
7 | 2117 'B' included: "\^[" (^[ is a real <Esc>) |
2118 'B' excluded: "<Esc>" (5 characters) | |
2119 ('<' excluded in both cases) | |
2120 *cpo-c* | |
2121 c Searching continues at the end of any match at the | |
2122 cursor position, but not further than the start of the | |
2123 next line. When not present searching continues | |
2124 one character from the cursor position. With 'c' | |
2125 "abababababab" only gets three matches when repeating | |
2126 "/abab", without 'c' there are five matches. | |
2127 *cpo-C* | |
2128 C Do not concatenate sourced lines that start with a | |
2129 backslash. See |line-continuation|. | |
2130 *cpo-d* | |
2131 d Using "./" in the 'tags' option doesn't mean to use | |
2132 the tags file relative to the current file, but the | |
2133 tags file in the current directory. | |
2134 *cpo-D* | |
2135 D Can't use CTRL-K to enter a digraph after Normal mode | |
2136 commands with a character argument, like |r|, |f| and | |
2137 |t|. | |
2138 *cpo-e* | |
2139 e When executing a register with ":@r", always add a | |
2140 <CR> to the last line, also when the register is not | |
2141 linewise. If this flag is not present, the register | |
2142 is not linewise and the last line does not end in a | |
2143 <CR>, then the last line is put on the command-line | |
2144 and can be edited before hitting <CR>. | |
2145 *cpo-E* | |
2146 E It is an error when using "y", "d", "c", "g~", "gu" or | |
2147 "gU" on an Empty region. The operators only work when | |
13818
28ac7914b2b6
Update runtime files and translations
Christian Brabandt <cb@256bit.org>
parents:
13742
diff
changeset
|
2148 at least one character is to be operated on. Example: |
7 | 2149 This makes "y0" fail in the first column. |
2150 *cpo-f* | |
2151 f When included, a ":read" command with a file name | |
2152 argument will set the file name for the current buffer, | |
2153 if the current buffer doesn't have a file name yet. | |
2154 *cpo-F* | |
2155 F When included, a ":write" command with a file name | |
2156 argument will set the file name for the current | |
2157 buffer, if the current buffer doesn't have a file name | |
590 | 2158 yet. Also see |cpo-P|. |
7 | 2159 *cpo-g* |
2160 g Goto line 1 when using ":edit" without argument. | |
164 | 2161 *cpo-H* |
2162 H When using "I" on a line with only blanks, insert | |
2163 before the last blank. Without this flag insert after | |
2164 the last blank. | |
7 | 2165 *cpo-i* |
2166 i When included, interrupting the reading of a file will | |
2167 leave it modified. | |
10 | 2168 *cpo-I* |
2169 I When moving the cursor up or down just after inserting | |
2170 indent for 'autoindent', do not delete the indent. | |
7 | 2171 *cpo-j* |
2172 j When joining lines, only add two spaces after a '.', | |
2173 not after '!' or '?'. Also see 'joinspaces'. | |
2174 *cpo-J* | |
2175 J A |sentence| has to be followed by two spaces after | |
233 | 2176 the '.', '!' or '?'. A <Tab> is not recognized as |
7 | 2177 white space. |
2178 *cpo-k* | |
2179 k Disable the recognition of raw key codes in | |
2180 mappings, abbreviations, and the "to" part of menu | |
2181 commands. For example, if <Key> sends ^[OA (where ^[ | |
2182 is <Esc>), the command ":map X ^[OA" results in X | |
2183 being mapped to: | |
2184 'k' included: "^[OA" (3 characters) | |
2185 'k' excluded: "<Key>" (one key code) | |
2186 Also see the '<' flag below. | |
2187 *cpo-K* | |
2188 K Don't wait for a key code to complete when it is | |
2189 halfway a mapping. This breaks mapping <F1><F1> when | |
2190 only part of the second <F1> has been read. It | |
2191 enables cancelling the mapping by typing <F1><Esc>. | |
2192 *cpo-l* | |
2193 l Backslash in a [] range in a search pattern is taken | |
168 | 2194 literally, only "\]", "\^", "\-" and "\\" are special. |
2195 See |/[]| | |
7 | 2196 'l' included: "/[ \t]" finds <Space>, '\' and 't' |
2197 'l' excluded: "/[ \t]" finds <Space> and <Tab> | |
168 | 2198 Also see |cpo-\|. |
7 | 2199 *cpo-L* |
2200 L When the 'list' option is set, 'wrapmargin', | |
2201 'textwidth', 'softtabstop' and Virtual Replace mode | |
2202 (see |gR|) count a <Tab> as two characters, instead of | |
2203 the normal behavior of a <Tab>. | |
2204 *cpo-m* | |
2205 m When included, a showmatch will always wait half a | |
2206 second. When not included, a showmatch will wait half | |
2207 a second or until a character is typed. |'showmatch'| | |
2208 *cpo-M* | |
2209 M When excluded, "%" matching will take backslashes into | |
2210 account. Thus in "( \( )" and "\( ( \)" the outer | |
2211 parenthesis match. When included "%" ignores | |
2212 backslashes, which is Vi compatible. | |
2213 *cpo-n* | |
2178
c6f1aa1e9f32
Add 'relativenumber' patch from Markus Heidelberg.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2214 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
|
2215 '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
|
2216 lines. |
7 | 2217 *cpo-o* |
2218 o Line offset to search command is not remembered for | |
2219 next search. | |
2220 *cpo-O* | |
2221 O Don't complain if a file is being overwritten, even | |
2222 when it didn't exist when editing it. This is a | |
2223 protection against a file unexpectedly created by | |
2224 someone else. Vi didn't complain about this. | |
2225 *cpo-p* | |
2226 p Vi compatible Lisp indenting. When not present, a | |
2227 slightly better algorithm is used. | |
590 | 2228 *cpo-P* |
2229 P When included, a ":write" command that appends to a | |
2230 file will set the file name for the current buffer, if | |
2231 the current buffer doesn't have a file name yet and | |
2232 the 'F' flag is also included |cpo-F|. | |
164 | 2233 *cpo-q* |
2234 q When joining multiple lines leave the cursor at the | |
2235 position where it would be when joining two lines. | |
7 | 2236 *cpo-r* |
2237 r Redo ("." command) uses "/" to repeat a search | |
2238 command, instead of the actually used search string. | |
2239 *cpo-R* | |
2240 R Remove marks from filtered lines. Without this flag | |
2241 marks are kept like |:keepmarks| was used. | |
2242 *cpo-s* | |
2243 s Set buffer options when entering the buffer for the | |
2244 first time. This is like it is in Vim version 3.0. | |
10 | 2245 And it is the default. If not present the options are |
7 | 2246 set when the buffer is created. |
2247 *cpo-S* | |
2248 S Set buffer options always when entering a buffer | |
2249 (except 'readonly', 'fileformat', 'filetype' and | |
2250 'syntax'). This is the (most) Vi compatible setting. | |
2251 The options are set to the values in the current | |
2252 buffer. When you change an option and go to another | |
2253 buffer, the value is copied. Effectively makes the | |
2254 buffer options global to all buffers. | |
2255 | |
2256 's' 'S' copy buffer options | |
2257 no no when buffer created | |
2258 yes no when buffer first entered (default) | |
2259 X yes each time when buffer entered (vi comp.) | |
2260 *cpo-t* | |
2261 t Search pattern for the tag command is remembered for | |
2262 "n" command. Otherwise Vim only puts the pattern in | |
2263 the history for search pattern, but doesn't change the | |
2264 last used search pattern. | |
2265 *cpo-u* | |
10 | 2266 u Undo is Vi compatible. See |undo-two-ways|. |
7 | 2267 *cpo-v* |
2268 v Backspaced characters remain visible on the screen in | |
2269 Insert mode. Without this flag the characters are | |
2270 erased from the screen right away. With this flag the | |
2271 screen newly typed text overwrites backspaced | |
2272 characters. | |
2273 *cpo-w* | |
2274 w When using "cw" on a blank character, only change one | |
2275 character and not all blanks until the start of the | |
2276 next word. | |
2277 *cpo-W* | |
2278 W Don't overwrite a readonly file. When omitted, ":w!" | |
2279 overwrites a readonly file, if possible. | |
2280 *cpo-x* | |
2281 x <Esc> on the command-line executes the command-line. | |
2282 The default in Vim is to abandon the command-line, | |
2283 because <Esc> normally aborts a command. |c_<Esc>| | |
164 | 2284 *cpo-X* |
2285 X When using a count with "R" the replaced text is | |
2286 deleted only once. Also when repeating "R" with "." | |
2287 and a count. | |
7 | 2288 *cpo-y* |
15512 | 2289 y A yank command can be redone with ".". Think twice if |
2290 you really want to use this, it may break some | |
2291 plugins, since most people expect "." to only repeat a | |
2292 change. | |
164 | 2293 *cpo-Z* |
2294 Z When using "w!" while the 'readonly' option is set, | |
2295 don't reset 'readonly'. | |
7 | 2296 *cpo-!* |
2297 ! When redoing a filter command, use the last used | |
2298 external command, whatever it was. Otherwise the last | |
2299 used -filter- command is used. | |
2300 *cpo-$* | |
2301 $ When making a change to one line, don't redisplay the | |
2302 line, but put a '$' at the end of the changed text. | |
2303 The changed text will be overwritten when you type the | |
2304 new text. The line is redisplayed if you type any | |
2305 command that moves the cursor from the insertion | |
2306 point. | |
2307 *cpo-%* | |
2308 % Vi-compatible matching is done for the "%" command. | |
2309 Does not recognize "#if", "#endif", etc. | |
2310 Does not recognize "/*" and "*/". | |
2311 Parens inside single and double quotes are also | |
2312 counted, causing a string that contains a paren to | |
2313 disturb the matching. For example, in a line like | |
2314 "if (strcmp("foo(", s))" the first paren does not | |
2315 match the last one. When this flag is not included, | |
2316 parens inside single and double quotes are treated | |
2317 specially. When matching a paren outside of quotes, | |
2318 everything inside quotes is ignored. When matching a | |
2319 paren inside quotes, it will find the matching one (if | |
10 | 2320 there is one). This works very well for C programs. |
36 | 2321 This flag is also used for other features, such as |
2322 C-indenting. | |
161 | 2323 *cpo--* |
2324 - When included, a vertical movement command fails when | |
632 | 2325 it would go above the first line or below the last |
2326 line. Without it the cursor moves to the first or | |
2327 last line, unless it already was in that line. | |
161 | 2328 Applies to the commands "-", "k", CTRL-P, "+", "j", |
632 | 2329 CTRL-N, CTRL-J and ":1234". |
39 | 2330 *cpo-+* |
2331 + When included, a ":write file" command will reset the | |
2332 'modified' flag of the buffer, even though the buffer | |
2333 itself may still be different from its file. | |
856 | 2334 *cpo-star* |
7 | 2335 * Use ":*" in the same way as ":@". When not included, |
2336 ":*" is an alias for ":'<,'>", select the Visual area. | |
2337 *cpo-<* | |
2338 < Disable the recognition of special key codes in |<>| | |
2339 form in mappings, abbreviations, and the "to" part of | |
10 | 2340 menu commands. For example, the command |
7 | 2341 ":map X <Tab>" results in X being mapped to: |
2342 '<' included: "<Tab>" (5 characters) | |
2343 '<' excluded: "^I" (^I is a real <Tab>) | |
2344 Also see the 'k' flag above. | |
164 | 2345 *cpo->* |
2346 > When appending to a register, put a line break before | |
2347 the appended text. | |
2925 | 2348 *cpo-;* |
2349 ; When using |,| or |;| to repeat the last |t| search | |
2350 and the cursor is right in front of the searched | |
2351 character, the cursor won't move. When not included, | |
2352 the cursor would skip over it and jump to the | |
3557 | 2353 following occurrence. |
164 | 2354 |
2355 POSIX flags. These are not included in the Vi default value, except | |
2356 when $VIM_POSIX was set on startup. |posix| | |
2357 | |
2358 contains behavior ~ | |
856 | 2359 *cpo-#* |
164 | 2360 # A count before "D", "o" and "O" has no effect. |
168 | 2361 *cpo-&* |
2362 & When ":preserve" was used keep the swap file when | |
2363 exiting normally while this buffer is still loaded. | |
2364 This flag is tested when exiting. | |
2365 *cpo-\* | |
2366 \ Backslash in a [] range in a search pattern is taken | |
2367 literally, only "\]" is special See |/[]| | |
488 | 2368 '\' included: "/[ \-]" finds <Space>, '\' and '-' |
2369 '\' excluded: "/[ \-]" finds <Space> and '-' | |
2370 Also see |cpo-l|. | |
168 | 2371 *cpo-/* |
2372 / When "%" is used as the replacement string in a |:s| | |
2373 command, use the previous replacement string. |:s%| | |
164 | 2374 *cpo-{* |
2375 { The |{| and |}| commands also stop at a "{" character | |
2376 at the start of a line. | |
168 | 2377 *cpo-.* |
2378 . The ":chdir" and ":cd" commands fail if the current | |
2379 buffer is modified, unless ! is used. Vim doesn't | |
2380 need this, since it remembers the full path of an | |
2381 opened file. | |
164 | 2382 *cpo-bar* |
2383 | The value of the $LINES and $COLUMNS environment | |
2384 variables overrule the terminal size values obtained | |
2385 with system specific functions. | |
2386 | |
7 | 2387 |
2180
f60a0c9cbe6c
Add the blowfish encryption patch from Mohsin Ahmed. Needs more work.
Bram Moolenaar <bram@vim.org>
parents:
2178
diff
changeset
|
2388 *'cryptmethod'* *'cm'* |
15192
690da0a83419
patch 8.1.0606: 'cryptmethod' defaults to a very old method
Bram Moolenaar <Bram@vim.org>
parents:
15131
diff
changeset
|
2389 'cryptmethod' 'cm' string (default "blowfish2") |
2360
d8e4b27cef80
Change 'cryptmethod' from a number to a string option. Make it global-local.
Bram Moolenaar <bram@vim.org>
parents:
2350
diff
changeset
|
2390 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
|
2391 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
|
2392 *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
|
2393 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
|
2394 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
|
2395 *blowfish* |
6122 | 2396 blowfish Blowfish method. Medium strong encryption but it has |
2397 an implementation flaw. Requires Vim 7.3 or later, | |
2398 files can NOT be read by Vim 7.2 and older. This adds | |
2399 a "seed" to the file, every time you write the file | |
2400 the encrypted bytes will be different. | |
2401 *blowfish2* | |
2402 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
|
2403 Vim 7.4.401 or later, files can NOT be read by Vim 7.3 |
6122 | 2404 and older. This adds a "seed" to the file, every time |
2405 you write the file the encrypted bytes will be | |
2406 different. The whole undo file is encrypted, not just | |
2407 the pieces of text. | |
24970
7e9e53a0368f
patch 8.2.3022: available encryption methods are not strong enough
Bram Moolenaar <Bram@vim.org>
parents:
24911
diff
changeset
|
2408 *E1193* *E1194* *E1195* *E1196* |
7e9e53a0368f
patch 8.2.3022: available encryption methods are not strong enough
Bram Moolenaar <Bram@vim.org>
parents:
24911
diff
changeset
|
2409 *E1197* *E1198* *E1199* *E1200* *E1201* |
7e9e53a0368f
patch 8.2.3022: available encryption methods are not strong enough
Bram Moolenaar <Bram@vim.org>
parents:
24911
diff
changeset
|
2410 xchacha20 XChaCha20 Cipher with Poly1305 Message Authentication |
7e9e53a0368f
patch 8.2.3022: available encryption methods are not strong enough
Bram Moolenaar <Bram@vim.org>
parents:
24911
diff
changeset
|
2411 Code. Medium strong till strong encryption. |
7e9e53a0368f
patch 8.2.3022: available encryption methods are not strong enough
Bram Moolenaar <Bram@vim.org>
parents:
24911
diff
changeset
|
2412 Encryption is provided by the libsodium library, it |
25973 | 2413 requires Vim to be built with |+sodium|. |
24970
7e9e53a0368f
patch 8.2.3022: available encryption methods are not strong enough
Bram Moolenaar <Bram@vim.org>
parents:
24911
diff
changeset
|
2414 It adds a seed and a message authentication code (MAC) |
7e9e53a0368f
patch 8.2.3022: available encryption methods are not strong enough
Bram Moolenaar <Bram@vim.org>
parents:
24911
diff
changeset
|
2415 to the file. This needs at least a Vim 8.2.3022 to |
7e9e53a0368f
patch 8.2.3022: available encryption methods are not strong enough
Bram Moolenaar <Bram@vim.org>
parents:
24911
diff
changeset
|
2416 read the encrypted file. |
7e9e53a0368f
patch 8.2.3022: available encryption methods are not strong enough
Bram Moolenaar <Bram@vim.org>
parents:
24911
diff
changeset
|
2417 Encryption of swap files is not supported, therefore |
7e9e53a0368f
patch 8.2.3022: available encryption methods are not strong enough
Bram Moolenaar <Bram@vim.org>
parents:
24911
diff
changeset
|
2418 no swap file will be used when xchacha20 encryption is |
7e9e53a0368f
patch 8.2.3022: available encryption methods are not strong enough
Bram Moolenaar <Bram@vim.org>
parents:
24911
diff
changeset
|
2419 enabled. |
7e9e53a0368f
patch 8.2.3022: available encryption methods are not strong enough
Bram Moolenaar <Bram@vim.org>
parents:
24911
diff
changeset
|
2420 Encryption of undo files is not yet supported, |
7e9e53a0368f
patch 8.2.3022: available encryption methods are not strong enough
Bram Moolenaar <Bram@vim.org>
parents:
24911
diff
changeset
|
2421 therefore no undo file will currently be written. |
7e9e53a0368f
patch 8.2.3022: available encryption methods are not strong enough
Bram Moolenaar <Bram@vim.org>
parents:
24911
diff
changeset
|
2422 CURRENTLY EXPERIMENTAL: Files written with this method |
7e9e53a0368f
patch 8.2.3022: available encryption methods are not strong enough
Bram Moolenaar <Bram@vim.org>
parents:
24911
diff
changeset
|
2423 might have to be read back with the same version of |
7e9e53a0368f
patch 8.2.3022: available encryption methods are not strong enough
Bram Moolenaar <Bram@vim.org>
parents:
24911
diff
changeset
|
2424 Vim if the binary format changes later. |
2204
c493d6bfde09
A few more changes for encryption. Add test that encrypted file can be read.
Bram Moolenaar <bram@vim.org>
parents:
2184
diff
changeset
|
2425 |
8748
b1a19a2f73f0
commit https://github.com/vim/vim/commit/4f3f668c8486444e53163c29d2fc79bf47eb3c82
Christian Brabandt <cb@256bit.org>
parents:
8629
diff
changeset
|
2426 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
|
2427 |
2180
f60a0c9cbe6c
Add the blowfish encryption patch from Mohsin Ahmed. Needs more work.
Bram Moolenaar <bram@vim.org>
parents:
2178
diff
changeset
|
2428 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
|
2429 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
|
2430 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
|
2431 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
|
2432 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
|
2433 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
|
2434 |
d8e4b27cef80
Change 'cryptmethod' from a number to a string option. Make it global-local.
Bram Moolenaar <bram@vim.org>
parents:
2350
diff
changeset
|
2435 When setting the global value to an empty string, it will end up with |
15192
690da0a83419
patch 8.1.0606: 'cryptmethod' defaults to a very old method
Bram Moolenaar <Bram@vim.org>
parents:
15131
diff
changeset
|
2436 the value "blowfish2". When setting the local value to an empty |
690da0a83419
patch 8.1.0606: 'cryptmethod' defaults to a very old method
Bram Moolenaar <Bram@vim.org>
parents:
15131
diff
changeset
|
2437 string the buffer will use the global value. |
2360
d8e4b27cef80
Change 'cryptmethod' from a number to a string option. Make it global-local.
Bram Moolenaar <bram@vim.org>
parents:
2350
diff
changeset
|
2438 |
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
|
2439 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
|
2440 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
|
2441 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
|
2442 |
f60a0c9cbe6c
Add the blowfish encryption patch from Mohsin Ahmed. Needs more work.
Bram Moolenaar <bram@vim.org>
parents:
2178
diff
changeset
|
2443 |
7 | 2444 *'cscopepathcomp'* *'cspc'* |
2445 'cscopepathcomp' 'cspc' number (default 0) | |
2446 global | |
2447 {not available when compiled without the |+cscope| | |
2448 feature} | |
2449 Determines how many components of the path to show in a list of tags. | |
2450 See |cscopepathcomp|. | |
11160 | 2451 NOTE: This option is set to 0 when 'compatible' is set. |
7 | 2452 |
2453 *'cscopeprg'* *'csprg'* | |
2454 'cscopeprg' 'csprg' string (default "cscope") | |
2455 global | |
2456 {not available when compiled without the |+cscope| | |
2457 feature} | |
2458 Specifies the command to execute cscope. See |cscopeprg|. | |
2459 This option cannot be set from a |modeline| or in the |sandbox|, for | |
2460 security reasons. | |
2461 | |
2462 *'cscopequickfix'* *'csqf'* | |
2463 'cscopequickfix' 'csqf' string (default "") | |
2464 global | |
2465 {not available when compiled without the |+cscope| | |
2466 or |+quickfix| features} | |
2467 Specifies whether to use quickfix window to show cscope results. | |
2468 See |cscopequickfix|. | |
2469 | |
4869 | 2470 *'cscoperelative'* *'csre'* *'nocscoperelative'* *'nocsre'* |
2873 | 2471 'cscoperelative' 'csre' boolean (default off) |
2472 global | |
2473 {not available when compiled without the |+cscope| | |
2474 feature} | |
2475 In the absence of a prefix (-P) for cscope. setting this option enables | |
2476 to use the basename of cscope.out path as the prefix. | |
2477 See |cscoperelative|. | |
11160 | 2478 NOTE: This option is reset when 'compatible' is set. |
2873 | 2479 |
7 | 2480 *'cscopetag'* *'cst'* *'nocscopetag'* *'nocst'* |
2481 'cscopetag' 'cst' boolean (default off) | |
2482 global | |
2483 {not available when compiled without the |+cscope| | |
2484 feature} | |
2485 Use cscope for tag commands. See |cscope-options|. | |
2486 NOTE: This option is reset when 'compatible' is set. | |
2487 | |
2488 *'cscopetagorder'* *'csto'* | |
2489 'cscopetagorder' 'csto' number (default 0) | |
2490 global | |
2491 {not available when compiled without the |+cscope| | |
2492 feature} | |
2493 Determines the order in which ":cstag" performs a search. See | |
2494 |cscopetagorder|. | |
2495 NOTE: This option is set to 0 when 'compatible' is set. | |
2496 | |
2497 *'cscopeverbose'* *'csverb'* | |
2498 *'nocscopeverbose'* *'nocsverb'* | |
2499 'cscopeverbose' 'csverb' boolean (default off) | |
2500 global | |
2501 {not available when compiled without the |+cscope| | |
2502 feature} | |
2503 Give messages when adding a cscope database. See |cscopeverbose|. | |
2504 NOTE: This option is reset when 'compatible' is set. | |
2505 | |
2250
1bac28a53fae
Add the conceal patch from Vince Negri.
Bram Moolenaar <bram@vim.org>
parents:
2249
diff
changeset
|
2506 *'cursorbind'* *'crb'* *'nocursorbind'* *'nocrb'* |
1bac28a53fae
Add the conceal patch from Vince Negri.
Bram Moolenaar <bram@vim.org>
parents:
2249
diff
changeset
|
2507 'cursorbind' 'crb' boolean (default off) |
1bac28a53fae
Add the conceal patch from Vince Negri.
Bram Moolenaar <bram@vim.org>
parents:
2249
diff
changeset
|
2508 local to window |
1bac28a53fae
Add the conceal patch from Vince Negri.
Bram Moolenaar <bram@vim.org>
parents:
2249
diff
changeset
|
2509 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
|
2510 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
|
2511 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
|
2512 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
|
2513 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
|
2514 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
|
2515 taken into account. |
2250
1bac28a53fae
Add the conceal patch from Vince Negri.
Bram Moolenaar <bram@vim.org>
parents:
2249
diff
changeset
|
2516 |
743 | 2517 |
2518 *'cursorcolumn'* *'cuc'* *'nocursorcolumn'* *'nocuc'* | |
2519 'cursorcolumn' 'cuc' boolean (default off) | |
2520 local to window | |
2570
71b56b4e7785
Make the references to features in the help more consistent. (Sylvain Hitier)
Bram Moolenaar <bram@vim.org>
parents:
2561
diff
changeset
|
2521 {not available when compiled without the |+syntax| |
743 | 2522 feature} |
2523 Highlight the screen column of the cursor with CursorColumn | |
2524 |hl-CursorColumn|. Useful to align text. Will make screen redrawing | |
2525 slower. | |
826 | 2526 If you only want the highlighting in the current window you can use |
2527 these autocommands: > | |
2528 au WinLeave * set nocursorline nocursorcolumn | |
2529 au WinEnter * set cursorline cursorcolumn | |
2530 < | |
743 | 2531 |
2532 *'cursorline'* *'cul'* *'nocursorline'* *'nocul'* | |
2533 'cursorline' 'cul' boolean (default off) | |
2534 local to window | |
2570
71b56b4e7785
Make the references to features in the help more consistent. (Sylvain Hitier)
Bram Moolenaar <bram@vim.org>
parents:
2561
diff
changeset
|
2535 {not available when compiled without the |+syntax| |
743 | 2536 feature} |
18047
6650e3dff8d4
patch 8.1.2019: 'cursorline' always highlights the whole line
Bram Moolenaar <Bram@vim.org>
parents:
17909
diff
changeset
|
2537 Highlight the text line of the cursor with CursorLine |hl-CursorLine|. |
6650e3dff8d4
patch 8.1.2019: 'cursorline' always highlights the whole line
Bram Moolenaar <Bram@vim.org>
parents:
17909
diff
changeset
|
2538 Useful to easily spot the cursor. Will make screen redrawing slower. |
818 | 2539 When Visual mode is active the highlighting isn't used to make it |
825 | 2540 easier to see the selected text. |
743 | 2541 |
2542 | |
18047
6650e3dff8d4
patch 8.1.2019: 'cursorline' always highlights the whole line
Bram Moolenaar <Bram@vim.org>
parents:
17909
diff
changeset
|
2543 *'cursorlineopt'* *'culopt'* |
18068
1101eacc1444
patch 8.1.2029: cannot control 'cursorline' highlighting well
Bram Moolenaar <Bram@vim.org>
parents:
18053
diff
changeset
|
2544 'cursorlineopt' 'culopt' string (default: "number,line") |
18047
6650e3dff8d4
patch 8.1.2019: 'cursorline' always highlights the whole line
Bram Moolenaar <Bram@vim.org>
parents:
17909
diff
changeset
|
2545 local to window |
6650e3dff8d4
patch 8.1.2019: 'cursorline' always highlights the whole line
Bram Moolenaar <Bram@vim.org>
parents:
17909
diff
changeset
|
2546 {not available when compiled without the |+syntax| |
6650e3dff8d4
patch 8.1.2019: 'cursorline' always highlights the whole line
Bram Moolenaar <Bram@vim.org>
parents:
17909
diff
changeset
|
2547 feature} |
18068
1101eacc1444
patch 8.1.2029: cannot control 'cursorline' highlighting well
Bram Moolenaar <Bram@vim.org>
parents:
18053
diff
changeset
|
2548 Comma separated list of settings for how 'cursorline' is displayed. |
1101eacc1444
patch 8.1.2029: cannot control 'cursorline' highlighting well
Bram Moolenaar <Bram@vim.org>
parents:
18053
diff
changeset
|
2549 Valid values: |
1101eacc1444
patch 8.1.2029: cannot control 'cursorline' highlighting well
Bram Moolenaar <Bram@vim.org>
parents:
18053
diff
changeset
|
2550 "line" Highlight the text line of the cursor with |
1101eacc1444
patch 8.1.2029: cannot control 'cursorline' highlighting well
Bram Moolenaar <Bram@vim.org>
parents:
18053
diff
changeset
|
2551 CursorLine |hl-CursorLine|. |
1101eacc1444
patch 8.1.2029: cannot control 'cursorline' highlighting well
Bram Moolenaar <Bram@vim.org>
parents:
18053
diff
changeset
|
2552 "screenline" Highlight only the screen line of the cursor with |
18047
6650e3dff8d4
patch 8.1.2019: 'cursorline' always highlights the whole line
Bram Moolenaar <Bram@vim.org>
parents:
17909
diff
changeset
|
2553 CursorLine |hl-CursorLine|. |
18068
1101eacc1444
patch 8.1.2029: cannot control 'cursorline' highlighting well
Bram Moolenaar <Bram@vim.org>
parents:
18053
diff
changeset
|
2554 "number" Highlight the line number of the cursor with |
18047
6650e3dff8d4
patch 8.1.2019: 'cursorline' always highlights the whole line
Bram Moolenaar <Bram@vim.org>
parents:
17909
diff
changeset
|
2555 CursorLineNr |hl-CursorLineNr|. |
18068
1101eacc1444
patch 8.1.2029: cannot control 'cursorline' highlighting well
Bram Moolenaar <Bram@vim.org>
parents:
18053
diff
changeset
|
2556 |
1101eacc1444
patch 8.1.2029: cannot control 'cursorline' highlighting well
Bram Moolenaar <Bram@vim.org>
parents:
18053
diff
changeset
|
2557 Special value: |
1101eacc1444
patch 8.1.2029: cannot control 'cursorline' highlighting well
Bram Moolenaar <Bram@vim.org>
parents:
18053
diff
changeset
|
2558 "both" Alias for the values "line,number". |
1101eacc1444
patch 8.1.2029: cannot control 'cursorline' highlighting well
Bram Moolenaar <Bram@vim.org>
parents:
18053
diff
changeset
|
2559 |
1101eacc1444
patch 8.1.2029: cannot control 'cursorline' highlighting well
Bram Moolenaar <Bram@vim.org>
parents:
18053
diff
changeset
|
2560 "line" and "screenline" cannot be used together. |
18047
6650e3dff8d4
patch 8.1.2019: 'cursorline' always highlights the whole line
Bram Moolenaar <Bram@vim.org>
parents:
17909
diff
changeset
|
2561 |
6650e3dff8d4
patch 8.1.2019: 'cursorline' always highlights the whole line
Bram Moolenaar <Bram@vim.org>
parents:
17909
diff
changeset
|
2562 |
7 | 2563 *'debug'* |
2564 'debug' string (default "") | |
2565 global | |
839 | 2566 These values can be used: |
2567 msg Error messages that would otherwise be omitted will be given | |
2568 anyway. | |
2569 throw Error messages that would otherwise be omitted will be given | |
2570 anyway and also throw an exception and set |v:errmsg|. | |
2571 beep A message will be given when otherwise only a beep would be | |
2572 produced. | |
168 | 2573 The values can be combined, separated by a comma. |
839 | 2574 "msg" and "throw" are useful for debugging 'foldexpr', 'formatexpr' or |
2575 'indentexpr'. | |
7 | 2576 |
2577 *'define'* *'def'* | |
2578 'define' 'def' string (default "^\s*#\s*define") | |
2579 global or local to buffer |global-local| | |
10 | 2580 Pattern to be used to find a macro definition. It is a search |
7 | 2581 pattern, just like for the "/" command. This option is used for the |
2582 commands like "[i" and "[d" |include-search|. The 'isident' option is | |
2583 used to recognize the defined name after the match: | |
2584 {match with 'define'}{non-ID chars}{defined name}{non-ID char} | |
2585 See |option-backslash| about inserting backslashes to include a space | |
2586 or backslash. | |
2587 The default value is for C programs. For C++ this value would be | |
2588 useful, to include const type declarations: > | |
2589 ^\(#\s*define\|[a-z]*\s*const\s*[a-z]*\) | |
16086 | 2590 < You can also use "\ze" just before the name and continue the pattern |
2591 to check what is following. E.g. for Javascript, if a function is | |
2592 defined with "func_name = function(args)": > | |
2593 ^\s*\ze\i\+\s*=\s*function( | |
2594 < If the function is defined with "func_name : function() {...": > | |
2595 ^\s*\ze\i\+\s*[:]\s*(*function\s*( | |
7 | 2596 < When using the ":set" command, you need to double the backslashes! |
16086 | 2597 To avoid that use `:let` with a single quote string: > |
2598 let &l:define = '^\s*\ze\k\+\s*=\s*function(' | |
16380 | 2599 < |
7 | 2600 |
2601 *'delcombine'* *'deco'* *'nodelcombine'* *'nodeco'* | |
2602 'delcombine' 'deco' boolean (default off) | |
2603 global | |
2604 If editing Unicode and this option is set, backspace and Normal mode | |
2605 "x" delete each combining character on its own. When it is off (the | |
2606 default) the character along with its combining characters are | |
2607 deleted. | |
22565 | 2608 Note: When 'delcombine' is set "xx" may work differently from "2x"! |
7 | 2609 |
2610 This is useful for Arabic, Hebrew and many other languages where one | |
2611 may have combining characters overtop of base characters, and want | |
2612 to remove only the combining ones. | |
11160 | 2613 NOTE: This option is reset when 'compatible' is set. |
7 | 2614 |
2615 *'dictionary'* *'dict'* | |
2616 'dictionary' 'dict' string (default "") | |
2617 global or local to buffer |global-local| | |
2618 List of file names, separated by commas, that are used to lookup words | |
2619 for keyword completion commands |i_CTRL-X_CTRL-K|. Each file should | |
2620 contain a list of words. This can be one word per line, or several | |
2621 words per line, separated by non-keyword characters (white space is | |
2622 preferred). Maximum line length is 510 bytes. | |
13950
741b1feeac9f
patch 8.0.1845: various comment updates needed, missing white space
Christian Brabandt <cb@256bit.org>
parents:
13818
diff
changeset
|
2623 |
741b1feeac9f
patch 8.0.1845: various comment updates needed, missing white space
Christian Brabandt <cb@256bit.org>
parents:
13818
diff
changeset
|
2624 When this option is empty or an entry "spell" is present, and spell |
741b1feeac9f
patch 8.0.1845: various comment updates needed, missing white space
Christian Brabandt <cb@256bit.org>
parents:
13818
diff
changeset
|
2625 checking is enabled, words in the word lists for the currently active |
741b1feeac9f
patch 8.0.1845: various comment updates needed, missing white space
Christian Brabandt <cb@256bit.org>
parents:
13818
diff
changeset
|
2626 'spelllang' are used. See |spell|. |
741b1feeac9f
patch 8.0.1845: various comment updates needed, missing white space
Christian Brabandt <cb@256bit.org>
parents:
13818
diff
changeset
|
2627 |
10 | 2628 To include a comma in a file name precede it with a backslash. Spaces |
7 | 2629 after a comma are ignored, otherwise spaces are included in the file |
2630 name. See |option-backslash| about using backslashes. | |
99 | 2631 This has nothing to do with the |Dictionary| variable type. |
7 | 2632 Where to find a list of words? |
2633 - On FreeBSD, there is the file "/usr/share/dict/words". | |
2634 - In the Simtel archive, look in the "msdos/linguist" directory. | |
2635 - In "miscfiles" of the GNU collection. | |
2636 The use of |:set+=| and |:set-=| is preferred when adding or removing | |
2637 directories from the list. This avoids problems when a future version | |
2638 uses another default. | |
2639 Backticks cannot be used in this option for security reasons. | |
2640 | |
2641 *'diff'* *'nodiff'* | |
2642 'diff' boolean (default off) | |
2643 local to window | |
2644 {not available when compiled without the |+diff| | |
2645 feature} | |
2646 Join the current window in the group of windows that shows differences | |
10 | 2647 between files. See |vimdiff|. |
7 | 2648 |
2649 *'dex'* *'diffexpr'* | |
2650 'diffexpr' 'dex' string (default "") | |
2651 global | |
2652 {not available when compiled without the |+diff| | |
2653 feature} | |
14696
195e8b1fcbbf
patch 8.1.0360: using an external diff program is slow and inflexible
Christian Brabandt <cb@256bit.org>
parents:
14695
diff
changeset
|
2654 Expression which is evaluated to obtain a diff file (either ed-style |
195e8b1fcbbf
patch 8.1.0360: using an external diff program is slow and inflexible
Christian Brabandt <cb@256bit.org>
parents:
14695
diff
changeset
|
2655 or unified-style) from two versions of a file. See |diff-diffexpr|. |
7 | 2656 This option cannot be set from a |modeline| or in the |sandbox|, for |
2657 security reasons. | |
2658 | |
2659 *'dip'* *'diffopt'* | |
18590
41484f342f80
patch 8.1.2289: after :diffsplit closing the window does not disable diff
Bram Moolenaar <Bram@vim.org>
parents:
18574
diff
changeset
|
2660 'diffopt' 'dip' string (default "internal,filler,closeoff") |
7 | 2661 global |
2662 {not available when compiled without the |+diff| | |
2663 feature} | |
10 | 2664 Option settings for diff mode. It can consist of the following items. |
7 | 2665 All are optional. Items must be separated by a comma. |
2666 | |
2667 filler Show filler lines, to keep the text | |
2668 synchronized with a window that has inserted | |
2669 lines at the same position. Mostly useful | |
2670 when windows are side-by-side and 'scrollbind' | |
2671 is set. | |
2672 | |
2673 context:{n} Use a context of {n} lines between a change | |
2674 and a fold that contains unchanged lines. | |
2675 When omitted a context of six lines is used. | |
15932 | 2676 When using zero the context is actually one, |
2677 since folds require a line in between, also | |
2678 for a deleted line. | |
7 | 2679 See |fold-diff|. |
2680 | |
14864 | 2681 iblank Ignore changes where lines are all blank. Adds |
2682 the "-B" flag to the "diff" command if | |
2683 'diffexpr' is empty. Check the documentation | |
2684 of the "diff" command for what this does | |
2685 exactly. | |
2686 NOTE: the diff windows will get out of sync, | |
2687 because no differences between blank lines are | |
2688 taken into account. | |
2689 | |
7 | 2690 icase Ignore changes in case of text. "a" and "A" |
2691 are considered the same. Adds the "-i" flag | |
2692 to the "diff" command if 'diffexpr' is empty. | |
2693 | |
2694 iwhite Ignore changes in amount of white space. Adds | |
2695 the "-b" flag to the "diff" command if | |
2696 'diffexpr' is empty. Check the documentation | |
2697 of the "diff" command for what this does | |
2698 exactly. It should ignore adding trailing | |
2699 white space, but not leading white space. | |
2700 | |
14864 | 2701 iwhiteall Ignore all white space changes. Adds |
2702 the "-w" flag to the "diff" command if | |
2703 'diffexpr' is empty. Check the documentation | |
2704 of the "diff" command for what this does | |
2705 exactly. | |
2706 | |
2707 iwhiteeol Ignore white space changes at end of line. | |
2708 Adds the "-Z" flag to the "diff" command if | |
2709 'diffexpr' is empty. Check the documentation | |
2710 of the "diff" command for what this does | |
2711 exactly. | |
2712 | |
766 | 2713 horizontal Start diff mode with horizontal splits (unless |
2714 explicitly specified otherwise). | |
2715 | |
2716 vertical Start diff mode with vertical splits (unless | |
2717 explicitly specified otherwise). | |
2718 | |
18590
41484f342f80
patch 8.1.2289: after :diffsplit closing the window does not disable diff
Bram Moolenaar <Bram@vim.org>
parents:
18574
diff
changeset
|
2719 closeoff When a window is closed where 'diff' is set |
41484f342f80
patch 8.1.2289: after :diffsplit closing the window does not disable diff
Bram Moolenaar <Bram@vim.org>
parents:
18574
diff
changeset
|
2720 and there is only one window remaining in the |
41484f342f80
patch 8.1.2289: after :diffsplit closing the window does not disable diff
Bram Moolenaar <Bram@vim.org>
parents:
18574
diff
changeset
|
2721 same tab page with 'diff' set, execute |
41484f342f80
patch 8.1.2289: after :diffsplit closing the window does not disable diff
Bram Moolenaar <Bram@vim.org>
parents:
18574
diff
changeset
|
2722 `:diffoff` in that window. This undoes a |
41484f342f80
patch 8.1.2289: after :diffsplit closing the window does not disable diff
Bram Moolenaar <Bram@vim.org>
parents:
18574
diff
changeset
|
2723 `:diffsplit` command. |
41484f342f80
patch 8.1.2289: after :diffsplit closing the window does not disable diff
Bram Moolenaar <Bram@vim.org>
parents:
18574
diff
changeset
|
2724 |
12971
ca3cb1997f08
patch 8.0.1361: some users don't want to diff with hidden buffers
Christian Brabandt <cb@256bit.org>
parents:
12968
diff
changeset
|
2725 hiddenoff Do not use diff mode for a buffer when it |
ca3cb1997f08
patch 8.0.1361: some users don't want to diff with hidden buffers
Christian Brabandt <cb@256bit.org>
parents:
12968
diff
changeset
|
2726 becomes hidden. |
ca3cb1997f08
patch 8.0.1361: some users don't want to diff with hidden buffers
Christian Brabandt <cb@256bit.org>
parents:
12968
diff
changeset
|
2727 |
766 | 2728 foldcolumn:{n} Set the 'foldcolumn' option to {n} when |
2729 starting diff mode. Without this 2 is used. | |
2730 | |
23895
e313b6ee2d9c
patch 8.2.2490: 'wrap' option is always reset when starting diff mode
Bram Moolenaar <Bram@vim.org>
parents:
23825
diff
changeset
|
2731 followwrap Follow the 'wrap' option and leave as it is. |
e313b6ee2d9c
patch 8.2.2490: 'wrap' option is always reset when starting diff mode
Bram Moolenaar <Bram@vim.org>
parents:
23825
diff
changeset
|
2732 |
14696
195e8b1fcbbf
patch 8.1.0360: using an external diff program is slow and inflexible
Christian Brabandt <cb@256bit.org>
parents:
14695
diff
changeset
|
2733 internal Use the internal diff library. This is |
195e8b1fcbbf
patch 8.1.0360: using an external diff program is slow and inflexible
Christian Brabandt <cb@256bit.org>
parents:
14695
diff
changeset
|
2734 ignored when 'diffexpr' is set. *E960* |
195e8b1fcbbf
patch 8.1.0360: using an external diff program is slow and inflexible
Christian Brabandt <cb@256bit.org>
parents:
14695
diff
changeset
|
2735 When running out of memory when writing a |
195e8b1fcbbf
patch 8.1.0360: using an external diff program is slow and inflexible
Christian Brabandt <cb@256bit.org>
parents:
14695
diff
changeset
|
2736 buffer this item will be ignored for diffs |
195e8b1fcbbf
patch 8.1.0360: using an external diff program is slow and inflexible
Christian Brabandt <cb@256bit.org>
parents:
14695
diff
changeset
|
2737 involving that buffer. Set the 'verbose' |
195e8b1fcbbf
patch 8.1.0360: using an external diff program is slow and inflexible
Christian Brabandt <cb@256bit.org>
parents:
14695
diff
changeset
|
2738 option to see when this happens. |
195e8b1fcbbf
patch 8.1.0360: using an external diff program is slow and inflexible
Christian Brabandt <cb@256bit.org>
parents:
14695
diff
changeset
|
2739 |
195e8b1fcbbf
patch 8.1.0360: using an external diff program is slow and inflexible
Christian Brabandt <cb@256bit.org>
parents:
14695
diff
changeset
|
2740 indent-heuristic |
15033 | 2741 Use the indent heuristic for the internal |
2742 diff library. | |
14696
195e8b1fcbbf
patch 8.1.0360: using an external diff program is slow and inflexible
Christian Brabandt <cb@256bit.org>
parents:
14695
diff
changeset
|
2743 |
195e8b1fcbbf
patch 8.1.0360: using an external diff program is slow and inflexible
Christian Brabandt <cb@256bit.org>
parents:
14695
diff
changeset
|
2744 algorithm:{text} Use the specified diff algorithm with the |
15033 | 2745 internal diff engine. Currently supported |
14696
195e8b1fcbbf
patch 8.1.0360: using an external diff program is slow and inflexible
Christian Brabandt <cb@256bit.org>
parents:
14695
diff
changeset
|
2746 algorithms are: |
195e8b1fcbbf
patch 8.1.0360: using an external diff program is slow and inflexible
Christian Brabandt <cb@256bit.org>
parents:
14695
diff
changeset
|
2747 myers the default algorithm |
195e8b1fcbbf
patch 8.1.0360: using an external diff program is slow and inflexible
Christian Brabandt <cb@256bit.org>
parents:
14695
diff
changeset
|
2748 minimal spend extra time to generate the |
195e8b1fcbbf
patch 8.1.0360: using an external diff program is slow and inflexible
Christian Brabandt <cb@256bit.org>
parents:
14695
diff
changeset
|
2749 smallest possible diff |
195e8b1fcbbf
patch 8.1.0360: using an external diff program is slow and inflexible
Christian Brabandt <cb@256bit.org>
parents:
14695
diff
changeset
|
2750 patience patience diff algorithm |
195e8b1fcbbf
patch 8.1.0360: using an external diff program is slow and inflexible
Christian Brabandt <cb@256bit.org>
parents:
14695
diff
changeset
|
2751 histogram histogram diff algorithm |
195e8b1fcbbf
patch 8.1.0360: using an external diff program is slow and inflexible
Christian Brabandt <cb@256bit.org>
parents:
14695
diff
changeset
|
2752 |
7 | 2753 Examples: > |
14696
195e8b1fcbbf
patch 8.1.0360: using an external diff program is slow and inflexible
Christian Brabandt <cb@256bit.org>
parents:
14695
diff
changeset
|
2754 :set diffopt=internal,filler,context:4 |
7 | 2755 :set diffopt= |
14696
195e8b1fcbbf
patch 8.1.0360: using an external diff program is slow and inflexible
Christian Brabandt <cb@256bit.org>
parents:
14695
diff
changeset
|
2756 :set diffopt=internal,filler,foldcolumn:3 |
195e8b1fcbbf
patch 8.1.0360: using an external diff program is slow and inflexible
Christian Brabandt <cb@256bit.org>
parents:
14695
diff
changeset
|
2757 :set diffopt-=internal " do NOT use the internal diff parser |
7 | 2758 < |
2759 *'digraph'* *'dg'* *'nodigraph'* *'nodg'* | |
2760 'digraph' 'dg' boolean (default off) | |
2761 global | |
2762 {not available when compiled without the |+digraphs| | |
2763 feature} | |
2764 Enable the entering of digraphs in Insert mode with {char1} <BS> | |
2765 {char2}. See |digraphs|. | |
2766 NOTE: This option is reset when 'compatible' is set. | |
2767 | |
2768 *'directory'* *'dir'* | |
2769 'directory' 'dir' string (default for Amiga: ".,t:", | |
18972 | 2770 for Win32: ".,$TEMP,c:\tmp,c:\temp" |
7 | 2771 for Unix: ".,~/tmp,/var/tmp,/tmp") |
2772 global | |
2773 List of directory names for the swap file, separated with commas. | |
21676 | 2774 Recommended value: ".,~/vimswap//" - this will put the swap file next |
2775 to the edited file if possible, and in your personal swap directory | |
2776 otherwise. Make sure "~/vimswap//" is only readable for you. | |
2777 | |
2778 Possible items: | |
7 | 2779 - The swap file will be created in the first directory where this is |
2780 possible. | |
2781 - Empty means that no swap file will be used (recovery is | |
18372
11394af51615
patch 8.1.2180: Error E303 is not useful when 'directory' is empty
Bram Moolenaar <Bram@vim.org>
parents:
18343
diff
changeset
|
2782 impossible!) and no |E303| error will be given. |
7 | 2783 - A directory "." means to put the swap file in the same directory as |
2784 the edited file. On Unix, a dot is prepended to the file name, so | |
2785 it doesn't show in a directory listing. On MS-Windows the "hidden" | |
2786 attribute is set and a dot prepended if possible. | |
19116 | 2787 - A directory starting with "./" (or ".\" for MS-Windows) means to put |
2788 the swap file relative to where the edited file is. The leading "." | |
2789 is replaced with the path name of the edited file. | |
14475
dddba3937532
patch 8.1.0251: using full path is not supported for 'backupdir'
Christian Brabandt <cb@256bit.org>
parents:
14421
diff
changeset
|
2790 - For Unix and Win32, if a directory ends in two path separators "//", |
dddba3937532
patch 8.1.0251: using full path is not supported for 'backupdir'
Christian Brabandt <cb@256bit.org>
parents:
14421
diff
changeset
|
2791 the swap file name will be built from the complete path to the file |
21991 | 2792 with all path separators replaced by percent '%' signs (including |
2793 the colon following the drive letter on Win32). This will ensure | |
2794 file name uniqueness in the preserve directory. | |
14475
dddba3937532
patch 8.1.0251: using full path is not supported for 'backupdir'
Christian Brabandt <cb@256bit.org>
parents:
14421
diff
changeset
|
2795 On Win32, it is also possible to end with "\\". However, When a |
dddba3937532
patch 8.1.0251: using full path is not supported for 'backupdir'
Christian Brabandt <cb@256bit.org>
parents:
14421
diff
changeset
|
2796 separating comma is following, you must use "//", since "\\" will |
dddba3937532
patch 8.1.0251: using full path is not supported for 'backupdir'
Christian Brabandt <cb@256bit.org>
parents:
14421
diff
changeset
|
2797 include the comma in the file name. Therefore it is recommended to |
dddba3937532
patch 8.1.0251: using full path is not supported for 'backupdir'
Christian Brabandt <cb@256bit.org>
parents:
14421
diff
changeset
|
2798 use '//', instead of '\\'. |
7 | 2799 - Spaces after the comma are ignored, other spaces are considered part |
2800 of the directory name. To have a space at the start of a directory | |
2801 name, precede it with a backslash. | |
2802 - To include a comma in a directory name precede it with a backslash. | |
2803 - A directory name may end in an ':' or '/'. | |
2804 - Environment variables are expanded |:set_env|. | |
2805 - Careful with '\' characters, type one before a space, type two to | |
2806 get one in the option (see |option-backslash|), for example: > | |
2807 :set dir=c:\\tmp,\ dir\\,with\\,commas,\\\ dir\ with\ spaces | |
2808 < - For backwards compatibility with Vim version 3.0 a '>' at the start | |
2809 of the option is removed. | |
2810 Using "." first in the list is recommended. This means that editing | |
2811 the same file twice will result in a warning. Using "/tmp" on Unix is | |
2812 discouraged: When the system crashes you lose the swap file. | |
2813 "/var/tmp" is often not cleared when rebooting, thus is a better | |
21676 | 2814 choice than "/tmp". But others on the computer may be able to see the |
2815 files, and it can contain a lot of files, your swap files get lost in | |
2816 the crowd. That is why a "tmp" directory in your home directory is | |
2817 tried first. | |
7 | 2818 The use of |:set+=| and |:set-=| is preferred when adding or removing |
2819 directories from the list. This avoids problems when a future version | |
2820 uses another default. | |
2821 This option cannot be set from a |modeline| or in the |sandbox|, for | |
2822 security reasons. | |
2823 | |
2824 *'display'* *'dy'* | |
9737
35ce559b8553
commit https://github.com/vim/vim/commit/bc8801c9317eb721a2ee91322669f2dd5d136380
Christian Brabandt <cb@256bit.org>
parents:
9669
diff
changeset
|
2825 '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
|
2826 |defaults.vim|) |
7 | 2827 global |
2828 Change the way text is displayed. This is comma separated list of | |
2829 flags: | |
2830 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
|
2831 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
|
2832 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
|
2833 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
|
2834 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
|
2835 column of the last screen line. Overrules "lastline". |
7 | 2836 uhex Show unprintable characters hexadecimal as <xx> |
2837 instead of using ^C and ~C. | |
2838 | |
10211
b7da8d4c594c
commit https://github.com/vim/vim/commit/d07969093a9b3051511c478d71c36de6fc33c0d6
Christian Brabandt <cb@256bit.org>
parents:
10198
diff
changeset
|
2839 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
|
2840 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
|
2841 |
7 | 2842 *'eadirection'* *'ead'* |
2843 'eadirection' 'ead' string (default "both") | |
2844 global | |
2845 Tells when the 'equalalways' option applies: | |
2846 ver vertically, width of windows is not affected | |
2847 hor horizontally, height of windows is not affected | |
2848 both width and height of windows is affected | |
2849 | |
2850 *'ed'* *'edcompatible'* *'noed'* *'noedcompatible'* | |
2851 'edcompatible' 'ed' boolean (default off) | |
2852 global | |
2853 Makes the 'g' and 'c' flags of the ":substitute" command to be | |
2854 toggled each time the flag is given. See |complex-change|. See | |
2855 also 'gdefault' option. | |
11442 | 2856 Switching this option on may break plugins! |
23305 | 2857 This option is not used in |Vim9| script. |
7 | 2858 |
8876
47f17f66da3d
commit https://github.com/vim/vim/commit/03413f44167c4b5cd0012def9bb331e2518c83cf
Christian Brabandt <cb@256bit.org>
parents:
8835
diff
changeset
|
2859 *'emoji'* *'emo'* *'noemoji'* *'noemo'* |
8629
54ac275e3fc4
commit https://github.com/vim/vim/commit/3848e00e0177abdb31bc600234967863ec487233
Christian Brabandt <cb@256bit.org>
parents:
8560
diff
changeset
|
2860 'emoji' 'emo' boolean (default: on) |
54ac275e3fc4
commit https://github.com/vim/vim/commit/3848e00e0177abdb31bc600234967863ec487233
Christian Brabandt <cb@256bit.org>
parents:
8560
diff
changeset
|
2861 global |
54ac275e3fc4
commit https://github.com/vim/vim/commit/3848e00e0177abdb31bc600234967863ec487233
Christian Brabandt <cb@256bit.org>
parents:
8560
diff
changeset
|
2862 When on all Unicode emoji characters are considered to be full width. |
22328 | 2863 This excludes "text emoji" characters, which are normally displayed as |
2864 single width. Unfortunately there is no good specification for this | |
2865 and it has been determined on trial-and-error basis. Use the | |
2866 |setcellwidths()| function to change the behavior. | |
8629
54ac275e3fc4
commit https://github.com/vim/vim/commit/3848e00e0177abdb31bc600234967863ec487233
Christian Brabandt <cb@256bit.org>
parents:
8560
diff
changeset
|
2867 |
7 | 2868 *'encoding'* *'enc'* *E543* |
24747
7da496081b91
patch 8.2.2912: MS-Windows: most users expect using Unicode
Bram Moolenaar <Bram@vim.org>
parents:
24636
diff
changeset
|
2869 'encoding' 'enc' string (default for MS-Windows: "utf-8", |
7da496081b91
patch 8.2.2912: MS-Windows: most users expect using Unicode
Bram Moolenaar <Bram@vim.org>
parents:
24636
diff
changeset
|
2870 otherwise: value from $LANG or "latin1") |
7 | 2871 global |
2872 Sets the character encoding used inside Vim. It applies to text in | |
2873 the buffers, registers, Strings in expressions, text stored in the | |
2874 viminfo file, etc. It sets the kind of characters which Vim can work | |
2875 with. See |encoding-names| for the possible values. | |
2876 | |
2877 NOTE: Changing this option will not change the encoding of the | |
39 | 2878 existing text in Vim. It may cause non-ASCII text to become invalid. |
7 | 2879 It should normally be kept at its default value, or set when Vim |
1152 | 2880 starts up. See |multibyte|. To reload the menus see |:menutrans|. |
7 | 2881 |
2317
2b2cd34569eb
Disallow setting 'enc' in a modeline. (Patrick Texier)
Bram Moolenaar <bram@vim.org>
parents:
2314
diff
changeset
|
2882 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
|
2883 corrupt the text. |
2b2cd34569eb
Disallow setting 'enc' in a modeline. (Patrick Texier)
Bram Moolenaar <bram@vim.org>
parents:
2314
diff
changeset
|
2884 |
10895
c391bfbdb452
Updated runtime files.
Christian Brabandt <cb@256bit.org>
parents:
10734
diff
changeset
|
2885 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
|
2886 to "utf-8". Although care has been taken to allow different values of |
7 | 2887 'encoding', "utf-8" is the natural choice for the environment and |
2888 avoids unnecessary conversion overhead. "utf-8" has not been made | |
10 | 2889 the default to prevent different behavior of the GUI and terminal |
7 | 2890 versions, and to avoid changing the encoding of newly created files |
2891 without your knowledge (in case 'fileencodings' is empty). | |
2892 | |
2893 The character encoding of files can be different from 'encoding'. | |
10 | 2894 This is specified with 'fileencoding'. The conversion is done with |
7 | 2895 iconv() or as specified with 'charconvert'. |
2896 | |
21991 | 2897 If you need to know whether 'encoding' is a multibyte encoding, you |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
2898 can use: > |
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
2899 if has("multi_byte_encoding") |
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
2900 < |
7 | 2901 Normally 'encoding' will be equal to your current locale. This will |
2902 be the default if Vim recognizes your environment settings. If | |
2903 'encoding' is not set to the current locale, 'termencoding' must be | |
2904 set to convert typed and displayed text. See |encoding-table|. | |
2905 | |
2906 When you set this option, it fires the |EncodingChanged| autocommand | |
2907 event so that you can set up fonts if necessary. | |
2908 | |
2909 When the option is set, the value is converted to lowercase. Thus | |
2910 you can set it with uppercase values too. Underscores are translated | |
2911 to '-' signs. | |
2912 When the encoding is recognized, it is changed to the standard name. | |
2913 For example "Latin-1" becomes "latin1", "ISO_88592" becomes | |
2914 "iso-8859-2" and "utf8" becomes "utf-8". | |
2915 | |
2916 Note: "latin1" is also used when the encoding could not be detected. | |
2917 This only works when editing files in the same encoding! When the | |
2918 actual character set is not latin1, make sure 'fileencoding' and | |
2919 'fileencodings' are empty. When conversion is needed, switch to using | |
2920 utf-8. | |
2921 | |
2922 When "unicode", "ucs-2" or "ucs-4" is used, Vim internally uses utf-8. | |
2923 You don't notice this while editing, but it does matter for the | |
2924 |viminfo-file|. And Vim expects the terminal to use utf-8 too. Thus | |
2925 setting 'encoding' to one of these values instead of utf-8 only has | |
2926 effect for encoding used for files when 'fileencoding' is empty. | |
448 | 2927 |
2928 When 'encoding' is set to a Unicode encoding, and 'fileencodings' was | |
2929 not set yet, the default for 'fileencodings' is changed. | |
7 | 2930 |
2931 *'endofline'* *'eol'* *'noendofline'* *'noeol'* | |
2932 'endofline' 'eol' boolean (default on) | |
2933 local to buffer | |
2934 When writing a file and this option is off and the 'binary' option | |
6933 | 2935 is on, or 'fixeol' option is off, no <EOL> will be written for the |
2936 last line in the file. This option is automatically set or reset when | |
2937 starting to edit a new file, depending on whether file has an <EOL> | |
2938 for the last line in the file. Normally you don't have to set or | |
2939 reset this option. | |
2940 When 'binary' is off and 'fixeol' is on the value is not used when | |
2941 writing the file. When 'binary' is on or 'fixeol' is off it is used | |
2942 to remember the presence of a <EOL> for the last line in the file, so | |
2943 that when you write the file the situation from the original file can | |
2944 be kept. But you can change it if you want to. | |
7 | 2945 |
2946 *'equalalways'* *'ea'* *'noequalalways'* *'noea'* | |
2947 'equalalways' 'ea' boolean (default on) | |
2948 global | |
2949 When on, all the windows are automatically made the same size after | |
33 | 2950 splitting or closing a window. This also happens the moment the |
2951 option is switched on. When off, splitting a window will reduce the | |
2952 size of the current window and leave the other windows the same. When | |
2953 closing a window the extra lines are given to the window next to it | |
2954 (depending on 'splitbelow' and 'splitright'). | |
7 | 2955 When mixing vertically and horizontally split windows, a minimal size |
2956 is computed and some windows may be larger if there is room. The | |
2957 'eadirection' option tells in which direction the size is affected. | |
1354 | 2958 Changing the height and width of a window can be avoided by setting |
2959 'winfixheight' and 'winfixwidth', respectively. | |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
2960 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
|
2961 currently not equalized (it's complicated, but may be implemented in |
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
2962 the future). |
7 | 2963 |
2964 *'equalprg'* *'ep'* | |
2965 'equalprg' 'ep' string (default "") | |
2966 global or local to buffer |global-local| | |
2967 External program to use for "=" command. When this option is empty | |
1621 | 2968 the internal formatting functions are used; either 'lisp', 'cindent' |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
2969 or 'indentexpr'. When Vim was compiled without internal formatting, |
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
2970 the "indent" program is used. |
10 | 2971 Environment variables are expanded |:set_env|. See |option-backslash| |
7 | 2972 about including spaces and backslashes. |
2973 This option cannot be set from a |modeline| or in the |sandbox|, for | |
2974 security reasons. | |
2975 | |
2976 *'errorbells'* *'eb'* *'noerrorbells'* *'noeb'* | |
2977 'errorbells' 'eb' boolean (default off) | |
2978 global | |
2979 Ring the bell (beep or screen flash) for error messages. This only | |
2980 makes a difference for error messages, the bell will be used always | |
2981 for a lot of errors without a message (e.g., hitting <Esc> in Normal | |
10 | 2982 mode). See 'visualbell' on how to make the bell behave like a beep, |
6949 | 2983 screen flash or do nothing. See 'belloff' to finetune when to ring the |
2984 bell. | |
7 | 2985 |
2986 *'errorfile'* *'ef'* | |
2987 'errorfile' 'ef' string (Amiga default: "AztecC.Err", | |
2988 others: "errors.err") | |
2989 global | |
2990 {not available when compiled without the |+quickfix| | |
2991 feature} | |
2992 Name of the errorfile for the QuickFix mode (see |:cf|). | |
2993 When the "-q" command-line argument is used, 'errorfile' is set to the | |
2994 following argument. See |-q|. | |
2995 NOT used for the ":make" command. See 'makeef' for that. | |
2996 Environment variables are expanded |:set_env|. | |
2997 See |option-backslash| about including spaces and backslashes. | |
2998 This option cannot be set from a |modeline| or in the |sandbox|, for | |
2999 security reasons. | |
3000 | |
3001 *'errorformat'* *'efm'* | |
3002 'errorformat' 'efm' string (default is very long) | |
3003 global or local to buffer |global-local| | |
3004 {not available when compiled without the |+quickfix| | |
3005 feature} | |
3006 Scanf-like description of the format for the lines in the error file | |
3007 (see |errorformat|). | |
3008 | |
3009 *'esckeys'* *'ek'* *'noesckeys'* *'noek'* | |
3010 'esckeys' 'ek' boolean (Vim default: on, Vi default: off) | |
3011 global | |
3012 Function keys that start with an <Esc> are recognized in Insert | |
3013 mode. When this option is off, the cursor and function keys cannot be | |
3014 used in Insert mode if they start with an <Esc>. The advantage of | |
3015 this is that the single <Esc> is recognized immediately, instead of | |
3016 after one second. Instead of resetting this option, you might want to | |
3017 try changing the values for 'timeoutlen' and 'ttimeoutlen'. Note that | |
3018 when 'esckeys' is off, you can still map anything, but the cursor keys | |
3019 won't work by default. | |
3020 NOTE: This option is set to the Vi default value when 'compatible' is | |
3021 set and to the Vim default value when 'compatible' is reset. | |
18590
41484f342f80
patch 8.1.2289: after :diffsplit closing the window does not disable diff
Bram Moolenaar <Bram@vim.org>
parents:
18574
diff
changeset
|
3022 NOTE: when this option is off then the |modifyOtherKeys| functionality |
41484f342f80
patch 8.1.2289: after :diffsplit closing the window does not disable diff
Bram Moolenaar <Bram@vim.org>
parents:
18574
diff
changeset
|
3023 is disabled while in Insert mode to avoid ending Insert mode with any |
41484f342f80
patch 8.1.2289: after :diffsplit closing the window does not disable diff
Bram Moolenaar <Bram@vim.org>
parents:
18574
diff
changeset
|
3024 key that has a modifier. |
7 | 3025 |
3026 *'eventignore'* *'ei'* | |
3027 'eventignore' 'ei' string (default "") | |
3028 global | |
3029 A list of autocommand event names, which are to be ignored. | |
844 | 3030 When set to "all" or when "all" is one of the items, all autocommand |
3031 events are ignored, autocommands will not be executed. | |
7 | 3032 Otherwise this is a comma separated list of event names. Example: > |
3033 :set ei=WinEnter,WinLeave | |
3034 < | |
3035 *'expandtab'* *'et'* *'noexpandtab'* *'noet'* | |
3036 'expandtab' 'et' boolean (default off) | |
3037 local to buffer | |
3038 In Insert mode: Use the appropriate number of spaces to insert a | |
10 | 3039 <Tab>. Spaces are used in indents with the '>' and '<' commands and |
7 | 3040 when 'autoindent' is on. To insert a real tab when 'expandtab' is |
3041 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
|
3042 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
|
3043 the 'paste' option is reset. |
7 | 3044 NOTE: This option is reset when 'compatible' is set. |
3045 | |
3046 *'exrc'* *'ex'* *'noexrc'* *'noex'* | |
3047 'exrc' 'ex' boolean (default off) | |
3048 global | |
3049 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
|
3050 directory. |
018fead968c1
commit https://github.com/vim/vim/commit/36f44c21da2e912c008683a0c4447fca2a071e9a
Christian Brabandt <cb@256bit.org>
parents:
9975
diff
changeset
|
3051 |
018fead968c1
commit https://github.com/vim/vim/commit/36f44c21da2e912c008683a0c4447fca2a071e9a
Christian Brabandt <cb@256bit.org>
parents:
9975
diff
changeset
|
3052 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
|
3053 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
|
3054 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
|
3055 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
|
3056 matching directory. |
018fead968c1
commit https://github.com/vim/vim/commit/36f44c21da2e912c008683a0c4447fca2a071e9a
Christian Brabandt <cb@256bit.org>
parents:
9975
diff
changeset
|
3057 |
018fead968c1
commit https://github.com/vim/vim/commit/36f44c21da2e912c008683a0c4447fca2a071e9a
Christian Brabandt <cb@256bit.org>
parents:
9975
diff
changeset
|
3058 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
|
3059 'secure' option (see |initialization|). |
018fead968c1
commit https://github.com/vim/vim/commit/36f44c21da2e912c008683a0c4447fca2a071e9a
Christian Brabandt <cb@256bit.org>
parents:
9975
diff
changeset
|
3060 Also see |.vimrc| and |gui-init|. |
7 | 3061 This option cannot be set from a |modeline| or in the |sandbox|, for |
3062 security reasons. | |
3063 | |
3064 *'fileencoding'* *'fenc'* *E213* | |
3065 'fileencoding' 'fenc' string (default: "") | |
3066 local to buffer | |
3067 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
|
3068 |
7 | 3069 When 'fileencoding' is different from 'encoding', conversion will be |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
3070 done when writing the file. For reading see below. |
7 | 3071 When 'fileencoding' is empty, the same value as 'encoding' will be |
3072 used (no conversion when reading or writing a file). | |
11062 | 3073 No error will be given when the value is set, only when it is used, |
3074 only when writing a file. | |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
3075 Conversion will also be done when 'encoding' and 'fileencoding' are |
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
3076 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
|
3077 because internally Unicode is always stored as utf-8. |
7 | 3078 WARNING: Conversion can cause loss of information! When |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
3079 'encoding' is "utf-8" or another Unicode encoding, conversion |
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
3080 is most likely done in a way that the reverse conversion |
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
3081 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
|
3082 characters may be lost! |
2317
2b2cd34569eb
Disallow setting 'enc' in a modeline. (Patrick Texier)
Bram Moolenaar <bram@vim.org>
parents:
2314
diff
changeset
|
3083 |
7 | 3084 See 'encoding' for the possible values. Additionally, values may be |
3085 specified that can be handled by the converter, see | |
3086 |mbyte-conversion|. | |
2317
2b2cd34569eb
Disallow setting 'enc' in a modeline. (Patrick Texier)
Bram Moolenaar <bram@vim.org>
parents:
2314
diff
changeset
|
3087 |
7 | 3088 When reading a file 'fileencoding' will be set from 'fileencodings'. |
3089 To read a file in a certain encoding it won't work by setting | |
1152 | 3090 'fileencoding', use the |++enc| argument. One exception: when |
3091 'fileencodings' is empty the value of 'fileencoding' is used. | |
692 | 3092 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
|
3093 |
7 | 3094 Prepending "8bit-" and "2byte-" has no meaning here, they are ignored. |
3095 When the option is set, the value is converted to lowercase. Thus | |
3096 you can set it with uppercase values too. '_' characters are | |
3097 replaced with '-'. If a name is recognized from the list for | |
3098 'encoding', it is replaced by the standard name. For example | |
3099 "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
|
3100 |
7 | 3101 When this option is set, after starting to edit a file, the 'modified' |
3102 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
|
3103 |
2b2cd34569eb
Disallow setting 'enc' in a modeline. (Patrick Texier)
Bram Moolenaar <bram@vim.org>
parents:
2314
diff
changeset
|
3104 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
|
3105 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
|
3106 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
|
3107 '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
|
3108 |
7 | 3109 This option can not be changed when 'modifiable' is off. |
3110 | |
3111 *'fe'* | |
3112 NOTE: Before version 6.0 this option specified the encoding for the | |
10 | 3113 whole of Vim, this was a mistake. Now use 'encoding' instead. The |
7 | 3114 old short name was 'fe', which is no longer used. |
3115 | |
3116 *'fileencodings'* *'fencs'* | |
39 | 3117 'fileencodings' 'fencs' string (default: "ucs-bom", |
3118 "ucs-bom,utf-8,default,latin1" when | |
3119 'encoding' is set to a Unicode value) | |
7 | 3120 global |
3121 This is a list of character encodings considered when starting to edit | |
3122 an existing file. When a file is read, Vim tries to use the first | |
3123 mentioned character encoding. If an error is detected, the next one | |
3124 in the list is tried. When an encoding is found that works, | |
10 | 3125 'fileencoding' is set to it. If all fail, 'fileencoding' is set to |
7 | 3126 an empty string, which means the value of 'encoding' is used. |
3127 WARNING: Conversion can cause loss of information! When | |
3128 'encoding' is "utf-8" (or one of the other Unicode variants) | |
3129 conversion is most likely done in a way that the reverse | |
3130 conversion results in the same text. When 'encoding' is not | |
596 | 3131 "utf-8" some non-ASCII characters may be lost! You can use |
3132 the |++bad| argument to specify what is done with characters | |
3133 that can't be converted. | |
7 | 3134 For an empty file or a file with only ASCII characters most encodings |
3135 will work and the first entry of 'fileencodings' will be used (except | |
3136 "ucs-bom", which requires the BOM to be present). If you prefer | |
3137 another encoding use an BufReadPost autocommand event to test if your | |
3138 preferred encoding is to be used. Example: > | |
3139 au BufReadPost * if search('\S', 'w') == 0 | | |
3140 \ set fenc=iso-2022-jp | endif | |
3141 < This sets 'fileencoding' to "iso-2022-jp" if the file does not contain | |
3142 non-blank characters. | |
596 | 3143 When the |++enc| argument is used then the value of 'fileencodings' is |
3144 not used. | |
692 | 3145 Note that 'fileencodings' is not used for a new file, the global value |
3146 of 'fileencoding' is used instead. You can set it with: > | |
3147 :setglobal fenc=iso-8859-2 | |
3148 < This means that a non-existing file may get a different encoding than | |
3149 an empty file. | |
7 | 3150 The special value "ucs-bom" can be used to check for a Unicode BOM |
3151 (Byte Order Mark) at the start of the file. It must not be preceded | |
3152 by "utf-8" or another Unicode encoding for this to work properly. | |
3153 An entry for an 8-bit encoding (e.g., "latin1") should be the last, | |
3154 because Vim cannot detect an error, thus the encoding is always | |
3155 accepted. | |
39 | 3156 The special value "default" can be used for the encoding from the |
24754
a4cb7499fa11
patch 8.2.2915: MS-Windows: when using "default" for encoding utf-8 is used
Bram Moolenaar <Bram@vim.org>
parents:
24751
diff
changeset
|
3157 environment. On MS-Windows this is the system encoding. Otherwise |
a4cb7499fa11
patch 8.2.2915: MS-Windows: when using "default" for encoding utf-8 is used
Bram Moolenaar <Bram@vim.org>
parents:
24751
diff
changeset
|
3158 this is the default value for 'encoding'. It is useful when |
a4cb7499fa11
patch 8.2.2915: MS-Windows: when using "default" for encoding utf-8 is used
Bram Moolenaar <Bram@vim.org>
parents:
24751
diff
changeset
|
3159 'encoding' is set to "utf-8" and your environment uses a non-latin1 |
a4cb7499fa11
patch 8.2.2915: MS-Windows: when using "default" for encoding utf-8 is used
Bram Moolenaar <Bram@vim.org>
parents:
24751
diff
changeset
|
3160 encoding, such as Russian. |
777 | 3161 When 'encoding' is "utf-8" and a file contains an illegal byte |
3162 sequence it won't be recognized as UTF-8. You can use the |8g8| | |
3163 command to find the illegal byte sequence. | |
7 | 3164 WRONG VALUES: WHAT'S WRONG: |
3165 latin1,utf-8 "latin1" will always be used | |
3166 utf-8,ucs-bom,latin1 BOM won't be recognized in an utf-8 | |
3167 file | |
3168 cp1250,latin1 "cp1250" will always be used | |
3169 If 'fileencodings' is empty, 'fileencoding' is not modified. | |
3170 See 'fileencoding' for the possible values. | |
3171 Setting this option does not have an effect until the next time a file | |
3172 is read. | |
3173 | |
3174 *'fileformat'* *'ff'* | |
15840
734b1928a5aa
patch 8.1.0927: USE_CR is never defined
Bram Moolenaar <Bram@vim.org>
parents:
15804
diff
changeset
|
3175 'fileformat' 'ff' string (MS-Windows default: "dos", |
734b1928a5aa
patch 8.1.0927: USE_CR is never defined
Bram Moolenaar <Bram@vim.org>
parents:
15804
diff
changeset
|
3176 Unix, macOS default: "unix") |
7 | 3177 local to buffer |
3178 This gives the <EOL> of the current buffer, which is used for | |
3179 reading/writing the buffer from/to a file: | |
23305 | 3180 dos <CR><NL> |
7 | 3181 unix <NL> |
3182 mac <CR> | |
3183 When "dos" is used, CTRL-Z at the end of a file is ignored. | |
3184 See |file-formats| and |file-read|. | |
3185 For the character encoding of the file see 'fileencoding'. | |
3186 When 'binary' is set, the value of 'fileformat' is ignored, file I/O | |
4264 | 3187 works like it was set to "unix". |
7 | 3188 This option is set automatically when starting to edit a file and |
3189 'fileformats' is not empty and 'binary' is off. | |
3190 When this option is set, after starting to edit a file, the 'modified' | |
3191 option is set, because the file would be different when written. | |
3192 This option can not be changed when 'modifiable' is off. | |
3193 For backwards compatibility: When this option is set to "dos", | |
3194 'textmode' is set, otherwise 'textmode' is reset. | |
3195 | |
3196 *'fileformats'* *'ffs'* | |
3197 'fileformats' 'ffs' string (default: | |
15840
734b1928a5aa
patch 8.1.0927: USE_CR is never defined
Bram Moolenaar <Bram@vim.org>
parents:
15804
diff
changeset
|
3198 Vim+Vi MS-Windows: "dos,unix", |
734b1928a5aa
patch 8.1.0927: USE_CR is never defined
Bram Moolenaar <Bram@vim.org>
parents:
15804
diff
changeset
|
3199 Vim Unix, macOS: "unix,dos", |
7 | 3200 Vi Cygwin: "unix,dos", |
3201 Vi others: "") | |
3202 global | |
3203 This gives the end-of-line (<EOL>) formats that will be tried when | |
3204 starting to edit a new buffer and when reading a file into an existing | |
3205 buffer: | |
3206 - When empty, the format defined with 'fileformat' will be used | |
3207 always. It is not set automatically. | |
3208 - When set to one name, that format will be used whenever a new buffer | |
10 | 3209 is opened. 'fileformat' is set accordingly for that buffer. The |
7 | 3210 'fileformats' name will be used when a file is read into an existing |
3211 buffer, no matter what 'fileformat' for that buffer is set to. | |
3212 - When more than one name is present, separated by commas, automatic | |
3213 <EOL> detection will be done when reading a file. When starting to | |
3214 edit a file, a check is done for the <EOL>: | |
3215 1. If all lines end in <CR><NL>, and 'fileformats' includes "dos", | |
3216 'fileformat' is set to "dos". | |
3217 2. If a <NL> is found and 'fileformats' includes "unix", 'fileformat' | |
10 | 3218 is set to "unix". Note that when a <NL> is found without a |
7 | 3219 preceding <CR>, "unix" is preferred over "dos". |
6647 | 3220 3. If 'fileformat' has not yet been set, and if a <CR> is found, and |
3221 if 'fileformats' includes "mac", 'fileformat' is set to "mac". | |
2587 | 3222 This means that "mac" is only chosen when: |
3223 "unix" is not present or no <NL> is found in the file, and | |
3224 "dos" is not present or no <CR><NL> is found in the file. | |
3225 Except: if "unix" was chosen, but there is a <CR> before | |
3226 the first <NL>, and there appear to be more <CR>s than <NL>s in | |
2642 | 3227 the first few lines, "mac" is used. |
7 | 3228 4. If 'fileformat' is still not set, the first name from |
3229 'fileformats' is used. | |
3230 When reading a file into an existing buffer, the same is done, but | |
3231 this happens like 'fileformat' has been set appropriately for that | |
3232 file only, the option is not changed. | |
3233 When 'binary' is set, the value of 'fileformats' is not used. | |
3234 | |
8748
b1a19a2f73f0
commit https://github.com/vim/vim/commit/4f3f668c8486444e53163c29d2fc79bf47eb3c82
Christian Brabandt <cb@256bit.org>
parents:
8629
diff
changeset
|
3235 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
|
3236 can overrule this by setting 'fileformat' in your .vimrc. |
2662 | 3237 |
7 | 3238 For systems with a Dos-like <EOL> (<CR><NL>), when reading files that |
3239 are ":source"ed and for vimrc files, automatic <EOL> detection may be | |
3240 done: | |
3241 - When 'fileformats' is empty, there is no automatic detection. Dos | |
3242 format will be used. | |
3243 - When 'fileformats' is set to one or more names, automatic detection | |
3244 is done. This is based on the first <NL> in the file: If there is a | |
3245 <CR> in front of it, Dos format is used, otherwise Unix format is | |
3246 used. | |
3247 Also see |file-formats|. | |
3248 For backwards compatibility: When this option is set to an empty | |
3249 string or one format (no comma is included), 'textauto' is reset, | |
3250 otherwise 'textauto' is set. | |
3251 NOTE: This option is set to the Vi default value when 'compatible' is | |
3252 set and to the Vim default value when 'compatible' is reset. | |
3253 | |
4264 | 3254 *'fileignorecase'* *'fic'* *'nofileignorecase'* *'nofic'* |
3255 'fileignorecase' 'fic' boolean (default on for systems where case in file | |
3256 names is normally ignored) | |
4242 | 3257 global |
3258 When set case is ignored when using file names and directories. | |
3259 See 'wildignorecase' for only ignoring case when doing completion. | |
3260 | |
7 | 3261 *'filetype'* *'ft'* |
3262 'filetype' 'ft' string (default: "") | |
3263 local to buffer | |
3264 When this option is set, the FileType autocommand event is triggered. | |
3265 All autocommands that match with the value of this option will be | |
3266 executed. Thus the value of 'filetype' is used in place of the file | |
3267 name. | |
3268 Otherwise this option does not always reflect the current file type. | |
3269 This option is normally set when the file type is detected. To enable | |
3270 this use the ":filetype on" command. |:filetype| | |
3271 Setting this option to a different value is most useful in a modeline, | |
3272 for a file for which the file type is not automatically recognized. | |
782 | 3273 Example, for in an IDL file: |
3274 /* vim: set filetype=idl : */ ~ | |
3275 |FileType| |filetypes| | |
3276 When a dot appears in the value then this separates two filetype | |
3277 names. Example: | |
3278 /* vim: set filetype=c.doxygen : */ ~ | |
3279 This will use the "c" filetype first, then the "doxygen" filetype. | |
3280 This works both for filetype plugins and for syntax files. More than | |
3281 one dot may appear. | |
7 | 3282 This option is not copied to another buffer, independent of the 's' or |
3283 'S' flag in 'cpoptions'. | |
36 | 3284 Only normal file name characters can be used, "/\*?[|<>" are illegal. |
7 | 3285 |
3286 *'fillchars'* *'fcs'* | |
23932
4549133c1e77
patch 8.2.2508: cannot change the character displayed in non existing lines
Bram Moolenaar <Bram@vim.org>
parents:
23931
diff
changeset
|
3287 'fillchars' 'fcs' string (default "vert:|,fold:-,eob:~") |
7 | 3288 global |
17771
4bd21046902b
patch 8.1.1882: cannot specify properties of the info popup window
Bram Moolenaar <Bram@vim.org>
parents:
17767
diff
changeset
|
3289 {not available when compiled without the |+folding| |
4bd21046902b
patch 8.1.1882: cannot specify properties of the info popup window
Bram Moolenaar <Bram@vim.org>
parents:
17767
diff
changeset
|
3290 feature} |
7 | 3291 Characters to fill the statuslines and vertical separators. |
3292 It is a comma separated list of items: | |
3293 | |
3294 item default Used for ~ | |
3295 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
|
3296 stlnc:c ' ' or '=' statusline of the non-current windows |
7 | 3297 vert:c '|' vertical separators |:vsplit| |
3298 fold:c '-' filling 'foldtext' | |
23964
17697c4e5d48
patch 8.2.2524: cannot change the characters displayed in the foldcolumn
Bram Moolenaar <Bram@vim.org>
parents:
23952
diff
changeset
|
3299 foldopen:c '-' mark the beginning of a fold |
17697c4e5d48
patch 8.2.2524: cannot change the characters displayed in the foldcolumn
Bram Moolenaar <Bram@vim.org>
parents:
23952
diff
changeset
|
3300 foldclose:c '+' show a closed fold |
17697c4e5d48
patch 8.2.2524: cannot change the characters displayed in the foldcolumn
Bram Moolenaar <Bram@vim.org>
parents:
23952
diff
changeset
|
3301 foldsep:c '|' open fold middle character |
7 | 3302 diff:c '-' deleted lines of the 'diff' option |
23932
4549133c1e77
patch 8.2.2508: cannot change the character displayed in non existing lines
Bram Moolenaar <Bram@vim.org>
parents:
23931
diff
changeset
|
3303 eob:c '~' empty lines below the end of a buffer |
7 | 3304 |
10 | 3305 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
|
3306 "stlnc" the space will be used when there is highlighting, '^' or '=' |
7 | 3307 otherwise. |
3308 | |
3309 Example: > | |
8061
abd64cf67bcf
commit https://github.com/vim/vim/commit/38a55639d603823efcf2d2fdf542dbffdeb60b75
Christian Brabandt <cb@256bit.org>
parents:
7876
diff
changeset
|
3310 :set fillchars=stl:^,stlnc:=,vert:\|,fold:-,diff:- |
7 | 3311 < This is similar to the default, except that these characters will also |
3312 be used when there is highlighting. | |
3313 | |
24055
90d1636a8fcb
patch 8.2.2569: 'fillchars' "stl" and "stlnc" items must be single byte
Bram Moolenaar <Bram@vim.org>
parents:
23964
diff
changeset
|
3314 For "stl" and "stlnc" single-byte and multibyte characters are |
90d1636a8fcb
patch 8.2.2569: 'fillchars' "stl" and "stlnc" items must be single byte
Bram Moolenaar <Bram@vim.org>
parents:
23964
diff
changeset
|
3315 supported. But double-width characters are not supported. |
819 | 3316 |
7 | 3317 The highlighting used for these items: |
3318 item highlight group ~ | |
3319 stl:c StatusLine |hl-StatusLine| | |
3320 stlnc:c StatusLineNC |hl-StatusLineNC| | |
3321 vert:c VertSplit |hl-VertSplit| | |
3322 fold:c Folded |hl-Folded| | |
3323 diff:c DiffDelete |hl-DiffDelete| | |
23932
4549133c1e77
patch 8.2.2508: cannot change the character displayed in non existing lines
Bram Moolenaar <Bram@vim.org>
parents:
23931
diff
changeset
|
3324 eob:c EndOfBuffer |hl-EndOfBuffer| |
7 | 3325 |
6933 | 3326 *'fixendofline'* *'fixeol'* *'nofixendofline'* *'nofixeol'* |
3327 'fixendofline' 'fixeol' boolean (default on) | |
3328 local to buffer | |
3329 When writing a file and this option is on, <EOL> at the end of file | |
3330 will be restored if missing. Turn this option off if you want to | |
3331 preserve the situation from the original file. | |
3332 When the 'binary' option is set the value of this option doesn't | |
3333 matter. | |
3334 See the 'endofline' option. | |
3335 | |
7 | 3336 *'fkmap'* *'fk'* *'nofkmap'* *'nofk'* |
23666 | 3337 'fkmap' 'fk' boolean (default off) |
7 | 3338 global |
3339 {only available when compiled with the |+rightleft| | |
3340 feature} | |
15850
a6ca8cf07a98
patch 8.1.0932: Farsi support is outdated and unused
Bram Moolenaar <Bram@vim.org>
parents:
15840
diff
changeset
|
3341 This option was for using Farsi, which has been removed. See |
a6ca8cf07a98
patch 8.1.0932: Farsi support is outdated and unused
Bram Moolenaar <Bram@vim.org>
parents:
15840
diff
changeset
|
3342 |farsi.txt|. |
7 | 3343 |
3344 *'foldclose'* *'fcl'* | |
3345 'foldclose' 'fcl' string (default "") | |
3346 global | |
3347 {not available when compiled without the |+folding| | |
3348 feature} | |
3349 When set to "all", a fold is closed when the cursor isn't in it and | |
3350 its level is higher than 'foldlevel'. Useful if you want folds to | |
3351 automatically close when moving out of them. | |
3352 | |
3353 *'foldcolumn'* *'fdc'* | |
3354 'foldcolumn' 'fdc' number (default 0) | |
3355 local to window | |
3356 {not available when compiled without the |+folding| | |
3357 feature} | |
3358 When non-zero, a column with the specified width is shown at the side | |
3359 of the window which indicates open and closed folds. The maximum | |
3360 value is 12. | |
3361 See |folding|. | |
3362 | |
3363 *'foldenable'* *'fen'* *'nofoldenable'* *'nofen'* | |
3364 'foldenable' 'fen' boolean (default on) | |
3365 local to window | |
3366 {not available when compiled without the |+folding| | |
3367 feature} | |
3368 When off, all folds are open. This option can be used to quickly | |
3369 switch between showing all text unfolded and viewing the text with | |
3370 folds (including manually opened or closed folds). It can be toggled | |
10 | 3371 with the |zi| command. The 'foldcolumn' will remain blank when |
7 | 3372 'foldenable' is off. |
3373 This option is set by commands that create a new fold or close a fold. | |
3374 See |folding|. | |
3375 | |
3376 *'foldexpr'* *'fde'* | |
3377 'foldexpr' 'fde' string (default: "0") | |
3378 local to window | |
3379 {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
|
3380 or |+eval| features} |
7 | 3381 The expression used for when 'foldmethod' is "expr". It is evaluated |
634 | 3382 for each line to obtain its fold level. See |fold-expr|. |
782 | 3383 |
3682 | 3384 The expression will be evaluated in the |sandbox| if set from a |
3385 modeline, see |sandbox-option|. | |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
3386 This option can't be set from a |modeline| when the 'diff' option is |
16728
e55c26aaf484
patch 8.1.1366: using expressions in a modeline is unsafe
Bram Moolenaar <Bram@vim.org>
parents:
16610
diff
changeset
|
3387 on or the 'modelineexpr' option is off. |
634 | 3388 |
3389 It is not allowed to change text or jump to another window while | |
3390 evaluating 'foldexpr' |textlock|. | |
7 | 3391 |
3392 *'foldignore'* *'fdi'* | |
3393 'foldignore' 'fdi' string (default: "#") | |
3394 local to window | |
3395 {not available when compiled without the |+folding| | |
3396 feature} | |
3397 Used only when 'foldmethod' is "indent". Lines starting with | |
3398 characters in 'foldignore' will get their fold level from surrounding | |
10 | 3399 lines. White space is skipped before checking for this character. |
7 | 3400 The default "#" works well for C programs. See |fold-indent|. |
3401 | |
3402 *'foldlevel'* *'fdl'* | |
3403 'foldlevel' 'fdl' number (default: 0) | |
3404 local to window | |
3405 {not available when compiled without the |+folding| | |
3406 feature} | |
3407 Sets the fold level: Folds with a higher level will be closed. | |
3408 Setting this option to zero will close all folds. Higher numbers will | |
3409 close fewer folds. | |
3410 This option is set by commands like |zm|, |zM| and |zR|. | |
3411 See |fold-foldlevel|. | |
3412 | |
3413 *'foldlevelstart'* *'fdls'* | |
3414 'foldlevelstart' 'fdls' number (default: -1) | |
3415 global | |
3416 {not available when compiled without the |+folding| | |
3417 feature} | |
3418 Sets 'foldlevel' when starting to edit another buffer in a window. | |
3419 Useful to always start editing with all folds closed (value zero), | |
3420 some folds closed (one) or no folds closed (99). | |
3421 This is done before reading any modeline, thus a setting in a modeline | |
10 | 3422 overrules this option. Starting to edit a file for |diff-mode| also |
7 | 3423 ignores this option and closes all folds. |
3424 It is also done before BufReadPre autocommands, to allow an autocmd to | |
3425 overrule the 'foldlevel' value for specific files. | |
3426 When the value is negative, it is not used. | |
3427 | |
3428 *'foldmarker'* *'fmr'* *E536* | |
3429 'foldmarker' 'fmr' string (default: "{{{,}}}") | |
3430 local to window | |
3431 {not available when compiled without the |+folding| | |
3432 feature} | |
3433 The start and end marker used when 'foldmethod' is "marker". There | |
3434 must be one comma, which separates the start and end marker. The | |
3435 marker is a literal string (a regular expression would be too slow). | |
3436 See |fold-marker|. | |
3437 | |
3438 *'foldmethod'* *'fdm'* | |
3439 'foldmethod' 'fdm' string (default: "manual") | |
3440 local to window | |
3441 {not available when compiled without the |+folding| | |
3442 feature} | |
3443 The kind of folding used for the current window. Possible values: | |
3444 |fold-manual| manual Folds are created manually. | |
3445 |fold-indent| indent Lines with equal indent form a fold. | |
3446 |fold-expr| expr 'foldexpr' gives the fold level of a line. | |
3447 |fold-marker| marker Markers are used to specify folds. | |
3448 |fold-syntax| syntax Syntax highlighting items specify folds. | |
3449 |fold-diff| diff Fold text that is not changed. | |
3450 | |
3451 *'foldminlines'* *'fml'* | |
3452 'foldminlines' 'fml' number (default: 1) | |
3453 local to window | |
3454 {not available when compiled without the |+folding| | |
3455 feature} | |
2709 | 3456 Sets the number of screen lines above which a fold can be displayed |
3457 closed. Also for manually closed folds. With the default value of | |
3458 one a fold can only be closed if it takes up two or more screen lines. | |
3459 Set to zero to be able to close folds of just one screen line. | |
2826 | 3460 Note that this only has an effect on what is displayed. After using |
7 | 3461 "zc" to close a fold, which is displayed open because it's smaller |
3462 than 'foldminlines', a following "zc" may close a containing fold. | |
3463 | |
3464 *'foldnestmax'* *'fdn'* | |
3465 'foldnestmax' 'fdn' number (default: 20) | |
3466 local to window | |
3467 {not available when compiled without the |+folding| | |
3468 feature} | |
3469 Sets the maximum nesting of folds for the "indent" and "syntax" | |
3470 methods. This avoids that too many folds will be created. Using more | |
3471 than 20 doesn't work, because the internal limit is 20. | |
3472 | |
3473 *'foldopen'* *'fdo'* | |
3474 'foldopen' 'fdo' string (default: "block,hor,mark,percent,quickfix, | |
3475 search,tag,undo") | |
3476 global | |
3477 {not available when compiled without the |+folding| | |
3478 feature} | |
3479 Specifies for which type of commands folds will be opened, if the | |
3480 command moves the cursor into a closed fold. It is a comma separated | |
3481 list of items. | |
2625 | 3482 NOTE: When the command is part of a mapping this option is not used. |
3483 Add the |zv| command to the mapping to get the same effect. | |
3484 (rationale: the mapping may want to control opening folds itself) | |
3485 | |
7 | 3486 item commands ~ |
3487 all any | |
3488 block "(", "{", "[[", "[{", etc. | |
3489 hor horizontal movements: "l", "w", "fx", etc. | |
3490 insert any command in Insert mode | |
3491 jump far jumps: "G", "gg", etc. | |
3492 mark jumping to a mark: "'m", CTRL-O, etc. | |
3493 percent "%" | |
3494 quickfix ":cn", ":crew", ":make", etc. | |
3495 search search for a pattern: "/", "n", "*", "gd", etc. | |
3496 (not for a search pattern in a ":" command) | |
819 | 3497 Also for |[s| and |]s|. |
7 | 3498 tag jumping to a tag: ":ta", CTRL-T, etc. |
3499 undo undo or redo: "u" and CTRL-R | |
3500 When a movement command is used for an operator (e.g., "dl" or "y%") | |
3501 this option is not used. This means the operator will include the | |
3502 whole closed fold. | |
3503 Note that vertical movements are not here, because it would make it | |
3504 very difficult to move onto a closed fold. | |
3505 In insert mode the folds containing the cursor will always be open | |
3506 when text is inserted. | |
3507 To close folds you can re-apply 'foldlevel' with the |zx| command or | |
3508 set the 'foldclose' option to "all". | |
3509 | |
3510 *'foldtext'* *'fdt'* | |
3511 'foldtext' 'fdt' string (default: "foldtext()") | |
3512 local to window | |
3513 {not available when compiled without the |+folding| | |
3514 feature} | |
3515 An expression which is used to specify the text displayed for a closed | |
3516 fold. See |fold-foldtext|. | |
3517 | |
3682 | 3518 The expression will be evaluated in the |sandbox| if set from a |
3519 modeline, see |sandbox-option|. | |
16728
e55c26aaf484
patch 8.1.1366: using expressions in a modeline is unsafe
Bram Moolenaar <Bram@vim.org>
parents:
16610
diff
changeset
|
3520 This option cannot be set in a modeline when 'modelineexpr' is off. |
634 | 3521 |
3522 It is not allowed to change text or jump to another window while | |
3523 evaluating 'foldtext' |textlock|. | |
3524 | |
9286
64035abb986b
commit https://github.com/vim/vim/commit/c95a302a4c42ec8230473cd4a5e0064d0a143aa8
Christian Brabandt <cb@256bit.org>
parents:
9227
diff
changeset
|
3525 *'formatexpr'* *'fex'* |
64035abb986b
commit https://github.com/vim/vim/commit/c95a302a4c42ec8230473cd4a5e0064d0a143aa8
Christian Brabandt <cb@256bit.org>
parents:
9227
diff
changeset
|
3526 'formatexpr' 'fex' string (default "") |
64035abb986b
commit https://github.com/vim/vim/commit/c95a302a4c42ec8230473cd4a5e0064d0a143aa8
Christian Brabandt <cb@256bit.org>
parents:
9227
diff
changeset
|
3527 local to buffer |
64035abb986b
commit https://github.com/vim/vim/commit/c95a302a4c42ec8230473cd4a5e0064d0a143aa8
Christian Brabandt <cb@256bit.org>
parents:
9227
diff
changeset
|
3528 {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
|
3529 feature} |
64035abb986b
commit https://github.com/vim/vim/commit/c95a302a4c42ec8230473cd4a5e0064d0a143aa8
Christian Brabandt <cb@256bit.org>
parents:
9227
diff
changeset
|
3530 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
|
3531 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
|
3532 option is empty 'formatprg' is used. |
64035abb986b
commit https://github.com/vim/vim/commit/c95a302a4c42ec8230473cd4a5e0064d0a143aa8
Christian Brabandt <cb@256bit.org>
parents:
9227
diff
changeset
|
3533 |
64035abb986b
commit https://github.com/vim/vim/commit/c95a302a4c42ec8230473cd4a5e0064d0a143aa8
Christian Brabandt <cb@256bit.org>
parents:
9227
diff
changeset
|
3534 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
|
3535 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
|
3536 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
|
3537 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
|
3538 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
|
3539 it yet! |
64035abb986b
commit https://github.com/vim/vim/commit/c95a302a4c42ec8230473cd4a5e0064d0a143aa8
Christian Brabandt <cb@256bit.org>
parents:
9227
diff
changeset
|
3540 |
64035abb986b
commit https://github.com/vim/vim/commit/c95a302a4c42ec8230473cd4a5e0064d0a143aa8
Christian Brabandt <cb@256bit.org>
parents:
9227
diff
changeset
|
3541 Example: > |
64035abb986b
commit https://github.com/vim/vim/commit/c95a302a4c42ec8230473cd4a5e0064d0a143aa8
Christian Brabandt <cb@256bit.org>
parents:
9227
diff
changeset
|
3542 :set formatexpr=mylang#Format() |
64035abb986b
commit https://github.com/vim/vim/commit/c95a302a4c42ec8230473cd4a5e0064d0a143aa8
Christian Brabandt <cb@256bit.org>
parents:
9227
diff
changeset
|
3543 < 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
|
3544 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
|
3545 |
64035abb986b
commit https://github.com/vim/vim/commit/c95a302a4c42ec8230473cd4a5e0064d0a143aa8
Christian Brabandt <cb@256bit.org>
parents:
9227
diff
changeset
|
3546 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
|
3547 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
|
3548 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
|
3549 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
|
3550 return "i" or "R" in this situation. |
13341
acd7eaa13d2b
Updated runtime files.
Christian Brabandt <cb@256bit.org>
parents:
13314
diff
changeset
|
3551 |
9286
64035abb986b
commit https://github.com/vim/vim/commit/c95a302a4c42ec8230473cd4a5e0064d0a143aa8
Christian Brabandt <cb@256bit.org>
parents:
9227
diff
changeset
|
3552 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
|
3553 the internal format mechanism. |
64035abb986b
commit https://github.com/vim/vim/commit/c95a302a4c42ec8230473cd4a5e0064d0a143aa8
Christian Brabandt <cb@256bit.org>
parents:
9227
diff
changeset
|
3554 |
64035abb986b
commit https://github.com/vim/vim/commit/c95a302a4c42ec8230473cd4a5e0064d0a143aa8
Christian Brabandt <cb@256bit.org>
parents:
9227
diff
changeset
|
3555 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
|
3556 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
|
3557 since changing the buffer text is not allowed. |
16728
e55c26aaf484
patch 8.1.1366: using expressions in a modeline is unsafe
Bram Moolenaar <Bram@vim.org>
parents:
16610
diff
changeset
|
3558 This option cannot be set in a modeline when 'modelineexpr' is off. |
11160 | 3559 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
|
3560 |
41 | 3561 *'formatlistpat'* *'flp'* |
3562 'formatlistpat' 'flp' string (default: "^\s*\d\+[\]:.)}\t ]\s*") | |
3563 local to buffer | |
3564 A pattern that is used to recognize a list header. This is used for | |
3565 the "n" flag in 'formatoptions'. | |
3566 The pattern must match exactly the text that will be the indent for | |
140 | 3567 the line below it. You can use |/\ze| to mark the end of the match |
41 | 3568 while still checking more characters. There must be a character |
3569 following the pattern, when it matches the whole line it is handled | |
3570 like there is no match. | |
3571 The default recognizes a number, followed by an optional punctuation | |
3572 character and white space. | |
3573 | |
16443
32a543152dc0
patch 8.1.1226: {not in Vi} remarks get in the way of useful help text
Bram Moolenaar <Bram@vim.org>
parents:
16439
diff
changeset
|
3574 *'formatoptions'* *'fo'* |
32a543152dc0
patch 8.1.1226: {not in Vi} remarks get in the way of useful help text
Bram Moolenaar <Bram@vim.org>
parents:
16439
diff
changeset
|
3575 'formatoptions' 'fo' string (Vim default: "tcq", Vi default: "vt") |
32a543152dc0
patch 8.1.1226: {not in Vi} remarks get in the way of useful help text
Bram Moolenaar <Bram@vim.org>
parents:
16439
diff
changeset
|
3576 local to buffer |
32a543152dc0
patch 8.1.1226: {not in Vi} remarks get in the way of useful help text
Bram Moolenaar <Bram@vim.org>
parents:
16439
diff
changeset
|
3577 This is a sequence of letters which describes how automatic |
32a543152dc0
patch 8.1.1226: {not in Vi} remarks get in the way of useful help text
Bram Moolenaar <Bram@vim.org>
parents:
16439
diff
changeset
|
3578 formatting is to be done. See |fo-table|. When the 'paste' option is |
32a543152dc0
patch 8.1.1226: {not in Vi} remarks get in the way of useful help text
Bram Moolenaar <Bram@vim.org>
parents:
16439
diff
changeset
|
3579 on, no formatting is done (like 'formatoptions' is empty). Commas can |
32a543152dc0
patch 8.1.1226: {not in Vi} remarks get in the way of useful help text
Bram Moolenaar <Bram@vim.org>
parents:
16439
diff
changeset
|
3580 be inserted for readability. |
32a543152dc0
patch 8.1.1226: {not in Vi} remarks get in the way of useful help text
Bram Moolenaar <Bram@vim.org>
parents:
16439
diff
changeset
|
3581 To avoid problems with flags that are added in the future, use the |
32a543152dc0
patch 8.1.1226: {not in Vi} remarks get in the way of useful help text
Bram Moolenaar <Bram@vim.org>
parents:
16439
diff
changeset
|
3582 "+=" and "-=" feature of ":set" |add-option-flags|. |
32a543152dc0
patch 8.1.1226: {not in Vi} remarks get in the way of useful help text
Bram Moolenaar <Bram@vim.org>
parents:
16439
diff
changeset
|
3583 NOTE: This option is set to the Vi default value when 'compatible' is |
32a543152dc0
patch 8.1.1226: {not in Vi} remarks get in the way of useful help text
Bram Moolenaar <Bram@vim.org>
parents:
16439
diff
changeset
|
3584 set and to the Vim default value when 'compatible' is reset. |
32a543152dc0
patch 8.1.1226: {not in Vi} remarks get in the way of useful help text
Bram Moolenaar <Bram@vim.org>
parents:
16439
diff
changeset
|
3585 |
7 | 3586 *'formatprg'* *'fp'* |
3587 '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
|
3588 global or local to buffer |global-local| |
7 | 3589 The name of an external program that will be used to format the lines |
667 | 3590 selected with the |gq| operator. The program must take the input on |
7 | 3591 stdin and produce the output on stdout. The Unix program "fmt" is |
557 | 3592 such a program. |
667 | 3593 If the 'formatexpr' option is not empty it will be used instead. |
3594 Otherwise, if 'formatprg' option is an empty string, the internal | |
3595 format function will be used |C-indenting|. | |
557 | 3596 Environment variables are expanded |:set_env|. See |option-backslash| |
3597 about including spaces and backslashes. | |
3682 | 3598 This option cannot be set from a |modeline| or in the |sandbox|, for |
3599 security reasons. | |
667 | 3600 |
7196
42717d048817
commit https://github.com/vim/vim/commit/d94464ee294a351ce7b6ba18e8bd3f24f1bef920
Christian Brabandt <cb@256bit.org>
parents:
7147
diff
changeset
|
3601 *'fsync'* *'fs'* *'nofsync'* *'nofs'* |
36 | 3602 'fsync' 'fs' boolean (default on) |
3603 global | |
3604 When on, the library function fsync() will be called after writing a | |
3605 file. This will flush a file to disk, ensuring that it is safely | |
3606 written even on filesystems which do metadata-only journaling. This | |
3607 will force the harddrive to spin up on Linux systems running in laptop | |
3608 mode, so it may be undesirable in some situations. Be warned that | |
3609 turning this off increases the chances of data loss after a crash. On | |
3610 systems without an fsync() implementation, this variable is always | |
3611 off. | |
3612 Also see 'swapsync' for controlling fsync() on swap files. | |
25951
560132056b97
patch 8.2.3509: undo file is not synced
Bram Moolenaar <Bram@vim.org>
parents:
25836
diff
changeset
|
3613 'fsync' also applies to |writefile()| (unless a flag is used to |
560132056b97
patch 8.2.3509: undo file is not synced
Bram Moolenaar <Bram@vim.org>
parents:
25836
diff
changeset
|
3614 overrule it) and when writing undo files (see |undo-persistence|). |
16728
e55c26aaf484
patch 8.1.1366: using expressions in a modeline is unsafe
Bram Moolenaar <Bram@vim.org>
parents:
16610
diff
changeset
|
3615 This option cannot be set from a |modeline| or in the |sandbox|, for |
e55c26aaf484
patch 8.1.1366: using expressions in a modeline is unsafe
Bram Moolenaar <Bram@vim.org>
parents:
16610
diff
changeset
|
3616 security reasons. |
36 | 3617 |
7 | 3618 *'gdefault'* *'gd'* *'nogdefault'* *'nogd'* |
3619 'gdefault' 'gd' boolean (default off) | |
3620 global | |
3621 When on, the ":substitute" flag 'g' is default on. This means that | |
3622 all matches in a line are substituted instead of one. When a 'g' flag | |
3623 is given to a ":substitute" command, this will toggle the substitution | |
3624 of all or one match. See |complex-change|. | |
3625 | |
3626 command 'gdefault' on 'gdefault' off ~ | |
3627 :s/// subst. all subst. one | |
3628 :s///g subst. one subst. all | |
3629 :s///gg subst. all subst. one | |
3630 | |
3631 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
|
3632 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
|
3633 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
|
3634 has the opposite effect of that it normally does. |
23305 | 3635 This option is not used in |Vim9| script. |
7 | 3636 |
3637 *'grepformat'* *'gfm'* | |
6213 | 3638 'grepformat' 'gfm' string (default "%f:%l:%m,%f:%l%m,%f %l%m") |
7 | 3639 global |
3640 Format to recognize for the ":grep" command output. | |
3641 This is a scanf-like string that uses the same format as the | |
3642 'errorformat' option: see |errorformat|. | |
3643 | |
3644 *'grepprg'* *'gp'* | |
3645 'grepprg' 'gp' string (default "grep -n ", | |
3646 Unix: "grep -n $* /dev/null", | |
3647 Win32: "findstr /n" or "grep -n", | |
3648 VMS: "SEARCH/NUMBERS ") | |
3649 global or local to buffer |global-local| | |
233 | 3650 Program to use for the |:grep| command. This option may contain '%' |
7 | 3651 and '#' characters, which are expanded like when used in a command- |
3652 line. The placeholder "$*" is allowed to specify where the arguments | |
3653 will be included. Environment variables are expanded |:set_env|. See | |
3654 |option-backslash| about including spaces and backslashes. | |
3655 When your "grep" accepts the "-H" argument, use this to make ":grep" | |
3656 also work well with a single file: > | |
3657 :set grepprg=grep\ -nH | |
161 | 3658 < Special value: When 'grepprg' is set to "internal" the |:grep| command |
657 | 3659 works like |:vimgrep|, |:lgrep| like |:lvimgrep|, |:grepadd| like |
3660 |:vimgrepadd| and |:lgrepadd| like |:lvimgrepadd|. | |
41 | 3661 See also the section |:make_makeprg|, since most of the comments there |
7 | 3662 apply equally to 'grepprg'. |
3663 For Win32, the default is "findstr /n" if "findstr.exe" can be found, | |
3664 otherwise it's "grep -n". | |
3665 This option cannot be set from a |modeline| or in the |sandbox|, for | |
3666 security reasons. | |
3667 | |
3668 *'guicursor'* *'gcr'* *E545* *E546* *E548* *E549* | |
3669 'guicursor' 'gcr' string (default "n-v-c:block-Cursor/lCursor, | |
3670 ve:ver35-Cursor, | |
3671 o:hor50-Cursor, | |
3672 i-ci:ver25-Cursor/lCursor, | |
3673 r-cr:hor20-Cursor/lCursor, | |
3674 sm:block-Cursor | |
3675 -blinkwait175-blinkoff150-blinkon175", | |
18972 | 3676 for Win32 console: |
7 | 3677 "n-v-c:block,o:hor50,i-ci:hor15, |
3678 r-cr:hor30,sm:block") | |
3679 global | |
3680 {only available when compiled with GUI enabled, and | |
18972 | 3681 for Win32 console} |
7 | 3682 This option tells Vim what the cursor should look like in different |
19116 | 3683 modes. It fully works in the GUI. In a Win32 console, only the |
18972 | 3684 height of the cursor can be changed. This can be done by specifying a |
3685 block cursor, or a percentage for a vertical or horizontal cursor. | |
6727 | 3686 For a console the 't_SI', 't_SR', and 't_EI' escape sequences are |
3687 used. | |
7 | 3688 |
10 | 3689 The option is a comma separated list of parts. Each part consist of a |
7 | 3690 mode-list and an argument-list: |
3691 mode-list:argument-list,mode-list:argument-list,.. | |
3692 The mode-list is a dash separated list of these modes: | |
3693 n Normal mode | |
3694 v Visual mode | |
3695 ve Visual mode with 'selection' "exclusive" (same as 'v', | |
3696 if not specified) | |
3697 o Operator-pending mode | |
3698 i Insert mode | |
3699 r Replace mode | |
3700 c Command-line Normal (append) mode | |
3701 ci Command-line Insert mode | |
3702 cr Command-line Replace mode | |
3703 sm showmatch in Insert mode | |
3704 a all modes | |
3705 The argument-list is a dash separated list of these arguments: | |
3706 hor{N} horizontal bar, {N} percent of the character height | |
3707 ver{N} vertical bar, {N} percent of the character width | |
3708 block block cursor, fills the whole character | |
3709 [only one of the above three should be present] | |
3710 blinkwait{N} *cursor-blinking* | |
3711 blinkon{N} | |
3712 blinkoff{N} | |
3713 blink times for cursor: blinkwait is the delay before | |
3714 the cursor starts blinking, blinkon is the time that | |
3715 the cursor is shown and blinkoff is the time that the | |
3716 cursor is not shown. The times are in msec. When one | |
3717 of the numbers is zero, there is no blinking. The | |
3718 default is: "blinkwait700-blinkon400-blinkoff250". | |
3719 These numbers are used for a missing entry. This | |
3720 means that blinking is enabled by default. To switch | |
3721 blinking off you can use "blinkon0". The cursor only | |
3722 blinks when Vim is waiting for input, not while | |
3723 executing a command. | |
3724 To make the cursor blink in an xterm, see | |
3725 |xterm-blink|. | |
3726 {group-name} | |
3727 a highlight group name, that sets the color and font | |
3728 for the cursor | |
3729 {group-name}/{group-name} | |
3730 Two highlight group names, the first is used when | |
3731 no language mappings are used, the other when they | |
3732 are. |language-mapping| | |
3733 | |
3734 Examples of parts: | |
3735 n-c-v:block-nCursor in Normal, Command-line and Visual mode, use a | |
3736 block cursor with colors from the "nCursor" | |
3737 highlight group | |
3738 i-ci:ver30-iCursor-blinkwait300-blinkon200-blinkoff150 | |
3739 In Insert and Command-line Insert mode, use a | |
3740 30% vertical bar cursor with colors from the | |
3741 "iCursor" highlight group. Blink a bit | |
3742 faster. | |
3743 | |
3744 The 'a' mode is different. It will set the given argument-list for | |
3745 all modes. It does not reset anything to defaults. This can be used | |
3746 to do a common setting for all modes. For example, to switch off | |
3747 blinking: "a:blinkon0" | |
3748 | |
3749 Examples of cursor highlighting: > | |
3750 :highlight Cursor gui=reverse guifg=NONE guibg=NONE | |
3751 :highlight Cursor gui=NONE guifg=bg guibg=fg | |
3752 < | |
3753 *'guifont'* *'gfn'* | |
2908 | 3754 *E235* *E596* |
7 | 3755 'guifont' 'gfn' string (default "") |
3756 global | |
3757 {only available when compiled with GUI enabled} | |
3758 This is a list of fonts which will be used for the GUI version of Vim. | |
16439
9d20e26dc13c
patch 8.1.1224: MS-Windows: cannot specify font weight
Bram Moolenaar <Bram@vim.org>
parents:
16427
diff
changeset
|
3759 In its simplest form the value is just one font name. |
9d20e26dc13c
patch 8.1.1224: MS-Windows: cannot specify font weight
Bram Moolenaar <Bram@vim.org>
parents:
16427
diff
changeset
|
3760 See |gui-font| for the details. |
7 | 3761 |
3762 *'guifontset'* *'gfs'* | |
3763 *E250* *E252* *E234* *E597* *E598* | |
3764 'guifontset' 'gfs' string (default "") | |
3765 global | |
3766 {only available when compiled with GUI enabled and | |
3767 with the |+xfontset| feature} | |
10895
c391bfbdb452
Updated runtime files.
Christian Brabandt <cb@256bit.org>
parents:
10734
diff
changeset
|
3768 {not available in the GTK+ GUI} |
7 | 3769 When not empty, specifies two (or more) fonts to be used. The first |
3770 one for normal English, the second one for your special language. See | |
3771 |xfontset|. | |
16439
9d20e26dc13c
patch 8.1.1224: MS-Windows: cannot specify font weight
Bram Moolenaar <Bram@vim.org>
parents:
16427
diff
changeset
|
3772 |
7 | 3773 *'guifontwide'* *'gfw'* *E231* *E533* *E534* |
3774 'guifontwide' 'gfw' string (default "") | |
3775 global | |
3776 {only available when compiled with GUI enabled} | |
3777 When not empty, specifies a comma-separated list of fonts to be used | |
3778 for double-width characters. The first font that can be loaded is | |
16439
9d20e26dc13c
patch 8.1.1224: MS-Windows: cannot specify font weight
Bram Moolenaar <Bram@vim.org>
parents:
16427
diff
changeset
|
3779 used. See |gui-fontwide|. |
4055 | 3780 |
7 | 3781 *'guiheadroom'* *'ghr'* |
3782 'guiheadroom' 'ghr' number (default 50) | |
3783 global | |
16728
e55c26aaf484
patch 8.1.1366: using expressions in a modeline is unsafe
Bram Moolenaar <Bram@vim.org>
parents:
16610
diff
changeset
|
3784 {only for GTK and X11 GUI} |
7 | 3785 The number of pixels subtracted from the screen height when fitting |
3786 the GUI window on the screen. Set this before the GUI is started, | |
3787 e.g., in your |gvimrc| file. When zero, the whole screen height will | |
10 | 3788 be used by the window. When positive, the specified number of pixel |
7 | 3789 lines will be left for window decorations and other items on the |
3790 screen. Set it to a negative value to allow windows taller than the | |
3791 screen. | |
3792 | |
3793 *'guioptions'* *'go'* | |
14945 | 3794 'guioptions' 'go' string (default "egmrLtT" (MS-Windows, |
3795 "t" is removed in |defaults.vim|), | |
9669
284b4eb307fc
commit https://github.com/vim/vim/commit/8c08b5b569e2a9e9f63dea514591ecfa2d3bb392
Christian Brabandt <cb@256bit.org>
parents:
9665
diff
changeset
|
3796 "aegimrLtT" (GTK, Motif and Athena), |
284b4eb307fc
commit https://github.com/vim/vim/commit/8c08b5b569e2a9e9f63dea514591ecfa2d3bb392
Christian Brabandt <cb@256bit.org>
parents:
9665
diff
changeset
|
3797 ) |
7 | 3798 global |
3799 {only available when compiled with GUI enabled} | |
8 | 3800 This option only has an effect in the GUI version of Vim. It is a |
7 | 3801 sequence of letters which describes what components and options of the |
3802 GUI should be used. | |
3803 To avoid problems with flags that are added in the future, use the | |
3804 "+=" and "-=" feature of ":set" |add-option-flags|. | |
3805 | |
13470
6faef782f50b
patch 8.0.1609: shell commands in the GUI use a dumb terminal
Christian Brabandt <cb@256bit.org>
parents:
13437
diff
changeset
|
3806 Valid characters are as follows: |
6faef782f50b
patch 8.0.1609: shell commands in the GUI use a dumb terminal
Christian Brabandt <cb@256bit.org>
parents:
13437
diff
changeset
|
3807 *'go-!'* |
6faef782f50b
patch 8.0.1609: shell commands in the GUI use a dumb terminal
Christian Brabandt <cb@256bit.org>
parents:
13437
diff
changeset
|
3808 '!' External commands are executed in a terminal window. Without |
6faef782f50b
patch 8.0.1609: shell commands in the GUI use a dumb terminal
Christian Brabandt <cb@256bit.org>
parents:
13437
diff
changeset
|
3809 this flag the MS-Windows GUI will open a console window to |
6faef782f50b
patch 8.0.1609: shell commands in the GUI use a dumb terminal
Christian Brabandt <cb@256bit.org>
parents:
13437
diff
changeset
|
3810 execute the command. The Unix GUI will simulate a dumb |
6faef782f50b
patch 8.0.1609: shell commands in the GUI use a dumb terminal
Christian Brabandt <cb@256bit.org>
parents:
13437
diff
changeset
|
3811 terminal to list the command output. |
6faef782f50b
patch 8.0.1609: shell commands in the GUI use a dumb terminal
Christian Brabandt <cb@256bit.org>
parents:
13437
diff
changeset
|
3812 The terminal window will be positioned at the bottom, and grow |
6faef782f50b
patch 8.0.1609: shell commands in the GUI use a dumb terminal
Christian Brabandt <cb@256bit.org>
parents:
13437
diff
changeset
|
3813 upwards as needed. |
14999 | 3814 *'go-a'* |
7 | 3815 'a' Autoselect: If present, then whenever VISUAL mode is started, |
3816 or the Visual area extended, Vim tries to become the owner of | |
3817 the windowing system's global selection. This means that the | |
3818 Visually highlighted text is available for pasting into other | |
3819 applications as well as into Vim itself. When the Visual mode | |
3820 ends, possibly due to an operation on the text, or when an | |
3821 application wants to paste the selection, the highlighted text | |
3822 is automatically yanked into the "* selection register. | |
3823 Thus the selection is still available for pasting into other | |
3824 applications after the VISUAL mode has ended. | |
3825 If not present, then Vim won't become the owner of the | |
3826 windowing system's global selection unless explicitly told to | |
3827 by a yank or delete operation for the "* register. | |
3828 The same applies to the modeless selection. | |
3674 | 3829 *'go-P'* |
3830 '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
|
3831 register. |
1152 | 3832 *'go-A'* |
10 | 3833 'A' Autoselect for the modeless selection. Like 'a', but only |
7 | 3834 applies to the modeless selection. |
3835 | |
3836 'guioptions' autoselect Visual autoselect modeless ~ | |
3837 "" - - | |
3838 "a" yes yes | |
3839 "A" - yes | |
3840 "aA" yes yes | |
3841 | |
1152 | 3842 *'go-c'* |
7 | 3843 'c' Use console dialogs instead of popup dialogs for simple |
3844 choices. | |
18078
5ae41d0ea397
patch 8.1.2034: dark them of GTK 3 not supported
Bram Moolenaar <Bram@vim.org>
parents:
18068
diff
changeset
|
3845 *'go-d'* |
5ae41d0ea397
patch 8.1.2034: dark them of GTK 3 not supported
Bram Moolenaar <Bram@vim.org>
parents:
18068
diff
changeset
|
3846 'd' Use dark theme variant if available. Currently only works for |
5ae41d0ea397
patch 8.1.2034: dark them of GTK 3 not supported
Bram Moolenaar <Bram@vim.org>
parents:
18068
diff
changeset
|
3847 GTK+ GUI. |
1152 | 3848 *'go-e'* |
697 | 3849 'e' Add tab pages when indicated with 'showtabline'. |
688 | 3850 'guitablabel' can be used to change the text in the labels. |
3851 When 'e' is missing a non-GUI tab pages line may be used. | |
857 | 3852 The GUI tabs are only supported on some systems, currently |
19526
22f0dda71638
patch 8.2.0320: no Haiku support
Bram Moolenaar <Bram@vim.org>
parents:
19404
diff
changeset
|
3853 GTK, Motif, Mac OS/X, Haiku, and MS-Windows. |
1152 | 3854 *'go-f'* |
7 | 3855 'f' Foreground: Don't use fork() to detach the GUI from the shell |
3856 where it was started. Use this for programs that wait for the | |
3857 editor to finish (e.g., an e-mail program). Alternatively you | |
3858 can use "gvim -f" or ":gui -f" to start the GUI in the | |
3859 foreground. |gui-fork| | |
3860 Note: Set this option in the vimrc file. The forking may have | |
819 | 3861 happened already when the |gvimrc| file is read. |
1152 | 3862 *'go-i'* |
7 | 3863 'i' Use a Vim icon. For GTK with KDE it is used in the left-upper |
3864 corner of the window. It's black&white on non-GTK, because of | |
3865 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
|
3866 *'go-m'* |
7 | 3867 'm' Menu bar is present. |
2290
22529abcd646
Fixed ":s" message. Docs updates.
Bram Moolenaar <bram@vim.org>
parents:
2283
diff
changeset
|
3868 *'go-M'* |
10 | 3869 'M' The system menu "$VIMRUNTIME/menu.vim" is not sourced. Note |
7 | 3870 that this flag must be added in the .vimrc file, before |
819 | 3871 switching on syntax or filetype recognition (when the |gvimrc| |
7 | 3872 file is sourced the system menu has already been loaded; the |
12756
3b26420fc639
Long overdue runtime update.
Christian Brabandt <cb@256bit.org>
parents:
12744
diff
changeset
|
3873 `: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
|
3874 *'go-g'* |
7 | 3875 'g' Grey menu items: Make menu items that are not active grey. If |
3876 'g' is not included inactive menu items are not shown at all. | |
3877 Exception: Athena will always use grey menu items. | |
1152 | 3878 *'go-t'* |
7 | 3879 't' Include tearoff menu items. Currently only works for Win32, |
3880 GTK+, and Motif 1.2 GUI. | |
1152 | 3881 *'go-T'* |
236 | 3882 'T' Include Toolbar. Currently only in Win32, GTK+, Motif, Photon |
856 | 3883 and Athena GUIs. |
1152 | 3884 *'go-r'* |
7 | 3885 'r' Right-hand scrollbar is always present. |
2290
22529abcd646
Fixed ":s" message. Docs updates.
Bram Moolenaar <bram@vim.org>
parents:
2283
diff
changeset
|
3886 *'go-R'* |
7 | 3887 'R' Right-hand scrollbar is present when there is a vertically |
3888 split window. | |
2290
22529abcd646
Fixed ":s" message. Docs updates.
Bram Moolenaar <bram@vim.org>
parents:
2283
diff
changeset
|
3889 *'go-l'* |
7 | 3890 'l' Left-hand scrollbar is always present. |
2290
22529abcd646
Fixed ":s" message. Docs updates.
Bram Moolenaar <bram@vim.org>
parents:
2283
diff
changeset
|
3891 *'go-L'* |
7 | 3892 'L' Left-hand scrollbar is present when there is a vertically |
3893 split window. | |
1152 | 3894 *'go-b'* |
7 | 3895 'b' Bottom (horizontal) scrollbar is present. Its size depends on |
3896 the longest visible line, or on the cursor line if the 'h' | |
3897 flag is included. |gui-horiz-scroll| | |
2290
22529abcd646
Fixed ":s" message. Docs updates.
Bram Moolenaar <bram@vim.org>
parents:
2283
diff
changeset
|
3898 *'go-h'* |
7 | 3899 'h' Limit horizontal scrollbar size to the length of the cursor |
3900 line. Reduces computations. |gui-horiz-scroll| | |
3901 | |
3902 And yes, you may even have scrollbars on the left AND the right if | |
3903 you really want to :-). See |gui-scrollbars| for more information. | |
3904 | |
2290
22529abcd646
Fixed ":s" message. Docs updates.
Bram Moolenaar <bram@vim.org>
parents:
2283
diff
changeset
|
3905 *'go-v'* |
7 | 3906 'v' Use a vertical button layout for dialogs. When not included, |
3907 a horizontal layout is preferred, but when it doesn't fit a | |
24278 | 3908 vertical layout is used anyway. Not supported in GTK 3. |
2290
22529abcd646
Fixed ":s" message. Docs updates.
Bram Moolenaar <bram@vim.org>
parents:
2283
diff
changeset
|
3909 *'go-p'* |
7 | 3910 'p' Use Pointer callbacks for X11 GUI. This is required for some |
3911 window managers. If the cursor is not blinking or hollow at | |
3912 the right moment, try adding this flag. This must be done | |
819 | 3913 before starting the GUI. Set it in your |gvimrc|. Adding or |
7 | 3914 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
|
3915 *'go-F'* |
10 | 3916 'F' Add a footer. Only for Motif. See |gui-footer|. |
12802
29a728529f92
patch 8.0.1278: GUI window always resizes when adding scrollbar
Christian Brabandt <cb@256bit.org>
parents:
12785
diff
changeset
|
3917 *'go-k'* |
29a728529f92
patch 8.0.1278: GUI window always resizes when adding scrollbar
Christian Brabandt <cb@256bit.org>
parents:
12785
diff
changeset
|
3918 'k' Keep the GUI window size when adding/removing a scrollbar, or |
29a728529f92
patch 8.0.1278: GUI window always resizes when adding scrollbar
Christian Brabandt <cb@256bit.org>
parents:
12785
diff
changeset
|
3919 toolbar, tabline, etc. Instead, the behavior is similar to |
29a728529f92
patch 8.0.1278: GUI window always resizes when adding scrollbar
Christian Brabandt <cb@256bit.org>
parents:
12785
diff
changeset
|
3920 when the window is maximized and will adjust 'lines' and |
29a728529f92
patch 8.0.1278: GUI window always resizes when adding scrollbar
Christian Brabandt <cb@256bit.org>
parents:
12785
diff
changeset
|
3921 'columns' to fit to the window. Without the 'k' flag Vim will |
12865
ebb4f6c93598
patch 8.0.1309: cannot use 'balloonexpr' in a terminal
Christian Brabandt <cb@256bit.org>
parents:
12826
diff
changeset
|
3922 try to keep 'lines' and 'columns' the same when adding and |
12802
29a728529f92
patch 8.0.1278: GUI window always resizes when adding scrollbar
Christian Brabandt <cb@256bit.org>
parents:
12785
diff
changeset
|
3923 removing GUI components. |
1152 | 3924 |
7 | 3925 *'guipty'* *'noguipty'* |
3926 'guipty' boolean (default on) | |
3927 global | |
3928 {only available when compiled with GUI enabled} | |
3929 Only in the GUI: If on, an attempt is made to open a pseudo-tty for | |
3930 I/O to/from shell commands. See |gui-pty|. | |
3931 | |
688 | 3932 *'guitablabel'* *'gtl'* |
3933 'guitablabel' 'gtl' string (default empty) | |
3934 global | |
17771
4bd21046902b
patch 8.1.1882: cannot specify properties of the info popup window
Bram Moolenaar <Bram@vim.org>
parents:
17767
diff
changeset
|
3935 {only available when compiled with GUI enabled} |
688 | 3936 When nonempty describes the text to use in a label of the GUI tab |
857 | 3937 pages line. When empty and when the result is empty Vim will use a |
3938 default label. See |setting-guitablabel| for more info. | |
688 | 3939 |
692 | 3940 The format of this option is like that of 'statusline'. |
839 | 3941 '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
|
3942 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
|
3943 modeline, see |sandbox-option|. |
16728
e55c26aaf484
patch 8.1.1366: using expressions in a modeline is unsafe
Bram Moolenaar <Bram@vim.org>
parents:
16610
diff
changeset
|
3944 This option cannot be set in a modeline when 'modelineexpr' is off. |
692 | 3945 |
688 | 3946 Only used when the GUI tab pages line is displayed. 'e' must be |
3947 present in 'guioptions'. For the non-GUI tab pages line 'tabline' is | |
3948 used. | |
3949 | |
839 | 3950 *'guitabtooltip'* *'gtt'* |
3951 'guitabtooltip' 'gtt' string (default empty) | |
3952 global | |
17771
4bd21046902b
patch 8.1.1882: cannot specify properties of the info popup window
Bram Moolenaar <Bram@vim.org>
parents:
17767
diff
changeset
|
3953 {only available when compiled with GUI enabled} |
839 | 3954 When nonempty describes the text to use in a tooltip for the GUI tab |
3955 pages line. When empty Vim will use a default tooltip. | |
3956 This option is otherwise just like 'guitablabel' above. | |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
3957 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
|
3958 :let &guitabtooltip = "line one\nline two" |
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
3959 < |
839 | 3960 |
7 | 3961 *'helpfile'* *'hf'* |
18972 | 3962 'helpfile' 'hf' string (default (MS-Windows) "$VIMRUNTIME\doc\help.txt" |
7 | 3963 (others) "$VIMRUNTIME/doc/help.txt") |
3964 global | |
3965 Name of the main help file. All distributed help files should be | |
3966 placed together in one directory. Additionally, all "doc" directories | |
3967 in 'runtimepath' will be used. | |
3968 Environment variables are expanded |:set_env|. For example: | |
3969 "$VIMRUNTIME/doc/help.txt". If $VIMRUNTIME is not set, $VIM is also | |
10 | 3970 tried. Also see |$VIMRUNTIME| and |option-backslash| about including |
7 | 3971 spaces and backslashes. |
3972 This option cannot be set from a |modeline| or in the |sandbox|, for | |
3973 security reasons. | |
3974 | |
3975 *'helpheight'* *'hh'* | |
3976 'helpheight' 'hh' number (default 20) | |
3977 global | |
3978 Minimal initial height of the help window when it is opened with the | |
3979 ":help" command. The initial height of the help window is half of the | |
3980 current window, or (when the 'ea' option is on) the same as other | |
3981 windows. When the height is less than 'helpheight', the height is | |
3982 set to 'helpheight'. Set to zero to disable. | |
3983 | |
3984 *'helplang'* *'hlg'* | |
3985 'helplang' 'hlg' string (default: messages language or empty) | |
3986 global | |
3987 {only available when compiled with the |+multi_lang| | |
3988 feature} | |
3989 Comma separated list of languages. Vim will use the first language | |
3990 for which the desired help can be found. The English help will always | |
3991 be used as a last resort. You can add "en" to prefer English over | |
3992 another language, but that will only find tags that exist in that | |
3993 language and not in the English help. | |
3994 Example: > | |
3995 :set helplang=de,it | |
3996 < This will first search German, then Italian and finally English help | |
3997 files. | |
3998 When using |CTRL-]| and ":help!" in a non-English help file Vim will | |
3999 try to find the tag in the current language before using this option. | |
4000 See |help-translated|. | |
4001 | |
4002 *'hidden'* *'hid'* *'nohidden'* *'nohid'* | |
4003 'hidden' 'hid' boolean (default off) | |
4004 global | |
4005 When off a buffer is unloaded when it is |abandon|ed. When on a | |
4006 buffer becomes hidden when it is |abandon|ed. If the buffer is still | |
4007 displayed in another window, it does not become hidden, of course. | |
4008 The commands that move through the buffer list sometimes make a buffer | |
4009 hidden although the 'hidden' option is off: When the buffer is | |
4010 modified, 'autowrite' is off or writing is not possible, and the '!' | |
10 | 4011 flag was used. See also |windows.txt|. |
12 | 4012 To only make one buffer hidden use the 'bufhidden' option. |
7 | 4013 This option is set for one command with ":hide {command}" |:hide|. |
4014 WARNING: It's easy to forget that you have changes in hidden buffers. | |
4015 Think twice when using ":q!" or ":qa!". | |
4016 | |
4017 *'highlight'* *'hl'* | |
4018 '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
|
4019 "8:SpecialKey,~:EndOfBuffer,@:NonText, |
7da89d9c744b
commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents:
9860
diff
changeset
|
4020 d:Directory,e:ErrorMsg,i:IncSearch, |
7da89d9c744b
commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents:
9860
diff
changeset
|
4021 l:Search,m:MoreMsg,M:ModeMsg,n:LineNr, |
18471
b9cf60801963
patch 8.1.2229: cannot color number column above/below cursor differently
Bram Moolenaar <Bram@vim.org>
parents:
18465
diff
changeset
|
4022 a:LineNrAbove,b:LineNrBelow, |
9877
7da89d9c744b
commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents:
9860
diff
changeset
|
4023 N:CursorLineNr,r:Question,s:StatusLine, |
7da89d9c744b
commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents:
9860
diff
changeset
|
4024 S:StatusLineNC,c:VertSplit,t:Title, |
15194 | 4025 v:Visual,V:VisualNOS,w:WarningMsg, |
4026 W:WildMenu,f:Folded,F:FoldColumn, | |
4027 A:DiffAdd,C:DiffChange,D:DiffDelete, | |
4028 T:DiffText,>:SignColumn,-:Conceal, | |
15281 | 4029 B:SpellBad,P:SpellCap,R:SpellRare, |
15194 | 4030 L:SpellLocal,+:Pmenu,=:PmenuSel, |
11516
80491a71c716
patch 8.0.0641: cannot set a separate highlighting for the quickfix line
Christian Brabandt <cb@256bit.org>
parents:
11473
diff
changeset
|
4031 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
|
4032 #:TabLineSel,_:TabLineFill,!:CursorColumn, |
11914 | 4033 .:CursorLine,o:ColorColumn,q:QuickFixLine, |
12254 | 4034 z:StatusLineTerm,Z:StatusLineTermNC") |
7 | 4035 global |
4036 This option can be used to set highlighting mode for various | |
4037 occasions. It is a comma separated list of character pairs. The | |
4038 first character in a pair gives the occasion, the second the mode to | |
10 | 4039 use for that occasion. The occasions are: |
7 | 4040 |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
|
4041 |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
|
4042 |hl-NonText| @ '@' at the end of the window and |
7 | 4043 characters from 'showbreak' |
4044 |hl-Directory| d directories in CTRL-D listing and other special | |
4045 things in listings | |
4046 |hl-ErrorMsg| e error messages | |
4047 h (obsolete, ignored) | |
4048 |hl-IncSearch| i 'incsearch' highlighting | |
4049 |hl-Search| l last search pattern highlighting (see 'hlsearch') | |
4050 |hl-MoreMsg| m |more-prompt| | |
4051 |hl-ModeMsg| M Mode (e.g., "-- INSERT --") | |
2178
c6f1aa1e9f32
Add 'relativenumber' patch from Markus Heidelberg.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
4052 |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
|
4053 when 'number' or 'relativenumber' option is set. |
18471
b9cf60801963
patch 8.1.2229: cannot color number column above/below cursor differently
Bram Moolenaar <Bram@vim.org>
parents:
18465
diff
changeset
|
4054 |hl-LineNrAbove| a line number above the cursor for when the |
b9cf60801963
patch 8.1.2229: cannot color number column above/below cursor differently
Bram Moolenaar <Bram@vim.org>
parents:
18465
diff
changeset
|
4055 'relativenumber' option is set. |
b9cf60801963
patch 8.1.2229: cannot color number column above/below cursor differently
Bram Moolenaar <Bram@vim.org>
parents:
18465
diff
changeset
|
4056 |hl-LineNrBelow| b line number below the cursor for when the |
b9cf60801963
patch 8.1.2229: cannot color number column above/below cursor differently
Bram Moolenaar <Bram@vim.org>
parents:
18465
diff
changeset
|
4057 'relativenumber' option is set. |
4073 | 4058 |hl-CursorLineNr| N like n for when 'cursorline' or 'relativenumber' is |
4059 set. | |
7 | 4060 |hl-Question| r |hit-enter| prompt and yes/no questions |
4061 |hl-StatusLine| s status line of current window |status-line| | |
12785 | 4062 |hl-StatusLineNC| S status lines of not-current windows |
7 | 4063 |hl-Title| t Titles for output from ":set all", ":autocmd" etc. |
4064 |hl-VertSplit| c column used to separate vertically split windows | |
4065 |hl-Visual| v Visual mode | |
4066 |hl-VisualNOS| V Visual mode when Vim does is "Not Owning the | |
4067 Selection" Only X11 Gui's |gui-x11| and | |
4068 |xterm-clipboard|. | |
4069 |hl-WarningMsg| w warning messages | |
4070 |hl-WildMenu| W wildcard matches displayed for 'wildmenu' | |
4071 |hl-Folded| f line used for closed folds | |
4072 |hl-FoldColumn| F 'foldcolumn' | |
386 | 4073 |hl-DiffAdd| A added line in diff mode |
4074 |hl-DiffChange| C changed line in diff mode | |
4075 |hl-DiffDelete| D deleted line in diff mode | |
4076 |hl-DiffText| T inserted text in diff mode | |
7 | 4077 |hl-SignColumn| > column used for |signs| |
15194 | 4078 |hl-Conceal| - the placeholders used for concealed characters |
4079 (see 'conceallevel') | |
221 | 4080 |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
|
4081 |hl-SpellCap| P word that should start with capital |spell| |
221 | 4082 |hl-SpellRare| R rare word |spell| |
4083 |hl-SpellLocal| L word from other region |spell| | |
15194 | 4084 |hl-Pmenu| + popup menu normal line |
4085 |hl-PmenuSel| = popup menu selected line | |
4086 |hl-PmenuSbar| x popup menu scrollbar | |
4087 |hl-PmenuThumb| X popup menu scrollbar thumb | |
7 | 4088 |
4089 The display modes are: | |
4090 r reverse (termcap entry "mr" and "me") | |
4091 i italic (termcap entry "ZH" and "ZR") | |
4092 b bold (termcap entry "md" and "me") | |
4093 s standout (termcap entry "so" and "se") | |
4094 u underline (termcap entry "us" and "ue") | |
205 | 4095 c undercurl (termcap entry "Cs" and "Ce") |
12317
2a8890b80923
patch 8.0.1038: strike-through text not supported
Christian Brabandt <cb@256bit.org>
parents:
12293
diff
changeset
|
4096 t strikethrough (termcap entry "Ts" and "Te") |
7 | 4097 n no highlighting |
4098 - no highlighting | |
4099 : use a highlight group | |
4100 The default is used for occasions that are not included. | |
4101 If you want to change what the display modes do, see |dos-colors| | |
4102 for an example. | |
4103 When using the ':' display mode, this must be followed by the name of | |
4104 a highlight group. A highlight group can be used to define any type | |
4105 of highlighting, including using color. See |:highlight| on how to | |
4106 define one. The default uses a different group for each occasion. | |
4107 See |highlight-default| for the default highlight groups. | |
4108 | |
4109 *'history'* *'hi'* | |
9669
284b4eb307fc
commit https://github.com/vim/vim/commit/8c08b5b569e2a9e9f63dea514591ecfa2d3bb392
Christian Brabandt <cb@256bit.org>
parents:
9665
diff
changeset
|
4110 '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
|
4111 set to 200 in |defaults.vim|) |
7 | 4112 global |
4113 A history of ":" commands, and a history of previous search patterns | |
5991 | 4114 is remembered. This option decides how many entries may be stored in |
7 | 4115 each of these histories (see |cmdline-editing|). |
5991 | 4116 The maximum value is 10000. |
7 | 4117 NOTE: This option is set to the Vi default value when 'compatible' is |
4118 set and to the Vim default value when 'compatible' is reset. | |
4119 | |
4120 *'hkmap'* *'hk'* *'nohkmap'* *'nohk'* | |
4121 'hkmap' 'hk' boolean (default off) | |
4122 global | |
4123 {only available when compiled with the |+rightleft| | |
4124 feature} | |
4125 When on, the keyboard is mapped for the Hebrew character set. | |
4126 Normally you would set 'allowrevins' and use CTRL-_ in insert mode to | |
4127 toggle this option. See |rileft.txt|. | |
4128 NOTE: This option is reset when 'compatible' is set. | |
4129 | |
4130 *'hkmapp'* *'hkp'* *'nohkmapp'* *'nohkp'* | |
4131 'hkmapp' 'hkp' boolean (default off) | |
4132 global | |
4133 {only available when compiled with the |+rightleft| | |
4134 feature} | |
4135 When on, phonetic keyboard mapping is used. 'hkmap' must also be on. | |
4136 This is useful if you have a non-Hebrew keyboard. | |
4137 See |rileft.txt|. | |
4138 NOTE: This option is reset when 'compatible' is set. | |
4139 | |
11160 | 4140 *'hlsearch'* *'hls'* *'nohlsearch'* *'nohls'* |
4141 'hlsearch' 'hls' boolean (default off) | |
4142 global | |
4143 {not available when compiled without the | |
4144 |+extra_search| feature} | |
4145 When there is a previous search pattern, highlight all its matches. | |
4146 The type of highlighting used can be set with the 'l' occasion in the | |
4147 'highlight' option. This uses the "Search" highlight group by | |
4148 default. Note that only the matching text is highlighted, any offsets | |
4149 are not applied. | |
4150 See also: 'incsearch' and |:match|. | |
4151 When you get bored looking at the highlighted matches, you can turn it | |
4152 off with |:nohlsearch|. This does not change the option value, as | |
4153 soon as you use a search command, the highlighting comes back. | |
4154 'redrawtime' specifies the maximum time spent on finding matches. | |
4155 When the search pattern can match an end-of-line, Vim will try to | |
4156 highlight all of the matched text. However, this depends on where the | |
4157 search starts. This will be the first line in the window or the first | |
4158 line below a closed fold. A match in a previous line which is not | |
4159 drawn may not continue in a newly drawn line. | |
4160 You can specify whether the highlight status is restored on startup | |
4161 with the 'h' flag in 'viminfo' |viminfo-h|. | |
4162 NOTE: This option is reset when 'compatible' is set. | |
4163 | |
7 | 4164 *'icon'* *'noicon'* |
4165 'icon' boolean (default off, on when title can be restored) | |
4166 global | |
4167 {not available when compiled without the |+title| | |
4168 feature} | |
4169 When on, the icon text of the window will be set to the value of | |
4170 'iconstring' (if it is not empty), or to the name of the file | |
4171 currently being edited. Only the last part of the name is used. | |
4172 Overridden by the 'iconstring' option. | |
4173 Only works if the terminal supports setting window icons (currently | |
4174 only X11 GUI and terminals with a non-empty 't_IS' option - these are | |
4175 Unix xterm and iris-ansi by default, where 't_IS' is taken from the | |
4176 builtin termcap). | |
4177 When Vim was compiled with HAVE_X11 defined, the original icon will be | |
233 | 4178 restored if possible |X11|. See |X11-icon| for changing the icon on |
7 | 4179 X11. |
6259 | 4180 For MS-Windows the icon can be changed, see |windows-icon|. |
7 | 4181 |
4182 *'iconstring'* | |
4183 'iconstring' string (default "") | |
4184 global | |
4185 {not available when compiled without the |+title| | |
4186 feature} | |
4187 When this option is not empty, it will be used for the icon text of | |
4188 the window. This happens only when the 'icon' option is on. | |
4189 Only works if the terminal supports setting window icon text | |
4190 (currently only X11 GUI and terminals with a non-empty 't_IS' option). | |
24387 | 4191 Does not work for MS-Windows. |
7 | 4192 When Vim was compiled with HAVE_X11 defined, the original icon will be |
4193 restored if possible |X11|. | |
4194 When this option contains printf-style '%' items, they will be | |
10 | 4195 expanded according to the rules used for 'statusline'. See |
7 | 4196 'titlestring' for example settings. |
16728
e55c26aaf484
patch 8.1.1366: using expressions in a modeline is unsafe
Bram Moolenaar <Bram@vim.org>
parents:
16610
diff
changeset
|
4197 This option cannot be set in a modeline when 'modelineexpr' is off. |
7 | 4198 {not available when compiled without the |+statusline| feature} |
4199 | |
4200 *'ignorecase'* *'ic'* *'noignorecase'* *'noic'* | |
4201 'ignorecase' 'ic' boolean (default off) | |
4202 global | |
4203 Ignore case in search patterns. Also used when searching in the tags | |
4204 file. | |
7266
6ba7182fb7bd
commit https://github.com/vim/vim/commit/0f6562e9036f889185dff49a75c7fc5ffb28b307
Christian Brabandt <cb@256bit.org>
parents:
7245
diff
changeset
|
4205 Also see 'smartcase' and 'tagcase'. |
7 | 4206 Can be overruled by using "\c" or "\C" in the pattern, see |
4207 |/ignorecase|. | |
4208 | |
5008
3717d569027d
updated for version 7.3.1248
Bram Moolenaar <bram@vim.org>
parents:
4869
diff
changeset
|
4209 *'imactivatefunc'* *'imaf'* |
3717d569027d
updated for version 7.3.1248
Bram Moolenaar <bram@vim.org>
parents:
4869
diff
changeset
|
4210 'imactivatefunc' 'imaf' string (default "") |
3717d569027d
updated for version 7.3.1248
Bram Moolenaar <bram@vim.org>
parents:
4869
diff
changeset
|
4211 global |
3717d569027d
updated for version 7.3.1248
Bram Moolenaar <bram@vim.org>
parents:
4869
diff
changeset
|
4212 This option specifies a function that will be called to |
12936
c53a80f39a52
patch 8.0.1344: using 'imactivatefunc' in the GUI does not work
Christian Brabandt <cb@256bit.org>
parents:
12934
diff
changeset
|
4213 activate or deactivate the Input Method. |
21112
2d3cd9acf853
patch 8.2.1107: 'imactivatefunc' and 'imstatusfunc' are not used in the GUI
Bram Moolenaar <Bram@vim.org>
parents:
20856
diff
changeset
|
4214 It is not used in the MS-Windows GUI version. |
16728
e55c26aaf484
patch 8.1.1366: using expressions in a modeline is unsafe
Bram Moolenaar <Bram@vim.org>
parents:
16610
diff
changeset
|
4215 The expression will be evaluated in the |sandbox| when set from a |
e55c26aaf484
patch 8.1.1366: using expressions in a modeline is unsafe
Bram Moolenaar <Bram@vim.org>
parents:
16610
diff
changeset
|
4216 modeline, see |sandbox-option|. |
5008
3717d569027d
updated for version 7.3.1248
Bram Moolenaar <bram@vim.org>
parents:
4869
diff
changeset
|
4217 |
3717d569027d
updated for version 7.3.1248
Bram Moolenaar <bram@vim.org>
parents:
4869
diff
changeset
|
4218 Example: > |
3717d569027d
updated for version 7.3.1248
Bram Moolenaar <bram@vim.org>
parents:
4869
diff
changeset
|
4219 function ImActivateFunc(active) |
3717d569027d
updated for version 7.3.1248
Bram Moolenaar <bram@vim.org>
parents:
4869
diff
changeset
|
4220 if a:active |
3717d569027d
updated for version 7.3.1248
Bram Moolenaar <bram@vim.org>
parents:
4869
diff
changeset
|
4221 ... do something |
3717d569027d
updated for version 7.3.1248
Bram Moolenaar <bram@vim.org>
parents:
4869
diff
changeset
|
4222 else |
3717d569027d
updated for version 7.3.1248
Bram Moolenaar <bram@vim.org>
parents:
4869
diff
changeset
|
4223 ... do something |
3717d569027d
updated for version 7.3.1248
Bram Moolenaar <bram@vim.org>
parents:
4869
diff
changeset
|
4224 endif |
3717d569027d
updated for version 7.3.1248
Bram Moolenaar <bram@vim.org>
parents:
4869
diff
changeset
|
4225 " return value is not used |
3717d569027d
updated for version 7.3.1248
Bram Moolenaar <bram@vim.org>
parents:
4869
diff
changeset
|
4226 endfunction |
3717d569027d
updated for version 7.3.1248
Bram Moolenaar <bram@vim.org>
parents:
4869
diff
changeset
|
4227 set imactivatefunc=ImActivateFunc |
3717d569027d
updated for version 7.3.1248
Bram Moolenaar <bram@vim.org>
parents:
4869
diff
changeset
|
4228 < |
7 | 4229 *'imactivatekey'* *'imak'* |
4230 'imactivatekey' 'imak' string (default "") | |
4231 global | |
4232 {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
|
4233 |+GUI_GTK|} *E599* |
7 | 4234 Specifies the key that your Input Method in X-Windows uses for |
4235 activation. When this is specified correctly, vim can fully control | |
4236 IM with 'imcmdline', 'iminsert' and 'imsearch'. | |
4237 You can't use this option to change the activation key, the option | |
4238 tells Vim what the key is. | |
4239 Format: | |
4240 [MODIFIER_FLAG-]KEY_STRING | |
4241 | |
4242 These characters can be used for MODIFIER_FLAG (case is ignored): | |
4243 S Shift key | |
4244 L Lock key | |
4245 C Control key | |
4246 1 Mod1 key | |
4247 2 Mod2 key | |
4248 3 Mod3 key | |
4249 4 Mod4 key | |
4250 5 Mod5 key | |
4251 Combinations are allowed, for example "S-C-space" or "SC-space" are | |
4252 both shift+ctrl+space. | |
4253 See <X11/keysymdef.h> and XStringToKeysym for KEY_STRING. | |
4254 | |
4255 Example: > | |
4256 :set imactivatekey=S-space | |
4257 < "S-space" means shift+space. This is the activation key for kinput2 + | |
4258 canna (Japanese), and ami (Korean). | |
4259 | |
4260 *'imcmdline'* *'imc'* *'noimcmdline'* *'noimc'* | |
4261 'imcmdline' 'imc' boolean (default off) | |
4262 global | |
4263 When set the Input Method is always on when starting to edit a command | |
4264 line, unless entering a search pattern (see 'imsearch' for that). | |
4265 Setting this option is useful when your input method allows entering | |
4266 English characters directly, e.g., when it's used to type accented | |
4267 characters with dead keys. | |
4268 | |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
4269 *'imdisable'* *'imd'* *'noimdisable'* *'noimd'* |
7 | 4270 'imdisable' 'imd' boolean (default off, on for some systems (SGI)) |
4271 global | |
4272 When set the Input Method is never used. This is useful to disable | |
4273 the IM when it doesn't work properly. | |
4274 Currently this option is on by default for SGI/IRIX machines. This | |
4275 may change in later releases. | |
4276 | |
4277 *'iminsert'* *'imi'* | |
12469
61d910f0999d
patch 8.0.1114: default for 'iminsert' is annoying
Christian Brabandt <cb@256bit.org>
parents:
12317
diff
changeset
|
4278 'iminsert' 'imi' number (default 0) |
7 | 4279 local to buffer |
4280 Specifies whether :lmap or an Input Method (IM) is to be used in | |
4281 Insert mode. Valid values: | |
4282 0 :lmap is off and IM is off | |
4283 1 :lmap is ON and IM is off | |
4284 2 :lmap is off and IM is ON | |
4285 To always reset the option to zero when leaving Insert mode with <Esc> | |
4286 this can be used: > | |
4287 :inoremap <ESC> <ESC>:set iminsert=0<CR> | |
4288 < This makes :lmap and IM turn off automatically when leaving Insert | |
4289 mode. | |
4290 Note that this option changes when using CTRL-^ in Insert mode | |
4291 |i_CTRL-^|. | |
4292 The value is set to 1 when setting 'keymap' to a valid keymap name. | |
4293 It is also used for the argument of commands like "r" and "f". | |
4294 The value 0 may not work correctly with Athena and Motif with some XIM | |
4295 methods. Use 'imdisable' to disable XIM then. | |
4296 | |
12920
327e1264b9bf
patch 8.0.1336: cannot use imactivatefunc() unless compiled with +xim
Christian Brabandt <cb@256bit.org>
parents:
12865
diff
changeset
|
4297 You can set 'imactivatefunc' and 'imstatusfunc' to handle IME/XIM |
14519 | 4298 via external command if Vim is not compiled with the |+xim|, |
12920
327e1264b9bf
patch 8.0.1336: cannot use imactivatefunc() unless compiled with +xim
Christian Brabandt <cb@256bit.org>
parents:
12865
diff
changeset
|
4299 |+multi_byte_ime| or |global-ime|. |
327e1264b9bf
patch 8.0.1336: cannot use imactivatefunc() unless compiled with +xim
Christian Brabandt <cb@256bit.org>
parents:
12865
diff
changeset
|
4300 |
7 | 4301 *'imsearch'* *'ims'* |
12469
61d910f0999d
patch 8.0.1114: default for 'iminsert' is annoying
Christian Brabandt <cb@256bit.org>
parents:
12317
diff
changeset
|
4302 'imsearch' 'ims' number (default -1) |
7 | 4303 local to buffer |
4304 Specifies whether :lmap or an Input Method (IM) is to be used when | |
4305 entering a search pattern. Valid values: | |
4306 -1 the value of 'iminsert' is used, makes it look like | |
4307 'iminsert' is also used when typing a search pattern | |
4308 0 :lmap is off and IM is off | |
4309 1 :lmap is ON and IM is off | |
4310 2 :lmap is off and IM is ON | |
4311 Note that this option changes when using CTRL-^ in Command-line mode | |
4312 |c_CTRL-^|. | |
4313 The value is set to 1 when it is not -1 and setting the 'keymap' | |
4314 option to a valid keymap name. | |
4315 The value 0 may not work correctly with Athena and Motif with some XIM | |
4316 methods. Use 'imdisable' to disable XIM then. | |
4317 | |
5008
3717d569027d
updated for version 7.3.1248
Bram Moolenaar <bram@vim.org>
parents:
4869
diff
changeset
|
4318 *'imstatusfunc'* *'imsf'* |
3717d569027d
updated for version 7.3.1248
Bram Moolenaar <bram@vim.org>
parents:
4869
diff
changeset
|
4319 'imstatusfunc' 'imsf' string (default "") |
3717d569027d
updated for version 7.3.1248
Bram Moolenaar <bram@vim.org>
parents:
4869
diff
changeset
|
4320 global |
3717d569027d
updated for version 7.3.1248
Bram Moolenaar <bram@vim.org>
parents:
4869
diff
changeset
|
4321 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
|
4322 of Input Method. It must return a positive number when IME is active. |
21112
2d3cd9acf853
patch 8.2.1107: 'imactivatefunc' and 'imstatusfunc' are not used in the GUI
Bram Moolenaar <Bram@vim.org>
parents:
20856
diff
changeset
|
4323 It is not used in the MS-Windows GUI version. |
5008
3717d569027d
updated for version 7.3.1248
Bram Moolenaar <bram@vim.org>
parents:
4869
diff
changeset
|
4324 |
3717d569027d
updated for version 7.3.1248
Bram Moolenaar <bram@vim.org>
parents:
4869
diff
changeset
|
4325 Example: > |
3717d569027d
updated for version 7.3.1248
Bram Moolenaar <bram@vim.org>
parents:
4869
diff
changeset
|
4326 function ImStatusFunc() |
3717d569027d
updated for version 7.3.1248
Bram Moolenaar <bram@vim.org>
parents:
4869
diff
changeset
|
4327 let is_active = ...do something |
3717d569027d
updated for version 7.3.1248
Bram Moolenaar <bram@vim.org>
parents:
4869
diff
changeset
|
4328 return is_active ? 1 : 0 |
3717d569027d
updated for version 7.3.1248
Bram Moolenaar <bram@vim.org>
parents:
4869
diff
changeset
|
4329 endfunction |
3717d569027d
updated for version 7.3.1248
Bram Moolenaar <bram@vim.org>
parents:
4869
diff
changeset
|
4330 set imstatusfunc=ImStatusFunc |
3717d569027d
updated for version 7.3.1248
Bram Moolenaar <bram@vim.org>
parents:
4869
diff
changeset
|
4331 < |
3717d569027d
updated for version 7.3.1248
Bram Moolenaar <bram@vim.org>
parents:
4869
diff
changeset
|
4332 NOTE: This function is invoked very often. Keep it fast. |
16728
e55c26aaf484
patch 8.1.1366: using expressions in a modeline is unsafe
Bram Moolenaar <Bram@vim.org>
parents:
16610
diff
changeset
|
4333 The expression will be evaluated in the |sandbox| when set from a |
e55c26aaf484
patch 8.1.1366: using expressions in a modeline is unsafe
Bram Moolenaar <Bram@vim.org>
parents:
16610
diff
changeset
|
4334 modeline, see |sandbox-option|. |
5008
3717d569027d
updated for version 7.3.1248
Bram Moolenaar <bram@vim.org>
parents:
4869
diff
changeset
|
4335 |
12293
1ff5e5dfa9b0
patch 8.0.1026: GTK on-the-spot input has problems
Christian Brabandt <cb@256bit.org>
parents:
12254
diff
changeset
|
4336 *'imstyle'* *'imst'* |
1ff5e5dfa9b0
patch 8.0.1026: GTK on-the-spot input has problems
Christian Brabandt <cb@256bit.org>
parents:
12254
diff
changeset
|
4337 'imstyle' 'imst' number (default 1) |
1ff5e5dfa9b0
patch 8.0.1026: GTK on-the-spot input has problems
Christian Brabandt <cb@256bit.org>
parents:
12254
diff
changeset
|
4338 global |
1ff5e5dfa9b0
patch 8.0.1026: GTK on-the-spot input has problems
Christian Brabandt <cb@256bit.org>
parents:
12254
diff
changeset
|
4339 {only available when compiled with |+xim| and |
1ff5e5dfa9b0
patch 8.0.1026: GTK on-the-spot input has problems
Christian Brabandt <cb@256bit.org>
parents:
12254
diff
changeset
|
4340 |+GUI_GTK|} |
12499 | 4341 This option specifies the input style of Input Method: |
4342 0 use on-the-spot style | |
4343 1 over-the-spot style | |
12293
1ff5e5dfa9b0
patch 8.0.1026: GTK on-the-spot input has problems
Christian Brabandt <cb@256bit.org>
parents:
12254
diff
changeset
|
4344 See: |xim-input-style| |
1ff5e5dfa9b0
patch 8.0.1026: GTK on-the-spot input has problems
Christian Brabandt <cb@256bit.org>
parents:
12254
diff
changeset
|
4345 |
12559 | 4346 For a long time on-the-spot style had been used in the GTK version of |
4347 vim, however, it is known that it causes troubles when using mappings, | |
12293
1ff5e5dfa9b0
patch 8.0.1026: GTK on-the-spot input has problems
Christian Brabandt <cb@256bit.org>
parents:
12254
diff
changeset
|
4348 |single-repeat|, etc. Therefore over-the-spot style becomes the |
1ff5e5dfa9b0
patch 8.0.1026: GTK on-the-spot input has problems
Christian Brabandt <cb@256bit.org>
parents:
12254
diff
changeset
|
4349 default now. This should work fine for most people, however if you |
1ff5e5dfa9b0
patch 8.0.1026: GTK on-the-spot input has problems
Christian Brabandt <cb@256bit.org>
parents:
12254
diff
changeset
|
4350 have any problem with it, try using on-the-spot style. |
16728
e55c26aaf484
patch 8.1.1366: using expressions in a modeline is unsafe
Bram Moolenaar <Bram@vim.org>
parents:
16610
diff
changeset
|
4351 The expression will be evaluated in the |sandbox| when set from a |
e55c26aaf484
patch 8.1.1366: using expressions in a modeline is unsafe
Bram Moolenaar <Bram@vim.org>
parents:
16610
diff
changeset
|
4352 modeline, see |sandbox-option|. |
12293
1ff5e5dfa9b0
patch 8.0.1026: GTK on-the-spot input has problems
Christian Brabandt <cb@256bit.org>
parents:
12254
diff
changeset
|
4353 |
7 | 4354 *'include'* *'inc'* |
4355 'include' 'inc' string (default "^\s*#\s*include") | |
4356 global or local to buffer |global-local| | |
4357 {not available when compiled without the | |
4358 |+find_in_path| feature} | |
10 | 4359 Pattern to be used to find an include command. It is a search |
7 | 4360 pattern, just like for the "/" command (See |pattern|). The default |
4361 value is for C programs. This option is used for the commands "[i", | |
532 | 4362 "]I", "[d", etc. |
4363 Normally the 'isfname' option is used to recognize the file name that | |
534 | 4364 comes after the matched pattern. But if "\zs" appears in the pattern |
4365 then the text matched from "\zs" to the end, or until "\ze" if it | |
4366 appears, is used as the file name. Use this to include characters | |
4367 that are not in 'isfname', such as a space. You can then use | |
4368 'includeexpr' to process the matched text. | |
532 | 4369 See |option-backslash| about including spaces and backslashes. |
7 | 4370 |
4371 *'includeexpr'* *'inex'* | |
4372 'includeexpr' 'inex' string (default "") | |
4373 local to buffer | |
4374 {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
|
4375 |+find_in_path| or |+eval| features} |
7 | 4376 Expression to be used to transform the string found with the 'include' |
10 | 4377 option to a file name. Mostly useful to change "." to "/" for Java: > |
7 | 4378 :set includeexpr=substitute(v:fname,'\\.','/','g') |
4379 < The "v:fname" variable will be set to the file name that was detected. | |
634 | 4380 |
7 | 4381 Also used for the |gf| command if an unmodified file name can't be |
10 | 4382 found. Allows doing "gf" on the name after an 'include' statement. |
7 | 4383 Also used for |<cfile>|. |
4384 | |
3682 | 4385 The expression will be evaluated in the |sandbox| when set from a |
4386 modeline, see |sandbox-option|. | |
16728
e55c26aaf484
patch 8.1.1366: using expressions in a modeline is unsafe
Bram Moolenaar <Bram@vim.org>
parents:
16610
diff
changeset
|
4387 This option cannot be set in a modeline when 'modelineexpr' is off. |
634 | 4388 |
4389 It is not allowed to change text or jump to another window while | |
4390 evaluating 'includeexpr' |textlock|. | |
4391 | |
7 | 4392 *'incsearch'* *'is'* *'noincsearch'* *'nois'* |
9669
284b4eb307fc
commit https://github.com/vim/vim/commit/8c08b5b569e2a9e9f63dea514591ecfa2d3bb392
Christian Brabandt <cb@256bit.org>
parents:
9665
diff
changeset
|
4393 '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
|
4394 +reltime feature is supported) |
7 | 4395 global |
4396 {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
|
4397 |+extra_search| features} |
17 | 4398 While typing a search command, show where the pattern, as it was typed |
4399 so far, matches. The matched string is highlighted. If the pattern | |
4400 is invalid or not found, nothing is shown. The screen will be updated | |
4401 often, this is only useful on fast terminals. | |
14637 | 4402 Also applies to the pattern in commands: > |
4403 :global | |
4404 :lvimgrep | |
4405 :lvimgrepadd | |
4406 :smagic | |
4407 :snomagic | |
4408 :sort | |
4409 :substitute | |
4410 :vglobal | |
4411 :vimgrep | |
4412 :vimgrepadd | |
4413 < Note that the match will be shown, but the cursor will return to its | |
17 | 4414 original position when no match is found and when pressing <Esc>. You |
4415 still need to finish the search command with <Enter> to move the | |
4416 cursor to the match. | |
10261
bdd7fc1a38c0
commit https://github.com/vim/vim/commit/dc08328821a2c11e33dfb1980332e4923ec64fca
Christian Brabandt <cb@256bit.org>
parents:
10244
diff
changeset
|
4417 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
|
4418 previous match. |c_CTRL-G| |c_CTRL-T| |
1521 | 4419 When compiled with the |+reltime| feature Vim only searches for about |
4420 half a second. With a complicated pattern and/or a lot of text the | |
4421 match may not be found. This is to avoid that Vim hangs while you | |
4422 are typing the pattern. | |
17 | 4423 The highlighting can be set with the 'i' flag in 'highlight'. |
12968 | 4424 When 'hlsearch' is on, all matched strings are highlighted too while |
4425 typing a search command. See also: 'hlsearch'. | |
14519 | 4426 If you don't want to turn 'hlsearch' on, but want to highlight all |
4427 matches while searching, you can turn on and off 'hlsearch' with | |
4428 autocmd. Example: > | |
12720
37c384802df4
patch 8.0.1238: incremental search only shows one match
Christian Brabandt <cb@256bit.org>
parents:
12608
diff
changeset
|
4429 augroup vimrc-incsearch-highlight |
37c384802df4
patch 8.0.1238: incremental search only shows one match
Christian Brabandt <cb@256bit.org>
parents:
12608
diff
changeset
|
4430 autocmd! |
12744
0c704288ced4
patch 8.0.1250: 'hlsearch' highlighting not removed after incsearch
Christian Brabandt <cb@256bit.org>
parents:
12720
diff
changeset
|
4431 autocmd CmdlineEnter /,\? :set hlsearch |
0c704288ced4
patch 8.0.1250: 'hlsearch' highlighting not removed after incsearch
Christian Brabandt <cb@256bit.org>
parents:
12720
diff
changeset
|
4432 autocmd CmdlineLeave /,\? :set nohlsearch |
12720
37c384802df4
patch 8.0.1238: incremental search only shows one match
Christian Brabandt <cb@256bit.org>
parents:
12608
diff
changeset
|
4433 augroup END |
37c384802df4
patch 8.0.1238: incremental search only shows one match
Christian Brabandt <cb@256bit.org>
parents:
12608
diff
changeset
|
4434 < |
772 | 4435 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
|
4436 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
|
4437 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
|
4438 converted to lowercase. |
772 | 4439 CTRL-R CTRL-W can be used to add the word at the end of the current |
4440 match, excluding the characters that were already typed. | |
7 | 4441 NOTE: This option is reset when 'compatible' is set. |
4442 | |
4443 *'indentexpr'* *'inde'* | |
4444 'indentexpr' 'inde' string (default "") | |
4445 local to buffer | |
4446 {not available when compiled without the |+cindent| | |
4447 or |+eval| features} | |
4448 Expression which is evaluated to obtain the proper indent for a line. | |
4449 It is used when a new line is created, for the |=| operator and | |
4450 in Insert mode as specified with the 'indentkeys' option. | |
4451 When this option is not empty, it overrules the 'cindent' and | |
2833 | 4452 'smartindent' indenting. When 'lisp' is set, this option is |
4453 overridden by the Lisp indentation algorithm. | |
7 | 4454 When 'paste' is set this option is not used for indenting. |
4455 The expression is evaluated with |v:lnum| set to the line number for | |
534 | 4456 which the indent is to be computed. The cursor is also in this line |
7 | 4457 when the expression is evaluated (but it may be moved around). |
4458 The expression must return the number of spaces worth of indent. It | |
4459 can return "-1" to keep the current indent (this means 'autoindent' is | |
4460 used for the indent). | |
4461 Functions useful for computing the indent are |indent()|, |cindent()| | |
4462 and |lispindent()|. | |
4463 The evaluation of the expression must not have side effects! It must | |
4464 not change the text, jump to another window, etc. Afterwards the | |
4465 cursor position is always restored, thus the cursor may be moved. | |
4466 Normally this option would be set to call a function: > | |
4467 :set indentexpr=GetMyIndent() | |
4468 < Error messages will be suppressed, unless the 'debug' option contains | |
4469 "msg". | |
634 | 4470 See |indent-expression|. |
11160 | 4471 NOTE: This option is set to "" when 'compatible' is set. |
7 | 4472 |
3682 | 4473 The expression will be evaluated in the |sandbox| when set from a |
4474 modeline, see |sandbox-option|. | |
16728
e55c26aaf484
patch 8.1.1366: using expressions in a modeline is unsafe
Bram Moolenaar <Bram@vim.org>
parents:
16610
diff
changeset
|
4475 This option cannot be set in a modeline when 'modelineexpr' is off. |
634 | 4476 |
4477 It is not allowed to change text or jump to another window while | |
4478 evaluating 'indentexpr' |textlock|. | |
4479 | |
4480 | |
7 | 4481 *'indentkeys'* *'indk'* |
15701
9cd11f6beb70
patch 8.1.0858: 'indentkeys' and 'cinkeys' defaults are different
Bram Moolenaar <Bram@vim.org>
parents:
15512
diff
changeset
|
4482 'indentkeys' 'indk' string (default "0{,0},0),0],:,0#,!^F,o,O,e") |
7 | 4483 local to buffer |
4484 {not available when compiled without the |+cindent| | |
4485 feature} | |
4486 A list of keys that, when typed in Insert mode, cause reindenting of | |
4487 the current line. Only happens if 'indentexpr' isn't empty. | |
4488 The format is identical to 'cinkeys', see |indentkeys-format|. | |
4489 See |C-indenting| and |indent-expression|. | |
4490 | |
4491 *'infercase'* *'inf'* *'noinfercase'* *'noinf'* | |
4492 'infercase' 'inf' boolean (default off) | |
4493 local to buffer | |
4494 When doing keyword completion in insert mode |ins-completion|, and | |
1621 | 4495 'ignorecase' is also on, the case of the match is adjusted depending |
4496 on the typed text. If the typed text contains a lowercase letter | |
4497 where the match has an upper case letter, the completed part is made | |
4498 lowercase. If the typed text has no lowercase letters and the match | |
4499 has a lowercase letter where the typed text has an uppercase letter, | |
4500 and there is a letter before it, the completed part is made uppercase. | |
4501 With 'noinfercase' the match is used as-is. | |
7 | 4502 |
4503 *'insertmode'* *'im'* *'noinsertmode'* *'noim'* | |
4504 'insertmode' 'im' boolean (default off) | |
4505 global | |
4506 Makes Vim work in a way that Insert mode is the default mode. Useful | |
4507 if you want to use Vim as a modeless editor. Used for |evim|. | |
4508 These Insert mode commands will be useful: | |
4509 - 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
|
4510 - Use CTRL-O to execute one Normal mode command |i_CTRL-O|. When |
7 | 4511 this is a mapping, it is executed as if 'insertmode' was off. |
4512 Normal mode remains active until the mapping is finished. | |
4513 - Use CTRL-L to execute a number of Normal mode commands, then use | |
477 | 4514 <Esc> to get back to Insert mode. Note that CTRL-L moves the cursor |
4515 left, like <Esc> does when 'insertmode' isn't set. |i_CTRL-L| | |
7 | 4516 |
4517 These items change when 'insertmode' is set: | |
4518 - when starting to edit of a file, Vim goes to Insert mode. | |
4519 - <Esc> in Insert mode is a no-op and beeps. | |
4520 - <Esc> in Normal mode makes Vim go to Insert mode. | |
4521 - CTRL-L in Insert mode is a command, it is not inserted. | |
4522 - CTRL-Z in Insert mode suspends Vim, see |CTRL-Z|. *i_CTRL-Z* | |
4523 However, when <Esc> is used inside a mapping, it behaves like | |
4524 'insertmode' was not set. This was done to be able to use the same | |
4525 mappings with 'insertmode' set or not set. | |
4526 When executing commands with |:normal| 'insertmode' is not used. | |
4527 | |
4528 NOTE: This option is reset when 'compatible' is set. | |
4529 | |
4530 *'isfname'* *'isf'* | |
18912
ccd16426a1f9
patch 8.2.0017: OS/2 and MS-DOS are still mentioned
Bram Moolenaar <Bram@vim.org>
parents:
18879
diff
changeset
|
4531 'isfname' 'isf' string (default for Win32: |
7 | 4532 "@,48-57,/,\,.,-,_,+,,,#,$,%,{,},[,],:,@-@,!,~,=" |
4533 for AMIGA: "@,48-57,/,.,-,_,+,,,$,:" | |
4534 for VMS: "@,48-57,/,.,-,_,+,,,#,$,%,<,>,[,],:,;,~" | |
4535 for OS/390: "@,240-249,/,.,-,_,+,,,#,$,%,~,=" | |
4536 otherwise: "@,48-57,/,.,-,_,+,,,#,$,%,~,=") | |
4537 global | |
4538 The characters specified by this option are included in file names and | |
4539 path names. Filenames are used for commands like "gf", "[i" and in | |
10 | 4540 the tags file. It is also used for "\f" in a |pattern|. |
7 | 4541 Multi-byte characters 256 and above are always included, only the |
4542 characters up to 255 are specified with this option. | |
4543 For UTF-8 the characters 0xa0 to 0xff are included as well. | |
1621 | 4544 Think twice before adding white space to this option. Although a |
4545 space may appear inside a file name, the effect will be that Vim | |
4546 doesn't know where a file name starts or ends when doing completion. | |
4547 It most likely works better without a space in 'isfname'. | |
7 | 4548 |
4549 Note that on systems using a backslash as path separator, Vim tries to | |
4550 do its best to make it work as you would expect. That is a bit | |
4551 tricky, since Vi originally used the backslash to escape special | |
4552 characters. Vim will not remove a backslash in front of a normal file | |
4553 name character on these systems, but it will on Unix and alikes. The | |
4554 '&' and '^' are not included by default, because these are special for | |
4555 cmd.exe. | |
4556 | |
4557 The format of this option is a list of parts, separated with commas. | |
10 | 4558 Each part can be a single character number or a range. A range is two |
4559 character numbers with '-' in between. A character number can be a | |
7 | 4560 decimal number between 0 and 255 or the ASCII character itself (does |
4561 not work for digits). Example: | |
4562 "_,-,128-140,#-43" (include '_' and '-' and the range | |
4563 128 to 140 and '#' to 43) | |
4564 If a part starts with '^', the following character number or range | |
4565 will be excluded from the option. The option is interpreted from left | |
4566 to right. Put the excluded character after the range where it is | |
4567 included. To include '^' itself use it as the last character of the | |
4568 option or the end of a range. Example: | |
4569 "^a-z,#,^" (exclude 'a' to 'z', include '#' and '^') | |
4570 If the character is '@', all characters where isalpha() returns TRUE | |
4571 are included. Normally these are the characters a to z and A to Z, | |
4572 plus accented characters. To include '@' itself use "@-@". Examples: | |
4573 "@,^a-z" All alphabetic characters, excluding lower | |
1621 | 4574 case ASCII letters. |
7 | 4575 "a-z,A-Z,@-@" All letters plus the '@' character. |
4576 A comma can be included by using it where a character number is | |
4577 expected. Example: | |
4578 "48-57,,,_" Digits, comma and underscore. | |
4579 A comma can be excluded by prepending a '^'. Example: | |
4580 " -~,^,,9" All characters from space to '~', excluding | |
4581 comma, plus <Tab>. | |
4582 See |option-backslash| about including spaces and backslashes. | |
4583 | |
4584 *'isident'* *'isi'* | |
18912
ccd16426a1f9
patch 8.2.0017: OS/2 and MS-DOS are still mentioned
Bram Moolenaar <Bram@vim.org>
parents:
18879
diff
changeset
|
4585 'isident' 'isi' string (default for Win32: |
7 | 4586 "@,48-57,_,128-167,224-235" |
4587 otherwise: "@,48-57,_,192-255") | |
4588 global | |
4589 The characters given by this option are included in identifiers. | |
4590 Identifiers are used in recognizing environment variables and after a | |
4591 match of the 'define' option. It is also used for "\i" in a | |
233 | 4592 |pattern|. See 'isfname' for a description of the format of this |
14864 | 4593 option. For '@' only characters up to 255 are used. |
7 | 4594 Careful: If you change this option, it might break expanding |
10 | 4595 environment variables. E.g., when '/' is included and Vim tries to |
7 | 4596 expand "$HOME/.viminfo". Maybe you should change 'iskeyword' instead. |
4597 | |
4598 *'iskeyword'* *'isk'* | |
18912
ccd16426a1f9
patch 8.2.0017: OS/2 and MS-DOS are still mentioned
Bram Moolenaar <Bram@vim.org>
parents:
18879
diff
changeset
|
4599 'iskeyword' 'isk' string (Vim default for Win32: |
7 | 4600 "@,48-57,_,128-167,224-235" |
4601 otherwise: "@,48-57,_,192-255" | |
4602 Vi default: "@,48-57,_") | |
4603 local to buffer | |
4604 Keywords are used in searching and recognizing with many commands: | |
10 | 4605 "w", "*", "[i", etc. It is also used for "\k" in a |pattern|. See |
14864 | 4606 'isfname' for a description of the format of this option. For '@' |
24569 | 4607 characters above 255 check the "word" character class (any character |
4608 that is not white space or punctuation). | |
14864 | 4609 For C programs you could use "a-z,A-Z,48-57,_,.,-,>". |
7 | 4610 For a help file it is set to all non-blank printable characters except |
4611 '*', '"' and '|' (so that CTRL-] on a command finds the help for that | |
4612 command). | |
4613 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
|
4614 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
|
4615 uses |:syn-iskeyword|. |
7 | 4616 NOTE: This option is set to the Vi default value when 'compatible' is |
4617 set and to the Vim default value when 'compatible' is reset. | |
4618 | |
4619 *'isprint'* *'isp'* | |
21825 | 4620 'isprint' 'isp' string (default for Win32 and macOS: |
7 | 4621 "@,~-255"; otherwise: "@,161-255") |
4622 global | |
4623 The characters given by this option are displayed directly on the | |
4624 screen. It is also used for "\p" in a |pattern|. The characters from | |
4625 space (ASCII 32) to '~' (ASCII 126) are always displayed directly, | |
4626 even when they are not included in 'isprint' or excluded. See | |
4627 'isfname' for a description of the format of this option. | |
4628 | |
4629 Non-printable characters are displayed with two characters: | |
4630 0 - 31 "^@" - "^_" | |
4631 32 - 126 always single characters | |
4632 127 "^?" | |
4633 128 - 159 "~@" - "~_" | |
4634 160 - 254 "| " - "|~" | |
4635 255 "~?" | |
4636 When 'encoding' is a Unicode one, illegal bytes from 128 to 255 are | |
4637 displayed as <xx>, with the hexadecimal value of the byte. | |
4638 When 'display' contains "uhex" all unprintable characters are | |
4639 displayed as <xx>. | |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
4640 The SpecialKey highlighting will be used for unprintable characters. |
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
4641 |hl-SpecialKey| |
7 | 4642 |
4643 Multi-byte characters 256 and above are always included, only the | |
4644 characters up to 255 are specified with this option. When a character | |
4645 is printable but it is not available in the current font, a | |
4646 replacement character will be shown. | |
4647 Unprintable and zero-width Unicode characters are displayed as <xxxx>. | |
4648 There is no option to specify these characters. | |
4649 | |
4650 *'joinspaces'* *'js'* *'nojoinspaces'* *'nojs'* | |
4651 'joinspaces' 'js' boolean (default on) | |
4652 global | |
4653 Insert two spaces after a '.', '?' and '!' with a join command. | |
4654 When 'cpoptions' includes the 'j' flag, only do this after a '.'. | |
4655 Otherwise only one space is inserted. | |
4656 NOTE: This option is set when 'compatible' is set. | |
4657 | |
4658 *'key'* | |
4659 'key' string (default "") | |
4660 local to buffer | |
2283
7e1bd501306d
Mainly documentation updates.
Bram Moolenaar <bram@vim.org>
parents:
2265
diff
changeset
|
4661 {only available when compiled with the |+cryptv| |
7e1bd501306d
Mainly documentation updates.
Bram Moolenaar <bram@vim.org>
parents:
2265
diff
changeset
|
4662 feature} |
7 | 4663 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
|
4664 See |encryption| and 'cryptmethod'. |
7 | 4665 Careful: Do not set the key value by hand, someone might see the typed |
4666 key. Use the |:X| command. But you can make 'key' empty: > | |
4667 :set key= | |
4668 < It is not possible to get the value of this option with ":set key" or | |
4669 "echo &key". This is to avoid showing it to someone who shouldn't | |
4670 know. It also means you cannot see it yourself once you have set it, | |
4671 be careful not to make a typing error! | |
2698
b6471224d2af
Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents:
2681
diff
changeset
|
4672 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
|
4673 enabled. When 'key' is set it returns "*****" (five stars). |
7 | 4674 |
4675 *'keymap'* *'kmp'* *E544* | |
4676 'keymap' 'kmp' string (default "") | |
4677 local to buffer | |
4678 {only available when compiled with the |+keymap| | |
4679 feature} | |
4680 Name of a keyboard mapping. See |mbyte-keymap|. | |
4681 Setting this option to a valid keymap name has the side effect of | |
4682 setting 'iminsert' to one, so that the keymap becomes effective. | |
4683 'imsearch' is also set to one, unless it was -1 | |
36 | 4684 Only normal file name characters can be used, "/\*?[|<>" are illegal. |
7 | 4685 |
4686 *'keymodel'* *'km'* | |
4687 'keymodel' 'km' string (default "") | |
4688 global | |
4689 List of comma separated words, which enable special things that keys | |
4690 can do. These values can be used: | |
4691 startsel Using a shifted special key starts selection (either | |
4692 Select mode or Visual mode, depending on "key" being | |
4693 present in 'selectmode'). | |
4694 stopsel Using a not-shifted special key stops selection. | |
4695 Special keys in this context are the cursor keys, <End>, <Home>, | |
4696 <PageUp> and <PageDown>. | |
4697 The 'keymodel' option is set by the |:behave| command. | |
4698 | |
4699 *'keywordprg'* *'kp'* | |
4700 '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
|
4701 VMS: "help") |
7 | 4702 global or local to buffer |global-local| |
4703 Program to use for the |K| command. Environment variables are | |
4704 expanded |:set_env|. ":help" may be used to access the Vim internal | |
4705 help. (Note that previously setting the global option to the empty | |
4706 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
|
4707 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
|
4708 Ex command prefixed with [count]. |
0d52ddff8db4
commit https://github.com/vim/vim/commit/2ff8b64679242e73248774a388d54931c9ce49bd
Christian Brabandt <cb@256bit.org>
parents:
9097
diff
changeset
|
4709 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
|
4710 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
|
4711 argument. For "man -s" the "-s" is removed when there is no count. |
7 | 4712 See |option-backslash| about including spaces and backslashes. |
4713 Example: > | |
4714 :set keywordprg=man\ -s | |
4715 < This option cannot be set from a |modeline| or in the |sandbox|, for | |
4716 security reasons. | |
4717 | |
4718 *'langmap'* *'lmap'* *E357* *E358* | |
4719 'langmap' 'lmap' string (default "") | |
4720 global | |
4721 {only available when compiled with the |+langmap| | |
4722 feature} | |
4723 This option allows switching your keyboard into a special language | |
10 | 4724 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
|
4725 inserted directly. When in Normal mode the 'langmap' option takes |
7 | 4726 care of translating these special characters to the original meaning |
4727 of the key. This means you don't have to change the keyboard mode to | |
4728 be able to execute Normal mode commands. | |
4729 This is the opposite of the 'keymap' option, where characters are | |
4730 mapped in Insert mode. | |
19646 | 4731 Also consider setting 'langremap' to off, to prevent 'langmap' from |
4732 applying to characters resulting from a mapping. | |
5908 | 4733 This option cannot be set from a |modeline| or in the |sandbox|, for |
4734 security reasons. | |
7 | 4735 |
699 | 4736 Example (for Greek, in UTF-8): *greek* > |
4737 :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 | 4738 < Example (exchanges meaning of z and y for commands): > |
4739 :set langmap=zy,yz,ZY,YZ | |
4740 < | |
4741 The 'langmap' option is a list of parts, separated with commas. Each | |
4742 part can be in one of two forms: | |
4743 1. A list of pairs. Each pair is a "from" character immediately | |
4744 followed by the "to" character. Examples: "aA", "aAbBcC". | |
4745 2. A list of "from" characters, a semi-colon and a list of "to" | |
4746 characters. Example: "abc;ABC" | |
4747 Example: "aA,fgh;FGH,cCdDeE" | |
4748 Special characters need to be preceded with a backslash. These are | |
22565 | 4749 ";", ',', '"', '|' and backslash itself. |
7 | 4750 |
4751 This will allow you to activate vim actions without having to switch | |
4752 back and forth between the languages. Your language characters will | |
4753 be understood as normal vim English characters (according to the | |
4754 langmap mappings) in the following cases: | |
4755 o Normal/Visual mode (commands, buffer/register names, user mappings) | |
4756 o Insert/Replace Mode: Register names after CTRL-R | |
4757 o Insert/Replace Mode: Mappings | |
4758 Characters entered in Command-line mode will NOT be affected by | |
4759 this option. Note that this option can be changed at any time | |
4760 allowing to switch between mappings for different languages/encodings. | |
4761 Use a mapping to avoid having to type it each time! | |
4762 | |
4763 *'langmenu'* *'lm'* | |
4764 'langmenu' 'lm' string (default "") | |
4765 global | |
4766 {only available when compiled with the |+menu| and | |
4767 |+multi_lang| features} | |
4768 Language to use for menu translation. Tells which file is loaded | |
4769 from the "lang" directory in 'runtimepath': > | |
4770 "lang/menu_" . &langmenu . ".vim" | |
4771 < (without the spaces). For example, to always use the Dutch menus, no | |
4772 matter what $LANG is set to: > | |
4773 :set langmenu=nl_NL.ISO_8859-1 | |
4774 < When 'langmenu' is empty, |v:lang| is used. | |
36 | 4775 Only normal file name characters can be used, "/\*?[|<>" are illegal. |
7 | 4776 If your $LANG is set to a non-English language but you do want to use |
4777 the English menus: > | |
4778 :set langmenu=none | |
4779 < This option must be set before loading menus, switching on filetype | |
4780 detection or syntax highlighting. Once the menus are defined setting | |
4781 this option has no effect. But you could do this: > | |
4782 :source $VIMRUNTIME/delmenu.vim | |
4783 :set langmenu=de_DE.ISO_8859-1 | |
4784 :source $VIMRUNTIME/menu.vim | |
4785 < Warning: This deletes all menus that you defined yourself! | |
4786 | |
7196
42717d048817
commit https://github.com/vim/vim/commit/d94464ee294a351ce7b6ba18e8bd3f24f1bef920
Christian Brabandt <cb@256bit.org>
parents:
7147
diff
changeset
|
4787 *'langnoremap'* *'lnr'* *'nolangnoremap'* *'nolnr'* |
9669
284b4eb307fc
commit https://github.com/vim/vim/commit/8c08b5b569e2a9e9f63dea514591ecfa2d3bb392
Christian Brabandt <cb@256bit.org>
parents:
9665
diff
changeset
|
4788 'langnoremap' 'lnr' boolean (default off, set in |defaults.vim|) |
6339 | 4789 global |
4790 {only available when compiled with the |+langmap| | |
4791 feature} | |
9975
03fa8a51e9dc
commit https://github.com/vim/vim/commit/e4a3bcf28d92d0bde9ca227ccb40d401038185e5
Christian Brabandt <cb@256bit.org>
parents:
9913
diff
changeset
|
4792 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
|
4793 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
|
4794 '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
|
4795 |
03fa8a51e9dc
commit https://github.com/vim/vim/commit/e4a3bcf28d92d0bde9ca227ccb40d401038185e5
Christian Brabandt <cb@256bit.org>
parents:
9913
diff
changeset
|
4796 *'langremap'* *'lrm'* *'nolangremap'* *'nolrm'* |
19646 | 4797 'langremap' 'lrm' boolean (default on, set to off in |defaults.vim|) |
9975
03fa8a51e9dc
commit https://github.com/vim/vim/commit/e4a3bcf28d92d0bde9ca227ccb40d401038185e5
Christian Brabandt <cb@256bit.org>
parents:
9913
diff
changeset
|
4798 global |
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 The value of this option influences when the last window will have a | |
4811 status line: | |
4812 0: never | |
4813 1: only if there are at least two windows | |
4814 2: always | |
4815 The screen looks nicer with a status line if you have several | |
4816 windows, but it takes another screen line. |status-line| | |
4817 | |
4818 *'lazyredraw'* *'lz'* *'nolazyredraw'* *'nolz'* | |
4819 'lazyredraw' 'lz' boolean (default off) | |
4820 global | |
4821 When this option is set, the screen will not be redrawn while | |
4822 executing macros, registers and other commands that have not been | |
10 | 4823 typed. Also, updating the window title is postponed. To force an |
7 | 4824 update use |:redraw|. |
4825 | |
4826 *'linebreak'* *'lbr'* *'nolinebreak'* *'nolbr'* | |
4827 'linebreak' 'lbr' boolean (default off) | |
4828 local to window | |
2570
71b56b4e7785
Make the references to features in the help more consistent. (Sylvain Hitier)
Bram Moolenaar <bram@vim.org>
parents:
2561
diff
changeset
|
4829 {not available when compiled without the |+linebreak| |
7 | 4830 feature} |
6009 | 4831 If on, Vim will wrap long lines at a character in 'breakat' rather |
7 | 4832 than at the last character that fits on the screen. Unlike |
4833 'wrapmargin' and 'textwidth', this does not insert <EOL>s in the file, | |
6009 | 4834 it only affects the way the file is displayed, not its contents. |
4835 If 'breakindent' is set, line is visually indented. Then, the value | |
4836 of 'showbreak' is used to put in front of wrapped lines. This option | |
6026 | 4837 is not used when the 'wrap' option is off. |
7 | 4838 Note that <Tab> characters after an <EOL> are mostly not displayed |
4839 with the right amount of white space. | |
4840 | |
4841 *'lines'* *E593* | |
4842 'lines' number (default 24 or terminal height) | |
4843 global | |
4844 Number of lines of the Vim window. | |
4845 Normally you don't need to set this. It is done automatically by the | |
161 | 4846 terminal initialization code. Also see |posix-screen-size|. |
7 | 4847 When Vim is running in the GUI or in a resizable window, setting this |
4848 option will cause the window size to be changed. When you only want | |
4849 to use the size for the GUI, put the command in your |gvimrc| file. | |
4850 Vim limits the number of lines to what fits on the screen. You can | |
4851 use this command to get the tallest window possible: > | |
4852 :set lines=999 | |
571 | 4853 < 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
|
4854 If you get fewer lines than expected, check the 'guiheadroom' option. |
7 | 4855 When you set this option and Vim is unable to change the physical |
4856 number of lines of the display, the display may be messed up. | |
4857 | |
4858 *'linespace'* *'lsp'* | |
4859 'linespace' 'lsp' number (default 0, 1 for Win32 GUI) | |
4860 global | |
4861 {only in the GUI} | |
4862 Number of pixel lines inserted between characters. Useful if the font | |
4863 uses the full character cell height, making lines touch each other. | |
4864 When non-zero there is room for underlining. | |
180 | 4865 With some fonts there can be too much room between lines (to have |
4866 space for ascents and descents). Then it makes sense to set | |
4867 'linespace' to a negative value. This may cause display problems | |
4868 though! | |
7 | 4869 |
4870 *'lisp'* *'nolisp'* | |
4871 'lisp' boolean (default off) | |
4872 local to buffer | |
4873 {not available when compiled without the |+lispindent| | |
4874 feature} | |
4875 Lisp mode: When <Enter> is typed in insert mode set the indent for | |
4876 the next line to Lisp standards (well, sort of). Also happens with | |
4877 "cc" or "S". 'autoindent' must also be on for this to work. The 'p' | |
4878 flag in 'cpoptions' changes the method of indenting: Vi compatible or | |
4879 better. Also see 'lispwords'. | |
4880 The '-' character is included in keyword characters. Redefines the | |
4881 "=" operator to use this same indentation algorithm rather than | |
4882 calling an external program if 'equalprg' is empty. | |
4883 This option is not used when 'paste' is set. | |
4884 | |
4885 *'lispwords'* *'lw'* | |
4886 'lispwords' 'lw' string (default is very long) | |
5712 | 4887 global or local to buffer |global-local| |
7 | 4888 {not available when compiled without the |+lispindent| |
4889 feature} | |
4890 Comma separated list of words that influence the Lisp indenting. | |
4891 |'lisp'| | |
4892 | |
4893 *'list'* *'nolist'* | |
4894 'list' boolean (default off) | |
4895 local to window | |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
4896 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
|
4897 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
|
4898 trailing blanks. Further changed by the 'listchars' option. |
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
4899 |
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
4900 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
|
4901 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
|
4902 position while displaying Tabs with spaces, use: > |
5161
f7add3891e95
Updated runtime files. Fix NL translations.
Bram Moolenaar <bram@vim.org>
parents:
5146
diff
changeset
|
4903 :set list lcs=tab:\ \ |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
4904 < |
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
4905 Note that list mode will also affect formatting (set with 'textwidth' |
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
4906 or 'wrapmargin') when 'cpoptions' includes 'L'. See 'listchars' for |
7 | 4907 changing the way tabs are displayed. |
4908 | |
4909 *'listchars'* *'lcs'* | |
4910 'listchars' 'lcs' string (default "eol:$") | |
23952
44be09b25619
patch 8.2.2518: 'listchars' should be window-local
Bram Moolenaar <Bram@vim.org>
parents:
23932
diff
changeset
|
4911 global or local to window |global-local| |
2458 | 4912 Strings to use in 'list' mode and for the |:list| command. It is a |
4913 comma separated list of string settings. | |
6777 | 4914 *lcs-eol* |
7 | 4915 eol:c Character to show at the end of each line. When |
4916 omitted, there is no extra character at the end of the | |
4917 line. | |
6777 | 4918 *lcs-tab* |
15502
bc17a9d37810
patch 8.1.0759: showing two characters for tab is limited
Bram Moolenaar <Bram@vim.org>
parents:
15396
diff
changeset
|
4919 tab:xy[z] Two or three characters to be used to show a tab. |
bc17a9d37810
patch 8.1.0759: showing two characters for tab is limited
Bram Moolenaar <Bram@vim.org>
parents:
15396
diff
changeset
|
4920 The third character is optional. |
bc17a9d37810
patch 8.1.0759: showing two characters for tab is limited
Bram Moolenaar <Bram@vim.org>
parents:
15396
diff
changeset
|
4921 |
bc17a9d37810
patch 8.1.0759: showing two characters for tab is limited
Bram Moolenaar <Bram@vim.org>
parents:
15396
diff
changeset
|
4922 tab:xy The 'x' is always used, then 'y' as many times as will |
bc17a9d37810
patch 8.1.0759: showing two characters for tab is limited
Bram Moolenaar <Bram@vim.org>
parents:
15396
diff
changeset
|
4923 fit. Thus "tab:>-" displays: |
bc17a9d37810
patch 8.1.0759: showing two characters for tab is limited
Bram Moolenaar <Bram@vim.org>
parents:
15396
diff
changeset
|
4924 > |
bc17a9d37810
patch 8.1.0759: showing two characters for tab is limited
Bram Moolenaar <Bram@vim.org>
parents:
15396
diff
changeset
|
4925 >- |
bc17a9d37810
patch 8.1.0759: showing two characters for tab is limited
Bram Moolenaar <Bram@vim.org>
parents:
15396
diff
changeset
|
4926 >-- |
bc17a9d37810
patch 8.1.0759: showing two characters for tab is limited
Bram Moolenaar <Bram@vim.org>
parents:
15396
diff
changeset
|
4927 etc. |
bc17a9d37810
patch 8.1.0759: showing two characters for tab is limited
Bram Moolenaar <Bram@vim.org>
parents:
15396
diff
changeset
|
4928 |
bc17a9d37810
patch 8.1.0759: showing two characters for tab is limited
Bram Moolenaar <Bram@vim.org>
parents:
15396
diff
changeset
|
4929 tab:xyz The 'z' is always used, then 'x' is prepended, and |
bc17a9d37810
patch 8.1.0759: showing two characters for tab is limited
Bram Moolenaar <Bram@vim.org>
parents:
15396
diff
changeset
|
4930 then 'y' is used as many times as will fit. Thus |
bc17a9d37810
patch 8.1.0759: showing two characters for tab is limited
Bram Moolenaar <Bram@vim.org>
parents:
15396
diff
changeset
|
4931 "tab:<->" displays: |
bc17a9d37810
patch 8.1.0759: showing two characters for tab is limited
Bram Moolenaar <Bram@vim.org>
parents:
15396
diff
changeset
|
4932 > |
bc17a9d37810
patch 8.1.0759: showing two characters for tab is limited
Bram Moolenaar <Bram@vim.org>
parents:
15396
diff
changeset
|
4933 <> |
bc17a9d37810
patch 8.1.0759: showing two characters for tab is limited
Bram Moolenaar <Bram@vim.org>
parents:
15396
diff
changeset
|
4934 <-> |
bc17a9d37810
patch 8.1.0759: showing two characters for tab is limited
Bram Moolenaar <Bram@vim.org>
parents:
15396
diff
changeset
|
4935 <--> |
bc17a9d37810
patch 8.1.0759: showing two characters for tab is limited
Bram Moolenaar <Bram@vim.org>
parents:
15396
diff
changeset
|
4936 etc. |
bc17a9d37810
patch 8.1.0759: showing two characters for tab is limited
Bram Moolenaar <Bram@vim.org>
parents:
15396
diff
changeset
|
4937 |
bc17a9d37810
patch 8.1.0759: showing two characters for tab is limited
Bram Moolenaar <Bram@vim.org>
parents:
15396
diff
changeset
|
4938 When "tab:" is omitted, a tab is shown as ^I. |
6777 | 4939 *lcs-space* |
4940 space:c Character to show for a space. When omitted, spaces | |
4941 are left blank. | |
25778
373278f5bd51
patch 8.2.3424: a sequence of spaces is hard to see in list mode
Bram Moolenaar <Bram@vim.org>
parents:
25773
diff
changeset
|
4942 *lcs-multispace* |
373278f5bd51
patch 8.2.3424: a sequence of spaces is hard to see in list mode
Bram Moolenaar <Bram@vim.org>
parents:
25773
diff
changeset
|
4943 multispace:c... |
373278f5bd51
patch 8.2.3424: a sequence of spaces is hard to see in list mode
Bram Moolenaar <Bram@vim.org>
parents:
25773
diff
changeset
|
4944 One or more characters to use cyclically to show for |
373278f5bd51
patch 8.2.3424: a sequence of spaces is hard to see in list mode
Bram Moolenaar <Bram@vim.org>
parents:
25773
diff
changeset
|
4945 multiple consecutive spaces. Overrides the "space" |
373278f5bd51
patch 8.2.3424: a sequence of spaces is hard to see in list mode
Bram Moolenaar <Bram@vim.org>
parents:
25773
diff
changeset
|
4946 setting, except for single spaces. When omitted, the |
373278f5bd51
patch 8.2.3424: a sequence of spaces is hard to see in list mode
Bram Moolenaar <Bram@vim.org>
parents:
25773
diff
changeset
|
4947 "space" setting is used. For example, |
373278f5bd51
patch 8.2.3424: a sequence of spaces is hard to see in list mode
Bram Moolenaar <Bram@vim.org>
parents:
25773
diff
changeset
|
4948 `:set listchars=multispace:---+` shows ten consecutive |
373278f5bd51
patch 8.2.3424: a sequence of spaces is hard to see in list mode
Bram Moolenaar <Bram@vim.org>
parents:
25773
diff
changeset
|
4949 spaces as: |
373278f5bd51
patch 8.2.3424: a sequence of spaces is hard to see in list mode
Bram Moolenaar <Bram@vim.org>
parents:
25773
diff
changeset
|
4950 ---+---+-- |
23825
0bd44e94dd14
patch 8.2.2454: leading space can not be made visible
Bram Moolenaar <Bram@vim.org>
parents:
23666
diff
changeset
|
4951 *lcs-lead* |
0bd44e94dd14
patch 8.2.2454: leading space can not be made visible
Bram Moolenaar <Bram@vim.org>
parents:
23666
diff
changeset
|
4952 lead:c Character to show for leading spaces. When omitted, |
25778
373278f5bd51
patch 8.2.3424: a sequence of spaces is hard to see in list mode
Bram Moolenaar <Bram@vim.org>
parents:
25773
diff
changeset
|
4953 leading spaces are blank. Overrides the "space" and |
373278f5bd51
patch 8.2.3424: a sequence of spaces is hard to see in list mode
Bram Moolenaar <Bram@vim.org>
parents:
25773
diff
changeset
|
4954 "multispace" settings for leading spaces. You can |
373278f5bd51
patch 8.2.3424: a sequence of spaces is hard to see in list mode
Bram Moolenaar <Bram@vim.org>
parents:
25773
diff
changeset
|
4955 combine it with "tab:", for example: > |
23931 | 4956 :set listchars+=tab:>-,lead:. |
4957 < *lcs-trail* | |
10 | 4958 trail:c Character to show for trailing spaces. When omitted, |
25778
373278f5bd51
patch 8.2.3424: a sequence of spaces is hard to see in list mode
Bram Moolenaar <Bram@vim.org>
parents:
25773
diff
changeset
|
4959 trailing spaces are blank. Overrides the "space" and |
373278f5bd51
patch 8.2.3424: a sequence of spaces is hard to see in list mode
Bram Moolenaar <Bram@vim.org>
parents:
25773
diff
changeset
|
4960 "multispace" settings for trailing spaces. |
6777 | 4961 *lcs-extends* |
7 | 4962 extends:c Character to show in the last column, when 'wrap' is |
4963 off and the line continues beyond the right of the | |
4964 screen. | |
6777 | 4965 *lcs-precedes* |
18131
851a014dfd8b
patch 8.1.2060: "precedes" in 'listchars' not used properly
Bram Moolenaar <Bram@vim.org>
parents:
18130
diff
changeset
|
4966 precedes:c Character to show in the first visible column of the |
851a014dfd8b
patch 8.1.2060: "precedes" in 'listchars' not used properly
Bram Moolenaar <Bram@vim.org>
parents:
18130
diff
changeset
|
4967 physical line, when there is text preceding the |
851a014dfd8b
patch 8.1.2060: "precedes" in 'listchars' not used properly
Bram Moolenaar <Bram@vim.org>
parents:
18130
diff
changeset
|
4968 character visible in the first column. |
6777 | 4969 *lcs-conceal* |
2250
1bac28a53fae
Add the conceal patch from Vince Negri.
Bram Moolenaar <bram@vim.org>
parents:
2249
diff
changeset
|
4970 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
|
4971 'conceallevel' is set to 1. |
6777 | 4972 *lcs-nbsp* |
6801 | 4973 nbsp:c Character to show for a non-breakable space character |
4974 (0xA0 (160 decimal) and U+202F). Left blank when | |
4975 omitted. | |
7 | 4976 |
10 | 4977 The characters ':' and ',' should not be used. UTF-8 characters can |
7 | 4978 be used when 'encoding' is "utf-8", otherwise only printable |
819 | 4979 characters are allowed. All characters must be single width. |
7 | 4980 |
25978
40b17deb294f
patch 8.2.3522: cannot use x and u when setting 'listchars'
Bram Moolenaar <Bram@vim.org>
parents:
25974
diff
changeset
|
4981 Each character can be specified as hex: > |
40b17deb294f
patch 8.2.3522: cannot use x and u when setting 'listchars'
Bram Moolenaar <Bram@vim.org>
parents:
25974
diff
changeset
|
4982 set listchars=eol:\\x24 |
40b17deb294f
patch 8.2.3522: cannot use x and u when setting 'listchars'
Bram Moolenaar <Bram@vim.org>
parents:
25974
diff
changeset
|
4983 set listchars=eol:\\u21b5 |
40b17deb294f
patch 8.2.3522: cannot use x and u when setting 'listchars'
Bram Moolenaar <Bram@vim.org>
parents:
25974
diff
changeset
|
4984 set listchars=eol:\\U000021b5 |
40b17deb294f
patch 8.2.3522: cannot use x and u when setting 'listchars'
Bram Moolenaar <Bram@vim.org>
parents:
25974
diff
changeset
|
4985 < Note that a double backslash is used. The number of hex characters |
40b17deb294f
patch 8.2.3522: cannot use x and u when setting 'listchars'
Bram Moolenaar <Bram@vim.org>
parents:
25974
diff
changeset
|
4986 must be exactly 2 for \\x, 4 for \\u and 8 for \\U. |
40b17deb294f
patch 8.2.3522: cannot use x and u when setting 'listchars'
Bram Moolenaar <Bram@vim.org>
parents:
25974
diff
changeset
|
4987 |
7 | 4988 Examples: > |
4989 :set lcs=tab:>-,trail:- | |
12 | 4990 :set lcs=tab:>-,eol:<,nbsp:% |
7 | 4991 :set lcs=extends:>,precedes:< |
4992 < The "NonText" highlighting will be used for "eol", "extends" and | |
25836 | 4993 "precedes". "SpecialKey" will be used for "tab", "nbsp", "space", |
4994 "multispace", "lead" and "trail". | |
1152 | 4995 |hl-NonText| |hl-SpecialKey| |
7 | 4996 |
4997 *'lpl'* *'nolpl'* *'loadplugins'* *'noloadplugins'* | |
4998 'loadplugins' 'lpl' boolean (default on) | |
4999 global | |
5000 When on the plugin scripts are loaded when starting up |load-plugins|. | |
5001 This option can be reset in your |vimrc| file to disable the loading | |
5002 of plugins. | |
11666
5cd9ba96561d
patch 8.0.0716: not easy to start Vim cleanly
Christian Brabandt <cb@256bit.org>
parents:
11659
diff
changeset
|
5003 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
|
5004 line arguments reset this option. See |-u| and |--noplugin|. |
7 | 5005 |
7196
42717d048817
commit https://github.com/vim/vim/commit/d94464ee294a351ce7b6ba18e8bd3f24f1bef920
Christian Brabandt <cb@256bit.org>
parents:
7147
diff
changeset
|
5006 *'luadll'* |
8629
54ac275e3fc4
commit https://github.com/vim/vim/commit/3848e00e0177abdb31bc600234967863ec487233
Christian Brabandt <cb@256bit.org>
parents:
8560
diff
changeset
|
5007 '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
|
5008 global |
7196
42717d048817
commit https://github.com/vim/vim/commit/d94464ee294a351ce7b6ba18e8bd3f24f1bef920
Christian Brabandt <cb@256bit.org>
parents:
7147
diff
changeset
|
5009 {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
|
5010 feature} |
7528
53163e4d9e4f
commit https://github.com/vim/vim/commit/25e4fcde767084d1a79e0926bc301c92987c0cce
Christian Brabandt <cb@256bit.org>
parents:
7477
diff
changeset
|
5011 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
|
5012 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
|
5013 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
|
5014 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
|
5015 security reasons. |
42717d048817
commit https://github.com/vim/vim/commit/d94464ee294a351ce7b6ba18e8bd3f24f1bef920
Christian Brabandt <cb@256bit.org>
parents:
7147
diff
changeset
|
5016 |
842 | 5017 *'macatsui'* *'nomacatsui'* |
5018 'macatsui' boolean (default on) | |
5019 global | |
21825 | 5020 {not supported} |
5021 No longer supported, as the Mac OS X GUI code was removed. | |
1152 | 5022 |
7 | 5023 *'magic'* *'nomagic'* |
5024 'magic' boolean (default on) | |
5025 global | |
5026 Changes the special characters that can be used in search patterns. | |
5027 See |pattern|. | |
10140
b11ceef7116e
commit https://github.com/vim/vim/commit/64d8e25bf6efe5f18b032563521c3ce278c316ab
Christian Brabandt <cb@256bit.org>
parents:
10027
diff
changeset
|
5028 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
|
5029 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
|
5030 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
|
5031 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
|
5032 when you want to |/\M|. |
23305 | 5033 In |Vim9| script the value of 'magic' is ignored, patterns behave like |
5034 it is always set. | |
7 | 5035 |
5036 *'makeef'* *'mef'* | |
5037 'makeef' 'mef' string (default: "") | |
5038 global | |
5039 {not available when compiled without the |+quickfix| | |
5040 feature} | |
5041 Name of the errorfile for the |:make| command (see |:make_makeprg|) | |
5042 and the |:grep| command. | |
5043 When it is empty, an internally generated temp file will be used. | |
5044 When "##" is included, it is replaced by a number to make the name | |
5045 unique. This makes sure that the ":make" command doesn't overwrite an | |
5046 existing file. | |
5047 NOT used for the ":cf" command. See 'errorfile' for that. | |
5048 Environment variables are expanded |:set_env|. | |
5049 See |option-backslash| about including spaces and backslashes. | |
5050 This option cannot be set from a |modeline| or in the |sandbox|, for | |
5051 security reasons. | |
5052 | |
11063
e71d3bdf3bc3
patch 8.0.0420: text garbled when the system encoding differs from 'encoding'
Christian Brabandt <cb@256bit.org>
parents:
11062
diff
changeset
|
5053 *'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
|
5054 '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
|
5055 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
|
5056 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
|
5057 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
|
5058 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
|
5059 `: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
|
5060 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
|
5061 |
e71d3bdf3bc3
patch 8.0.0420: text garbled when the system encoding differs from 'encoding'
Christian Brabandt <cb@256bit.org>
parents:
11062
diff
changeset
|
5062 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
|
5063 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
|
5064 '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
|
5065 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
|
5066 :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
|
5067 :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
|
5068 < |
7 | 5069 *'makeprg'* *'mp'* |
5070 'makeprg' 'mp' string (default "make", VMS: "MMS") | |
5071 global or local to buffer |global-local| | |
1152 | 5072 Program to use for the ":make" command. See |:make_makeprg|. |
13341
acd7eaa13d2b
Updated runtime files.
Christian Brabandt <cb@256bit.org>
parents:
13314
diff
changeset
|
5073 This option may contain '%' and '#' characters (see |:_%| and |:_#|), |
acd7eaa13d2b
Updated runtime files.
Christian Brabandt <cb@256bit.org>
parents:
13314
diff
changeset
|
5074 which are expanded to the current and alternate file name. Use |::S| |
5690 | 5075 to escape file names in case they contain special characters. |
1152 | 5076 Environment variables are expanded |:set_env|. See |option-backslash| |
5077 about including spaces and backslashes. | |
5078 Note that a '|' must be escaped twice: once for ":set" and once for | |
5079 the interpretation of a command. When you use a filter called | |
5080 "myfilter" do it like this: > | |
7 | 5081 :set makeprg=gmake\ \\\|\ myfilter |
5082 < The placeholder "$*" can be given (even multiple times) to specify | |
5083 where the arguments will be included, for example: > | |
5084 :set makeprg=latex\ \\\\nonstopmode\ \\\\input\\{$*} | |
5085 < This option cannot be set from a |modeline| or in the |sandbox|, for | |
5086 security reasons. | |
5087 | |
5088 *'matchpairs'* *'mps'* | |
5089 'matchpairs' 'mps' string (default "(:),{:},[:]") | |
5090 local to buffer | |
5091 Characters that form pairs. The |%| command jumps from one to the | |
4073 | 5092 other. |
5093 Only character pairs are allowed that are different, thus you cannot | |
5094 jump between two double quotes. | |
5095 The characters must be separated by a colon. | |
1152 | 5096 The pairs must be separated by a comma. Example for including '<' and |
24387 | 5097 '>' (for HTML): > |
7 | 5098 :set mps+=<:> |
5099 | |
5100 < A more exotic example, to jump between the '=' and ';' in an | |
5101 assignment, useful for languages like C and Java: > | |
5102 :au FileType c,cpp,java set mps+==:; | |
5103 | |
5104 < For a more advanced way of using "%", see the matchit.vim plugin in | |
12756
3b26420fc639
Long overdue runtime update.
Christian Brabandt <cb@256bit.org>
parents:
12744
diff
changeset
|
5105 the $VIMRUNTIME/pack/dist/opt/matchit directory. |add-local-help| |
7 | 5106 |
5107 *'matchtime'* *'mat'* | |
5108 'matchtime' 'mat' number (default 5) | |
5109 global | |
5110 Tenths of a second to show the matching paren, when 'showmatch' is | |
5111 set. Note that this is not in milliseconds, like other options that | |
5112 set a time. This is to be compatible with Nvi. | |
5113 | |
714 | 5114 *'maxcombine'* *'mco'* |
5115 'maxcombine' 'mco' number (default 2) | |
5116 global | |
5117 The maximum number of combining characters supported for displaying. | |
5118 Only used when 'encoding' is "utf-8". | |
5119 The default is OK for most languages. Hebrew may require 4. | |
5120 Maximum value is 6. | |
5121 Even when this option is set to 2 you can still edit text with more | |
5122 combining characters, you just can't see them. Use |g8| or |ga|. | |
5123 See |mbyte-combining|. | |
5124 | |
7 | 5125 *'maxfuncdepth'* *'mfd'* |
5126 'maxfuncdepth' 'mfd' number (default 100) | |
5127 global | |
2570
71b56b4e7785
Make the references to features in the help more consistent. (Sylvain Hitier)
Bram Moolenaar <bram@vim.org>
parents:
2561
diff
changeset
|
5128 {not available when compiled without the |+eval| |
1152 | 5129 feature} |
7 | 5130 Maximum depth of function calls for user functions. This normally |
5131 catches endless recursion. When using a recursive function with | |
5132 more depth, set 'maxfuncdepth' to a bigger number. But this will use | |
5133 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
|
5134 Increasing this limit above 200 also changes the maximum for Ex |
14006 | 5135 command recursion, see |E169|. |
7 | 5136 See also |:function|. |
5137 | |
5138 *'maxmapdepth'* *'mmd'* *E223* | |
5139 'maxmapdepth' 'mmd' number (default 1000) | |
5140 global | |
5141 Maximum number of times a mapping is done without resulting in a | |
5142 character to be used. This normally catches endless mappings, like | |
5143 ":map x y" with ":map y x". It still does not catch ":map g wg", | |
5144 because the 'w' is used before the next mapping is done. See also | |
5145 |key-mapping|. | |
5146 | |
5147 *'maxmem'* *'mm'* | |
5148 'maxmem' 'mm' number (default between 256 to 5120 (system | |
5149 dependent) or half the amount of memory | |
5150 available) | |
5151 global | |
5152 Maximum amount of memory (in Kbyte) to use for one buffer. When this | |
5153 limit is reached allocating extra memory for a buffer will cause | |
13314
65c3e8259124
patch 8.0.1531: cannot use 24 bit colors in MS-Windows console
Christian Brabandt <cb@256bit.org>
parents:
13234
diff
changeset
|
5154 other memory to be freed. |
65c3e8259124
patch 8.0.1531: cannot use 24 bit colors in MS-Windows console
Christian Brabandt <cb@256bit.org>
parents:
13234
diff
changeset
|
5155 The maximum usable value is about 2000000. Use this to work without a |
65c3e8259124
patch 8.0.1531: cannot use 24 bit colors in MS-Windows console
Christian Brabandt <cb@256bit.org>
parents:
13234
diff
changeset
|
5156 limit. |
65c3e8259124
patch 8.0.1531: cannot use 24 bit colors in MS-Windows console
Christian Brabandt <cb@256bit.org>
parents:
13234
diff
changeset
|
5157 The value is ignored when 'swapfile' is off. |
65c3e8259124
patch 8.0.1531: cannot use 24 bit colors in MS-Windows console
Christian Brabandt <cb@256bit.org>
parents:
13234
diff
changeset
|
5158 Also see 'maxmemtot'. |
7 | 5159 |
189 | 5160 *'maxmempattern'* *'mmp'* |
5161 'maxmempattern' 'mmp' number (default 1000) | |
5162 global | |
5163 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
|
5164 The maximum value is about 2000000. Use this to work without a limit. |
189 | 5165 *E363* |
1152 | 5166 When Vim runs into the limit it gives an error message and mostly |
5167 behaves like CTRL-C was typed. | |
189 | 5168 Running into the limit often means that the pattern is very |
5169 inefficient or too complex. This may already happen with the pattern | |
5170 "\(.\)*" on a very long line. ".*" works much better. | |
14298
4a588e3afd4a
Update runtime files, add Danish translations.
Christian Brabandt <cb@256bit.org>
parents:
14249
diff
changeset
|
5171 Might also happen on redraw, when syntax rules try to match a complex |
4a588e3afd4a
Update runtime files, add Danish translations.
Christian Brabandt <cb@256bit.org>
parents:
14249
diff
changeset
|
5172 text structure. |
4a588e3afd4a
Update runtime files, add Danish translations.
Christian Brabandt <cb@256bit.org>
parents:
14249
diff
changeset
|
5173 Vim may run out of memory before hitting the 'maxmempattern' limit, in |
4a588e3afd4a
Update runtime files, add Danish translations.
Christian Brabandt <cb@256bit.org>
parents:
14249
diff
changeset
|
5174 which case you get an "Out of memory" error instead. |
189 | 5175 |
7 | 5176 *'maxmemtot'* *'mmt'* |
5177 'maxmemtot' 'mmt' number (default between 2048 and 10240 (system | |
5178 dependent) or half the amount of memory | |
5179 available) | |
5180 global | |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
5181 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
|
5182 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
|
5183 without a limit. |
05cf4cc72a9f
commit https://github.com/vim/vim/commit/fa7353428f705f7a13465a1943dddeede4083023
Christian Brabandt <cb@256bit.org>
parents:
7272
diff
changeset
|
5184 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
|
5185 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
|
5186 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
|
5187 need the memory to store undo info. |
13314
65c3e8259124
patch 8.0.1531: cannot use 24 bit colors in MS-Windows console
Christian Brabandt <cb@256bit.org>
parents:
13234
diff
changeset
|
5188 Buffers with 'swapfile' off still count to the total amount of memory |
65c3e8259124
patch 8.0.1531: cannot use 24 bit colors in MS-Windows console
Christian Brabandt <cb@256bit.org>
parents:
13234
diff
changeset
|
5189 used. |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
5190 Also see 'maxmem'. |
7 | 5191 |
5192 *'menuitems'* *'mis'* | |
5193 'menuitems' 'mis' number (default 25) | |
5194 global | |
5195 {not available when compiled without the |+menu| | |
5196 feature} | |
5197 Maximum number of items to use in a menu. Used for menus that are | |
5198 generated from a list of items, e.g., the Buffers menu. Changing this | |
5199 option has no direct effect, the menu must be refreshed first. | |
5200 | |
484 | 5201 *'mkspellmem'* *'msm'* |
5202 'mkspellmem' 'msm' string (default "460000,2000,500") | |
5203 global | |
5204 {not available when compiled without the |+syntax| | |
5205 feature} | |
5206 Parameters for |:mkspell|. This tunes when to start compressing the | |
5207 word tree. Compression can be slow when there are many words, but | |
5208 it's needed to avoid running out of memory. The amount of memory used | |
5209 per word depends very much on how similar the words are, that's why | |
5210 this tuning is complicated. | |
5211 | |
5212 There are three numbers, separated by commas: | |
5213 {start},{inc},{added} | |
5214 | |
5215 For most languages the uncompressed word tree fits in memory. {start} | |
5216 gives the amount of memory in Kbyte that can be used before any | |
5217 compression is done. It should be a bit smaller than the amount of | |
5218 memory that is available to Vim. | |
5219 | |
5220 When going over the {start} limit the {inc} number specifies the | |
5221 amount of memory in Kbyte that can be allocated before another | |
5222 compression is done. A low number means compression is done after | |
5223 less words are added, which is slow. A high number means more memory | |
5224 will be allocated. | |
5225 | |
5226 After doing compression, {added} times 1024 words can be added before | |
5227 the {inc} limit is ignored and compression is done when any extra | |
5228 amount of memory is needed. A low number means there is a smaller | |
5229 chance of hitting the {inc} limit, less memory is used but it's | |
5230 slower. | |
5231 | |
5232 The languages for which these numbers are important are Italian and | |
5233 Hungarian. The default works for when you have about 512 Mbyte. If | |
5234 you have 1 Gbyte you could use: > | |
5235 :set mkspellmem=900000,3000,800 | |
5236 < If you have less than 512 Mbyte |:mkspell| may fail for some | |
5237 languages, no matter what you set 'mkspellmem' to. | |
5238 | |
16798
63ac51f16ea1
patch 8.1.1401: misspelled mkspellmem as makespellmem
Bram Moolenaar <Bram@vim.org>
parents:
16778
diff
changeset
|
5239 This option cannot be set from a |modeline| or in the |sandbox|. |
63ac51f16ea1
patch 8.1.1401: misspelled mkspellmem as makespellmem
Bram Moolenaar <Bram@vim.org>
parents:
16778
diff
changeset
|
5240 |
7 | 5241 *'modeline'* *'ml'* *'nomodeline'* *'noml'* |
1111 | 5242 'modeline' 'ml' boolean (Vim default: on (off for root), |
5243 Vi default: off) | |
7 | 5244 local to buffer |
16728
e55c26aaf484
patch 8.1.1366: using expressions in a modeline is unsafe
Bram Moolenaar <Bram@vim.org>
parents:
16610
diff
changeset
|
5245 If 'modeline' is on 'modelines' gives the number of lines that is |
e55c26aaf484
patch 8.1.1366: using expressions in a modeline is unsafe
Bram Moolenaar <Bram@vim.org>
parents:
16610
diff
changeset
|
5246 checked for set commands. If 'modeline' is off or 'modelines' is zero |
e55c26aaf484
patch 8.1.1366: using expressions in a modeline is unsafe
Bram Moolenaar <Bram@vim.org>
parents:
16610
diff
changeset
|
5247 no lines are checked. See |modeline|. |
e55c26aaf484
patch 8.1.1366: using expressions in a modeline is unsafe
Bram Moolenaar <Bram@vim.org>
parents:
16610
diff
changeset
|
5248 |
e55c26aaf484
patch 8.1.1366: using expressions in a modeline is unsafe
Bram Moolenaar <Bram@vim.org>
parents:
16610
diff
changeset
|
5249 *'modelineexpr'* *'mle'* *'nomodelineexpr'* *'nomle'* |
e55c26aaf484
patch 8.1.1366: using expressions in a modeline is unsafe
Bram Moolenaar <Bram@vim.org>
parents:
16610
diff
changeset
|
5250 'modelineexpr' 'mle' boolean (default: off) |
e55c26aaf484
patch 8.1.1366: using expressions in a modeline is unsafe
Bram Moolenaar <Bram@vim.org>
parents:
16610
diff
changeset
|
5251 global |
e55c26aaf484
patch 8.1.1366: using expressions in a modeline is unsafe
Bram Moolenaar <Bram@vim.org>
parents:
16610
diff
changeset
|
5252 When on allow some options that are an expression to be set in the |
e55c26aaf484
patch 8.1.1366: using expressions in a modeline is unsafe
Bram Moolenaar <Bram@vim.org>
parents:
16610
diff
changeset
|
5253 modeline. Check the option for whether it is affected by |
e55c26aaf484
patch 8.1.1366: using expressions in a modeline is unsafe
Bram Moolenaar <Bram@vim.org>
parents:
16610
diff
changeset
|
5254 'modelineexpr'. Also see |modeline|. |
16740
dc85d49349f7
patch 8.1.1372: when evaluating 'statusline' the current window is unknown
Bram Moolenaar <Bram@vim.org>
parents:
16728
diff
changeset
|
5255 This option cannot be set from a |modeline| or in the |sandbox|, for |
dc85d49349f7
patch 8.1.1372: when evaluating 'statusline' the current window is unknown
Bram Moolenaar <Bram@vim.org>
parents:
16728
diff
changeset
|
5256 security reasons. |
16728
e55c26aaf484
patch 8.1.1366: using expressions in a modeline is unsafe
Bram Moolenaar <Bram@vim.org>
parents:
16610
diff
changeset
|
5257 |
7 | 5258 *'modelines'* *'mls'* |
5259 'modelines' 'mls' number (default 5) | |
5260 global | |
5261 If 'modeline' is on 'modelines' gives the number of lines that is | |
5262 checked for set commands. If 'modeline' is off or 'modelines' is zero | |
5263 no lines are checked. See |modeline|. | |
5264 NOTE: 'modeline' is set to the Vi default value when 'compatible' is | |
5265 set and to the Vim default value when 'compatible' is reset. | |
5266 | |
5267 *'modifiable'* *'ma'* *'nomodifiable'* *'noma'* | |
16728
e55c26aaf484
patch 8.1.1366: using expressions in a modeline is unsafe
Bram Moolenaar <Bram@vim.org>
parents:
16610
diff
changeset
|
5268 *E21* |
7 | 5269 'modifiable' 'ma' boolean (default on) |
5270 local to buffer | |
5271 When off the buffer contents cannot be changed. The 'fileformat' and | |
5272 'fileencoding' options also can't be changed. | |
10617 | 5273 Can be reset on startup with the |-M| command line argument. |
7 | 5274 |
5275 *'modified'* *'mod'* *'nomodified'* *'nomod'* | |
5276 'modified' 'mod' boolean (default off) | |
5277 local to buffer | |
5278 When on, the buffer is considered to be modified. This option is set | |
5279 when: | |
5280 1. A change was made to the text since it was last written. Using the | |
5281 |undo| command to go back to the original text will reset the | |
5282 option. But undoing changes that were made before writing the | |
5283 buffer will set the option again, since the text is different from | |
5284 when it was written. | |
5285 2. 'fileformat' or 'fileencoding' is different from its original | |
5286 value. The original value is set when the buffer is read or | |
5287 written. A ":set nomodified" command also resets the original | |
5288 values to the current values and the 'modified' option will be | |
5289 reset. | |
8748
b1a19a2f73f0
commit https://github.com/vim/vim/commit/4f3f668c8486444e53163c29d2fc79bf47eb3c82
Christian Brabandt <cb@256bit.org>
parents:
8629
diff
changeset
|
5290 Similarly for 'eol' and 'bomb'. |
3082 | 5291 This option is not set when a change is made to the buffer as the |
5292 result of a BufNewFile, BufRead/BufReadPost, BufWritePost, | |
5293 FileAppendPost or VimLeave autocommand event. See |gzip-example| for | |
5294 an explanation. | |
7 | 5295 When 'buftype' is "nowrite" or "nofile" this option may be set, but |
5296 will be ignored. | |
13437 | 5297 Note that the text may actually be the same, e.g. 'modified' is set |
5298 when using "rA" on an "A". | |
7 | 5299 |
5300 *'more'* *'nomore'* | |
5301 'more' boolean (Vim default: on, Vi default: off) | |
5302 global | |
5303 When on, listings pause when the whole screen is filled. You will get | |
5304 the |more-prompt|. When this option is off there are no pauses, the | |
5305 listing continues until finished. | |
5306 NOTE: This option is set to the Vi default value when 'compatible' is | |
5307 set and to the Vim default value when 'compatible' is reset. | |
5308 | |
23666 | 5309 *'mouse'* |
18972 | 5310 'mouse' string (default "", "a" for GUI and Win32, |
18465
d7619a9874cd
patch 8.1.2226: cannot use system copy/paste in non-xterm terminals
Bram Moolenaar <Bram@vim.org>
parents:
18463
diff
changeset
|
5311 set to "a" or "nvi" in |defaults.vim|) |
d7619a9874cd
patch 8.1.2226: cannot use system copy/paste in non-xterm terminals
Bram Moolenaar <Bram@vim.org>
parents:
18463
diff
changeset
|
5312 global |
18972 | 5313 Enable the use of the mouse. Works for most terminals (xterm, Win32 |
5314 |win32-mouse|, QNX pterm, *BSD console with sysmouse and Linux console | |
5315 with gpm). For using the mouse in the GUI, see |gui-mouse|. The | |
5316 mouse can be enabled for different modes: | |
12826 | 5317 n Normal mode and Terminal modes |
7 | 5318 v Visual mode |
5319 i Insert mode | |
5320 c Command-line mode | |
5321 h all previous modes when editing a help file | |
5322 a all previous modes | |
5323 r for |hit-enter| and |more-prompt| prompt | |
14864 | 5324 Normally you would enable the mouse in all five modes with: > |
7 | 5325 :set mouse=a |
18465
d7619a9874cd
patch 8.1.2226: cannot use system copy/paste in non-xterm terminals
Bram Moolenaar <Bram@vim.org>
parents:
18463
diff
changeset
|
5326 < If your terminal can't overrule the mouse events going to the |
d7619a9874cd
patch 8.1.2226: cannot use system copy/paste in non-xterm terminals
Bram Moolenaar <Bram@vim.org>
parents:
18463
diff
changeset
|
5327 application, use: > |
d7619a9874cd
patch 8.1.2226: cannot use system copy/paste in non-xterm terminals
Bram Moolenaar <Bram@vim.org>
parents:
18463
diff
changeset
|
5328 :set mouse=nvi |
20856 | 5329 < Then you can press ":", select text for the system, and press Esc to go |
18465
d7619a9874cd
patch 8.1.2226: cannot use system copy/paste in non-xterm terminals
Bram Moolenaar <Bram@vim.org>
parents:
18463
diff
changeset
|
5330 back to Vim using the mouse events. |
d7619a9874cd
patch 8.1.2226: cannot use system copy/paste in non-xterm terminals
Bram Moolenaar <Bram@vim.org>
parents:
18463
diff
changeset
|
5331 In |defaults.vim| "nvi" is used if the 'term' option is not matching |
d7619a9874cd
patch 8.1.2226: cannot use system copy/paste in non-xterm terminals
Bram Moolenaar <Bram@vim.org>
parents:
18463
diff
changeset
|
5332 "xterm". |
d7619a9874cd
patch 8.1.2226: cannot use system copy/paste in non-xterm terminals
Bram Moolenaar <Bram@vim.org>
parents:
18463
diff
changeset
|
5333 |
d7619a9874cd
patch 8.1.2226: cannot use system copy/paste in non-xterm terminals
Bram Moolenaar <Bram@vim.org>
parents:
18463
diff
changeset
|
5334 When the mouse is not enabled, the GUI will still use the mouse for |
7 | 5335 modeless selection. This doesn't move the text cursor. |
5336 | |
5337 See |mouse-using|. Also see |'clipboard'|. | |
5338 | |
5339 Note: When enabling the mouse in a terminal, copy/paste will use the | |
10 | 5340 "* register if there is access to an X-server. The xterm handling of |
7 | 5341 the mouse buttons can still be used by keeping the shift key pressed. |
5342 Also see the 'clipboard' option. | |
5343 | |
5344 *'mousefocus'* *'mousef'* *'nomousefocus'* *'nomousef'* | |
5345 'mousefocus' 'mousef' boolean (default off) | |
5346 global | |
5347 {only works in the GUI} | |
5348 The window that the mouse pointer is on is automatically activated. | |
5349 When changing the window layout or window focus in another way, the | |
5350 mouse pointer is moved to the window with keyboard focus. Off is the | |
5351 default because it makes using the pull down menus a little goofy, as | |
5352 a pointer transit may activate a window unintentionally. | |
18594 | 5353 MS-Windows: Also see 'scrollfocus' for what window is scrolled when |
19180 | 5354 using the mouse scroll wheel. |
7 | 5355 |
5356 *'mousehide'* *'mh'* *'nomousehide'* *'nomh'* | |
5357 'mousehide' 'mh' boolean (default on) | |
5358 global | |
5359 {only works in the GUI} | |
5360 When on, the mouse pointer is hidden when characters are typed. | |
5361 The mouse pointer is restored when the mouse is moved. | |
5362 | |
5363 *'mousemodel'* *'mousem'* | |
18972 | 5364 'mousemodel' 'mousem' string (default "extend", "popup" for Win32) |
7 | 5365 global |
5366 Sets the model to use for the mouse. The name mostly specifies what | |
5367 the right mouse button is used for: | |
5368 extend Right mouse button extends a selection. This works | |
5369 like in an xterm. | |
5370 popup Right mouse button pops up a menu. The shifted left | |
5371 mouse button extends a selection. This works like | |
233 | 5372 with Microsoft Windows. |
7 | 5373 popup_setpos Like "popup", but the cursor will be moved to the |
5374 position where the mouse was clicked, and thus the | |
5375 selected operation will act upon the clicked object. | |
5376 If clicking inside a selection, that selection will | |
233 | 5377 be acted upon, i.e. no cursor move. This implies of |
7 | 5378 course, that right clicking outside a selection will |
5379 end Visual mode. | |
5380 Overview of what button does what for each model: | |
5381 mouse extend popup(_setpos) ~ | |
5382 left click place cursor place cursor | |
5383 left drag start selection start selection | |
5384 shift-left search word extend selection | |
5385 right click extend selection popup menu (place cursor) | |
5386 right drag extend selection - | |
5387 middle click paste paste | |
5388 | |
5389 In the "popup" model the right mouse button produces a pop-up menu. | |
5390 You need to define this first, see |popup-menu|. | |
5391 | |
5392 Note that you can further refine the meaning of buttons with mappings. | |
5393 See |gui-mouse-mapping|. But mappings are NOT used for modeless | |
5394 selection (because that's handled in the GUI code directly). | |
5395 | |
5396 The 'mousemodel' option is set by the |:behave| command. | |
5397 | |
5398 *'mouseshape'* *'mouses'* *E547* | |
15932 | 5399 'mouseshape' 'mouses' string (default "i-r:beam,s:updown,sd:udsizing, |
5400 vs:leftright,vd:lrsizing,m:no, | |
5401 ml:up-arrow,v:rightup-arrow") | |
7 | 5402 global |
5403 {only available when compiled with the |+mouseshape| | |
5404 feature} | |
5405 This option tells Vim what the mouse pointer should look like in | |
5406 different modes. The option is a comma separated list of parts, much | |
5407 like used for 'guicursor'. Each part consist of a mode/location-list | |
5408 and an argument-list: | |
5409 mode-list:shape,mode-list:shape,.. | |
5410 The mode-list is a dash separated list of these modes/locations: | |
5411 In a normal window: ~ | |
5412 n Normal mode | |
5413 v Visual mode | |
5414 ve Visual mode with 'selection' "exclusive" (same as 'v', | |
5415 if not specified) | |
5416 o Operator-pending mode | |
5417 i Insert mode | |
5418 r Replace mode | |
5419 | |
5420 Others: ~ | |
5421 c appending to the command-line | |
5422 ci inserting in the command-line | |
5423 cr replacing in the command-line | |
5424 m at the 'Hit ENTER' or 'More' prompts | |
5425 ml idem, but cursor in the last line | |
5426 e any mode, pointer below last window | |
5427 s any mode, pointer on a status line | |
5428 sd any mode, while dragging a status line | |
5429 vs any mode, pointer on a vertical separator line | |
5430 vd any mode, while dragging a vertical separator line | |
5431 a everywhere | |
5432 | |
5433 The shape is one of the following: | |
5434 avail name looks like ~ | |
5435 w x arrow Normal mouse pointer | |
5436 w x blank no pointer at all (use with care!) | |
5437 w x beam I-beam | |
5438 w x updown up-down sizing arrows | |
5439 w x leftright left-right sizing arrows | |
5440 w x busy The system's usual busy pointer | |
5441 w x no The system's usual 'no input' pointer | |
5442 x udsizing indicates up-down resizing | |
5443 x lrsizing indicates left-right resizing | |
5444 x crosshair like a big thin + | |
5445 x hand1 black hand | |
5446 x hand2 white hand | |
5447 x pencil what you write with | |
5448 x question big ? | |
5449 x rightup-arrow arrow pointing right-up | |
5450 w x up-arrow arrow pointing up | |
5451 x <number> any X11 pointer number (see X11/cursorfont.h) | |
5452 | |
5453 The "avail" column contains a 'w' if the shape is available for Win32, | |
5454 x for X11. | |
5455 Any modes not specified or shapes not available use the normal mouse | |
5456 pointer. | |
5457 | |
5458 Example: > | |
5459 :set mouseshape=s:udsizing,m:no | |
5460 < will make the mouse turn to a sizing arrow over the status lines and | |
5461 indicate no input when the hit-enter prompt is displayed (since | |
5462 clicking the mouse has no effect in this state.) | |
5463 | |
5464 *'mousetime'* *'mouset'* | |
5465 'mousetime' 'mouset' number (default 500) | |
5466 global | |
18972 | 5467 Only for GUI, Win32 and Unix with xterm. Defines the maximum |
7 | 5468 time in msec between two mouse clicks for the second click to be |
5469 recognized as a multi click. | |
5470 | |
12608
b390f5003e2f
patch 8.0.1182: cannot see or change mzscheme dll name
Christian Brabandt <cb@256bit.org>
parents:
12559
diff
changeset
|
5471 *'mzschemedll'* |
b390f5003e2f
patch 8.0.1182: cannot see or change mzscheme dll name
Christian Brabandt <cb@256bit.org>
parents:
12559
diff
changeset
|
5472 'mzschemedll' string (default depends on the build) |
b390f5003e2f
patch 8.0.1182: cannot see or change mzscheme dll name
Christian Brabandt <cb@256bit.org>
parents:
12559
diff
changeset
|
5473 global |
b390f5003e2f
patch 8.0.1182: cannot see or change mzscheme dll name
Christian Brabandt <cb@256bit.org>
parents:
12559
diff
changeset
|
5474 {only available when compiled with the |+mzscheme/dyn| |
b390f5003e2f
patch 8.0.1182: cannot see or change mzscheme dll name
Christian Brabandt <cb@256bit.org>
parents:
12559
diff
changeset
|
5475 feature} |
b390f5003e2f
patch 8.0.1182: cannot see or change mzscheme dll name
Christian Brabandt <cb@256bit.org>
parents:
12559
diff
changeset
|
5476 Specifies the name of the MzScheme shared library. The default is |
b390f5003e2f
patch 8.0.1182: cannot see or change mzscheme dll name
Christian Brabandt <cb@256bit.org>
parents:
12559
diff
changeset
|
5477 DYNAMIC_MZSCH_DLL which was specified at compile time. |
b390f5003e2f
patch 8.0.1182: cannot see or change mzscheme dll name
Christian Brabandt <cb@256bit.org>
parents:
12559
diff
changeset
|
5478 Environment variables are expanded |:set_env|. |
12785 | 5479 The value must be set in the |vimrc| script or earlier. In the |
12756
3b26420fc639
Long overdue runtime update.
Christian Brabandt <cb@256bit.org>
parents:
12744
diff
changeset
|
5480 startup, before the |load-plugins| step. |
12608
b390f5003e2f
patch 8.0.1182: cannot see or change mzscheme dll name
Christian Brabandt <cb@256bit.org>
parents:
12559
diff
changeset
|
5481 This option cannot be set from a |modeline| or in the |sandbox|, for |
b390f5003e2f
patch 8.0.1182: cannot see or change mzscheme dll name
Christian Brabandt <cb@256bit.org>
parents:
12559
diff
changeset
|
5482 security reasons. |
b390f5003e2f
patch 8.0.1182: cannot see or change mzscheme dll name
Christian Brabandt <cb@256bit.org>
parents:
12559
diff
changeset
|
5483 |
b390f5003e2f
patch 8.0.1182: cannot see or change mzscheme dll name
Christian Brabandt <cb@256bit.org>
parents:
12559
diff
changeset
|
5484 *'mzschemegcdll'* |
b390f5003e2f
patch 8.0.1182: cannot see or change mzscheme dll name
Christian Brabandt <cb@256bit.org>
parents:
12559
diff
changeset
|
5485 'mzschemegcdll' string (default depends on the build) |
b390f5003e2f
patch 8.0.1182: cannot see or change mzscheme dll name
Christian Brabandt <cb@256bit.org>
parents:
12559
diff
changeset
|
5486 global |
b390f5003e2f
patch 8.0.1182: cannot see or change mzscheme dll name
Christian Brabandt <cb@256bit.org>
parents:
12559
diff
changeset
|
5487 {only available when compiled with the |+mzscheme/dyn| |
b390f5003e2f
patch 8.0.1182: cannot see or change mzscheme dll name
Christian Brabandt <cb@256bit.org>
parents:
12559
diff
changeset
|
5488 feature} |
b390f5003e2f
patch 8.0.1182: cannot see or change mzscheme dll name
Christian Brabandt <cb@256bit.org>
parents:
12559
diff
changeset
|
5489 Specifies the name of the MzScheme GC shared library. The default is |
b390f5003e2f
patch 8.0.1182: cannot see or change mzscheme dll name
Christian Brabandt <cb@256bit.org>
parents:
12559
diff
changeset
|
5490 DYNAMIC_MZGC_DLL which was specified at compile time. |
b390f5003e2f
patch 8.0.1182: cannot see or change mzscheme dll name
Christian Brabandt <cb@256bit.org>
parents:
12559
diff
changeset
|
5491 The value can be equal to 'mzschemedll' if it includes the GC code. |
b390f5003e2f
patch 8.0.1182: cannot see or change mzscheme dll name
Christian Brabandt <cb@256bit.org>
parents:
12559
diff
changeset
|
5492 Environment variables are expanded |:set_env|. |
b390f5003e2f
patch 8.0.1182: cannot see or change mzscheme dll name
Christian Brabandt <cb@256bit.org>
parents:
12559
diff
changeset
|
5493 This option cannot be set from a |modeline| or in the |sandbox|, for |
b390f5003e2f
patch 8.0.1182: cannot see or change mzscheme dll name
Christian Brabandt <cb@256bit.org>
parents:
12559
diff
changeset
|
5494 security reasons. |
b390f5003e2f
patch 8.0.1182: cannot see or change mzscheme dll name
Christian Brabandt <cb@256bit.org>
parents:
12559
diff
changeset
|
5495 |
14 | 5496 *'mzquantum'* *'mzq'* |
5497 'mzquantum' 'mzq' number (default 100) | |
5498 global | |
5499 {not available when compiled without the |+mzscheme| | |
5500 feature} | |
5501 The number of milliseconds between polls for MzScheme threads. | |
5502 Negative or zero value means no thread scheduling. | |
11160 | 5503 NOTE: This option is set to the Vim default value when 'compatible' |
5504 is reset. | |
14 | 5505 |
7 | 5506 *'nrformats'* *'nf'* |
9669
284b4eb307fc
commit https://github.com/vim/vim/commit/8c08b5b569e2a9e9f63dea514591ecfa2d3bb392
Christian Brabandt <cb@256bit.org>
parents:
9665
diff
changeset
|
5507 '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
|
5508 set to "bin,hex" in |defaults.vim|) |
7 | 5509 local to buffer |
5510 This defines what bases Vim will consider for numbers when using the | |
5511 CTRL-A and CTRL-X commands for adding to and subtracting from a number | |
5512 respectively; see |CTRL-A| for more info on these commands. | |
625 | 5513 alpha If included, single alphabetical characters will be |
7 | 5514 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
|
5515 letter index a), b), etc. *octal-nrformats* |
625 | 5516 octal If included, numbers that start with a zero will be considered |
7 | 5517 to be octal. Example: Using CTRL-A on "007" results in "010". |
625 | 5518 hex If included, numbers starting with "0x" or "0X" will be |
7 | 5519 considered to be hexadecimal. Example: Using CTRL-X on |
5520 "0x100" results in "0x0ff". | |
7528
53163e4d9e4f
commit https://github.com/vim/vim/commit/25e4fcde767084d1a79e0926bc301c92987c0cce
Christian Brabandt <cb@256bit.org>
parents:
7477
diff
changeset
|
5521 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
|
5522 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
|
5523 "0b1000" subtracts one, resulting in "0b0111". |
20613
9edb439adbea
patch 8.2.0860: cannot use CTRL-A and CTRL-X on unsigned numbers
Bram Moolenaar <Bram@vim.org>
parents:
20575
diff
changeset
|
5524 unsigned If included, numbers are recognized as unsigned. Thus a |
9edb439adbea
patch 8.2.0860: cannot use CTRL-A and CTRL-X on unsigned numbers
Bram Moolenaar <Bram@vim.org>
parents:
20575
diff
changeset
|
5525 leading dash or negative sign won't be considered as part of |
9edb439adbea
patch 8.2.0860: cannot use CTRL-A and CTRL-X on unsigned numbers
Bram Moolenaar <Bram@vim.org>
parents:
20575
diff
changeset
|
5526 the number. Examples: |
9edb439adbea
patch 8.2.0860: cannot use CTRL-A and CTRL-X on unsigned numbers
Bram Moolenaar <Bram@vim.org>
parents:
20575
diff
changeset
|
5527 Using CTRL-X on "2020" in "9-2020" results in "9-2019" |
9edb439adbea
patch 8.2.0860: cannot use CTRL-A and CTRL-X on unsigned numbers
Bram Moolenaar <Bram@vim.org>
parents:
20575
diff
changeset
|
5528 (without "unsigned" it would become "9-2021"). |
9edb439adbea
patch 8.2.0860: cannot use CTRL-A and CTRL-X on unsigned numbers
Bram Moolenaar <Bram@vim.org>
parents:
20575
diff
changeset
|
5529 Using CTRL-A on "2020" in "9-2020" results in "9-2021" |
9edb439adbea
patch 8.2.0860: cannot use CTRL-A and CTRL-X on unsigned numbers
Bram Moolenaar <Bram@vim.org>
parents:
20575
diff
changeset
|
5530 (without "unsigned" it would become "9-2019"). |
20753 | 5531 Using CTRL-X on "0" or CTRL-A on "18446744073709551615" |
5532 (2^64 - 1) has no effect, overflow is prevented. | |
7 | 5533 Numbers which simply begin with a digit in the range 1-9 are always |
5534 considered decimal. This also happens for numbers that are not | |
5535 recognized as octal or hex. | |
5536 | |
5537 *'number'* *'nu'* *'nonumber'* *'nonu'* | |
5538 'number' 'nu' boolean (default off) | |
5539 local to window | |
5540 Print the line number in front of each line. When the 'n' option is | |
5541 excluded from 'cpoptions' a wrapped line will not use the column of | |
5542 line numbers (this is the default when 'compatible' isn't set). | |
13 | 5543 The 'numberwidth' option can be used to set the room used for the line |
5544 number. | |
7 | 5545 When a long, wrapped line doesn't start with the first character, '-' |
5546 characters are put before the number. | |
3445 | 5547 See |hl-LineNr| and |hl-CursorLineNr| for the highlighting used for |
5548 the number. | |
4780 | 5549 *number_relativenumber* |
5550 The 'relativenumber' option changes the displayed number to be | |
5551 relative to the cursor. Together with 'number' there are these | |
5552 four combinations (cursor in line 3): | |
5553 | |
8629
54ac275e3fc4
commit https://github.com/vim/vim/commit/3848e00e0177abdb31bc600234967863ec487233
Christian Brabandt <cb@256bit.org>
parents:
8560
diff
changeset
|
5554 'nonu' 'nu' 'nonu' 'nu' |
4780 | 5555 'nornu' 'nornu' 'rnu' 'rnu' |
5556 | |
5557 |apple | 1 apple | 2 apple | 2 apple | |
5558 |pear | 2 pear | 1 pear | 1 pear | |
5559 |nobody | 3 nobody | 0 nobody |3 nobody | |
5560 |there | 4 there | 1 there | 1 there | |
7 | 5561 |
13 | 5562 *'numberwidth'* *'nuw'* |
5563 'numberwidth' 'nuw' number (Vim default: 4 Vi default: 8) | |
5564 local to window | |
14 | 5565 {only available when compiled with the |+linebreak| |
5566 feature} | |
13 | 5567 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
|
5568 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
|
5569 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
|
5570 the text, there is one less character for the number itself. |
13 | 5571 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
|
5572 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
|
5573 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
|
5574 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
|
5575 up to 999. When the buffer has 1000 lines five columns will be used. |
17229
f1c7b7a4d9e4
patch 8.1.1614: 'numberwidth' can only go up to 10
Bram Moolenaar <Bram@vim.org>
parents:
17161
diff
changeset
|
5576 The minimum value is 1, the maximum value is 20. |
11160 | 5577 NOTE: This option is set to the Vi default value when 'compatible' is |
5578 set and to the Vim default value when 'compatible' is reset. | |
13 | 5579 |
523 | 5580 *'omnifunc'* *'ofu'* |
5581 'omnifunc' 'ofu' string (default: empty) | |
502 | 5582 local to buffer |
2570
71b56b4e7785
Make the references to features in the help more consistent. (Sylvain Hitier)
Bram Moolenaar <bram@vim.org>
parents:
2561
diff
changeset
|
5583 {not available when compiled without the |+eval| |
17809
59f8948b7590
patch 8.1.1901: the +insert_expand feature is not always available
Bram Moolenaar <Bram@vim.org>
parents:
17771
diff
changeset
|
5584 feature} |
623 | 5585 This option specifies a function to be used for Insert mode omni |
5586 completion with CTRL-X CTRL-O. |i_CTRL-X_CTRL-O| | |
648 | 5587 See |complete-functions| for an explanation of how the function is |
5588 invoked and what it should return. | |
1004 | 5589 This option is usually set by a filetype plugin: |
859 | 5590 |:filetype-plugin-on| |
3682 | 5591 This option cannot be set from a |modeline| or in the |sandbox|, for |
5592 security reasons. | |
502 | 5593 |
5594 | |
1152 | 5595 *'opendevice'* *'odev'* *'noopendevice'* *'noodev'* |
1004 | 5596 'opendevice' 'odev' boolean (default off) |
5597 global | |
18912
ccd16426a1f9
patch 8.2.0017: OS/2 and MS-DOS are still mentioned
Bram Moolenaar <Bram@vim.org>
parents:
18879
diff
changeset
|
5598 {only for MS-Windows} |
1004 | 5599 Enable reading and writing from devices. This may get Vim stuck on a |
5600 device that can be opened but doesn't actually do the I/O. Therefore | |
5601 it is off by default. | |
5602 Note that on MS-Windows editing "aux.h", "lpt1.txt" and the like also | |
5603 result in editing a device. | |
5604 | |
5605 | |
593 | 5606 *'operatorfunc'* *'opfunc'* |
5607 'operatorfunc' 'opfunc' string (default: empty) | |
5608 global | |
5609 This option specifies a function to be called by the |g@| operator. | |
5610 See |:map-operator| for more info and an example. | |
5611 | |
5612 This option cannot be set from a |modeline| or in the |sandbox|, for | |
5613 security reasons. | |
5614 | |
5615 | |
2908 | 5616 *'osfiletype'* *'oft'* |
5617 'osfiletype' 'oft' string (default: "") | |
7 | 5618 local to buffer |
2908 | 5619 This option was supported on RISC OS, which has been removed. |
5620 | |
7 | 5621 |
8182
95d59081580f
commit https://github.com/vim/vim/commit/f6fee0e2d4341c0c2f5339c1268e5877fafd07cf
Christian Brabandt <cb@256bit.org>
parents:
8148
diff
changeset
|
5622 *'packpath'* *'pp'* |
95d59081580f
commit https://github.com/vim/vim/commit/f6fee0e2d4341c0c2f5339c1268e5877fafd07cf
Christian Brabandt <cb@256bit.org>
parents:
8148
diff
changeset
|
5623 'packpath' 'pp' string (default: see 'runtimepath') |
95d59081580f
commit https://github.com/vim/vim/commit/f6fee0e2d4341c0c2f5339c1268e5877fafd07cf
Christian Brabandt <cb@256bit.org>
parents:
8148
diff
changeset
|
5624 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
|
5625 |
95d59081580f
commit https://github.com/vim/vim/commit/f6fee0e2d4341c0c2f5339c1268e5877fafd07cf
Christian Brabandt <cb@256bit.org>
parents:
8148
diff
changeset
|
5626 |
7 | 5627 *'paragraphs'* *'para'* |
1564 | 5628 'paragraphs' 'para' string (default "IPLPPPQPP TPHPLIPpLpItpplpipbp") |
7 | 5629 global |
5630 Specifies the nroff macros that separate paragraphs. These are pairs | |
5631 of two letters (see |object-motions|). | |
5632 | |
5633 *'paste'* *'nopaste'* | |
5634 'paste' boolean (default off) | |
5635 global | |
10 | 5636 Put Vim in Paste mode. This is useful if you want to cut or copy |
5637 some text from one window and paste it in Vim. This will avoid | |
7 | 5638 unexpected effects. |
5639 Setting this option is useful when using Vim in a terminal, where Vim | |
10 | 5640 cannot distinguish between typed text and pasted text. In the GUI, Vim |
7 | 5641 knows about pasting and will mostly do the right thing without 'paste' |
5642 being set. The same is true for a terminal where Vim handles the | |
5643 mouse clicks itself. | |
148 | 5644 This option is reset when starting the GUI. Thus if you set it in |
5645 your .vimrc it will work in a terminal, but not in the GUI. Setting | |
5646 'paste' in the GUI has side effects: e.g., the Paste toolbar button | |
5647 will no longer work in Insert mode, because it uses a mapping. | |
7 | 5648 When the 'paste' option is switched on (also when it was already on): |
5649 - mapping in Insert mode and Command-line mode is disabled | |
5650 - abbreviations are disabled | |
5651 - 'autoindent' is reset | |
7147
c590de398af9
commit https://github.com/vim/vim/commit/ca63501fbcd1cf9c8aa9ff12c093c95b62a89ed7
Christian Brabandt <cb@256bit.org>
parents:
7080
diff
changeset
|
5652 - 'expandtab' is reset |
25056 | 5653 - 'hkmap' is reset |
7 | 5654 - 'revins' is reset |
5655 - 'ruler' is reset | |
5656 - 'showmatch' is reset | |
7147
c590de398af9
commit https://github.com/vim/vim/commit/ca63501fbcd1cf9c8aa9ff12c093c95b62a89ed7
Christian Brabandt <cb@256bit.org>
parents:
7080
diff
changeset
|
5657 - 'smarttab' is reset |
c590de398af9
commit https://github.com/vim/vim/commit/ca63501fbcd1cf9c8aa9ff12c093c95b62a89ed7
Christian Brabandt <cb@256bit.org>
parents:
7080
diff
changeset
|
5658 - 'softtabstop' is set to 0 |
c590de398af9
commit https://github.com/vim/vim/commit/ca63501fbcd1cf9c8aa9ff12c093c95b62a89ed7
Christian Brabandt <cb@256bit.org>
parents:
7080
diff
changeset
|
5659 - 'textwidth' is set to 0 |
c590de398af9
commit https://github.com/vim/vim/commit/ca63501fbcd1cf9c8aa9ff12c093c95b62a89ed7
Christian Brabandt <cb@256bit.org>
parents:
7080
diff
changeset
|
5660 - 'wrapmargin' is set to 0 |
25056 | 5661 - 'varsofttabstop' is made empty |
7 | 5662 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
|
5663 - 'cindent' |
25056 | 5664 - 'formatoptions' is used like it is empty |
7147
c590de398af9
commit https://github.com/vim/vim/commit/ca63501fbcd1cf9c8aa9ff12c093c95b62a89ed7
Christian Brabandt <cb@256bit.org>
parents:
7080
diff
changeset
|
5665 - 'indentexpr' |
7 | 5666 - 'lisp' |
25056 | 5667 - 'smartindent' |
7 | 5668 NOTE: When you start editing another file while the 'paste' option is |
5669 on, settings from the modelines or autocommands may change the | |
5670 settings again, causing trouble when pasting text. You might want to | |
5671 set the 'paste' option again. | |
5672 When the 'paste' option is reset the mentioned options are restored to | |
5673 the value before the moment 'paste' was switched from off to on. | |
5674 Resetting 'paste' before ever setting it does not have any effect. | |
5675 Since mapping doesn't work while 'paste' is active, you need to use | |
5676 the 'pastetoggle' option to toggle the 'paste' option with some key. | |
5677 | |
5678 *'pastetoggle'* *'pt'* | |
5679 'pastetoggle' 'pt' string (default "") | |
5680 global | |
5681 When non-empty, specifies the key sequence that toggles the 'paste' | |
5682 option. This is like specifying a mapping: > | |
5683 :map {keys} :set invpaste<CR> | |
5684 < Where {keys} is the value of 'pastetoggle'. | |
5685 The difference is that it will work even when 'paste' is set. | |
5686 'pastetoggle' works in Insert mode and Normal mode, but not in | |
5687 Command-line mode. | |
5688 Mappings are checked first, thus overrule 'pastetoggle'. However, | |
5689 when 'paste' is on mappings are ignored in Insert mode, thus you can do | |
5690 this: > | |
5691 :map <F10> :set paste<CR> | |
5692 :map <F11> :set nopaste<CR> | |
5693 :imap <F10> <C-O>:set paste<CR> | |
5694 :imap <F11> <nop> | |
5695 :set pastetoggle=<F11> | |
5696 < This will make <F10> start paste mode and <F11> stop paste mode. | |
5697 Note that typing <F10> in paste mode inserts "<F10>", since in paste | |
5698 mode everything is inserted literally, except the 'pastetoggle' key | |
5699 sequence. | |
1621 | 5700 When the value has several bytes 'ttimeoutlen' applies. |
7 | 5701 |
5702 *'pex'* *'patchexpr'* | |
5703 'patchexpr' 'pex' string (default "") | |
5704 global | |
5705 {not available when compiled without the |+diff| | |
5706 feature} | |
5707 Expression which is evaluated to apply a patch to a file and generate | |
10 | 5708 the resulting new version of the file. See |diff-patchexpr|. |
7 | 5709 |
6091
7090d7f160f7
Update runtime files. Add vroom file support.
Bram Moolenaar <bram@vim.org>
parents:
6032
diff
changeset
|
5710 *'patchmode'* *'pm'* *E205* *E206* |
7 | 5711 'patchmode' 'pm' string (default "") |
5712 global | |
5713 When non-empty the oldest version of a file is kept. This can be used | |
5714 to keep the original version of a file if you are changing files in a | |
5715 source distribution. Only the first time that a file is written a | |
5716 copy of the original file will be kept. The name of the copy is the | |
5717 name of the original file with the string in the 'patchmode' option | |
5718 appended. This option should start with a dot. Use a string like | |
13100
656ab57d1ddc
update a few runtime files
Christian Brabandt <cb@256bit.org>
parents:
13051
diff
changeset
|
5719 ".orig" or ".org". 'backupdir' must not be empty for this to work |
656ab57d1ddc
update a few runtime files
Christian Brabandt <cb@256bit.org>
parents:
13051
diff
changeset
|
5720 (Detail: The backup file is renamed to the patchmode file after the |
656ab57d1ddc
update a few runtime files
Christian Brabandt <cb@256bit.org>
parents:
13051
diff
changeset
|
5721 new file has been successfully written, that's why it must be possible |
656ab57d1ddc
update a few runtime files
Christian Brabandt <cb@256bit.org>
parents:
13051
diff
changeset
|
5722 to write a backup file). If there was no file to be backed up, an |
656ab57d1ddc
update a few runtime files
Christian Brabandt <cb@256bit.org>
parents:
13051
diff
changeset
|
5723 empty file is created. |
7 | 5724 When the 'backupskip' pattern matches, a patchmode file is not made. |
5725 Using 'patchmode' for compressed files appends the extension at the | |
5726 end (e.g., "file.gz.orig"), thus the resulting name isn't always | |
5727 recognized as a compressed file. | |
36 | 5728 Only normal file name characters can be used, "/\*?[|<>" are illegal. |
7 | 5729 |
3224 | 5730 *'path'* *'pa'* *E343* *E345* *E347* *E854* |
7 | 5731 'path' 'pa' string (default on Unix: ".,/usr/include,," |
5732 other systems: ".,,") | |
5733 global or local to buffer |global-local| | |
5734 This is a list of directories which will be searched when using the | |
1668 | 5735 |gf|, [f, ]f, ^Wf, |:find|, |:sfind|, |:tabfind| and other commands, |
5736 provided that the file being searched for has a relative path (not | |
5737 starting with "/", "./" or "../"). The directories in the 'path' | |
5738 option may be relative or absolute. | |
7 | 5739 - Use commas to separate directory names: > |
5740 :set path=.,/usr/local/include,/usr/include | |
5741 < - Spaces can also be used to separate directory names (for backwards | |
5742 compatibility with version 3.0). To have a space in a directory | |
5743 name, precede it with an extra backslash, and escape the space: > | |
5744 :set path=.,/dir/with\\\ space | |
5745 < - To include a comma in a directory name precede it with an extra | |
5746 backslash: > | |
5747 :set path=.,/dir/with\\,comma | |
5748 < - To search relative to the directory of the current file, use: > | |
5749 :set path=. | |
5750 < - To search in the current directory use an empty string between two | |
5751 commas: > | |
5752 :set path=,, | |
5753 < - A directory name may end in a ':' or '/'. | |
5754 - Environment variables are expanded |:set_env|. | |
5755 - When using |netrw.vim| URLs can be used. For example, adding | |
5756 "http://www.vim.org" will make ":find index.html" work. | |
1668 | 5757 - Search upwards and downwards in a directory tree using "*", "**" and |
5758 ";". See |file-searching| for info and syntax. | |
7 | 5759 {not available when compiled without the |+path_extra| feature} |
5760 - Careful with '\' characters, type two to get one in the option: > | |
5761 :set path=.,c:\\include | |
5762 < Or just use '/' instead: > | |
5763 :set path=.,c:/include | |
5764 < Don't forget "." or files won't even be found in the same directory as | |
5765 the file! | |
10 | 5766 The maximum length is limited. How much depends on the system, mostly |
7 | 5767 it is something like 256 or 1024 characters. |
5768 You can check if all the include files are found, using the value of | |
5769 'path', see |:checkpath|. | |
5770 The use of |:set+=| and |:set-=| is preferred when adding or removing | |
5771 directories from the list. This avoids problems when a future version | |
5772 uses another default. To remove the current directory use: > | |
5773 :set path-= | |
5774 < To add the current directory use: > | |
5775 :set path+= | |
5776 < To use an environment variable, you probably need to replace the | |
5777 separator. Here is an example to append $INCL, in which directory | |
5778 names are separated with a semi-colon: > | |
5779 :let &path = &path . "," . substitute($INCL, ';', ',', 'g') | |
5780 < Replace the ';' with a ':' or whatever separator is used. Note that | |
5781 this doesn't work when $INCL contains a comma or white space. | |
5782 | |
12499 | 5783 *'perldll'* |
5784 'perldll' string (default depends on the build) | |
5785 global | |
5786 {only available when compiled with the |+perl/dyn| | |
5787 feature} | |
5788 Specifies the name of the Perl shared library. The default is | |
5789 DYNAMIC_PERL_DLL, which was specified at compile time. | |
5790 Environment variables are expanded |:set_env|. | |
5791 This option cannot be set from a |modeline| or in the |sandbox|, for | |
5792 security reasons. | |
5793 | |
7 | 5794 *'preserveindent'* *'pi'* *'nopreserveindent'* *'nopi'* |
5795 'preserveindent' 'pi' boolean (default off) | |
5796 local to buffer | |
5797 When changing the indent of the current line, preserve as much of the | |
5798 indent structure as possible. Normally the indent is replaced by a | |
5799 series of tabs followed by spaces as required (unless |'expandtab'| is | |
5800 enabled, in which case only spaces are used). Enabling this option | |
5801 means the indent will preserve as many existing characters as possible | |
5802 for indenting, and only add additional tabs or spaces as required. | |
1621 | 5803 'expandtab' does not apply to the preserved white space, a Tab remains |
5804 a Tab. | |
7 | 5805 NOTE: When using ">>" multiple times the resulting indent is a mix of |
5806 tabs and spaces. You might not like this. | |
11160 | 5807 NOTE: This option is reset when 'compatible' is set. |
7 | 5808 Also see 'copyindent'. |
5809 Use |:retab| to clean up white space. | |
5810 | |
5811 *'previewheight'* *'pvh'* | |
5812 'previewheight' 'pvh' number (default 12) | |
5813 global | |
17771
4bd21046902b
patch 8.1.1882: cannot specify properties of the info popup window
Bram Moolenaar <Bram@vim.org>
parents:
17767
diff
changeset
|
5814 {not available when compiled without the |+quickfix| |
4bd21046902b
patch 8.1.1882: cannot specify properties of the info popup window
Bram Moolenaar <Bram@vim.org>
parents:
17767
diff
changeset
|
5815 feature} |
7 | 5816 Default height for a preview window. Used for |:ptag| and associated |
17431
ce35cdbe9f74
patch 8.1.1714: cannot preview a file in a popup window
Bram Moolenaar <Bram@vim.org>
parents:
17372
diff
changeset
|
5817 commands. Used for |CTRL-W_}| when no count is given. Not used when |
ce35cdbe9f74
patch 8.1.1714: cannot preview a file in a popup window
Bram Moolenaar <Bram@vim.org>
parents:
17372
diff
changeset
|
5818 'previewpopup' is set. |
ce35cdbe9f74
patch 8.1.1714: cannot preview a file in a popup window
Bram Moolenaar <Bram@vim.org>
parents:
17372
diff
changeset
|
5819 |
ce35cdbe9f74
patch 8.1.1714: cannot preview a file in a popup window
Bram Moolenaar <Bram@vim.org>
parents:
17372
diff
changeset
|
5820 *'previewpopup'* *'pvp'* |
ce35cdbe9f74
patch 8.1.1714: cannot preview a file in a popup window
Bram Moolenaar <Bram@vim.org>
parents:
17372
diff
changeset
|
5821 'previewpopup' 'pvp' string (default empty) |
ce35cdbe9f74
patch 8.1.1714: cannot preview a file in a popup window
Bram Moolenaar <Bram@vim.org>
parents:
17372
diff
changeset
|
5822 global |
17771
4bd21046902b
patch 8.1.1882: cannot specify properties of the info popup window
Bram Moolenaar <Bram@vim.org>
parents:
17767
diff
changeset
|
5823 {not available when compiled without the |+textprop| |
4bd21046902b
patch 8.1.1882: cannot specify properties of the info popup window
Bram Moolenaar <Bram@vim.org>
parents:
17767
diff
changeset
|
5824 or |+quickfix| feature} |
17431
ce35cdbe9f74
patch 8.1.1714: cannot preview a file in a popup window
Bram Moolenaar <Bram@vim.org>
parents:
17372
diff
changeset
|
5825 When not empty a popup window is used for commands that would open a |
ce35cdbe9f74
patch 8.1.1714: cannot preview a file in a popup window
Bram Moolenaar <Bram@vim.org>
parents:
17372
diff
changeset
|
5826 preview window. See |preview-popup|. |
17767
c75da1064e33
patch 8.1.1880: cannot show extra info for completion in a popup window
Bram Moolenaar <Bram@vim.org>
parents:
17571
diff
changeset
|
5827 Not used for the insert completion info, add "popup" to |
c75da1064e33
patch 8.1.1880: cannot show extra info for completion in a popup window
Bram Moolenaar <Bram@vim.org>
parents:
17571
diff
changeset
|
5828 'completeopt' for that. |
7 | 5829 |
5830 *'previewwindow'* *'nopreviewwindow'* | |
5831 *'pvw'* *'nopvw'* *E590* | |
5832 'previewwindow' 'pvw' boolean (default off) | |
5833 local to window | |
17771
4bd21046902b
patch 8.1.1882: cannot specify properties of the info popup window
Bram Moolenaar <Bram@vim.org>
parents:
17767
diff
changeset
|
5834 {not available when compiled without the |+quickfix| |
4bd21046902b
patch 8.1.1882: cannot specify properties of the info popup window
Bram Moolenaar <Bram@vim.org>
parents:
17767
diff
changeset
|
5835 feature} |
10 | 5836 Identifies the preview window. Only one window can have this option |
7 | 5837 set. It's normally not set directly, but by using one of the commands |
5838 |:ptag|, |:pedit|, etc. | |
5839 | |
5840 *'printdevice'* *'pdev'* | |
5841 'printdevice' 'pdev' string (default empty) | |
5842 global | |
5843 {only available when compiled with the |+printer| | |
5844 feature} | |
15 | 5845 The name of the printer to be used for |:hardcopy|. |
5846 See |pdev-option|. | |
36 | 5847 This option cannot be set from a |modeline| or in the |sandbox|, for |
5848 security reasons. | |
15 | 5849 |
5850 *'printencoding'* *'penc'* | |
14864 | 5851 'printencoding' 'penc' string (default empty, except for some systems) |
7 | 5852 global |
5853 {only available when compiled with the |+printer| | |
5854 and |+postscript| features} | |
15 | 5855 Sets the character encoding used when printing. |
5856 See |penc-option|. | |
7 | 5857 |
5858 *'printexpr'* *'pexpr'* | |
14864 | 5859 'printexpr' 'pexpr' string (default: see below) |
7 | 5860 global |
5861 {only available when compiled with the |+printer| | |
5862 and |+postscript| features} | |
15 | 5863 Expression used to print the PostScript produced with |:hardcopy|. |
5864 See |pexpr-option|. | |
10449
222b1432814e
commit https://github.com/vim/vim/commit/5162822914372fc916a93f85848c0c82209e7cec
Christian Brabandt <cb@256bit.org>
parents:
10272
diff
changeset
|
5865 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
|
5866 security reasons. |
15 | 5867 |
5868 *'printfont'* *'pfn'* | |
7 | 5869 'printfont' 'pfn' string (default "courier") |
5870 global | |
5871 {only available when compiled with the |+printer| | |
5872 feature} | |
15 | 5873 The name of the font that will be used for |:hardcopy|. |
5874 See |pfn-option|. | |
7 | 5875 |
5876 *'printheader'* *'pheader'* | |
5877 'printheader' 'pheader' string (default "%<%f%h%m%=Page %N") | |
5878 global | |
5879 {only available when compiled with the |+printer| | |
5880 feature} | |
15 | 5881 The format of the header produced in |:hardcopy| output. |
5882 See |pheader-option|. | |
5883 | |
5884 *'printmbcharset'* *'pmbcs'* | |
5885 'printmbcharset' 'pmbcs' string (default "") | |
5886 global | |
15878 | 5887 {only available when compiled with the |+printer| |
5888 and |+postscript| features} | |
15 | 5889 The CJK character set to be used for CJK output from |:hardcopy|. |
5890 See |pmbcs-option|. | |
5891 | |
5892 *'printmbfont'* *'pmbfn'* | |
5893 'printmbfont' 'pmbfn' string (default "") | |
5894 global | |
15878 | 5895 {only available when compiled with the |+printer| |
5896 and |+postscript| features} | |
15 | 5897 List of font names to be used for CJK output from |:hardcopy|. |
5898 See |pmbfn-option|. | |
7 | 5899 |
5900 *'printoptions'* *'popt'* | |
5901 'printoptions' 'popt' string (default "") | |
5902 global | |
5903 {only available when compiled with |+printer| feature} | |
15 | 5904 List of items that control the format of the output of |:hardcopy|. |
5905 See |popt-option|. | |
5906 | |
168 | 5907 *'prompt'* *'noprompt'* |
5908 'prompt' boolean (default on) | |
5909 global | |
5910 When on a ":" prompt is used in Ex mode. | |
5911 | |
766 | 5912 *'pumheight'* *'ph'* |
5913 'pumheight' 'ph' number (default 0) | |
5914 global | |
853 | 5915 Determines the maximum number of items to show in the popup menu for |
5916 Insert mode completion. When zero as much space as available is used. | |
766 | 5917 |ins-completion-menu|. |
5918 | |
13234
6e972d830e13
patch 8.0.1491: the minimum width of the popup menu is hard coded
Christian Brabandt <cb@256bit.org>
parents:
13231
diff
changeset
|
5919 *'pumwidth'* *'pw'* |
13314
65c3e8259124
patch 8.0.1531: cannot use 24 bit colors in MS-Windows console
Christian Brabandt <cb@256bit.org>
parents:
13234
diff
changeset
|
5920 'pumwidth' 'pw' number (default 15) |
13234
6e972d830e13
patch 8.0.1491: the minimum width of the popup menu is hard coded
Christian Brabandt <cb@256bit.org>
parents:
13231
diff
changeset
|
5921 global |
13341
acd7eaa13d2b
Updated runtime files.
Christian Brabandt <cb@256bit.org>
parents:
13314
diff
changeset
|
5922 Determines the minimum width to use for the popup menu for Insert mode |
13314
65c3e8259124
patch 8.0.1531: cannot use 24 bit colors in MS-Windows console
Christian Brabandt <cb@256bit.org>
parents:
13234
diff
changeset
|
5923 completion. |ins-completion-menu|. |
13234
6e972d830e13
patch 8.0.1491: the minimum width of the popup menu is hard coded
Christian Brabandt <cb@256bit.org>
parents:
13231
diff
changeset
|
5924 |
7228
873eae260c97
commit https://github.com/vim/vim/commit/b4ff518d95aa57c2f8c0568c915035bef849581b
Christian Brabandt <cb@256bit.org>
parents:
7218
diff
changeset
|
5925 *'pythondll'* |
8629
54ac275e3fc4
commit https://github.com/vim/vim/commit/3848e00e0177abdb31bc600234967863ec487233
Christian Brabandt <cb@256bit.org>
parents:
8560
diff
changeset
|
5926 '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
|
5927 global |
7228
873eae260c97
commit https://github.com/vim/vim/commit/b4ff518d95aa57c2f8c0568c915035bef849581b
Christian Brabandt <cb@256bit.org>
parents:
7218
diff
changeset
|
5928 {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
|
5929 feature} |
7528
53163e4d9e4f
commit https://github.com/vim/vim/commit/25e4fcde767084d1a79e0926bc301c92987c0cce
Christian Brabandt <cb@256bit.org>
parents:
7477
diff
changeset
|
5930 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
|
5931 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
|
5932 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
|
5933 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
|
5934 security reasons. |
873eae260c97
commit https://github.com/vim/vim/commit/b4ff518d95aa57c2f8c0568c915035bef849581b
Christian Brabandt <cb@256bit.org>
parents:
7218
diff
changeset
|
5935 |
13154
53cc7ea77c54
patch 8.0.1451: difficult to set the python home directories properly
Christian Brabandt <cb@256bit.org>
parents:
13150
diff
changeset
|
5936 *'pythonhome'* |
53cc7ea77c54
patch 8.0.1451: difficult to set the python home directories properly
Christian Brabandt <cb@256bit.org>
parents:
13150
diff
changeset
|
5937 'pythonhome' string (default "") |
53cc7ea77c54
patch 8.0.1451: difficult to set the python home directories properly
Christian Brabandt <cb@256bit.org>
parents:
13150
diff
changeset
|
5938 global |
53cc7ea77c54
patch 8.0.1451: difficult to set the python home directories properly
Christian Brabandt <cb@256bit.org>
parents:
13150
diff
changeset
|
5939 {only available when compiled with the |+python/dyn| |
53cc7ea77c54
patch 8.0.1451: difficult to set the python home directories properly
Christian Brabandt <cb@256bit.org>
parents:
13150
diff
changeset
|
5940 feature} |
53cc7ea77c54
patch 8.0.1451: difficult to set the python home directories properly
Christian Brabandt <cb@256bit.org>
parents:
13150
diff
changeset
|
5941 Specifies the name of the Python 2.x home directory. When 'pythonhome' |
53cc7ea77c54
patch 8.0.1451: difficult to set the python home directories properly
Christian Brabandt <cb@256bit.org>
parents:
13150
diff
changeset
|
5942 and the PYTHONHOME environment variable are not set, PYTHON_HOME, |
53cc7ea77c54
patch 8.0.1451: difficult to set the python home directories properly
Christian Brabandt <cb@256bit.org>
parents:
13150
diff
changeset
|
5943 which was specified at compile time, will be used for the Python 2.x |
53cc7ea77c54
patch 8.0.1451: difficult to set the python home directories properly
Christian Brabandt <cb@256bit.org>
parents:
13150
diff
changeset
|
5944 home directory. |
53cc7ea77c54
patch 8.0.1451: difficult to set the python home directories properly
Christian Brabandt <cb@256bit.org>
parents:
13150
diff
changeset
|
5945 Environment variables are expanded |:set_env|. |
53cc7ea77c54
patch 8.0.1451: difficult to set the python home directories properly
Christian Brabandt <cb@256bit.org>
parents:
13150
diff
changeset
|
5946 This option cannot be set from a |modeline| or in the |sandbox|, for |
53cc7ea77c54
patch 8.0.1451: difficult to set the python home directories properly
Christian Brabandt <cb@256bit.org>
parents:
13150
diff
changeset
|
5947 security reasons. |
53cc7ea77c54
patch 8.0.1451: difficult to set the python home directories properly
Christian Brabandt <cb@256bit.org>
parents:
13150
diff
changeset
|
5948 |
7218
36dc8df8560f
commit https://github.com/vim/vim/commit/0796c0625fa4b9eb2f47fe8c976b78523924e1fb
Christian Brabandt <cb@256bit.org>
parents:
7196
diff
changeset
|
5949 *'pythonthreedll'* |
7528
53163e4d9e4f
commit https://github.com/vim/vim/commit/25e4fcde767084d1a79e0926bc301c92987c0cce
Christian Brabandt <cb@256bit.org>
parents:
7477
diff
changeset
|
5950 '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
|
5951 global |
7196
42717d048817
commit https://github.com/vim/vim/commit/d94464ee294a351ce7b6ba18e8bd3f24f1bef920
Christian Brabandt <cb@256bit.org>
parents:
7147
diff
changeset
|
5952 {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
|
5953 feature} |
7528
53163e4d9e4f
commit https://github.com/vim/vim/commit/25e4fcde767084d1a79e0926bc301c92987c0cce
Christian Brabandt <cb@256bit.org>
parents:
7477
diff
changeset
|
5954 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
|
5955 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
|
5956 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
|
5957 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
|
5958 security reasons. |
42717d048817
commit https://github.com/vim/vim/commit/d94464ee294a351ce7b6ba18e8bd3f24f1bef920
Christian Brabandt <cb@256bit.org>
parents:
7147
diff
changeset
|
5959 |
13154
53cc7ea77c54
patch 8.0.1451: difficult to set the python home directories properly
Christian Brabandt <cb@256bit.org>
parents:
13150
diff
changeset
|
5960 *'pythonthreehome'* |
53cc7ea77c54
patch 8.0.1451: difficult to set the python home directories properly
Christian Brabandt <cb@256bit.org>
parents:
13150
diff
changeset
|
5961 'pythonthreehome' string (default "") |
53cc7ea77c54
patch 8.0.1451: difficult to set the python home directories properly
Christian Brabandt <cb@256bit.org>
parents:
13150
diff
changeset
|
5962 global |
53cc7ea77c54
patch 8.0.1451: difficult to set the python home directories properly
Christian Brabandt <cb@256bit.org>
parents:
13150
diff
changeset
|
5963 {only available when compiled with the |+python3/dyn| |
53cc7ea77c54
patch 8.0.1451: difficult to set the python home directories properly
Christian Brabandt <cb@256bit.org>
parents:
13150
diff
changeset
|
5964 feature} |
53cc7ea77c54
patch 8.0.1451: difficult to set the python home directories properly
Christian Brabandt <cb@256bit.org>
parents:
13150
diff
changeset
|
5965 Specifies the name of the Python 3 home directory. When |
53cc7ea77c54
patch 8.0.1451: difficult to set the python home directories properly
Christian Brabandt <cb@256bit.org>
parents:
13150
diff
changeset
|
5966 'pythonthreehome' and the PYTHONHOME environment variable are not set, |
53cc7ea77c54
patch 8.0.1451: difficult to set the python home directories properly
Christian Brabandt <cb@256bit.org>
parents:
13150
diff
changeset
|
5967 PYTHON3_HOME, which was specified at compile time, will be used for |
53cc7ea77c54
patch 8.0.1451: difficult to set the python home directories properly
Christian Brabandt <cb@256bit.org>
parents:
13150
diff
changeset
|
5968 the Python 3 home directory. |
53cc7ea77c54
patch 8.0.1451: difficult to set the python home directories properly
Christian Brabandt <cb@256bit.org>
parents:
13150
diff
changeset
|
5969 Environment variables are expanded |:set_env|. |
53cc7ea77c54
patch 8.0.1451: difficult to set the python home directories properly
Christian Brabandt <cb@256bit.org>
parents:
13150
diff
changeset
|
5970 This option cannot be set from a |modeline| or in the |sandbox|, for |
53cc7ea77c54
patch 8.0.1451: difficult to set the python home directories properly
Christian Brabandt <cb@256bit.org>
parents:
13150
diff
changeset
|
5971 security reasons. |
53cc7ea77c54
patch 8.0.1451: difficult to set the python home directories properly
Christian Brabandt <cb@256bit.org>
parents:
13150
diff
changeset
|
5972 |
10722
7598ce51bf2a
patch 8.0.0251: not easy to select Python 2 or 3
Christian Brabandt <cb@256bit.org>
parents:
10617
diff
changeset
|
5973 *'pyxversion'* *'pyx'* |
7598ce51bf2a
patch 8.0.0251: not easy to select Python 2 or 3
Christian Brabandt <cb@256bit.org>
parents:
10617
diff
changeset
|
5974 '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
|
5975 global |
7598ce51bf2a
patch 8.0.0251: not easy to select Python 2 or 3
Christian Brabandt <cb@256bit.org>
parents:
10617
diff
changeset
|
5976 {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
|
5977 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
|
5978 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
|
5979 |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
|
5980 |
7598ce51bf2a
patch 8.0.0251: not easy to select Python 2 or 3
Christian Brabandt <cb@256bit.org>
parents:
10617
diff
changeset
|
5981 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
|
5982 |+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
|
5983 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
|
5984 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
|
5985 |
7598ce51bf2a
patch 8.0.0251: not easy to select Python 2 or 3
Christian Brabandt <cb@256bit.org>
parents:
10617
diff
changeset
|
5986 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
|
5987 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
|
5988 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
|
5989 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
|
5990 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
|
5991 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
|
5992 |
7598ce51bf2a
patch 8.0.0251: not easy to select Python 2 or 3
Christian Brabandt <cb@256bit.org>
parents:
10617
diff
changeset
|
5993 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
|
5994 '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
|
5995 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
|
5996 |
7598ce51bf2a
patch 8.0.0251: not easy to select Python 2 or 3
Christian Brabandt <cb@256bit.org>
parents:
10617
diff
changeset
|
5997 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
|
5998 security reasons. |
7598ce51bf2a
patch 8.0.0251: not easy to select Python 2 or 3
Christian Brabandt <cb@256bit.org>
parents:
10617
diff
changeset
|
5999 |
20631
d6827bd31d1d
patch 8.2.0869: it is not possible to customize the quickfix window contents
Bram Moolenaar <Bram@vim.org>
parents:
20613
diff
changeset
|
6000 *'quickfixtextfunc'* *'qftf'* |
d6827bd31d1d
patch 8.2.0869: it is not possible to customize the quickfix window contents
Bram Moolenaar <Bram@vim.org>
parents:
20613
diff
changeset
|
6001 'quickfixtextfunc' 'qftf' string (default "") |
d6827bd31d1d
patch 8.2.0869: it is not possible to customize the quickfix window contents
Bram Moolenaar <Bram@vim.org>
parents:
20613
diff
changeset
|
6002 global |
d6827bd31d1d
patch 8.2.0869: it is not possible to customize the quickfix window contents
Bram Moolenaar <Bram@vim.org>
parents:
20613
diff
changeset
|
6003 {only available when compiled with the |+quickfix| |
d6827bd31d1d
patch 8.2.0869: it is not possible to customize the quickfix window contents
Bram Moolenaar <Bram@vim.org>
parents:
20613
diff
changeset
|
6004 feature} |
d6827bd31d1d
patch 8.2.0869: it is not possible to customize the quickfix window contents
Bram Moolenaar <Bram@vim.org>
parents:
20613
diff
changeset
|
6005 This option specifies a function to be used to get the text to display |
d6827bd31d1d
patch 8.2.0869: it is not possible to customize the quickfix window contents
Bram Moolenaar <Bram@vim.org>
parents:
20613
diff
changeset
|
6006 in the quickfix and location list windows. This can be used to |
d6827bd31d1d
patch 8.2.0869: it is not possible to customize the quickfix window contents
Bram Moolenaar <Bram@vim.org>
parents:
20613
diff
changeset
|
6007 customize the information displayed in the quickfix or location window |
d6827bd31d1d
patch 8.2.0869: it is not possible to customize the quickfix window contents
Bram Moolenaar <Bram@vim.org>
parents:
20613
diff
changeset
|
6008 for each entry in the corresponding quickfix or location list. See |
d6827bd31d1d
patch 8.2.0869: it is not possible to customize the quickfix window contents
Bram Moolenaar <Bram@vim.org>
parents:
20613
diff
changeset
|
6009 |quickfix-window-function| for an explanation of how to write the |
21409
2c40e60017a8
patch 8.2.1255: cannot use a lambda with quickfix functions
Bram Moolenaar <Bram@vim.org>
parents:
21373
diff
changeset
|
6010 function and an example. The value can be the name of a function or a |
2c40e60017a8
patch 8.2.1255: cannot use a lambda with quickfix functions
Bram Moolenaar <Bram@vim.org>
parents:
21373
diff
changeset
|
6011 lambda. |
20631
d6827bd31d1d
patch 8.2.0869: it is not possible to customize the quickfix window contents
Bram Moolenaar <Bram@vim.org>
parents:
20613
diff
changeset
|
6012 |
d6827bd31d1d
patch 8.2.0869: it is not possible to customize the quickfix window contents
Bram Moolenaar <Bram@vim.org>
parents:
20613
diff
changeset
|
6013 This option cannot be set from a |modeline| or in the |sandbox|, for |
d6827bd31d1d
patch 8.2.0869: it is not possible to customize the quickfix window contents
Bram Moolenaar <Bram@vim.org>
parents:
20613
diff
changeset
|
6014 security reasons. |
d6827bd31d1d
patch 8.2.0869: it is not possible to customize the quickfix window contents
Bram Moolenaar <Bram@vim.org>
parents:
20613
diff
changeset
|
6015 |
140 | 6016 *'quoteescape'* *'qe'* |
12 | 6017 'quoteescape' 'qe' string (default "\") |
6018 local to buffer | |
6019 The characters that are used to escape quotes in a string. Used for | |
6020 objects like a', a" and a` |a'|. | |
6021 When one of the characters in this option is found inside a string, | |
6022 the following character will be skipped. The default value makes the | |
6023 text "foo\"bar\\" considered to be one string. | |
6024 | |
7 | 6025 *'readonly'* *'ro'* *'noreadonly'* *'noro'* |
6026 'readonly' 'ro' boolean (default off) | |
6027 local to buffer | |
6028 If on, writes fail unless you use a '!'. Protects you from | |
6029 accidentally overwriting a file. Default on when Vim is started | |
6030 in read-only mode ("vim -R") or when the executable is called "view". | |
164 | 6031 When using ":w!" the 'readonly' option is reset for the current |
6032 buffer, unless the 'Z' flag is in 'cpoptions'. | |
16443
32a543152dc0
patch 8.1.1226: {not in Vi} remarks get in the way of useful help text
Bram Moolenaar <Bram@vim.org>
parents:
16439
diff
changeset
|
6033 When using the ":view" command the 'readonly' option is set for the |
32a543152dc0
patch 8.1.1226: {not in Vi} remarks get in the way of useful help text
Bram Moolenaar <Bram@vim.org>
parents:
16439
diff
changeset
|
6034 newly edited buffer. |
10617 | 6035 See 'modifiable' for disallowing changes to the buffer. |
7 | 6036 |
1521 | 6037 *'redrawtime'* *'rdt'* |
6038 'redrawtime' 'rdt' number (default 2000) | |
6039 global | |
6040 {only available when compiled with the |+reltime| | |
6041 feature} | |
6042 The time in milliseconds for redrawing the display. This applies to | |
13818
28ac7914b2b6
Update runtime files and translations
Christian Brabandt <cb@256bit.org>
parents:
13742
diff
changeset
|
6043 searching for patterns for 'hlsearch', |:match| highlighting and syntax |
11529
998d2cf59caa
patch 8.0.0647: syntax highlighting can make cause a freeze
Christian Brabandt <cb@256bit.org>
parents:
11516
diff
changeset
|
6044 highlighting. |
1521 | 6045 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
|
6046 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
|
6047 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
|
6048 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
|
6049 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
|
6050 pattern. |
1521 | 6051 |
4681
2eb30f341e8d
Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents:
4502
diff
changeset
|
6052 *'regexpengine'* *'re'* |
4502
605c9ce57ec3
Updated runtime files, language files and translations.
Bram Moolenaar <bram@vim.org>
parents:
4358
diff
changeset
|
6053 'regexpengine' 're' number (default 0) |
605c9ce57ec3
Updated runtime files, language files and translations.
Bram Moolenaar <bram@vim.org>
parents:
4358
diff
changeset
|
6054 global |
605c9ce57ec3
Updated runtime files, language files and translations.
Bram Moolenaar <bram@vim.org>
parents:
4358
diff
changeset
|
6055 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
|
6056 The possible values are: |
605c9ce57ec3
Updated runtime files, language files and translations.
Bram Moolenaar <bram@vim.org>
parents:
4358
diff
changeset
|
6057 0 automatic selection |
605c9ce57ec3
Updated runtime files, language files and translations.
Bram Moolenaar <bram@vim.org>
parents:
4358
diff
changeset
|
6058 1 old engine |
605c9ce57ec3
Updated runtime files, language files and translations.
Bram Moolenaar <bram@vim.org>
parents:
4358
diff
changeset
|
6059 2 NFA engine |
605c9ce57ec3
Updated runtime files, language files and translations.
Bram Moolenaar <bram@vim.org>
parents:
4358
diff
changeset
|
6060 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
|
6061 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
|
6062 for debugging the regexp engine. |
6328 | 6063 Using automatic selection enables Vim to switch the engine, if the |
6064 default engine becomes too costly. E.g., when the NFA engine uses too | |
6065 many states. This should prevent Vim from hanging on a combination of | |
6066 a complex pattern with long text. | |
4502
605c9ce57ec3
Updated runtime files, language files and translations.
Bram Moolenaar <bram@vim.org>
parents:
4358
diff
changeset
|
6067 |
2178
c6f1aa1e9f32
Add 'relativenumber' patch from Markus Heidelberg.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
6068 *'relativenumber'* *'rnu'* *'norelativenumber'* *'nornu'* |
c6f1aa1e9f32
Add 'relativenumber' patch from Markus Heidelberg.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
6069 'relativenumber' 'rnu' boolean (default off) |
c6f1aa1e9f32
Add 'relativenumber' patch from Markus Heidelberg.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
6070 local to window |
c6f1aa1e9f32
Add 'relativenumber' patch from Markus Heidelberg.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
6071 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
|
6072 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
|
6073 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
|
6074 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
|
6075 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
|
6076 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
|
6077 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
|
6078 'compatible' isn't set). |
c6f1aa1e9f32
Add 'relativenumber' patch from Markus Heidelberg.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
6079 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
|
6080 number. |
c6f1aa1e9f32
Add 'relativenumber' patch from Markus Heidelberg.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
6081 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
|
6082 characters are put before the number. |
3445 | 6083 See |hl-LineNr| and |hl-CursorLineNr| for the highlighting used for |
6084 the number. | |
13341
acd7eaa13d2b
Updated runtime files.
Christian Brabandt <cb@256bit.org>
parents:
13314
diff
changeset
|
6085 |
4780 | 6086 The number in front of the cursor line also depends on the value of |
6087 'number', see |number_relativenumber| for all combinations of the two | |
6088 options. | |
2178
c6f1aa1e9f32
Add 'relativenumber' patch from Markus Heidelberg.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
6089 |
7 | 6090 *'remap'* *'noremap'* |
6091 'remap' boolean (default on) | |
6092 global | |
6093 Allows for mappings to work recursively. If you do not want this for | |
6094 a single entry, use the :noremap[!] command. | |
717 | 6095 NOTE: To avoid portability problems with Vim scripts, always keep |
6096 this option at the default "on". Only switch it off when working with | |
6097 old Vi scripts. | |
7 | 6098 |
6110 | 6099 *'renderoptions'* *'rop'* |
6100 'renderoptions' 'rop' string (default: empty) | |
6101 global | |
6102 {only available when compiled with GUI and DIRECTX on | |
6103 MS-Windows} | |
6104 Select a text renderer and set its options. The options depend on the | |
6105 renderer. | |
6106 | |
6107 Syntax: > | |
6108 set rop=type:{renderer}(,{name}:{value})* | |
6109 < | |
6110 Currently, only one optional renderer is available. | |
6111 | |
6112 render behavior ~ | |
6113 directx Vim will draw text using DirectX (DirectWrite). It makes | |
6114 drawn glyphs more beautiful than default GDI. | |
6115 It requires 'encoding' is "utf-8", and only works on | |
6116 MS-Windows Vista or newer version. | |
6117 | |
6118 Options: | |
6119 name meaning type value ~ | |
6120 gamma gamma float 1.0 - 2.2 (maybe) | |
6121 contrast enhancedContrast float (unknown) | |
6122 level clearTypeLevel float (unknown) | |
6123 geom pixelGeometry int 0 - 2 (see below) | |
6124 renmode renderingMode int 0 - 6 (see below) | |
6125 taamode textAntialiasMode int 0 - 3 (see below) | |
13150
808625d4b71b
patch 8.0.1449: slow redrawing with DirectX
Christian Brabandt <cb@256bit.org>
parents:
13100
diff
changeset
|
6126 scrlines Scroll Lines int (deprecated) |
12986
18e6f4addce9
patch 8.0.1369: MS-Windows: drawing underline slow, mFallbackDC not updated
Christian Brabandt <cb@256bit.org>
parents:
12971
diff
changeset
|
6127 |
18e6f4addce9
patch 8.0.1369: MS-Windows: drawing underline slow, mFallbackDC not updated
Christian Brabandt <cb@256bit.org>
parents:
12971
diff
changeset
|
6128 See this URL for detail (except for scrlines): |
18e6f4addce9
patch 8.0.1369: MS-Windows: drawing underline slow, mFallbackDC not updated
Christian Brabandt <cb@256bit.org>
parents:
12971
diff
changeset
|
6129 https://msdn.microsoft.com/en-us/library/dd368190.aspx |
6110 | 6130 |
6131 For geom: structure of a device pixel. | |
6132 0 - DWRITE_PIXEL_GEOMETRY_FLAT | |
6133 1 - DWRITE_PIXEL_GEOMETRY_RGB | |
6134 2 - DWRITE_PIXEL_GEOMETRY_BGR | |
6135 | |
6136 See this URL for detail: | |
12986
18e6f4addce9
patch 8.0.1369: MS-Windows: drawing underline slow, mFallbackDC not updated
Christian Brabandt <cb@256bit.org>
parents:
12971
diff
changeset
|
6137 https://msdn.microsoft.com/en-us/library/dd368114.aspx |
6110 | 6138 |
6139 For renmode: method of rendering glyphs. | |
6140 0 - DWRITE_RENDERING_MODE_DEFAULT | |
6141 1 - DWRITE_RENDERING_MODE_ALIASED | |
6142 2 - DWRITE_RENDERING_MODE_GDI_CLASSIC | |
6143 3 - DWRITE_RENDERING_MODE_GDI_NATURAL | |
6144 4 - DWRITE_RENDERING_MODE_NATURAL | |
6145 5 - DWRITE_RENDERING_MODE_NATURAL_SYMMETRIC | |
6146 6 - DWRITE_RENDERING_MODE_OUTLINE | |
6147 | |
6148 See this URL for detail: | |
12986
18e6f4addce9
patch 8.0.1369: MS-Windows: drawing underline slow, mFallbackDC not updated
Christian Brabandt <cb@256bit.org>
parents:
12971
diff
changeset
|
6149 https://msdn.microsoft.com/en-us/library/dd368118.aspx |
6110 | 6150 |
6151 For taamode: antialiasing mode used for drawing text. | |
6152 0 - D2D1_TEXT_ANTIALIAS_MODE_DEFAULT | |
6153 1 - D2D1_TEXT_ANTIALIAS_MODE_CLEARTYPE | |
6154 2 - D2D1_TEXT_ANTIALIAS_MODE_GRAYSCALE | |
6155 3 - D2D1_TEXT_ANTIALIAS_MODE_ALIASED | |
6156 | |
6157 See this URL for detail: | |
12986
18e6f4addce9
patch 8.0.1369: MS-Windows: drawing underline slow, mFallbackDC not updated
Christian Brabandt <cb@256bit.org>
parents:
12971
diff
changeset
|
6158 https://msdn.microsoft.com/en-us/library/dd368170.aspx |
18e6f4addce9
patch 8.0.1369: MS-Windows: drawing underline slow, mFallbackDC not updated
Christian Brabandt <cb@256bit.org>
parents:
12971
diff
changeset
|
6159 |
13150
808625d4b71b
patch 8.0.1449: slow redrawing with DirectX
Christian Brabandt <cb@256bit.org>
parents:
13100
diff
changeset
|
6160 For scrlines: |
808625d4b71b
patch 8.0.1449: slow redrawing with DirectX
Christian Brabandt <cb@256bit.org>
parents:
13100
diff
changeset
|
6161 This was used for optimizing scrolling behavior, however this |
808625d4b71b
patch 8.0.1449: slow redrawing with DirectX
Christian Brabandt <cb@256bit.org>
parents:
13100
diff
changeset
|
6162 is now deprecated. If specified, it is simply ignored. |
6110 | 6163 |
6164 Example: > | |
6165 set encoding=utf-8 | |
12934
2ebc3df65ca2
patch 8.0.1343: MS-Windows: does not show colored emojis
Christian Brabandt <cb@256bit.org>
parents:
12930
diff
changeset
|
6166 set gfn=Ricty_Diminished:h12 |
6110 | 6167 set rop=type:directx |
6168 < | |
12934
2ebc3df65ca2
patch 8.0.1343: MS-Windows: does not show colored emojis
Christian Brabandt <cb@256bit.org>
parents:
12930
diff
changeset
|
6169 If select a raster font (Courier, Terminal or FixedSys which |
2ebc3df65ca2
patch 8.0.1343: MS-Windows: does not show colored emojis
Christian Brabandt <cb@256bit.org>
parents:
12930
diff
changeset
|
6170 have ".fon" extension in file name) to 'guifont', it will be |
12986
18e6f4addce9
patch 8.0.1369: MS-Windows: drawing underline slow, mFallbackDC not updated
Christian Brabandt <cb@256bit.org>
parents:
12971
diff
changeset
|
6171 drawn by GDI as a fallback. |
12934
2ebc3df65ca2
patch 8.0.1343: MS-Windows: does not show colored emojis
Christian Brabandt <cb@256bit.org>
parents:
12930
diff
changeset
|
6172 |
2ebc3df65ca2
patch 8.0.1343: MS-Windows: does not show colored emojis
Christian Brabandt <cb@256bit.org>
parents:
12930
diff
changeset
|
6173 NOTE: It is known that some fonts and options combination |
2ebc3df65ca2
patch 8.0.1343: MS-Windows: does not show colored emojis
Christian Brabandt <cb@256bit.org>
parents:
12930
diff
changeset
|
6174 causes trouble on drawing glyphs. |
2ebc3df65ca2
patch 8.0.1343: MS-Windows: does not show colored emojis
Christian Brabandt <cb@256bit.org>
parents:
12930
diff
changeset
|
6175 |
12986
18e6f4addce9
patch 8.0.1369: MS-Windows: drawing underline slow, mFallbackDC not updated
Christian Brabandt <cb@256bit.org>
parents:
12971
diff
changeset
|
6176 - 'renmode:5' and 'renmode:6' will not work with some |
12934
2ebc3df65ca2
patch 8.0.1343: MS-Windows: does not show colored emojis
Christian Brabandt <cb@256bit.org>
parents:
12930
diff
changeset
|
6177 special made fonts (True-Type fonts which includes only |
2ebc3df65ca2
patch 8.0.1343: MS-Windows: does not show colored emojis
Christian Brabandt <cb@256bit.org>
parents:
12930
diff
changeset
|
6178 bitmap glyphs). |
2ebc3df65ca2
patch 8.0.1343: MS-Windows: does not show colored emojis
Christian Brabandt <cb@256bit.org>
parents:
12930
diff
changeset
|
6179 - 'taamode:3' will not work with some vector fonts. |
2ebc3df65ca2
patch 8.0.1343: MS-Windows: does not show colored emojis
Christian Brabandt <cb@256bit.org>
parents:
12930
diff
changeset
|
6180 |
2ebc3df65ca2
patch 8.0.1343: MS-Windows: does not show colored emojis
Christian Brabandt <cb@256bit.org>
parents:
12930
diff
changeset
|
6181 NOTE: With this option, you can display colored emoji |
2ebc3df65ca2
patch 8.0.1343: MS-Windows: does not show colored emojis
Christian Brabandt <cb@256bit.org>
parents:
12930
diff
changeset
|
6182 (emoticon) in Windows 8.1 or later. To display colored emoji, |
2ebc3df65ca2
patch 8.0.1343: MS-Windows: does not show colored emojis
Christian Brabandt <cb@256bit.org>
parents:
12930
diff
changeset
|
6183 there are some conditions which you should notice. |
2ebc3df65ca2
patch 8.0.1343: MS-Windows: does not show colored emojis
Christian Brabandt <cb@256bit.org>
parents:
12930
diff
changeset
|
6184 |
2ebc3df65ca2
patch 8.0.1343: MS-Windows: does not show colored emojis
Christian Brabandt <cb@256bit.org>
parents:
12930
diff
changeset
|
6185 - If your font includes non-colored emoji already, it will |
2ebc3df65ca2
patch 8.0.1343: MS-Windows: does not show colored emojis
Christian Brabandt <cb@256bit.org>
parents:
12930
diff
changeset
|
6186 be used. |
2ebc3df65ca2
patch 8.0.1343: MS-Windows: does not show colored emojis
Christian Brabandt <cb@256bit.org>
parents:
12930
diff
changeset
|
6187 - If your font doesn't have emoji, the system chooses an |
2ebc3df65ca2
patch 8.0.1343: MS-Windows: does not show colored emojis
Christian Brabandt <cb@256bit.org>
parents:
12930
diff
changeset
|
6188 alternative symbol font. On Windows 10, "Segoe UI Emoji" |
2ebc3df65ca2
patch 8.0.1343: MS-Windows: does not show colored emojis
Christian Brabandt <cb@256bit.org>
parents:
12930
diff
changeset
|
6189 will be used. |
2ebc3df65ca2
patch 8.0.1343: MS-Windows: does not show colored emojis
Christian Brabandt <cb@256bit.org>
parents:
12930
diff
changeset
|
6190 - When this alternative font didn't have fixed width glyph, |
2ebc3df65ca2
patch 8.0.1343: MS-Windows: does not show colored emojis
Christian Brabandt <cb@256bit.org>
parents:
12930
diff
changeset
|
6191 emoji might be rendered beyond the bounding box of drawing |
2ebc3df65ca2
patch 8.0.1343: MS-Windows: does not show colored emojis
Christian Brabandt <cb@256bit.org>
parents:
12930
diff
changeset
|
6192 cell. |
6110 | 6193 |
6194 Other render types are currently not supported. | |
6195 | |
7 | 6196 *'report'* |
6197 'report' number (default 2) | |
6198 global | |
6199 Threshold for reporting number of lines changed. When the number of | |
6200 changed lines is more than 'report' a message will be given for most | |
6201 ":" commands. If you want it always, set 'report' to 0. | |
6202 For the ":substitute" command the number of substitutions is used | |
6203 instead of the number of lines. | |
6204 | |
6205 *'restorescreen'* *'rs'* *'norestorescreen'* *'nors'* | |
6206 'restorescreen' 'rs' boolean (default on) | |
6207 global | |
19116 | 6208 {only in MS-Windows console version} |
7 | 6209 When set, the screen contents is restored when exiting Vim. This also |
6210 happens when executing external commands. | |
6211 | |
6212 For non-Windows Vim: You can set or reset the 't_ti' and 't_te' | |
6213 options in your .vimrc. To disable restoring: | |
6214 set t_ti= t_te= | |
6215 To enable restoring (for an xterm): | |
6216 set t_ti=^[7^[[r^[[?47h t_te=^[[?47l^[8 | |
6217 (Where ^[ is an <Esc>, type CTRL-V <Esc> to insert it) | |
6218 | |
6219 *'revins'* *'ri'* *'norevins'* *'nori'* | |
6220 'revins' 'ri' boolean (default off) | |
6221 global | |
6222 {only available when compiled with the |+rightleft| | |
6223 feature} | |
6224 Inserting characters in Insert mode will work backwards. See "typing | |
6225 backwards" |ins-reverse|. This option can be toggled with the CTRL-_ | |
6226 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
|
6227 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
|
6228 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
|
6229 reset. |
7 | 6230 |
6231 *'rightleft'* *'rl'* *'norightleft'* *'norl'* | |
6232 'rightleft' 'rl' boolean (default off) | |
6233 local to window | |
6234 {only available when compiled with the |+rightleft| | |
6235 feature} | |
6236 When on, display orientation becomes right-to-left, i.e., characters | |
6237 that are stored in the file appear from the right to the left. | |
6238 Using this option, it is possible to edit files for languages that | |
6239 are written from the right to the left such as Hebrew and Arabic. | |
6240 This option is per window, so it is possible to edit mixed files | |
6241 simultaneously, or to view the same file in both ways (this is | |
6242 useful whenever you have a mixed text file with both right-to-left | |
6243 and left-to-right strings so that both sets are displayed properly | |
6244 in different windows). Also see |rileft.txt|. | |
6245 | |
2341 | 6246 *'rightleftcmd'* *'rlc'* |
7 | 6247 'rightleftcmd' 'rlc' string (default "search") |
6248 local to window | |
6249 {only available when compiled with the |+rightleft| | |
6250 feature} | |
6251 Each word in this option enables the command line editing to work in | |
6252 right-to-left mode for a group of commands: | |
6253 | |
6254 search "/" and "?" commands | |
6255 | |
6256 This is useful for languages such as Hebrew, Arabic and Farsi. | |
6257 The 'rightleft' option must be set for 'rightleftcmd' to take effect. | |
6258 | |
7196
42717d048817
commit https://github.com/vim/vim/commit/d94464ee294a351ce7b6ba18e8bd3f24f1bef920
Christian Brabandt <cb@256bit.org>
parents:
7147
diff
changeset
|
6259 *'rubydll'* |
8629
54ac275e3fc4
commit https://github.com/vim/vim/commit/3848e00e0177abdb31bc600234967863ec487233
Christian Brabandt <cb@256bit.org>
parents:
8560
diff
changeset
|
6260 '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
|
6261 global |
7196
42717d048817
commit https://github.com/vim/vim/commit/d94464ee294a351ce7b6ba18e8bd3f24f1bef920
Christian Brabandt <cb@256bit.org>
parents:
7147
diff
changeset
|
6262 {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
|
6263 feature} |
7528
53163e4d9e4f
commit https://github.com/vim/vim/commit/25e4fcde767084d1a79e0926bc301c92987c0cce
Christian Brabandt <cb@256bit.org>
parents:
7477
diff
changeset
|
6264 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
|
6265 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
|
6266 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
|
6267 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
|
6268 security reasons. |
42717d048817
commit https://github.com/vim/vim/commit/d94464ee294a351ce7b6ba18e8bd3f24f1bef920
Christian Brabandt <cb@256bit.org>
parents:
7147
diff
changeset
|
6269 |
7 | 6270 *'ruler'* *'ru'* *'noruler'* *'noru'* |
9669
284b4eb307fc
commit https://github.com/vim/vim/commit/8c08b5b569e2a9e9f63dea514591ecfa2d3bb392
Christian Brabandt <cb@256bit.org>
parents:
9665
diff
changeset
|
6271 'ruler' 'ru' boolean (default off, set in |defaults.vim|) |
7 | 6272 global |
6273 {not available when compiled without the | |
6274 |+cmdline_info| feature} | |
6275 Show the line and column number of the cursor position, separated by a | |
10 | 6276 comma. When there is room, the relative position of the displayed |
7 | 6277 text in the file is shown on the far right: |
6278 Top first line is visible | |
6279 Bot last line is visible | |
6280 All first and last line are visible | |
6281 45% relative position in the file | |
6282 If 'rulerformat' is set, it will determine the contents of the ruler. | |
10 | 6283 Each window has its own ruler. If a window has a status line, the |
7 | 6284 ruler is shown there. Otherwise it is shown in the last line of the |
233 | 6285 screen. If the statusline is given by 'statusline' (i.e. not empty), |
7 | 6286 this option takes precedence over 'ruler' and 'rulerformat' |
6287 If the number of characters displayed is different from the number of | |
21991 | 6288 bytes in the text (e.g., for a TAB or a multibyte character), both |
7 | 6289 the text column (byte number) and the screen column are shown, |
6290 separated with a dash. | |
6291 For an empty line "0-1" is shown. | |
6292 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
|
6293 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
|
6294 reset. |
7 | 6295 If you don't want to see the ruler all the time but want to know where |
6296 you are, use "g CTRL-G" |g_CTRL-G|. | |
6297 NOTE: This option is reset when 'compatible' is set. | |
6298 | |
6299 *'rulerformat'* *'ruf'* | |
6300 'rulerformat' 'ruf' string (default empty) | |
6301 global | |
6302 {not available when compiled without the |+statusline| | |
6303 feature} | |
6304 When this option is not empty, it determines the content of the ruler | |
6305 string, as displayed for the 'ruler' option. | |
692 | 6306 The format of this option is like that of 'statusline'. |
16728
e55c26aaf484
patch 8.1.1366: using expressions in a modeline is unsafe
Bram Moolenaar <Bram@vim.org>
parents:
16610
diff
changeset
|
6307 This option cannot be set in a modeline when 'modelineexpr' is off. |
e55c26aaf484
patch 8.1.1366: using expressions in a modeline is unsafe
Bram Moolenaar <Bram@vim.org>
parents:
16610
diff
changeset
|
6308 |
7 | 6309 The default ruler width is 17 characters. To make the ruler 15 |
6310 characters wide, put "%15(" at the start and "%)" at the end. | |
6311 Example: > | |
6312 :set rulerformat=%15(%c%V\ %p%%%) | |
6313 < | |
6314 *'runtimepath'* *'rtp'* *vimfiles* | |
6315 'runtimepath' 'rtp' string (default: | |
23931 | 6316 Unix: "$HOME/.vim, |
7 | 6317 $VIM/vimfiles, |
6318 $VIMRUNTIME, | |
6319 $VIM/vimfiles/after, | |
6320 $HOME/.vim/after" | |
6321 Amiga: "home:vimfiles, | |
6322 $VIM/vimfiles, | |
6323 $VIMRUNTIME, | |
6324 $VIM/vimfiles/after, | |
6325 home:vimfiles/after" | |
23931 | 6326 MS-Windows: "$HOME/vimfiles, |
7 | 6327 $VIM/vimfiles, |
6328 $VIMRUNTIME, | |
6329 $VIM/vimfiles/after, | |
6330 $HOME/vimfiles/after" | |
21825 | 6331 macOS: "$VIM:vimfiles, |
7 | 6332 $VIMRUNTIME, |
6333 $VIM:vimfiles:after" | |
19526
22f0dda71638
patch 8.2.0320: no Haiku support
Bram Moolenaar <Bram@vim.org>
parents:
19404
diff
changeset
|
6334 Haiku: "$BE_USER_SETTINGS/vim, |
22f0dda71638
patch 8.2.0320: no Haiku support
Bram Moolenaar <Bram@vim.org>
parents:
19404
diff
changeset
|
6335 $VIM/vimfiles, |
22f0dda71638
patch 8.2.0320: no Haiku support
Bram Moolenaar <Bram@vim.org>
parents:
19404
diff
changeset
|
6336 $VIMRUNTIME, |
22f0dda71638
patch 8.2.0320: no Haiku support
Bram Moolenaar <Bram@vim.org>
parents:
19404
diff
changeset
|
6337 $VIM/vimfiles/after, |
23931 | 6338 $BE_USER_SETTINGS/vim/after" |
6339 VMS: "sys$login:vimfiles, | |
7 | 6340 $VIM/vimfiles, |
6341 $VIMRUNTIME, | |
6342 $VIM/vimfiles/after, | |
233 | 6343 sys$login:vimfiles/after") |
7 | 6344 global |
6345 This is a list of directories which will be searched for runtime | |
6346 files: | |
6347 filetype.vim filetypes by file name |new-filetype| | |
6348 scripts.vim filetypes by file contents |new-filetype-scripts| | |
164 | 6349 autoload/ automatically loaded scripts |autoload-functions| |
7 | 6350 colors/ color scheme files |:colorscheme| |
6351 compiler/ compiler files |:compiler| | |
6352 doc/ documentation |write-local-help| | |
6353 ftplugin/ filetype plugins |write-filetype-plugin| | |
19181
94eda51ba9ba
patch 8.2.0149: maintaining a Vim9 branch separately is more work
Bram Moolenaar <Bram@vim.org>
parents:
19180
diff
changeset
|
6354 import/ files that are found by `:import` |
7 | 6355 indent/ indent scripts |indent-expression| |
6356 keymap/ key mapping files |mbyte-keymap| | |
6357 lang/ menu translations |:menutrans| | |
6358 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
|
6359 pack/ packages |:packadd| |
7 | 6360 plugin/ plugin scripts |write-plugin| |
6361 print/ files for printing |postscript-print-encoding| | |
650 | 6362 spell/ spell checking files |spell| |
7 | 6363 syntax/ syntax files |mysyntaxfile| |
6364 tutor/ files for vimtutor |tutor| | |
6365 | |
6366 And any other file searched for with the |:runtime| command. | |
6367 | |
6368 The defaults for most systems are setup to search five locations: | |
6369 1. In your home directory, for your personal preferences. | |
6370 2. In a system-wide Vim directory, for preferences from the system | |
6371 administrator. | |
6372 3. In $VIMRUNTIME, for files distributed with Vim. | |
6373 *after-directory* | |
6374 4. In the "after" directory in the system-wide Vim directory. This is | |
6375 for the system administrator to overrule or add to the distributed | |
6376 defaults (rarely needed) | |
6377 5. In the "after" directory in your home directory. This is for | |
6378 personal preferences to overrule or add to the distributed defaults | |
6379 or system-wide settings (rarely needed). | |
6380 | |
10211
b7da8d4c594c
commit https://github.com/vim/vim/commit/d07969093a9b3051511c478d71c36de6fc33c0d6
Christian Brabandt <cb@256bit.org>
parents:
10198
diff
changeset
|
6381 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
|
6382 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
|
6383 string. |
9116
bc38030aec7d
commit https://github.com/vim/vim/commit/26852128a2b713ef49341a0c18daba928444e7eb
Christian Brabandt <cb@256bit.org>
parents:
9098
diff
changeset
|
6384 |
7 | 6385 Note that, unlike 'path', no wildcards like "**" are allowed. Normal |
6386 wildcards are allowed, but can significantly slow down searching for | |
10 | 6387 runtime files. For speed, use as few items as possible and avoid |
7 | 6388 wildcards. |
6389 See |:runtime|. | |
6390 Example: > | |
6391 :set runtimepath=~/vimruntime,/mygroup/vim,$VIMRUNTIME | |
6392 < This will use the directory "~/vimruntime" first (containing your | |
6393 personal Vim runtime files), then "/mygroup/vim" (shared between a | |
6394 group of people) and finally "$VIMRUNTIME" (the distributed runtime | |
6395 files). | |
6396 You probably should always include $VIMRUNTIME somewhere, to use the | |
6397 distributed runtime files. You can put a directory before $VIMRUNTIME | |
6398 to find files which replace a distributed runtime files. You can put | |
6399 a directory after $VIMRUNTIME to find files which add to distributed | |
6400 runtime files. | |
13437 | 6401 When Vim is started with |--clean| the home directory entries are not |
6402 included. | |
7 | 6403 This option cannot be set from a |modeline| or in the |sandbox|, for |
6404 security reasons. | |
6405 | |
6406 *'scroll'* *'scr'* | |
6407 'scroll' 'scr' number (default: half the window height) | |
6408 local to window | |
6409 Number of lines to scroll with CTRL-U and CTRL-D commands. Will be | |
6410 set to half the number of lines in the window when the window size | |
23386
3105546b941f
patch 8.2.2236: 'scroll' option can change when setting the statusline
Bram Moolenaar <Bram@vim.org>
parents:
23305
diff
changeset
|
6411 changes. This may happen when enabling the |status-line| or |
3105546b941f
patch 8.2.2236: 'scroll' option can change when setting the statusline
Bram Moolenaar <Bram@vim.org>
parents:
23305
diff
changeset
|
6412 'tabline' option after setting the 'scroll' option. |
3105546b941f
patch 8.2.2236: 'scroll' option can change when setting the statusline
Bram Moolenaar <Bram@vim.org>
parents:
23305
diff
changeset
|
6413 If you give a count to the CTRL-U or CTRL-D command it will |
10 | 6414 be used as the new value for 'scroll'. Reset to half the window |
16553
0e473e9e70c2
patch 8.1.1280: remarks about functionality not in Vi clutters the help
Bram Moolenaar <Bram@vim.org>
parents:
16533
diff
changeset
|
6415 height with ":set scroll=0". |
7 | 6416 |
6417 *'scrollbind'* *'scb'* *'noscrollbind'* *'noscb'* | |
6418 'scrollbind' 'scb' boolean (default off) | |
6419 local to window | |
6420 See also |scroll-binding|. When this option is set, the current | |
6421 window scrolls as other scrollbind windows (windows that also have | |
6422 this option set) scroll. This option is useful for viewing the | |
6423 differences between two versions of a file, see 'diff'. | |
6424 See |'scrollopt'| for options that determine how this option should be | |
6425 interpreted. | |
6426 This option is mostly reset when splitting a window to edit another | |
6427 file. This means that ":split | edit file" results in two windows | |
6428 with scroll-binding, but ":split file" does not. | |
6429 | |
18526
334b1f897f3a
patch 8.1.2257: MS-Windows GUI: scroll wheel always uses current window
Bram Moolenaar <Bram@vim.org>
parents:
18489
diff
changeset
|
6430 *'scrollfocus'* *'scf'* *'noscrollfocus'* *'noscf'* |
334b1f897f3a
patch 8.1.2257: MS-Windows GUI: scroll wheel always uses current window
Bram Moolenaar <Bram@vim.org>
parents:
18489
diff
changeset
|
6431 'scrollfocus' 'scf' boolean (default off) |
334b1f897f3a
patch 8.1.2257: MS-Windows GUI: scroll wheel always uses current window
Bram Moolenaar <Bram@vim.org>
parents:
18489
diff
changeset
|
6432 global |
334b1f897f3a
patch 8.1.2257: MS-Windows GUI: scroll wheel always uses current window
Bram Moolenaar <Bram@vim.org>
parents:
18489
diff
changeset
|
6433 {only for MS-Windows GUI} |
334b1f897f3a
patch 8.1.2257: MS-Windows GUI: scroll wheel always uses current window
Bram Moolenaar <Bram@vim.org>
parents:
18489
diff
changeset
|
6434 When using the scroll wheel and this option is set, the window under |
334b1f897f3a
patch 8.1.2257: MS-Windows GUI: scroll wheel always uses current window
Bram Moolenaar <Bram@vim.org>
parents:
18489
diff
changeset
|
6435 the mouse pointer is scrolled. With this option off the current |
334b1f897f3a
patch 8.1.2257: MS-Windows GUI: scroll wheel always uses current window
Bram Moolenaar <Bram@vim.org>
parents:
18489
diff
changeset
|
6436 window is scrolled. |
18594 | 6437 Systems other than MS-Windows always behave like this option is on. |
18526
334b1f897f3a
patch 8.1.2257: MS-Windows GUI: scroll wheel always uses current window
Bram Moolenaar <Bram@vim.org>
parents:
18489
diff
changeset
|
6438 |
7 | 6439 *'scrolljump'* *'sj'* |
6440 'scrolljump' 'sj' number (default 1) | |
6441 global | |
6442 Minimal number of lines to scroll when the cursor gets off the | |
6443 screen (e.g., with "j"). Not used for scroll commands (e.g., CTRL-E, | |
6444 CTRL-D). Useful if your terminal scrolls very slowly. | |
532 | 6445 When set to a negative number from -1 to -100 this is used as the |
6446 percentage of the window height. Thus -50 scrolls half the window | |
6447 height. | |
7 | 6448 NOTE: This option is set to 1 when 'compatible' is set. |
6449 | |
6450 *'scrolloff'* *'so'* | |
10218
584c835a2de1
commit https://github.com/vim/vim/commit/50ba526fbf3e9e5e0e6b0b3086a4d5df581ebc7e
Christian Brabandt <cb@256bit.org>
parents:
10211
diff
changeset
|
6451 'scrolloff' 'so' number (default 0, set to 5 in |defaults.vim|) |
15713
ad8b2c109b22
patch 8.1.0864: cannot have a local value for 'scrolloff' and 'sidescrolloff'
Bram Moolenaar <Bram@vim.org>
parents:
15701
diff
changeset
|
6452 global or local to window |global-local| |
7 | 6453 Minimal number of screen lines to keep above and below the cursor. |
6454 This will make some context visible around where you are working. If | |
6455 you set it to a very large value (999) the cursor line will always be | |
6456 in the middle of the window (except at the start or end of the file or | |
6457 when long lines wrap). | |
15713
ad8b2c109b22
patch 8.1.0864: cannot have a local value for 'scrolloff' and 'sidescrolloff'
Bram Moolenaar <Bram@vim.org>
parents:
15701
diff
changeset
|
6458 After using the local value, go back the global value with one of |
ad8b2c109b22
patch 8.1.0864: cannot have a local value for 'scrolloff' and 'sidescrolloff'
Bram Moolenaar <Bram@vim.org>
parents:
15701
diff
changeset
|
6459 these two: > |
ad8b2c109b22
patch 8.1.0864: cannot have a local value for 'scrolloff' and 'sidescrolloff'
Bram Moolenaar <Bram@vim.org>
parents:
15701
diff
changeset
|
6460 setlocal scrolloff< |
ad8b2c109b22
patch 8.1.0864: cannot have a local value for 'scrolloff' and 'sidescrolloff'
Bram Moolenaar <Bram@vim.org>
parents:
15701
diff
changeset
|
6461 setlocal scrolloff=-1 |
ad8b2c109b22
patch 8.1.0864: cannot have a local value for 'scrolloff' and 'sidescrolloff'
Bram Moolenaar <Bram@vim.org>
parents:
15701
diff
changeset
|
6462 < For scrolling horizontally see 'sidescrolloff'. |
7 | 6463 NOTE: This option is set to 0 when 'compatible' is set. |
6464 | |
6465 *'scrollopt'* *'sbo'* | |
6466 'scrollopt' 'sbo' string (default "ver,jump") | |
6467 global | |
6468 This is a comma-separated list of words that specifies how | |
236 | 6469 'scrollbind' windows should behave. 'sbo' stands for ScrollBind |
6470 Options. | |
7 | 6471 The following words are available: |
6472 ver Bind vertical scrolling for 'scrollbind' windows | |
6473 hor Bind horizontal scrolling for 'scrollbind' windows | |
6474 jump Applies to the offset between two windows for vertical | |
6475 scrolling. This offset is the difference in the first | |
6476 displayed line of the bound windows. When moving | |
6477 around in a window, another 'scrollbind' window may | |
6478 reach a position before the start or after the end of | |
6479 the buffer. The offset is not changed though, when | |
6480 moving back the 'scrollbind' window will try to scroll | |
6481 to the desired position when possible. | |
6482 When now making that window the current one, two | |
6483 things can be done with the relative offset: | |
6484 1. When "jump" is not included, the relative offset is | |
6485 adjusted for the scroll position in the new current | |
6486 window. When going back to the other window, the | |
1152 | 6487 new relative offset will be used. |
7 | 6488 2. When "jump" is included, the other windows are |
6489 scrolled to keep the same relative offset. When | |
6490 going back to the other window, it still uses the | |
6491 same relative offset. | |
6492 Also see |scroll-binding|. | |
819 | 6493 When 'diff' mode is active there always is vertical scroll binding, |
6494 even when "ver" isn't there. | |
7 | 6495 |
6496 *'sections'* *'sect'* | |
6497 'sections' 'sect' string (default "SHNHH HUnhsh") | |
6498 global | |
6499 Specifies the nroff macros that separate sections. These are pairs of | |
6500 two letters (See |object-motions|). The default makes a section start | |
6501 at the nroff macros ".SH", ".NH", ".H", ".HU", ".nh" and ".sh". | |
6502 | |
6503 *'secure'* *'nosecure'* *E523* | |
6504 'secure' boolean (default off) | |
6505 global | |
6506 When on, ":autocmd", shell and write commands are not allowed in | |
6507 ".vimrc" and ".exrc" in the current directory and map commands are | |
6508 displayed. Switch it off only if you know that you will not run into | |
6509 problems, or when the 'exrc' option is off. On Unix this option is | |
6510 only used if the ".vimrc" or ".exrc" is not owned by you. This can be | |
10 | 6511 dangerous if the systems allows users to do a "chown". You better set |
7 | 6512 'secure' at the end of your ~/.vimrc then. |
6513 This option cannot be set from a |modeline| or in the |sandbox|, for | |
6514 security reasons. | |
6515 | |
6516 *'selection'* *'sel'* | |
6517 'selection' 'sel' string (default "inclusive") | |
6518 global | |
6519 This option defines the behavior of the selection. It is only used | |
6520 in Visual and Select mode. | |
6521 Possible values: | |
6522 value past line inclusive ~ | |
6523 old no yes | |
6524 inclusive yes yes | |
6525 exclusive yes no | |
6526 "past line" means that the cursor is allowed to be positioned one | |
6527 character past the line. | |
6528 "inclusive" means that the last character of the selection is included | |
6529 in an operation. For example, when "x" is used to delete the | |
6530 selection. | |
9975
03fa8a51e9dc
commit https://github.com/vim/vim/commit/e4a3bcf28d92d0bde9ca227ccb40d401038185e5
Christian Brabandt <cb@256bit.org>
parents:
9913
diff
changeset
|
6531 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
|
6532 the end of line the line break still isn't included. |
7 | 6533 Note that when "exclusive" is used and selecting from the end |
6534 backwards, you cannot include the last character of a line, when | |
6535 starting in Normal mode and 'virtualedit' empty. | |
6536 | |
6537 The 'selection' option is set by the |:behave| command. | |
6538 | |
6539 *'selectmode'* *'slm'* | |
6540 'selectmode' 'slm' string (default "") | |
6541 global | |
6542 This is a comma separated list of words, which specifies when to start | |
6543 Select mode instead of Visual mode, when a selection is started. | |
6544 Possible values: | |
6545 mouse when using the mouse | |
6546 key when using shifted special keys | |
6547 cmd when using "v", "V" or CTRL-V | |
6548 See |Select-mode|. | |
6549 The 'selectmode' option is set by the |:behave| command. | |
6550 | |
6551 *'sessionoptions'* *'ssop'* | |
6552 'sessionoptions' 'ssop' string (default: "blank,buffers,curdir,folds, | |
13437 | 6553 help,options,tabpages,winsize,terminal") |
7 | 6554 global |
2570
71b56b4e7785
Make the references to features in the help more consistent. (Sylvain Hitier)
Bram Moolenaar <bram@vim.org>
parents:
2561
diff
changeset
|
6555 {not available when compiled without the |+mksession| |
7 | 6556 feature} |
6557 Changes the effect of the |:mksession| command. It is a comma | |
6558 separated list of words. Each word enables saving and restoring | |
6559 something: | |
6560 word save and restore ~ | |
6561 blank empty windows | |
6562 buffers hidden and unloaded buffers, not just those in windows | |
6563 curdir the current directory | |
6564 folds manually created folds, opened/closed folds and local | |
6565 fold options | |
6566 globals global variables that start with an uppercase letter | |
75 | 6567 and contain at least one lowercase letter. Only |
6568 String and Number types are stored. | |
7 | 6569 help the help window |
6570 localoptions options and mappings local to a window or buffer (not | |
6571 global values for local options) | |
6572 options all options and mappings (also global values for local | |
6573 options) | |
24476
e79d1475fc89
patch 8.2.2778: problem restoring 'packpath' in session
Bram Moolenaar <Bram@vim.org>
parents:
24468
diff
changeset
|
6574 skiprtp exclude 'runtimepath' and 'packpath' from the options |
7 | 6575 resize size of the Vim window: 'lines' and 'columns' |
6576 sesdir the directory in which the session file is located | |
6577 will become the current directory (useful with | |
6578 projects accessed over a network from different | |
6579 systems) | |
6580 slash backslashes in file names replaced with forward | |
6581 slashes | |
827 | 6582 tabpages all tab pages; without this only the current tab page |
6583 is restored, so that you can make a session for each | |
6584 tab page separately | |
14519 | 6585 terminal include terminal windows where the command can be |
6586 restored | |
7 | 6587 unix with Unix end-of-line format (single <NL>), even when |
6588 on Windows or DOS | |
6589 winpos position of the whole Vim window | |
6590 winsize window sizes | |
6591 | |
6592 Don't include both "curdir" and "sesdir". | |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
6593 When neither "curdir" nor "sesdir" is included, file names are stored |
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
6594 with absolute paths. |
7 | 6595 "slash" and "unix" are useful on Windows when sharing session files |
6596 with Unix. The Unix version of Vim cannot source dos format scripts, | |
6597 but the Windows version of Vim can source unix format scripts. | |
6598 | |
6599 *'shell'* *'sh'* *E91* | |
18928 | 6600 'shell' 'sh' string (default $SHELL or "sh", Win32: "cmd.exe") |
7 | 6601 global |
6602 Name of the shell to use for ! and :! commands. When changing the | |
6603 value also check these options: 'shelltype', 'shellpipe', 'shellslash' | |
6604 'shellredir', 'shellquote', 'shellxquote' and 'shellcmdflag'. | |
10 | 6605 It is allowed to give an argument to the command, e.g. "csh -f". |
7 | 6606 See |option-backslash| about including spaces and backslashes. |
6607 Environment variables are expanded |:set_env|. | |
13162
51521b8a370c
patch 8.0.1455: if $SHELL contains a space then 'shell' is incorrect
Christian Brabandt <cb@256bit.org>
parents:
13154
diff
changeset
|
6608 |
18489 | 6609 If the name of the shell contains a space, you need to enclose it in |
18594 | 6610 quotes and escape the space. Example with quotes: > |
7 | 6611 :set shell=\"c:\program\ files\unix\sh.exe\"\ -f |
6612 < Note the backslash before each quote (to avoid starting a comment) and | |
10 | 6613 each space (to avoid ending the option value). Also note that the |
7 | 6614 "-f" is not inside the quotes, because it is not part of the command |
13162
51521b8a370c
patch 8.0.1455: if $SHELL contains a space then 'shell' is incorrect
Christian Brabandt <cb@256bit.org>
parents:
13154
diff
changeset
|
6615 name. Vim automagically recognizes the backslashes that are path |
7 | 6616 separators. |
13162
51521b8a370c
patch 8.0.1455: if $SHELL contains a space then 'shell' is incorrect
Christian Brabandt <cb@256bit.org>
parents:
13154
diff
changeset
|
6617 Example with escaped space (Vim will do this when initializing the |
51521b8a370c
patch 8.0.1455: if $SHELL contains a space then 'shell' is incorrect
Christian Brabandt <cb@256bit.org>
parents:
13154
diff
changeset
|
6618 option from $SHELL): > |
51521b8a370c
patch 8.0.1455: if $SHELL contains a space then 'shell' is incorrect
Christian Brabandt <cb@256bit.org>
parents:
13154
diff
changeset
|
6619 :set shell=/bin/with\\\ space/sh |
14519 | 6620 < The resulting value of 'shell' is "/bin/with\ space/sh", two |
13162
51521b8a370c
patch 8.0.1455: if $SHELL contains a space then 'shell' is incorrect
Christian Brabandt <cb@256bit.org>
parents:
13154
diff
changeset
|
6621 backslashes are consumed by `:set`. |
51521b8a370c
patch 8.0.1455: if $SHELL contains a space then 'shell' is incorrect
Christian Brabandt <cb@256bit.org>
parents:
13154
diff
changeset
|
6622 |
7 | 6623 Under MS-Windows, when the executable ends in ".com" it must be |
6624 included. Thus setting the shell to "command.com" or "4dos.com" | |
6625 works, but "command" and "4dos" do not work for all commands (e.g., | |
6626 filtering). | |
6627 For unknown reasons, when using "4dos.com" the current directory is | |
6628 changed to "C:\". To avoid this set 'shell' like this: > | |
6629 :set shell=command.com\ /c\ 4dos | |
6630 < This option cannot be set from a |modeline| or in the |sandbox|, for | |
6631 security reasons. | |
6632 | |
6633 *'shellcmdflag'* *'shcf'* | |
3356 | 6634 'shellcmdflag' 'shcf' string (default: "-c"; |
25068
0ce24f734615
patch 8.2.3071: shell options are not set properly for PowerShell
Bram Moolenaar <Bram@vim.org>
parents:
25056
diff
changeset
|
6635 Win32, when 'shell' contains "powershell": |
0ce24f734615
patch 8.2.3071: shell options are not set properly for PowerShell
Bram Moolenaar <Bram@vim.org>
parents:
25056
diff
changeset
|
6636 "-Command", or when it does not contain "sh" |
18972 | 6637 somewhere: "/c") |
7 | 6638 global |
6639 Flag passed to the shell to execute "!" and ":!" commands; e.g., | |
25068
0ce24f734615
patch 8.2.3071: shell options are not set properly for PowerShell
Bram Moolenaar <Bram@vim.org>
parents:
25056
diff
changeset
|
6640 "bash.exe -c ls", "powershell.exe -Command dir", or "cmd.exe /c dir". |
0ce24f734615
patch 8.2.3071: shell options are not set properly for PowerShell
Bram Moolenaar <Bram@vim.org>
parents:
25056
diff
changeset
|
6641 For MS-Windows, the default is set according to the value of 'shell', |
0ce24f734615
patch 8.2.3071: shell options are not set properly for PowerShell
Bram Moolenaar <Bram@vim.org>
parents:
25056
diff
changeset
|
6642 to reduce the need to set this option by the user. |
3082 | 6643 On Unix it can have more than one flag. Each white space separated |
6644 part is passed as an argument to the shell command. | |
6645 See |option-backslash| about including spaces and backslashes. | |
25068
0ce24f734615
patch 8.2.3071: shell options are not set properly for PowerShell
Bram Moolenaar <Bram@vim.org>
parents:
25056
diff
changeset
|
6646 Also see |dos-shell| and |dos-powershell| for MS-Windows. |
7 | 6647 This option cannot be set from a |modeline| or in the |sandbox|, for |
6648 security reasons. | |
6649 | |
6650 *'shellpipe'* *'sp'* | |
25068
0ce24f734615
patch 8.2.3071: shell options are not set properly for PowerShell
Bram Moolenaar <Bram@vim.org>
parents:
25056
diff
changeset
|
6651 'shellpipe' 'sp' string (default ">", ">%s 2>&1", "| tee", "|& tee" |
0ce24f734615
patch 8.2.3071: shell options are not set properly for PowerShell
Bram Moolenaar <Bram@vim.org>
parents:
25056
diff
changeset
|
6652 "2>&1| tee", or |
0ce24f734615
patch 8.2.3071: shell options are not set properly for PowerShell
Bram Moolenaar <Bram@vim.org>
parents:
25056
diff
changeset
|
6653 "2>&1 | Out-File -Encoding default") |
7 | 6654 global |
6655 {not available when compiled without the |+quickfix| | |
6656 feature} | |
6657 String to be used to put the output of the ":make" command in the | |
10 | 6658 error file. See also |:make_makeprg|. See |option-backslash| about |
7 | 6659 including spaces and backslashes. |
6660 The name of the temporary file can be represented by "%s" if necessary | |
6661 (the file name is appended automatically if no %s appears in the value | |
6662 of this option). | |
25068
0ce24f734615
patch 8.2.3071: shell options are not set properly for PowerShell
Bram Moolenaar <Bram@vim.org>
parents:
25056
diff
changeset
|
6663 For the Amiga the default is ">". For MS-Windows using powershell the |
0ce24f734615
patch 8.2.3071: shell options are not set properly for PowerShell
Bram Moolenaar <Bram@vim.org>
parents:
25056
diff
changeset
|
6664 default is "2>&1 | Out-File -Encoding default", otherwise the default |
0ce24f734615
patch 8.2.3071: shell options are not set properly for PowerShell
Bram Moolenaar <Bram@vim.org>
parents:
25056
diff
changeset
|
6665 is ">%s 2>&1". The output is directly saved in a file and not echoed |
0ce24f734615
patch 8.2.3071: shell options are not set properly for PowerShell
Bram Moolenaar <Bram@vim.org>
parents:
25056
diff
changeset
|
6666 to the screen. |
22171 | 6667 For Unix the default is "| tee". The stdout of the compiler is saved |
7 | 6668 in a file and echoed to the screen. If the 'shell' option is "csh" or |
6669 "tcsh" after initializations, the default becomes "|& tee". If the | |
18456 | 6670 'shell' option is "sh", "ksh", "mksh", "pdksh", "zsh", "zsh-beta", |
24600
cb4cb3ff5736
patch 8.2.2839: default redirection missing "ash" and "dash"
Bram Moolenaar <Bram@vim.org>
parents:
24569
diff
changeset
|
6671 "bash", "fish", "ash" or "dash" the default becomes "2>&1| tee". This |
cb4cb3ff5736
patch 8.2.2839: default redirection missing "ash" and "dash"
Bram Moolenaar <Bram@vim.org>
parents:
24569
diff
changeset
|
6672 means that stderr is also included. Before using the 'shell' option a |
cb4cb3ff5736
patch 8.2.2839: default redirection missing "ash" and "dash"
Bram Moolenaar <Bram@vim.org>
parents:
24569
diff
changeset
|
6673 path is removed, thus "/bin/sh" uses "sh". |
25084
beff72446e2e
patch 8.2.3079: Powershell core not supported by default
Bram Moolenaar <Bram@vim.org>
parents:
25068
diff
changeset
|
6674 For Unix and MS-Windows, when the 'shell' option is "pwsh" the default |
beff72446e2e
patch 8.2.3079: Powershell core not supported by default
Bram Moolenaar <Bram@vim.org>
parents:
25068
diff
changeset
|
6675 becomes ">%s 2>&1" and the output is not echoed to the screen. |
7 | 6676 The initialization of this option is done after reading the ".vimrc" |
6677 and the other initializations, so that when the 'shell' option is set | |
6678 there, the 'shellpipe' option changes automatically, unless it was | |
6679 explicitly set before. | |
6680 When 'shellpipe' is set to an empty string, no redirection of the | |
6681 ":make" output will be done. This is useful if you use a 'makeprg' | |
6682 that writes to 'makeef' by itself. If you want no piping, but do | |
6683 want to include the 'makeef', set 'shellpipe' to a single space. | |
6684 Don't forget to precede the space with a backslash: ":set sp=\ ". | |
6685 In the future pipes may be used for filtering and this option will | |
6686 become obsolete (at least for Unix). | |
6687 This option cannot be set from a |modeline| or in the |sandbox|, for | |
6688 security reasons. | |
6689 | |
6690 *'shellquote'* *'shq'* | |
25084
beff72446e2e
patch 8.2.3079: Powershell core not supported by default
Bram Moolenaar <Bram@vim.org>
parents:
25068
diff
changeset
|
6691 'shellquote' 'shq' string (default: "") |
7 | 6692 global |
6693 Quoting character(s), put around the command passed to the shell, for | |
6694 the "!" and ":!" commands. The redirection is kept outside of the | |
6695 quoting. See 'shellxquote' to include the redirection. It's | |
6696 probably not useful to set both options. | |
6697 This is an empty string by default. Only known to be useful for | |
18972 | 6698 third-party shells on MS-Windows-like systems, such as the MKS Korn |
25084
beff72446e2e
patch 8.2.3079: Powershell core not supported by default
Bram Moolenaar <Bram@vim.org>
parents:
25068
diff
changeset
|
6699 Shell or bash, where it should be "\"". See |dos-shell|. |
7 | 6700 This option cannot be set from a |modeline| or in the |sandbox|, for |
6701 security reasons. | |
6702 | |
6703 *'shellredir'* *'srr'* | |
25068
0ce24f734615
patch 8.2.3071: shell options are not set properly for PowerShell
Bram Moolenaar <Bram@vim.org>
parents:
25056
diff
changeset
|
6704 'shellredir' 'srr' string (default ">", ">&", ">%s 2>&1", or |
0ce24f734615
patch 8.2.3071: shell options are not set properly for PowerShell
Bram Moolenaar <Bram@vim.org>
parents:
25056
diff
changeset
|
6705 "2>&1 | Out-File -Encoding default") |
7 | 6706 global |
6707 String to be used to put the output of a filter command in a temporary | |
6708 file. See also |:!|. See |option-backslash| about including spaces | |
6709 and backslashes. | |
6710 The name of the temporary file can be represented by "%s" if necessary | |
6711 (the file name is appended automatically if no %s appears in the value | |
6712 of this option). | |
18456 | 6713 The default is ">". For Unix, if the 'shell' option is "csh" or |
6714 "tcsh" during initializations, the default becomes ">&". If the | |
18719 | 6715 'shell' option is "sh", "ksh", "mksh", "pdksh", "zsh", "zsh-beta", |
25084
beff72446e2e
patch 8.2.3079: Powershell core not supported by default
Bram Moolenaar <Bram@vim.org>
parents:
25068
diff
changeset
|
6716 "bash", "fish", or "pwsh", the default becomes ">%s 2>&1". This means |
beff72446e2e
patch 8.2.3079: Powershell core not supported by default
Bram Moolenaar <Bram@vim.org>
parents:
25068
diff
changeset
|
6717 that stderr is also included. For Win32, the Unix checks are done and |
25068
0ce24f734615
patch 8.2.3071: shell options are not set properly for PowerShell
Bram Moolenaar <Bram@vim.org>
parents:
25056
diff
changeset
|
6718 additionally "cmd" is checked for, which makes the default ">%s 2>&1", |
0ce24f734615
patch 8.2.3071: shell options are not set properly for PowerShell
Bram Moolenaar <Bram@vim.org>
parents:
25056
diff
changeset
|
6719 and "powershell" is checked for which makes the default |
25084
beff72446e2e
patch 8.2.3079: Powershell core not supported by default
Bram Moolenaar <Bram@vim.org>
parents:
25068
diff
changeset
|
6720 "2>&1 | Out-File -Encoding default" (see |dos-powershell|). Also, the |
beff72446e2e
patch 8.2.3079: Powershell core not supported by default
Bram Moolenaar <Bram@vim.org>
parents:
25068
diff
changeset
|
6721 same names with ".exe" appended are checked for. |
7 | 6722 The initialization of this option is done after reading the ".vimrc" |
6723 and the other initializations, so that when the 'shell' option is set | |
6724 there, the 'shellredir' option changes automatically unless it was | |
6725 explicitly set before. | |
6726 In the future pipes may be used for filtering and this option will | |
6727 become obsolete (at least for Unix). | |
6728 This option cannot be set from a |modeline| or in the |sandbox|, for | |
6729 security reasons. | |
6730 | |
6731 *'shellslash'* *'ssl'* *'noshellslash'* *'nossl'* | |
6732 'shellslash' 'ssl' boolean (default off) | |
6733 global | |
18912
ccd16426a1f9
patch 8.2.0017: OS/2 and MS-DOS are still mentioned
Bram Moolenaar <Bram@vim.org>
parents:
18879
diff
changeset
|
6734 {only for MS-Windows} |
7 | 6735 When set, a forward slash is used when expanding file names. This is |
25084
beff72446e2e
patch 8.2.3079: Powershell core not supported by default
Bram Moolenaar <Bram@vim.org>
parents:
25068
diff
changeset
|
6736 useful when a Unix-like shell is used instead of cmd.exe, pwsh.exe, or |
25068
0ce24f734615
patch 8.2.3071: shell options are not set properly for PowerShell
Bram Moolenaar <Bram@vim.org>
parents:
25056
diff
changeset
|
6737 powershell.exe. Backward slashes can still be typed, but they are |
0ce24f734615
patch 8.2.3071: shell options are not set properly for PowerShell
Bram Moolenaar <Bram@vim.org>
parents:
25056
diff
changeset
|
6738 changed to forward slashes by Vim. |
7 | 6739 Note that setting or resetting this option has no effect for some |
6740 existing file names, thus this option needs to be set before opening | |
6741 any file for best results. This might change in the future. | |
6742 'shellslash' only works when a backslash can be used as a path | |
6743 separator. To test if this is so use: > | |
6744 if exists('+shellslash') | |
17543
77c3f6428b6c
patch 8.1.1769: 'shellslash' is also used for completion
Bram Moolenaar <Bram@vim.org>
parents:
17433
diff
changeset
|
6745 < Also see 'completeslash'. |
77c3f6428b6c
patch 8.1.1769: 'shellslash' is also used for completion
Bram Moolenaar <Bram@vim.org>
parents:
17433
diff
changeset
|
6746 |
168 | 6747 *'shelltemp'* *'stmp'* *'noshelltemp'* *'nostmp'* |
6748 'shelltemp' 'stmp' boolean (Vi default off, Vim default on) | |
6749 global | |
6750 When on, use temp files for shell commands. When off use a pipe. | |
6751 When using a pipe is not possible temp files are used anyway. | |
2965 | 6752 Currently a pipe is only supported on Unix and MS-Windows 2K and |
6753 later. You can check it with: > | |
168 | 6754 :if has("filterpipe") |
6755 < The advantage of using a pipe is that nobody can read the temp file | |
6756 and the 'shell' command does not need to support redirection. | |
6757 The advantage of using a temp file is that the file type and encoding | |
6758 can be detected. | |
6759 The |FilterReadPre|, |FilterReadPost| and |FilterWritePre|, | |
6760 |FilterWritePost| autocommands event are not triggered when | |
6761 'shelltemp' is off. | |
9533
9f921133ee90
commit https://github.com/vim/vim/commit/269f595f9eef584937e7eae70fde68cdd7da5bcf
Christian Brabandt <cb@256bit.org>
parents:
9464
diff
changeset
|
6762 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
|
6763 temp files. |
11160 | 6764 NOTE: This option is set to the Vim default value when 'compatible' |
6765 is reset. | |
168 | 6766 |
7 | 6767 *'shelltype'* *'st'* |
6768 'shelltype' 'st' number (default 0) | |
6769 global | |
16443
32a543152dc0
patch 8.1.1226: {not in Vi} remarks get in the way of useful help text
Bram Moolenaar <Bram@vim.org>
parents:
16439
diff
changeset
|
6770 {only for the Amiga} |
7 | 6771 On the Amiga this option influences the way how the commands work |
6772 which use a shell. | |
6773 0 and 1: always use the shell | |
6774 2 and 3: use the shell only to filter lines | |
6775 4 and 5: use shell only for ':sh' command | |
6776 When not using the shell, the command is executed directly. | |
6777 | |
6778 0 and 2: use "shell 'shellcmdflag' cmd" to start external commands | |
6779 1 and 3: use "shell cmd" to start external commands | |
6780 | |
3371 | 6781 *'shellxescape'* *'sxe'* |
6782 'shellxescape' 'sxe' string (default: ""; | |
18972 | 6783 for MS-Windows: "\"&|<>()@^") |
3371 | 6784 global |
6785 When 'shellxquote' is set to "(" then the characters listed in this | |
6786 option will be escaped with a '^' character. This makes it possible | |
6787 to execute most external commands with cmd.exe. | |
6788 | |
7 | 6789 *'shellxquote'* *'sxq'* |
6790 'shellxquote' 'sxq' string (default: ""; | |
3359 | 6791 for Win32, when 'shell' is cmd.exe: "(" |
25068
0ce24f734615
patch 8.2.3071: shell options are not set properly for PowerShell
Bram Moolenaar <Bram@vim.org>
parents:
25056
diff
changeset
|
6792 for Win32, when 'shell' is |
0ce24f734615
patch 8.2.3071: shell options are not set properly for PowerShell
Bram Moolenaar <Bram@vim.org>
parents:
25056
diff
changeset
|
6793 powershell.exe: "\"" |
3359 | 6794 for Win32, when 'shell' contains "sh" |
6795 somewhere: "\"" | |
7 | 6796 for Unix, when using system(): "\"") |
6797 global | |
6798 Quoting character(s), put around the command passed to the shell, for | |
6799 the "!" and ":!" commands. Includes the redirection. See | |
6800 'shellquote' to exclude the redirection. It's probably not useful | |
6801 to set both options. | |
3359 | 6802 When the value is '(' then ')' is appended. When the value is '"(' |
6803 then ')"' is appended. | |
6804 When the value is '(' then also see 'shellxescape'. | |
3352 | 6805 This is an empty string by default on most systems, but is known to be |
25084
beff72446e2e
patch 8.2.3079: Powershell core not supported by default
Bram Moolenaar <Bram@vim.org>
parents:
25068
diff
changeset
|
6806 useful for on Win32 version, either for cmd.exe, powershell.exe, or |
beff72446e2e
patch 8.2.3079: Powershell core not supported by default
Bram Moolenaar <Bram@vim.org>
parents:
25068
diff
changeset
|
6807 pwsh.exe which automatically strips off the first and last quote on a |
beff72446e2e
patch 8.2.3079: Powershell core not supported by default
Bram Moolenaar <Bram@vim.org>
parents:
25068
diff
changeset
|
6808 command, or 3rd-party shells such as the MKS Korn Shell or bash, where |
beff72446e2e
patch 8.2.3079: Powershell core not supported by default
Bram Moolenaar <Bram@vim.org>
parents:
25068
diff
changeset
|
6809 it should be "\"". The default is adjusted according the value of |
25068
0ce24f734615
patch 8.2.3071: shell options are not set properly for PowerShell
Bram Moolenaar <Bram@vim.org>
parents:
25056
diff
changeset
|
6810 'shell', to reduce the need to set this option by the user. See |
0ce24f734615
patch 8.2.3071: shell options are not set properly for PowerShell
Bram Moolenaar <Bram@vim.org>
parents:
25056
diff
changeset
|
6811 |dos-shell|. |
7 | 6812 This option cannot be set from a |modeline| or in the |sandbox|, for |
6813 security reasons. | |
6814 | |
6815 *'shiftround'* *'sr'* *'noshiftround'* *'nosr'* | |
6816 'shiftround' 'sr' boolean (default off) | |
6817 global | |
6818 Round indent to multiple of 'shiftwidth'. Applies to > and < | |
6819 commands. CTRL-T and CTRL-D in Insert mode always round the indent to | |
6820 a multiple of 'shiftwidth' (this is Vi compatible). | |
6821 NOTE: This option is reset when 'compatible' is set. | |
6822 | |
6823 *'shiftwidth'* *'sw'* | |
6824 'shiftwidth' 'sw' number (default 8) | |
6825 local to buffer | |
10 | 6826 Number of spaces to use for each step of (auto)indent. Used for |
7 | 6827 |'cindent'|, |>>|, |<<|, etc. |
3893 | 6828 When zero the 'ts' value will be used. Use the |shiftwidth()| |
6829 function to get the effective shiftwidth value. | |
7 | 6830 |
6831 *'shortmess'* *'shm'* | |
16533
5e25171e0e75
patch 8.1.1270: cannot see current match position
Bram Moolenaar <Bram@vim.org>
parents:
16447
diff
changeset
|
6832 'shortmess' 'shm' string (Vim default "filnxtToOS", Vi default: "S", |
5e25171e0e75
patch 8.1.1270: cannot see current match position
Bram Moolenaar <Bram@vim.org>
parents:
16447
diff
changeset
|
6833 POSIX default: "AS") |
7 | 6834 global |
6835 This option helps to avoid all the |hit-enter| prompts caused by file | |
6836 messages, for example with CTRL-G, and to avoid some other messages. | |
6837 It is a list of flags: | |
6838 flag meaning when present ~ | |
6839 f use "(3 of 5)" instead of "(file 3 of 5)" | |
6840 i use "[noeol]" instead of "[Incomplete last line]" | |
21154
9f9c26b3ddc5
patch 8.2.1128: the write message mentions characters, but it's bytes
Bram Moolenaar <Bram@vim.org>
parents:
21112
diff
changeset
|
6841 l use "999L, 888B" instead of "999 lines, 888 bytes" |
7 | 6842 m use "[+]" instead of "[Modified]" |
6843 n use "[New]" instead of "[New File]" | |
6844 r use "[RO]" instead of "[readonly]" | |
6845 w use "[w]" instead of "written" for file write message | |
6846 and "[a]" instead of "appended" for ':w >> file' command | |
6847 x use "[dos]" instead of "[dos format]", "[unix]" instead of | |
6848 "[unix format]" and "[mac]" instead of "[mac format]". | |
6849 a all of the above abbreviations | |
6850 | |
6851 o overwrite message for writing a file with subsequent message | |
6852 for reading a file (useful for ":wn" or when 'autowrite' on) | |
6853 O message for reading a file overwrites any previous message. | |
6854 Also for quickfix message (e.g., ":cn"). | |
6855 s don't give "search hit BOTTOM, continuing at TOP" or "search | |
16610 | 6856 hit TOP, continuing at BOTTOM" messages; when using the search |
6857 count do not show "W" after the count message (see S below) | |
7 | 6858 t truncate file message at the start if it is too long to fit |
6859 on the command-line, "<" will appear in the left most column. | |
6860 Ignored in Ex mode. | |
6861 T truncate other messages in the middle if they are too long to | |
233 | 6862 fit on the command line. "..." will appear in the middle. |
7 | 6863 Ignored in Ex mode. |
6864 W don't give "written" or "[w]" when writing a file | |
6865 A don't give the "ATTENTION" message when an existing swap file | |
6866 is found. | |
6867 I don't give the intro message when starting Vim |:intro|. | |
5946 | 6868 c don't give |ins-completion-menu| messages. For example, |
6869 "-- XXX completion (YYY)", "match 1 of 2", "The only match", | |
6870 "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
|
6871 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
|
6872 F don't give the file info when editing a file, like `:silent` |
16728
e55c26aaf484
patch 8.1.1366: using expressions in a modeline is unsafe
Bram Moolenaar <Bram@vim.org>
parents:
16610
diff
changeset
|
6873 was used for the command; note that this also affects messages |
e55c26aaf484
patch 8.1.1366: using expressions in a modeline is unsafe
Bram Moolenaar <Bram@vim.org>
parents:
16610
diff
changeset
|
6874 from autocommands |
16533
5e25171e0e75
patch 8.1.1270: cannot see current match position
Bram Moolenaar <Bram@vim.org>
parents:
16447
diff
changeset
|
6875 S do not show search count message when searching, e.g. |
5e25171e0e75
patch 8.1.1270: cannot see current match position
Bram Moolenaar <Bram@vim.org>
parents:
16447
diff
changeset
|
6876 "[1/5]" |
7 | 6877 |
6878 This gives you the opportunity to avoid that a change between buffers | |
6879 requires you to hit <Enter>, but still gives as useful a message as | |
6880 possible for the space available. To get the whole message that you | |
6881 would have got with 'shm' empty, use ":file!" | |
6882 Useful values: | |
6883 shm= No abbreviation of message. | |
6884 shm=a Abbreviation, but no loss of information. | |
6885 shm=at Abbreviation, and truncate message when necessary. | |
6886 | |
6887 NOTE: This option is set to the Vi default value when 'compatible' is | |
6888 set and to the Vim default value when 'compatible' is reset. | |
6889 | |
6890 *'shortname'* *'sn'* *'noshortname'* *'nosn'* | |
6891 'shortname' 'sn' boolean (default off) | |
6892 local to buffer | |
6893 Filenames are assumed to be 8 characters plus one extension of 3 | |
6894 characters. Multiple dots in file names are not allowed. When this | |
6895 option is on, dots in file names are replaced with underscores when | |
18972 | 6896 adding an extension (".~" or ".swp"). This option is useful |
7 | 6897 when editing files on an MS-DOS compatible filesystem, e.g., messydos |
19163 | 6898 or crossdos. |
7 | 6899 |
6900 *'showbreak'* *'sbr'* *E595* | |
6901 'showbreak' 'sbr' string (default "") | |
18574
8b0114ffde2b
patch 8.1.2281: 'showbreak' cannot be set for one window
Bram Moolenaar <Bram@vim.org>
parents:
18526
diff
changeset
|
6902 global or local to window |global-local| |
2570
71b56b4e7785
Make the references to features in the help more consistent. (Sylvain Hitier)
Bram Moolenaar <bram@vim.org>
parents:
2561
diff
changeset
|
6903 {not available when compiled without the |+linebreak| |
7 | 6904 feature} |
6905 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
|
6906 values are "> " or "+++ ": > |
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
6907 :set showbreak=>\ |
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
6908 < 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
|
6909 this: > |
2314
233eb4412f5d
Added 'colorcolumn' option. Partly by Gregor Uhlenheuer.
Bram Moolenaar <bram@vim.org>
parents:
2302
diff
changeset
|
6910 :let &showbreak = '+++ ' |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
6911 < Only printable single-cell characters are allowed, excluding <Tab> and |
7 | 6912 comma (in a future version the comma might be used to separate the |
6913 part that is shown at the end and at the start of a line). | |
6914 The characters are highlighted according to the '@' flag in | |
6915 'highlight'. | |
6916 Note that tabs after the showbreak will be displayed differently. | |
6917 If you want the 'showbreak' to appear in between line numbers, add the | |
6918 "n" flag to 'cpoptions'. | |
18574
8b0114ffde2b
patch 8.1.2281: 'showbreak' cannot be set for one window
Bram Moolenaar <Bram@vim.org>
parents:
18526
diff
changeset
|
6919 A window-local value overrules a global value. If the global value is |
8b0114ffde2b
patch 8.1.2281: 'showbreak' cannot be set for one window
Bram Moolenaar <Bram@vim.org>
parents:
18526
diff
changeset
|
6920 set and you want no value in the current window use NONE: > |
8b0114ffde2b
patch 8.1.2281: 'showbreak' cannot be set for one window
Bram Moolenaar <Bram@vim.org>
parents:
18526
diff
changeset
|
6921 :setlocal showbreak=NONE |
8b0114ffde2b
patch 8.1.2281: 'showbreak' cannot be set for one window
Bram Moolenaar <Bram@vim.org>
parents:
18526
diff
changeset
|
6922 < |
7 | 6923 *'showcmd'* *'sc'* *'noshowcmd'* *'nosc'* |
9669
284b4eb307fc
commit https://github.com/vim/vim/commit/8c08b5b569e2a9e9f63dea514591ecfa2d3bb392
Christian Brabandt <cb@256bit.org>
parents:
9665
diff
changeset
|
6924 '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
|
6925 Vi default: off, set in |defaults.vim|) |
7 | 6926 global |
6927 {not available when compiled without the | |
6928 |+cmdline_info| feature} | |
1152 | 6929 Show (partial) command in the last line of the screen. Set this |
6930 option off if your terminal is slow. | |
7 | 6931 In Visual mode the size of the selected area is shown: |
6932 - 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
|
6933 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
|
6934 means two characters and six bytes. |
7 | 6935 - When selecting more than one line, the number of lines. |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
6936 - When selecting a block, the size in screen characters: |
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
6937 {lines}x{columns}. |
7 | 6938 NOTE: This option is set to the Vi default value when 'compatible' is |
6939 set and to the Vim default value when 'compatible' is reset. | |
6940 | |
6941 *'showfulltag'* *'sft'* *'noshowfulltag'* *'nosft'* | |
6942 'showfulltag' 'sft' boolean (default off) | |
6943 global | |
6944 When completing a word in insert mode (see |ins-completion|) from the | |
6945 tags file, show both the tag name and a tidied-up form of the search | |
10 | 6946 pattern (if there is one) as possible matches. Thus, if you have |
7 | 6947 matched a C function, you can see a template for what arguments are |
6948 required (coding style permitting). | |
1621 | 6949 Note that this doesn't work well together with having "longest" in |
6950 'completeopt', because the completion from the search pattern may not | |
6951 match the typed text. | |
7 | 6952 |
6953 *'showmatch'* *'sm'* *'noshowmatch'* *'nosm'* | |
6954 'showmatch' 'sm' boolean (default off) | |
6955 global | |
6956 When a bracket is inserted, briefly jump to the matching one. The | |
6957 jump is only done if the match can be seen on the screen. The time to | |
6958 show the match can be set with 'matchtime'. | |
6959 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
|
6960 seen or not). |
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 When the 'm' flag is not included in 'cpoptions', typing a character |
6964 will immediately move the cursor back to where it belongs. | |
6965 See the "sm" field in 'guicursor' for setting the cursor shape and | |
6966 blinking when showing the match. | |
6967 The 'matchpairs' option can be used to specify the characters to show | |
6968 matches for. 'rightleft' and 'revins' are used to look for opposite | |
6969 matches. | |
699 | 6970 Also see the matchparen plugin for highlighting the match when moving |
6971 around |pi_paren.txt|. | |
6972 Note: Use of the short form is rated PG. | |
7 | 6973 |
6974 *'showmode'* *'smd'* *'noshowmode'* *'nosmd'* | |
6975 'showmode' 'smd' boolean (Vim default: on, Vi default: off) | |
6976 global | |
6977 If in Insert, Replace or Visual mode put a message on the last line. | |
6978 Use the 'M' flag in 'highlight' to set the type of highlighting for | |
6979 this message. | |
10 | 6980 When |XIM| may be used the message will include "XIM". But this |
7 | 6981 doesn't mean XIM is really active, especially when 'imactivatekey' is |
6982 not set. | |
6983 NOTE: This option is set to the Vi default value when 'compatible' is | |
6984 set and to the Vim default value when 'compatible' is reset. | |
6985 | |
677 | 6986 *'showtabline'* *'stal'* |
6987 'showtabline' 'stal' number (default 1) | |
6988 global | |
6989 The value of this option specifies when the line with tab page labels | |
6990 will be displayed: | |
6991 0: never | |
6992 1: only if there are at least two tab pages | |
6993 2: always | |
6994 This is both for the GUI and non-GUI implementation of the tab pages | |
6995 line. | |
6996 See |tab-page| for more information about tab pages. | |
6997 | |
7 | 6998 *'sidescroll'* *'ss'* |
6999 'sidescroll' 'ss' number (default 0) | |
7000 global | |
7001 The minimal number of columns to scroll horizontally. Used only when | |
7002 the 'wrap' option is off and the cursor is moved off of the screen. | |
7003 When it is zero the cursor will be put in the middle of the screen. | |
7004 When using a slow terminal set it to a large number or 0. When using | |
7005 a fast terminal use a small number or 1. Not used for "zh" and "zl" | |
7006 commands. | |
7007 | |
7008 *'sidescrolloff'* *'siso'* | |
7009 'sidescrolloff' 'siso' number (default 0) | |
15713
ad8b2c109b22
patch 8.1.0864: cannot have a local value for 'scrolloff' and 'sidescrolloff'
Bram Moolenaar <Bram@vim.org>
parents:
15701
diff
changeset
|
7010 global or local to window |global-local| |
7 | 7011 The minimal number of screen columns to keep to the left and to the |
534 | 7012 right of the cursor if 'nowrap' is set. Setting this option to a |
7013 value greater than 0 while having |'sidescroll'| also at a non-zero | |
7014 value makes some context visible in the line you are scrolling in | |
7015 horizontally (except at beginning of the line). Setting this option | |
7016 to a large value (like 999) has the effect of keeping the cursor | |
7017 horizontally centered in the window, as long as one does not come too | |
7018 close to the beginning of the line. | |
15713
ad8b2c109b22
patch 8.1.0864: cannot have a local value for 'scrolloff' and 'sidescrolloff'
Bram Moolenaar <Bram@vim.org>
parents:
15701
diff
changeset
|
7019 After using the local value, go back the global value with one of |
ad8b2c109b22
patch 8.1.0864: cannot have a local value for 'scrolloff' and 'sidescrolloff'
Bram Moolenaar <Bram@vim.org>
parents:
15701
diff
changeset
|
7020 these two: > |
ad8b2c109b22
patch 8.1.0864: cannot have a local value for 'scrolloff' and 'sidescrolloff'
Bram Moolenaar <Bram@vim.org>
parents:
15701
diff
changeset
|
7021 setlocal sidescrolloff< |
ad8b2c109b22
patch 8.1.0864: cannot have a local value for 'scrolloff' and 'sidescrolloff'
Bram Moolenaar <Bram@vim.org>
parents:
15701
diff
changeset
|
7022 setlocal sidescrolloff=-1 |
ad8b2c109b22
patch 8.1.0864: cannot have a local value for 'scrolloff' and 'sidescrolloff'
Bram Moolenaar <Bram@vim.org>
parents:
15701
diff
changeset
|
7023 < NOTE: This option is set to 0 when 'compatible' is set. |
7 | 7024 |
7025 Example: Try this together with 'sidescroll' and 'listchars' as | |
7026 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
|
7027 onto the "extends" character: > |
7 | 7028 |
7029 :set nowrap sidescroll=1 listchars=extends:>,precedes:< | |
7030 :set sidescrolloff=1 | |
9852
4eea48b76d03
commit https://github.com/vim/vim/commit/95ec9d6a6ab3117d60ff638670a803d43974ba51
Christian Brabandt <cb@256bit.org>
parents:
9737
diff
changeset
|
7031 < |
4eea48b76d03
commit https://github.com/vim/vim/commit/95ec9d6a6ab3117d60ff638670a803d43974ba51
Christian Brabandt <cb@256bit.org>
parents:
9737
diff
changeset
|
7032 *'signcolumn'* *'scl'* |
4eea48b76d03
commit https://github.com/vim/vim/commit/95ec9d6a6ab3117d60ff638670a803d43974ba51
Christian Brabandt <cb@256bit.org>
parents:
9737
diff
changeset
|
7033 'signcolumn' 'scl' string (default "auto") |
4eea48b76d03
commit https://github.com/vim/vim/commit/95ec9d6a6ab3117d60ff638670a803d43974ba51
Christian Brabandt <cb@256bit.org>
parents:
9737
diff
changeset
|
7034 local to window |
4eea48b76d03
commit https://github.com/vim/vim/commit/95ec9d6a6ab3117d60ff638670a803d43974ba51
Christian Brabandt <cb@256bit.org>
parents:
9737
diff
changeset
|
7035 {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
|
7036 feature} |
9860
9eaf8ef656e9
commit https://github.com/vim/vim/commit/0952131376a517fc12dc5ae908a97018b4ee23f0
Christian Brabandt <cb@256bit.org>
parents:
9852
diff
changeset
|
7037 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
|
7038 "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
|
7039 "no" never |
9eaf8ef656e9
commit https://github.com/vim/vim/commit/0952131376a517fc12dc5ae908a97018b4ee23f0
Christian Brabandt <cb@256bit.org>
parents:
9852
diff
changeset
|
7040 "yes" always |
17129
4fb68abc770f
patch 8.1.1564: sign column takes up space
Bram Moolenaar <Bram@vim.org>
parents:
16808
diff
changeset
|
7041 "number" display signs in the 'number' column. If the number |
17161 | 7042 column is not present, then behaves like "auto". |
7 | 7043 |
7044 | |
7045 *'smartcase'* *'scs'* *'nosmartcase'* *'noscs'* | |
7046 'smartcase' 'scs' boolean (default off) | |
7047 global | |
7048 Override the 'ignorecase' option if the search pattern contains upper | |
7049 case characters. Only used when the search pattern is typed and | |
7050 'ignorecase' option is on. Used for the commands "/", "?", "n", "N", | |
3557 | 7051 ":g" and ":s". Not used for "*", "#", "gd", tag search, etc. After |
7 | 7052 "*" and "#" you can make 'smartcase' used by doing a "/" command, |
7053 recalling the search pattern from history and hitting <Enter>. | |
7054 NOTE: This option is reset when 'compatible' is set. | |
7055 | |
7056 *'smartindent'* *'si'* *'nosmartindent'* *'nosi'* | |
7057 'smartindent' 'si' boolean (default off) | |
7058 local to buffer | |
7059 {not available when compiled without the | |
7060 |+smartindent| feature} | |
7061 Do smart autoindenting when starting a new line. Works for C-like | |
7062 programs, but can also be used for other languages. 'cindent' does | |
7063 something like this, works better in most cases, but is more strict, | |
2662 | 7064 see |C-indenting|. When 'cindent' is on or 'indentexpr' is set, |
2642 | 7065 setting 'si' has no effect. 'indentexpr' is a more advanced |
7066 alternative. | |
7 | 7067 Normally 'autoindent' should also be on when using 'smartindent'. |
7068 An indent is automatically inserted: | |
7069 - After a line ending in '{'. | |
7070 - After a line starting with a keyword from 'cinwords'. | |
7071 - Before a line starting with '}' (only with the "O" command). | |
7072 When typing '}' as the first character in a new line, that line is | |
7073 given the same indent as the matching '{'. | |
7074 When typing '#' as the first character in a new line, the indent for | |
7075 that line is removed, the '#' is put in the first column. The indent | |
10 | 7076 is restored for the next line. If you don't want this, use this |
7 | 7077 mapping: ":inoremap # X^H#", where ^H is entered with CTRL-V CTRL-H. |
7078 When using the ">>" command, lines starting with '#' are not shifted | |
7079 right. | |
11160 | 7080 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
|
7081 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
|
7082 reset. |
7 | 7083 |
7084 *'smarttab'* *'sta'* *'nosmarttab'* *'nosta'* | |
7085 'smarttab' 'sta' boolean (default off) | |
7086 global | |
7087 When on, a <Tab> in front of a line inserts blanks according to | |
648 | 7088 'shiftwidth'. 'tabstop' or 'softtabstop' is used in other places. A |
7089 <BS> will delete a 'shiftwidth' worth of space at the start of the | |
7090 line. | |
650 | 7091 When off, a <Tab> always inserts blanks according to 'tabstop' or |
648 | 7092 'softtabstop'. 'shiftwidth' is only used for shifting text left or |
7093 right |shift-left-right|. | |
1263 | 7094 What gets inserted (a <Tab> or spaces) depends on the 'expandtab' |
7 | 7095 option. Also see |ins-expandtab|. When 'expandtab' is not set, the |
11 | 7096 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
|
7097 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
|
7098 reset. |
7 | 7099 NOTE: This option is reset when 'compatible' is set. |
7100 | |
7101 *'softtabstop'* *'sts'* | |
7102 'softtabstop' 'sts' number (default 0) | |
7103 local to buffer | |
7104 Number of spaces that a <Tab> counts for while performing editing | |
7105 operations, like inserting a <Tab> or using <BS>. It "feels" like | |
7106 <Tab>s are being inserted, while in fact a mix of spaces and <Tab>s is | |
7107 used. This is useful to keep the 'ts' setting at its standard value | |
7108 of 8, while being able to edit like it is set to 'sts'. However, | |
7109 commands like "x" still work on the actual characters. | |
7110 When 'sts' is zero, this feature is off. | |
3893 | 7111 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
|
7112 '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
|
7113 when 'paste' is reset. |
7 | 7114 See also |ins-expandtab|. When 'expandtab' is not set, the number of |
7115 spaces is minimized by using <Tab>s. | |
7116 The 'L' flag in 'cpoptions' changes how tabs are used when 'list' is | |
7117 set. | |
7118 NOTE: This option is set to 0 when 'compatible' is set. | |
7119 | |
14175
2ad722003b36
patch 8.1.0105: all tab stops are the same
Christian Brabandt <cb@256bit.org>
parents:
14019
diff
changeset
|
7120 If Vim is compiled with the |+vartabs| feature then the value of |
2ad722003b36
patch 8.1.0105: all tab stops are the same
Christian Brabandt <cb@256bit.org>
parents:
14019
diff
changeset
|
7121 'softtabstop' will be ignored if |'varsofttabstop'| is set to |
2ad722003b36
patch 8.1.0105: all tab stops are the same
Christian Brabandt <cb@256bit.org>
parents:
14019
diff
changeset
|
7122 anything other than an empty string. |
2ad722003b36
patch 8.1.0105: all tab stops are the same
Christian Brabandt <cb@256bit.org>
parents:
14019
diff
changeset
|
7123 |
221 | 7124 *'spell'* *'nospell'* |
7125 'spell' boolean (default off) | |
7126 local to window | |
7127 {not available when compiled without the |+syntax| | |
7128 feature} | |
7129 When on spell checking will be done. See |spell|. | |
236 | 7130 The languages are specified with 'spelllang'. |
221 | 7131 |
386 | 7132 *'spellcapcheck'* *'spc'* |
389 | 7133 'spellcapcheck' 'spc' string (default "[.?!]\_[\])'" \t]\+") |
386 | 7134 local to buffer |
7135 {not available when compiled without the |+syntax| | |
7136 feature} | |
7137 Pattern to locate the end of a sentence. The following word will be | |
7138 checked to start with a capital letter. If not then it is highlighted | |
484 | 7139 with SpellCap |hl-SpellCap| (unless the word is also badly spelled). |
386 | 7140 When this check is not wanted make this option empty. |
7141 Only used when 'spell' is set. | |
389 | 7142 Be careful with special characters, see |option-backslash| about |
7143 including spaces and backslashes. | |
480 | 7144 To set this option automatically depending on the language, see |
7145 |set-spc-auto|. | |
386 | 7146 |
314 | 7147 *'spellfile'* *'spf'* |
7148 'spellfile' 'spf' string (default empty) | |
7149 local to buffer | |
7150 {not available when compiled without the |+syntax| | |
7151 feature} | |
7152 Name of the word list file where words are added for the |zg| and |zw| | |
401 | 7153 commands. It must end in ".{encoding}.add". You need to include the |
7154 path, otherwise the file is placed in the current directory. | |
386 | 7155 *E765* |
7156 It may also be a comma separated list of names. A count before the | |
7157 |zg| and |zw| commands can be used to access each. This allows using | |
7158 a personal word list file and a project word list file. | |
314 | 7159 When a word is added while this option is empty Vim will set it for |
819 | 7160 you: Using the first directory in 'runtimepath' that is writable. If |
7161 there is no "spell" directory yet it will be created. For the file | |
7162 name the first language name that appears in 'spelllang' is used, | |
353 | 7163 ignoring the region. |
7164 The resulting ".spl" file will be used for spell checking, it does not | |
7165 have to appear in 'spelllang'. | |
7166 Normally one file is used for all regions, but you can add the region | |
7167 name if you want to. However, it will then only be used when | |
7168 'spellfile' is set to it, for entries in 'spelllang' only files | |
7169 without region name will be found. | |
336 | 7170 This option cannot be set from a |modeline| or in the |sandbox|, for |
7171 security reasons. | |
314 | 7172 |
221 | 7173 *'spelllang'* *'spl'* |
314 | 7174 'spelllang' 'spl' string (default "en") |
221 | 7175 local to buffer |
7176 {not available when compiled without the |+syntax| | |
7177 feature} | |
353 | 7178 A comma separated list of word list names. When the 'spell' option is |
7179 on spellchecking will be done for these languages. Example: > | |
7180 set spelllang=en_us,nl,medical | |
7181 < This means US English, Dutch and medical words are recognized. Words | |
7182 that are not recognized will be highlighted. | |
16380 | 7183 The word list name must consist of alphanumeric characters, a dash or |
7184 an underscore. It should not include a comma or dot. Using a dash is | |
353 | 7185 recommended to separate the two letter language name from a |
7186 specification. Thus "en-rare" is used for rare English words. | |
7187 A region name must come last and have the form "_xx", where "xx" is | |
7188 the two-letter, lower case region name. You can use more than one | |
7189 region by listing them: "en_us,en_ca" supports both US and Canadian | |
7190 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
|
7191 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
|
7192 en_ca, en_gb and en_us). |
5477 | 7193 If the name "cjk" is included East Asian characters are excluded from |
7194 spell checking. This is useful when editing text that also has Asian | |
7195 words. | |
25773 | 7196 Note that the "medical" dictionary does not exist, it is just an |
7197 example of a longer name. | |
484 | 7198 *E757* |
419 | 7199 As a special case the name of a .spl file can be given as-is. The |
7200 first "_xx" in the name is removed and used as the region name | |
7201 (_xx is an underscore, two letters and followed by a non-letter). | |
7202 This is mainly for testing purposes. You must make sure the correct | |
7203 encoding is used, Vim doesn't check it. | |
236 | 7204 When 'encoding' is set the word lists are reloaded. Thus it's a good |
419 | 7205 idea to set 'spelllang' after setting 'encoding' to avoid loading the |
7206 files twice. | |
353 | 7207 How the related spell files are found is explained here: |spell-load|. |
221 | 7208 |
653 | 7209 If the |spellfile.vim| plugin is active and you use a language name |
7210 for which Vim cannot find the .spl file in 'runtimepath' the plugin | |
7211 will ask you if you want to download the file. | |
7212 | |
480 | 7213 After this option has been set successfully, Vim will source the files |
7214 "spell/LANG.vim" in 'runtimepath'. "LANG" is the value of 'spelllang' | |
15068 | 7215 up to the first character that is not an ASCII letter or number and |
7216 not a dash. Also see |set-spc-auto|. | |
480 | 7217 |
20802
ed00f0fbdaef
patch 8.2.0953: spell checking doesn't work for CamelCased words
Bram Moolenaar <Bram@vim.org>
parents:
20758
diff
changeset
|
7218 *'spelloptions'* *'spo'* |
ed00f0fbdaef
patch 8.2.0953: spell checking doesn't work for CamelCased words
Bram Moolenaar <Bram@vim.org>
parents:
20758
diff
changeset
|
7219 'spelloptions' 'spo' string (default "") |
ed00f0fbdaef
patch 8.2.0953: spell checking doesn't work for CamelCased words
Bram Moolenaar <Bram@vim.org>
parents:
20758
diff
changeset
|
7220 local to buffer |
ed00f0fbdaef
patch 8.2.0953: spell checking doesn't work for CamelCased words
Bram Moolenaar <Bram@vim.org>
parents:
20758
diff
changeset
|
7221 {not available when compiled without the |+syntax| |
ed00f0fbdaef
patch 8.2.0953: spell checking doesn't work for CamelCased words
Bram Moolenaar <Bram@vim.org>
parents:
20758
diff
changeset
|
7222 feature} |
ed00f0fbdaef
patch 8.2.0953: spell checking doesn't work for CamelCased words
Bram Moolenaar <Bram@vim.org>
parents:
20758
diff
changeset
|
7223 A comma separated list of options for spell checking: |
ed00f0fbdaef
patch 8.2.0953: spell checking doesn't work for CamelCased words
Bram Moolenaar <Bram@vim.org>
parents:
20758
diff
changeset
|
7224 camel When a word is CamelCased, assume "Cased" is a |
ed00f0fbdaef
patch 8.2.0953: spell checking doesn't work for CamelCased words
Bram Moolenaar <Bram@vim.org>
parents:
20758
diff
changeset
|
7225 separate word: every upper-case character in a word |
ed00f0fbdaef
patch 8.2.0953: spell checking doesn't work for CamelCased words
Bram Moolenaar <Bram@vim.org>
parents:
20758
diff
changeset
|
7226 that comes after a lower case character indicates the |
ed00f0fbdaef
patch 8.2.0953: spell checking doesn't work for CamelCased words
Bram Moolenaar <Bram@vim.org>
parents:
20758
diff
changeset
|
7227 start of a new word. |
480 | 7228 |
344 | 7229 *'spellsuggest'* *'sps'* |
7230 'spellsuggest' 'sps' string (default "best") | |
7231 global | |
7232 {not available when compiled without the |+syntax| | |
7233 feature} | |
593 | 7234 Methods used for spelling suggestions. Both for the |z=| command and |
374 | 7235 the |spellsuggest()| function. This is a comma-separated list of |
7236 items: | |
7237 | |
7238 best Internal method that works best for English. Finds | |
7239 changes like "fast" and uses a bit of sound-a-like | |
7240 scoring to improve the ordering. | |
7241 | |
7242 double Internal method that uses two methods and mixes the | |
7243 results. The first method is "fast", the other method | |
344 | 7244 computes how much the suggestion sounds like the bad |
374 | 7245 word. That only works when the language specifies |
7246 sound folding. Can be slow and doesn't always give | |
7247 better results. | |
7248 | |
7249 fast Internal method that only checks for simple changes: | |
7250 character inserts/deletes/swaps. Works well for | |
7251 simple typing mistakes. | |
7252 | |
593 | 7253 {number} The maximum number of suggestions listed for |z=|. |
484 | 7254 Not used for |spellsuggest()|. The number of |
7255 suggestions is never more than the value of 'lines' | |
7256 minus two. | |
7257 | |
374 | 7258 file:{filename} Read file {filename}, which must have two columns, |
7259 separated by a slash. The first column contains the | |
7260 bad word, the second column the suggested good word. | |
7261 Example: | |
7262 theribal/terrible ~ | |
7263 Use this for common mistakes that do not appear at the | |
7264 top of the suggestion list with the internal methods. | |
7265 Lines without a slash are ignored, use this for | |
7266 comments. | |
5862 | 7267 The word in the second column must be correct, |
7268 otherwise it will not be used. Add the word to an | |
7269 ".add" file if it is currently flagged as a spelling | |
7270 mistake. | |
374 | 7271 The file is used for all languages. |
7272 | |
7273 expr:{expr} Evaluate expression {expr}. Use a function to avoid | |
7274 trouble with spaces. |v:val| holds the badly spelled | |
7275 word. The expression must evaluate to a List of | |
7276 Lists, each with a suggestion and a score. | |
7277 Example: | |
11062 | 7278 [['the', 33], ['that', 44]] ~ |
593 | 7279 Set 'verbose' and use |z=| to see the scores that the |
374 | 7280 internal methods use. A lower score is better. |
7281 This may invoke |spellsuggest()| if you temporarily | |
7282 set 'spellsuggest' to exclude the "expr:" part. | |
7283 Errors are silently ignored, unless you set the | |
7284 'verbose' option to a non-zero value. | |
7285 | |
7286 Only one of "best", "double" or "fast" may be used. The others may | |
7287 appear several times in any order. Example: > | |
7288 :set sps=file:~/.vim/sugg,best,expr:MySuggest() | |
7289 < | |
7290 This option cannot be set from a |modeline| or in the |sandbox|, for | |
7291 security reasons. | |
344 | 7292 |
7293 | |
7 | 7294 *'splitbelow'* *'sb'* *'nosplitbelow'* *'nosb'* |
7295 'splitbelow' 'sb' boolean (default off) | |
7296 global | |
7297 When on, splitting a window will put the new window below the current | |
7298 one. |:split| | |
7299 | |
7300 *'splitright'* *'spr'* *'nosplitright'* *'nospr'* | |
7301 'splitright' 'spr' boolean (default off) | |
7302 global | |
7303 When on, splitting a window will put the new window right of the | |
7304 current one. |:vsplit| | |
7305 | |
7306 *'startofline'* *'sol'* *'nostartofline'* *'nosol'* | |
7307 'startofline' 'sol' boolean (default on) | |
7308 global | |
7309 When "on" the commands listed below move the cursor to the first | |
11 | 7310 non-blank of the line. When off the cursor is kept in the same column |
10 | 7311 (if possible). This applies to the commands: CTRL-D, CTRL-U, CTRL-B, |
11 | 7312 CTRL-F, "G", "H", "M", "L", gg, and to the commands "d", "<<" and ">>" |
7 | 7313 with a linewise operator, with "%" with a count and to buffer changing |
7314 commands (CTRL-^, :bnext, :bNext, etc.). Also for an Ex command that | |
7315 only has a line number, e.g., ":25" or ":+". | |
7316 In case of buffer changing commands the cursor is placed at the column | |
7317 where it was the last time the buffer was edited. | |
7318 NOTE: This option is set when 'compatible' is set. | |
7319 | |
2709 | 7320 *'statusline'* *'stl'* *E540* *E542* |
7 | 7321 'statusline' 'stl' string (default empty) |
40 | 7322 global or local to window |global-local| |
7 | 7323 {not available when compiled without the |+statusline| |
7324 feature} | |
7325 When nonempty, this option determines the content of the status line. | |
7326 Also see |status-line|. | |
7327 | |
7328 The option consists of printf style '%' items interspersed with | |
7329 normal text. Each status line item is of the form: | |
7330 %-0{minwid}.{maxwid}{item} | |
7876
93f747af7b58
commit https://github.com/vim/vim/commit/5e9b2fa9bb0e6061cf18457c173cd141a5dc9c92
Christian Brabandt <cb@256bit.org>
parents:
7687
diff
changeset
|
7331 All fields except the {item} are optional. A single percent sign can |
22721
92a100fc5e17
patch 8.2.1909: number of status line items is limited to 80
Bram Moolenaar <Bram@vim.org>
parents:
22565
diff
changeset
|
7332 be given as "%%". |
7 | 7333 |
680 | 7334 When the option starts with "%!" then it is used as an expression, |
7335 evaluated and the result is used as the option value. Example: > | |
7336 :set statusline=%!MyStatusLine() | |
16740
dc85d49349f7
patch 8.1.1372: when evaluating 'statusline' the current window is unknown
Bram Moolenaar <Bram@vim.org>
parents:
16728
diff
changeset
|
7337 < The *g:statusline_winid* variable will be set to the |window-ID| of the |
dc85d49349f7
patch 8.1.1372: when evaluating 'statusline' the current window is unknown
Bram Moolenaar <Bram@vim.org>
parents:
16728
diff
changeset
|
7338 window that the status line belongs to. |
dc85d49349f7
patch 8.1.1372: when evaluating 'statusline' the current window is unknown
Bram Moolenaar <Bram@vim.org>
parents:
16728
diff
changeset
|
7339 The result can contain %{} items that will be evaluated too. |
3445 | 7340 Note that the "%!" expression is evaluated in the context of the |
7341 current window and buffer, while %{} items are evaluated in the | |
7342 context of the window that the statusline belongs to. | |
680 | 7343 |
7344 When there is error while evaluating the option then it will be made | |
7345 empty to avoid further errors. Otherwise screen updating would loop. | |
7346 | |
7 | 7347 Note that the only effect of 'ruler' when this option is set (and |
7348 'laststatus' is 2) is controlling the output of |CTRL-G|. | |
7349 | |
7350 field meaning ~ | |
233 | 7351 - Left justify the item. The default is right justified |
7 | 7352 when minwid is larger than the length of the item. |
233 | 7353 0 Leading zeroes in numeric items. Overridden by '-'. |
7 | 7354 minwid Minimum width of the item, padding as set by '-' & '0'. |
7355 Value must be 50 or less. | |
10 | 7356 maxwid Maximum width of the item. Truncation occurs with a '<' |
7 | 7357 on the left for text items. Numeric items will be |
7358 shifted down to maxwid-2 digits followed by '>'number | |
7359 where number is the amount of missing digits, much like | |
7360 an exponential notation. | |
7361 item A one letter code as described below. | |
7362 | |
7363 Following is a description of the possible statusline items. The | |
7364 second character in "item" is the type: | |
7365 N for number | |
7366 S for string | |
7367 F for flags as described below | |
7368 - not applicable | |
7369 | |
7370 item meaning ~ | |
1152 | 7371 f S Path to the file in the buffer, as typed or relative to current |
7372 directory. | |
7 | 7373 F S Full path to the file in the buffer. |
7374 t S File name (tail) of file in the buffer. | |
1698 | 7375 m F Modified flag, text is "[+]"; "[-]" if 'modifiable' is off. |
7 | 7376 M F Modified flag, text is ",+" or ",-". |
1698 | 7377 r F Readonly flag, text is "[RO]". |
7 | 7378 R F Readonly flag, text is ",RO". |
1698 | 7379 h F Help buffer flag, text is "[help]". |
7 | 7380 H F Help buffer flag, text is ",HLP". |
1698 | 7381 w F Preview window flag, text is "[Preview]". |
7 | 7382 W F Preview window flag, text is ",PRV". |
1698 | 7383 y F Type of file in the buffer, e.g., "[vim]". See 'filetype'. |
7 | 7384 Y F Type of file in the buffer, e.g., ",VIM". See 'filetype'. |
2411
68e394361ca3
Add "q" item for 'statusline'. Add w:quickfix_title. (Lech Lorens)
Bram Moolenaar <bram@vim.org>
parents:
2400
diff
changeset
|
7385 q S "[Quickfix List]", "[Location List]" or empty. |
7 | 7386 k S Value of "b:keymap_name" or 'keymap' when |:lmap| mappings are |
7387 being used: "<keymap>" | |
7388 n N Buffer number. | |
2709 | 7389 b N Value of character under cursor. |
7 | 7390 B N As above, in hexadecimal. |
7391 o N Byte number in file of byte under cursor, first byte is 1. | |
7392 Mnemonic: Offset from start of file (with one added) | |
7393 {not available when compiled without |+byte_offset| feature} | |
7394 O N As above, in hexadecimal. | |
233 | 7395 N N Printer page number. (Only works in the 'printheader' option.) |
7 | 7396 l N Line number. |
7397 L N Number of lines in buffer. | |
22328 | 7398 c N Column number (byte index). |
7399 v N Virtual column number (screen column). | |
10 | 7400 V N Virtual column number as -{num}. Not displayed if equal to 'c'. |
7 | 7401 p N Percentage through file in lines as in |CTRL-G|. |
7402 P S Percentage through file of displayed window. This is like the | |
5055 | 7403 percentage described for 'ruler'. Always 3 in length, unless |
7404 translated. | |
233 | 7405 a S Argument list status as in default title. ({current} of {max}) |
7 | 7406 Empty if the argument file count is zero or one. |
680 | 7407 { NF Evaluate expression between '%{' and '}' and substitute result. |
13742
a34b1323286c
patch 8.0.1743: terminal window options are named inconsistently
Christian Brabandt <cb@256bit.org>
parents:
13735
diff
changeset
|
7408 Note that there is no '%' before the closing '}'. The |
a34b1323286c
patch 8.0.1743: terminal window options are named inconsistently
Christian Brabandt <cb@256bit.org>
parents:
13735
diff
changeset
|
7409 expression cannot contain a '}' character, call a function to |
18719 | 7410 work around that. See |stl-%{| below. |
24630
4cf4d7a71fac
patch 8.2.2854: custom statusline cannot contain % items
Bram Moolenaar <Bram@vim.org>
parents:
24600
diff
changeset
|
7411 {% - This is almost same as { except the result of the expression is |
4cf4d7a71fac
patch 8.2.2854: custom statusline cannot contain % items
Bram Moolenaar <Bram@vim.org>
parents:
24600
diff
changeset
|
7412 re-evaluated as a statusline format string. Thus if the |
4cf4d7a71fac
patch 8.2.2854: custom statusline cannot contain % items
Bram Moolenaar <Bram@vim.org>
parents:
24600
diff
changeset
|
7413 return value of expr contains % items they will get expanded. |
4cf4d7a71fac
patch 8.2.2854: custom statusline cannot contain % items
Bram Moolenaar <Bram@vim.org>
parents:
24600
diff
changeset
|
7414 The expression can contain the } character, the end of |
4cf4d7a71fac
patch 8.2.2854: custom statusline cannot contain % items
Bram Moolenaar <Bram@vim.org>
parents:
24600
diff
changeset
|
7415 expression is denoted by %}. |
25973 | 7416 For example: > |
24630
4cf4d7a71fac
patch 8.2.2854: custom statusline cannot contain % items
Bram Moolenaar <Bram@vim.org>
parents:
24600
diff
changeset
|
7417 func! Stl_filename() abort |
4cf4d7a71fac
patch 8.2.2854: custom statusline cannot contain % items
Bram Moolenaar <Bram@vim.org>
parents:
24600
diff
changeset
|
7418 return "%t" |
4cf4d7a71fac
patch 8.2.2854: custom statusline cannot contain % items
Bram Moolenaar <Bram@vim.org>
parents:
24600
diff
changeset
|
7419 endfunc |
4cf4d7a71fac
patch 8.2.2854: custom statusline cannot contain % items
Bram Moolenaar <Bram@vim.org>
parents:
24600
diff
changeset
|
7420 < `stl=%{Stl_filename()}` results in `"%t"` |
4cf4d7a71fac
patch 8.2.2854: custom statusline cannot contain % items
Bram Moolenaar <Bram@vim.org>
parents:
24600
diff
changeset
|
7421 `stl=%{%Stl_filename()%}` results in `"Name of current file"` |
25973 | 7422 %} - End of `{%` expression |
7 | 7423 ( - Start of item group. Can be used for setting the width and |
7424 alignment of a section. Must be followed by %) somewhere. | |
7425 ) - End of item group. No width fields allowed. | |
681 | 7426 T N For 'tabline': start of tab page N label. Use %T after the last |
7427 label. This information is used for mouse clicks. | |
7428 X N For 'tabline': start of close tab N label. Use %X after the | |
7429 label, e.g.: %3Xclose%X. Use %999X for a "close current tab" | |
7430 mark. This information is used for mouse clicks. | |
7 | 7431 < - Where to truncate line if too long. Default is at the start. |
7432 No width fields allowed. | |
7433 = - Separation point between left and right aligned items. | |
7434 No width fields allowed. | |
680 | 7435 # - Set highlight group. The name must follow and then a # again. |
7436 Thus use %#HLname# for highlight group HLname. The same | |
7437 highlighting is used, also for the statusline of non-current | |
7438 windows. | |
7 | 7439 * - Set highlight group to User{N}, where {N} is taken from the |
233 | 7440 minwid field, e.g. %1*. Restore normal highlight with %* or %0*. |
7 | 7441 The difference between User{N} and StatusLine will be applied |
7442 to StatusLineNC for the statusline of non-current windows. | |
7443 The number N must be between 1 and 9. See |hl-User1..9| | |
7444 | |
1698 | 7445 When displaying a flag, Vim removes the leading comma, if any, when |
7446 that flag comes right after plaintext. This will make a nice display | |
7447 when flags are used like in the examples below. | |
7 | 7448 |
233 | 7449 When all items in a group becomes an empty string (i.e. flags that are |
7 | 7450 not set) and a minwid is not set for the group, the whole group will |
7451 become empty. This will make a group like the following disappear | |
7452 completely from the statusline when none of the flags are set. > | |
7453 :set statusline=...%(\ [%M%R%H]%)... | |
16740
dc85d49349f7
patch 8.1.1372: when evaluating 'statusline' the current window is unknown
Bram Moolenaar <Bram@vim.org>
parents:
16728
diff
changeset
|
7454 < Beware that an expression is evaluated each and every time the status |
dc85d49349f7
patch 8.1.1372: when evaluating 'statusline' the current window is unknown
Bram Moolenaar <Bram@vim.org>
parents:
16728
diff
changeset
|
7455 line is displayed. |
18719 | 7456 *stl-%{* *g:actual_curbuf* *g:actual_curwin* |
19163 | 7457 While evaluating %{} the current buffer and current window will be set |
7458 temporarily to that of the window (and buffer) whose statusline is | |
18719 | 7459 currently being drawn. The expression will evaluate in this context. |
7460 The variable "g:actual_curbuf" is set to the `bufnr()` number of the | |
7461 real current buffer and "g:actual_curwin" to the |window-ID| of the | |
7462 real current window. These values are strings. | |
634 | 7463 |
3682 | 7464 The 'statusline' option will be evaluated in the |sandbox| if set from |
7465 a modeline, see |sandbox-option|. | |
16728
e55c26aaf484
patch 8.1.1366: using expressions in a modeline is unsafe
Bram Moolenaar <Bram@vim.org>
parents:
16610
diff
changeset
|
7466 This option cannot be set in a modeline when 'modelineexpr' is off. |
634 | 7467 |
7468 It is not allowed to change text or jump to another window while | |
7469 evaluating 'statusline' |textlock|. | |
7 | 7470 |
7471 If the statusline is not updated when you want it (e.g., after setting | |
7472 a variable that's used in an expression), you can force an update by | |
7473 setting an option without changing its value. Example: > | |
7474 :let &ro = &ro | |
7475 | |
7476 < A result of all digits is regarded a number for display purposes. | |
7477 Otherwise the result is taken as flag text and applied to the rules | |
7478 described above. | |
7479 | |
199 | 7480 Watch out for errors in expressions. They may render Vim unusable! |
7 | 7481 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
|
7482 edit your .vimrc or whatever with "vim --clean" to get it right. |
7 | 7483 |
7484 Examples: | |
7485 Emulate standard status line with 'ruler' set > | |
7486 :set statusline=%<%f\ %h%m%r%=%-14.(%l,%c%V%)\ %P | |
7487 < Similar, but add ASCII value of char under the cursor (like "ga") > | |
7488 :set statusline=%<%f%h%m%r%=%b\ 0x%B\ \ %l,%c%V\ %P | |
7489 < Display byte count and byte value, modified flag in red. > | |
7490 :set statusline=%<%f%=\ [%1*%M%*%n%R%H]\ %-19(%3l,%02c%03V%)%O'%02b' | |
7491 :hi User1 term=inverse,bold cterm=inverse,bold ctermfg=red | |
7492 < Display a ,GZ flag if a compressed file is loaded > | |
7493 :set statusline=...%r%{VarExists('b:gzflag','\ [GZ]')}%h... | |
7494 < In the |:autocmd|'s: > | |
7495 :let b:gzflag = 1 | |
7496 < And: > | |
7497 :unlet b:gzflag | |
7498 < And define this function: > | |
7499 :function VarExists(var, val) | |
7500 : if exists(a:var) | return a:val | else | return '' | endif | |
7501 :endfunction | |
7502 < | |
7503 *'suffixes'* *'su'* | |
7504 'suffixes' 'su' string (default ".bak,~,.o,.h,.info,.swp,.obj") | |
7505 global | |
7506 Files with these suffixes get a lower priority when multiple files | |
7507 match a wildcard. See |suffixes|. Commas can be used to separate the | |
10 | 7508 suffixes. Spaces after the comma are ignored. A dot is also seen as |
7509 the start of a suffix. To avoid a dot or comma being recognized as a | |
7 | 7510 separator, precede it with a backslash (see |option-backslash| about |
7511 including spaces and backslashes). | |
7512 See 'wildignore' for completely ignoring files. | |
7513 The use of |:set+=| and |:set-=| is preferred when adding or removing | |
7514 suffixes from the list. This avoids problems when a future version | |
7515 uses another default. | |
7516 | |
7517 *'suffixesadd'* *'sua'* | |
7518 'suffixesadd' 'sua' string (default "") | |
7519 local to buffer | |
7520 {not available when compiled without the | |
7521 |+file_in_path| feature} | |
7522 Comma separated list of suffixes, which are used when searching for a | |
7523 file for the "gf", "[I", etc. commands. Example: > | |
7524 :set suffixesadd=.java | |
7525 < | |
7526 *'swapfile'* *'swf'* *'noswapfile'* *'noswf'* | |
7527 'swapfile' 'swf' boolean (default on) | |
7528 local to buffer | |
10 | 7529 Use a swapfile for the buffer. This option can be reset when a |
7 | 7530 swapfile is not wanted for a specific buffer. For example, with |
7531 confidential information that even root must not be able to access. | |
7532 Careful: All text will be in memory: | |
7533 - Don't use this for big files. | |
7534 - Recovery will be impossible! | |
7535 A swapfile will only be present when |'updatecount'| is non-zero and | |
7536 'swapfile' is set. | |
7537 When 'swapfile' is reset, the swap file for the current buffer is | |
7538 immediately deleted. When 'swapfile' is set, and 'updatecount' is | |
7539 non-zero, a swap file is immediately created. | |
7540 Also see |swap-file| and |'swapsync'|. | |
5763 | 7541 If you want to open a new buffer without creating a swap file for it, |
7542 use the |:noswapfile| modifier. | |
13341
acd7eaa13d2b
Updated runtime files.
Christian Brabandt <cb@256bit.org>
parents:
13314
diff
changeset
|
7543 See 'directory' for where the swap file is created. |
7 | 7544 |
7545 This option is used together with 'bufhidden' and 'buftype' to | |
7546 specify special kinds of buffers. See |special-buffers|. | |
7547 | |
7548 *'swapsync'* *'sws'* | |
7549 'swapsync' 'sws' string (default "fsync") | |
7550 global | |
7551 When this option is not empty a swap file is synced to disk after | |
10 | 7552 writing to it. This takes some time, especially on busy unix systems. |
7 | 7553 When this option is empty parts of the swap file may be in memory and |
7554 not written to disk. When the system crashes you may lose more work. | |
7555 On Unix the system does a sync now and then without Vim asking for it, | |
7556 so the disadvantage of setting this option off is small. On some | |
7557 systems the swap file will not be written at all. For a unix system | |
7558 setting it to "sync" will use the sync() call instead of the default | |
7559 fsync(), which may work better on some systems. | |
36 | 7560 The 'fsync' option is used for the actual file. |
7 | 7561 |
7562 *'switchbuf'* *'swb'* | |
7563 'switchbuf' 'swb' string (default "") | |
7564 global | |
7565 This option controls the behavior when switching between buffers. | |
24751 | 7566 Mostly for |quickfix| commands some values are also used for other |
7567 commands, as mentioned below. | |
7 | 7568 Possible values (comma separated list): |
7569 useopen If included, jump to the first open window that | |
7570 contains the specified buffer (if there is one). | |
7571 Otherwise: Do not examine other windows. | |
7572 This setting is checked with |quickfix| commands, when | |
7573 jumping to errors (":cc", ":cn", "cp", etc.). It is | |
7574 also used in all buffer related split commands, for | |
7575 example ":sbuffer", ":sbnext", or ":sbrewind". | |
825 | 7576 usetab Like "useopen", but also consider windows in other tab |
856 | 7577 pages. |
7 | 7578 split If included, split the current window before loading |
3153 | 7579 a buffer for a |quickfix| command that display errors. |
16086 | 7580 Otherwise: do not split, use current window (when used |
7581 in the quickfix window: the previously used window or | |
7582 split if there is no other window). | |
6843 | 7583 vsplit Just like "split" but split vertically. |
1621 | 7584 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
|
7585 "split" when both are present. |
18646
394abd397e15
patch 8.1.2315: not always using the right window when jumping to an error
Bram Moolenaar <Bram@vim.org>
parents:
18594
diff
changeset
|
7586 uselast If included, jump to the previously used window when |
394abd397e15
patch 8.1.2315: not always using the right window when jumping to an error
Bram Moolenaar <Bram@vim.org>
parents:
18594
diff
changeset
|
7587 jumping to errors with |quickfix| commands. |
7 | 7588 |
410 | 7589 *'synmaxcol'* *'smc'* |
7590 'synmaxcol' 'smc' number (default 3000) | |
7591 local to buffer | |
7592 {not available when compiled without the |+syntax| | |
7593 feature} | |
419 | 7594 Maximum column in which to search for syntax items. In long lines the |
7595 text after this column is not highlighted and following lines may not | |
7596 be highlighted correctly, because the syntax state is cleared. | |
410 | 7597 This helps to avoid very slow redrawing for an XML file that is one |
7598 long line. | |
7599 Set to zero to remove the limit. | |
7600 | |
7 | 7601 *'syntax'* *'syn'* |
7602 'syntax' 'syn' string (default empty) | |
7603 local to buffer | |
7604 {not available when compiled without the |+syntax| | |
7605 feature} | |
7606 When this option is set, the syntax with this name is loaded, unless | |
7607 syntax highlighting has been switched off with ":syntax off". | |
7608 Otherwise this option does not always reflect the current syntax (the | |
7609 b:current_syntax variable does). | |
7610 This option is most useful in a modeline, for a file which syntax is | |
782 | 7611 not automatically recognized. Example, in an IDL file: |
7612 /* vim: set syntax=idl : */ ~ | |
7613 When a dot appears in the value then this separates two filetype | |
7614 names. Example: | |
7615 /* vim: set syntax=c.doxygen : */ ~ | |
7616 This will use the "c" syntax first, then the "doxygen" syntax. | |
7617 Note that the second one must be prepared to be loaded as an addition, | |
7618 otherwise it will be skipped. More than one dot may appear. | |
7619 To switch off syntax highlighting for the current file, use: > | |
7 | 7620 :set syntax=OFF |
7621 < To switch syntax highlighting on according to the current value of the | |
7622 'filetype' option: > | |
7623 :set syntax=ON | |
7624 < What actually happens when setting the 'syntax' option is that the | |
7625 Syntax autocommand event is triggered with the value as argument. | |
7626 This option is not copied to another buffer, independent of the 's' or | |
7627 'S' flag in 'cpoptions'. | |
36 | 7628 Only normal file name characters can be used, "/\*?[|<>" are illegal. |
7 | 7629 |
699 | 7630 *'tabline'* *'tal'* |
677 | 7631 'tabline' 'tal' string (default empty) |
674 | 7632 global |
677 | 7633 When nonempty, this option determines the content of the tab pages |
7634 line at the top of the Vim window. When empty Vim will use a default | |
681 | 7635 tab pages line. See |setting-tabline| for more info. |
677 | 7636 |
7637 The tab pages line only appears as specified with the 'showtabline' | |
688 | 7638 option and only when there is no GUI tab line. When 'e' is in |
7639 '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
|
7640 instead. Note that the two tab pages lines are very different. |
677 | 7641 |
7642 The value is evaluated like with 'statusline'. You can use | |
7643 |tabpagenr()|, |tabpagewinnr()| and |tabpagebuflist()| to figure out | |
681 | 7644 the text to be displayed. Use "%1T" for the first label, "%2T" for |
7645 the second one, etc. Use "%X" items for closing labels. | |
677 | 7646 |
15396
325e4a8ba1b6
patch 8.1.0706: tabline is not always redrawn
Bram Moolenaar <Bram@vim.org>
parents:
15281
diff
changeset
|
7647 When changing something that is used in 'tabline' that does not |
325e4a8ba1b6
patch 8.1.0706: tabline is not always redrawn
Bram Moolenaar <Bram@vim.org>
parents:
15281
diff
changeset
|
7648 trigger it to be updated, use |:redrawtabline|. |
16728
e55c26aaf484
patch 8.1.1366: using expressions in a modeline is unsafe
Bram Moolenaar <Bram@vim.org>
parents:
16610
diff
changeset
|
7649 This option cannot be set in a modeline when 'modelineexpr' is off. |
15396
325e4a8ba1b6
patch 8.1.0706: tabline is not always redrawn
Bram Moolenaar <Bram@vim.org>
parents:
15281
diff
changeset
|
7650 |
677 | 7651 Keep in mind that only one of the tab pages is the current one, others |
7652 are invisible and you can't jump to their windows. | |
7653 | |
674 | 7654 |
699 | 7655 *'tabpagemax'* *'tpm'* |
7656 'tabpagemax' 'tpm' number (default 10) | |
7657 global | |
7658 Maximum number of tab pages to be opened by the |-p| command line | |
7659 argument or the ":tab all" command. |tabpage| | |
7660 | |
7661 | |
7662 *'tabstop'* *'ts'* | |
7 | 7663 'tabstop' 'ts' number (default 8) |
7664 local to buffer | |
7665 Number of spaces that a <Tab> in the file counts for. Also see | |
7666 |:retab| command, and 'softtabstop' option. | |
7667 | |
7668 Note: Setting 'tabstop' to any other value than 8 can make your file | |
7669 appear wrong in many places (e.g., when printing it). | |
7670 | |
7671 There are four main ways to use tabs in Vim: | |
7672 1. Always keep 'tabstop' at 8, set 'softtabstop' and 'shiftwidth' to 4 | |
7673 (or 3 or whatever you prefer) and use 'noexpandtab'. Then Vim | |
1263 | 7674 will use a mix of tabs and spaces, but typing <Tab> and <BS> will |
7 | 7675 behave like a tab appears every 4 (or 3) characters. |
7676 2. Set 'tabstop' and 'shiftwidth' to whatever you prefer and use | |
7677 'expandtab'. This way you will always insert spaces. The | |
7678 formatting will never be messed up when 'tabstop' is changed. | |
7679 3. Set 'tabstop' and 'shiftwidth' to whatever you prefer and use a | |
10 | 7680 |modeline| to set these values when editing the file again. Only |
7 | 7681 works when using Vim to edit the file. |
7682 4. Always set 'tabstop' and 'shiftwidth' to the same value, and | |
7683 'noexpandtab'. This should then work (for initial indents only) | |
7684 for any tabstop setting that people use. It might be nice to have | |
7685 tabs after the first non-blank inserted as spaces if you do this | |
7686 though. Otherwise aligned comments will be wrong when 'tabstop' is | |
7687 changed. | |
7688 | |
14175
2ad722003b36
patch 8.1.0105: all tab stops are the same
Christian Brabandt <cb@256bit.org>
parents:
14019
diff
changeset
|
7689 If Vim is compiled with the |+vartabs| feature then the value of |
2ad722003b36
patch 8.1.0105: all tab stops are the same
Christian Brabandt <cb@256bit.org>
parents:
14019
diff
changeset
|
7690 'tabstop' will be ignored if |'vartabstop'| is set to anything other |
2ad722003b36
patch 8.1.0105: all tab stops are the same
Christian Brabandt <cb@256bit.org>
parents:
14019
diff
changeset
|
7691 than an empty string. |
2ad722003b36
patch 8.1.0105: all tab stops are the same
Christian Brabandt <cb@256bit.org>
parents:
14019
diff
changeset
|
7692 |
7 | 7693 *'tagbsearch'* *'tbs'* *'notagbsearch'* *'notbs'* |
7694 'tagbsearch' 'tbs' boolean (default on) | |
7695 global | |
7696 When searching for a tag (e.g., for the |:ta| command), Vim can either | |
10 | 7697 use a binary search or a linear search in a tags file. Binary |
7 | 7698 searching makes searching for a tag a LOT faster, but a linear search |
7699 will find more tags if the tags file wasn't properly sorted. | |
7700 Vim normally assumes that your tags files are sorted, or indicate that | |
7701 they are not sorted. Only when this is not the case does the | |
7702 'tagbsearch' option need to be switched off. | |
7703 | |
7704 When 'tagbsearch' is on, binary searching is first used in the tags | |
10 | 7705 files. In certain situations, Vim will do a linear search instead for |
7 | 7706 certain files, or retry all files with a linear search. When |
7707 'tagbsearch' is off, only a linear search is done. | |
7708 | |
7709 Linear searching is done anyway, for one file, when Vim finds a line | |
7710 at the start of the file indicating that it's not sorted: > | |
1621 | 7711 !_TAG_FILE_SORTED 0 /some comment/ |
7 | 7712 < [The whitespace before and after the '0' must be a single <Tab>] |
7713 | |
7714 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
|
7715 files listed in 'tags', and case is ignored or a pattern is used |
7 | 7716 instead of a normal tag name, a retry is done with a linear search. |
7717 Tags in unsorted tags files, and matches with different case will only | |
7718 be found in the retry. | |
7719 | |
22 | 7720 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
|
7721 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
|
7722 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
|
7723 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
|
7724 "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
|
7725 (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
|
7726 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
|
7727 |
6ba7182fb7bd
commit https://github.com/vim/vim/commit/0f6562e9036f889185dff49a75c7fc5ffb28b307
Christian Brabandt <cb@256bit.org>
parents:
7245
diff
changeset
|
7728 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
|
7729 '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
|
7730 "ignore". |
9913
bb00c661b3a4
commit https://github.com/vim/vim/commit/66e29d7112e437b2b50efe1f82c7e892736d23e4
Christian Brabandt <cb@256bit.org>
parents:
9887
diff
changeset
|
7731 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
|
7732 '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
|
7733 characters. |
7 | 7734 |
7735 When 'tagbsearch' is off, tags searching is slower when a full match | |
7736 exists, but faster when no full match exists. Tags in unsorted tags | |
7737 files may only be found with 'tagbsearch' off. | |
7738 When the tags file is not sorted, or sorted in a wrong way (not on | |
7739 ASCII byte value), 'tagbsearch' should be off, or the line given above | |
7740 must be included in the tags file. | |
7741 This option doesn't affect commands that find all matching tags (e.g., | |
7742 command-line completion and ":help"). | |
7743 | |
7266
6ba7182fb7bd
commit https://github.com/vim/vim/commit/0f6562e9036f889185dff49a75c7fc5ffb28b307
Christian Brabandt <cb@256bit.org>
parents:
7245
diff
changeset
|
7744 *'tagcase'* *'tc'* |
6ba7182fb7bd
commit https://github.com/vim/vim/commit/0f6562e9036f889185dff49a75c7fc5ffb28b307
Christian Brabandt <cb@256bit.org>
parents:
7245
diff
changeset
|
7745 'tagcase' 'tc' string (default "followic") |
6ba7182fb7bd
commit https://github.com/vim/vim/commit/0f6562e9036f889185dff49a75c7fc5ffb28b307
Christian Brabandt <cb@256bit.org>
parents:
7245
diff
changeset
|
7746 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
|
7747 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
|
7748 file: |
6ba7182fb7bd
commit https://github.com/vim/vim/commit/0f6562e9036f889185dff49a75c7fc5ffb28b307
Christian Brabandt <cb@256bit.org>
parents:
7245
diff
changeset
|
7749 followic Follow the 'ignorecase' option |
9913
bb00c661b3a4
commit https://github.com/vim/vim/commit/66e29d7112e437b2b50efe1f82c7e892736d23e4
Christian Brabandt <cb@256bit.org>
parents:
9887
diff
changeset
|
7750 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
|
7751 ignore Ignore case |
6ba7182fb7bd
commit https://github.com/vim/vim/commit/0f6562e9036f889185dff49a75c7fc5ffb28b307
Christian Brabandt <cb@256bit.org>
parents:
7245
diff
changeset
|
7752 match Match case |
9913
bb00c661b3a4
commit https://github.com/vim/vim/commit/66e29d7112e437b2b50efe1f82c7e892736d23e4
Christian Brabandt <cb@256bit.org>
parents:
9887
diff
changeset
|
7753 smart Ignore case unless an upper case letter is used |
11160 | 7754 NOTE: This option is set to the Vi default value when 'compatible' is |
7755 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
|
7756 |
16447
54ffc82f38a8
patch 8.1.1228: not possible to process tags with a function
Bram Moolenaar <Bram@vim.org>
parents:
16443
diff
changeset
|
7757 *'tagfunc'* *'tfu'* |
54ffc82f38a8
patch 8.1.1228: not possible to process tags with a function
Bram Moolenaar <Bram@vim.org>
parents:
16443
diff
changeset
|
7758 'tagfunc' 'tfu' string (default: empty) |
54ffc82f38a8
patch 8.1.1228: not possible to process tags with a function
Bram Moolenaar <Bram@vim.org>
parents:
16443
diff
changeset
|
7759 local to buffer |
54ffc82f38a8
patch 8.1.1228: not possible to process tags with a function
Bram Moolenaar <Bram@vim.org>
parents:
16443
diff
changeset
|
7760 {not available when compiled without the |+eval| |
54ffc82f38a8
patch 8.1.1228: not possible to process tags with a function
Bram Moolenaar <Bram@vim.org>
parents:
16443
diff
changeset
|
7761 feature} |
54ffc82f38a8
patch 8.1.1228: not possible to process tags with a function
Bram Moolenaar <Bram@vim.org>
parents:
16443
diff
changeset
|
7762 This option specifies a function to be used to perform tag searches. |
54ffc82f38a8
patch 8.1.1228: not possible to process tags with a function
Bram Moolenaar <Bram@vim.org>
parents:
16443
diff
changeset
|
7763 The function gets the tag pattern and should return a List of matching |
54ffc82f38a8
patch 8.1.1228: not possible to process tags with a function
Bram Moolenaar <Bram@vim.org>
parents:
16443
diff
changeset
|
7764 tags. See |tag-function| for an explanation of how to write the |
54ffc82f38a8
patch 8.1.1228: not possible to process tags with a function
Bram Moolenaar <Bram@vim.org>
parents:
16443
diff
changeset
|
7765 function and an example. |
54ffc82f38a8
patch 8.1.1228: not possible to process tags with a function
Bram Moolenaar <Bram@vim.org>
parents:
16443
diff
changeset
|
7766 |
7 | 7767 *'taglength'* *'tl'* |
7768 'taglength' 'tl' number (default 0) | |
7769 global | |
7770 If non-zero, tags are significant up to this number of characters. | |
7771 | |
7772 *'tagrelative'* *'tr'* *'notagrelative'* *'notr'* | |
7773 'tagrelative' 'tr' boolean (Vim default: on, Vi default: off) | |
7774 global | |
824 | 7775 If on and using a tags file in another directory, file names in that |
7776 tags file are relative to the directory where the tags file is. | |
7 | 7777 NOTE: This option is set to the Vi default value when 'compatible' is |
7778 set and to the Vim default value when 'compatible' is reset. | |
7779 | |
7780 *'tags'* *'tag'* *E433* | |
7781 'tags' 'tag' string (default "./tags,tags", when compiled with | |
7782 |+emacs_tags|: "./tags,./TAGS,tags,TAGS") | |
7783 global or local to buffer |global-local| | |
7784 Filenames for the tag command, separated by spaces or commas. To | |
7785 include a space or comma in a file name, precede it with a backslash | |
7786 (see |option-backslash| about including spaces and backslashes). | |
7787 When a file name starts with "./", the '.' is replaced with the path | |
7788 of the current file. But only when the 'd' flag is not included in | |
7789 'cpoptions'. Environment variables are expanded |:set_env|. Also see | |
7790 |tags-option|. | |
7791 "*", "**" 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
|
7792 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
|
7793 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
|
7794 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
|
7795 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
|
7796 |+path_extra| feature} |
515 | 7797 The |tagfiles()| function can be used to get a list of the file names |
7798 actually used. | |
7 | 7799 If Vim was compiled with the |+emacs_tags| feature, Emacs-style tag |
7800 files are also supported. They are automatically recognized. The | |
7801 default value becomes "./tags,./TAGS,tags,TAGS", unless case | |
7802 differences are ignored (MS-Windows). |emacs-tags| | |
7803 The use of |:set+=| and |:set-=| is preferred when adding or removing | |
7804 file names from the list. This avoids problems when a future version | |
7805 uses another default. | |
7806 | |
7807 *'tagstack'* *'tgst'* *'notagstack'* *'notgst'* | |
7808 'tagstack' 'tgst' boolean (default on) | |
7809 global | |
7810 When on, the |tagstack| is used normally. When off, a ":tag" or | |
7811 ":tselect" command with an argument will not push the tag onto the | |
7812 tagstack. A following ":tag" without an argument, a ":pop" command or | |
7813 any other command that uses the tagstack will use the unmodified | |
7814 tagstack, but does change the pointer to the active entry. | |
7815 Resetting this option is useful when using a ":tag" command in a | |
7816 mapping which should not change the tagstack. | |
7817 | |
7538
c9fc24b76293
commit https://github.com/vim/vim/commit/8a5115cf18751022387af2085f374d38c60dde83
Christian Brabandt <cb@256bit.org>
parents:
7528
diff
changeset
|
7818 *'tcldll'* |
8629
54ac275e3fc4
commit https://github.com/vim/vim/commit/3848e00e0177abdb31bc600234967863ec487233
Christian Brabandt <cb@256bit.org>
parents:
8560
diff
changeset
|
7819 '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
|
7820 global |
c9fc24b76293
commit https://github.com/vim/vim/commit/8a5115cf18751022387af2085f374d38c60dde83
Christian Brabandt <cb@256bit.org>
parents:
7528
diff
changeset
|
7821 {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
|
7822 feature} |
c9fc24b76293
commit https://github.com/vim/vim/commit/8a5115cf18751022387af2085f374d38c60dde83
Christian Brabandt <cb@256bit.org>
parents:
7528
diff
changeset
|
7823 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
|
7824 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
|
7825 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
|
7826 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
|
7827 security reasons. |
c9fc24b76293
commit https://github.com/vim/vim/commit/8a5115cf18751022387af2085f374d38c60dde83
Christian Brabandt <cb@256bit.org>
parents:
7528
diff
changeset
|
7828 |
7 | 7829 *'term'* *E529* *E530* *E531* |
7830 'term' string (default is $TERM, if that fails: | |
7831 in the GUI: "builtin_gui" | |
7832 on Amiga: "amiga" | |
19526
22f0dda71638
patch 8.2.0320: no Haiku support
Bram Moolenaar <Bram@vim.org>
parents:
19404
diff
changeset
|
7833 on Haiku: "xterm" |
7 | 7834 on Mac: "mac-ansi" |
7835 on Unix: "ansi" | |
7836 on VMS: "ansi" | |
7837 on Win 32: "win32") | |
7838 global | |
7839 Name of the terminal. Used for choosing the terminal control | |
7840 characters. Environment variables are expanded |:set_env|. | |
7841 For example: > | |
7842 :set term=$TERM | |
7843 < See |termcap|. | |
7844 | |
7845 *'termbidi'* *'tbidi'* | |
7846 *'notermbidi'* *'notbidi'* | |
7847 'termbidi' 'tbidi' boolean (default off, on for "mlterm") | |
7848 global | |
7849 {only available when compiled with the |+arabic| | |
7850 feature} | |
7851 The terminal is in charge of Bi-directionality of text (as specified | |
7852 by Unicode). The terminal is also expected to do the required shaping | |
7853 that some languages (such as Arabic) require. | |
7854 Setting this option implies that 'rightleft' will not be set when | |
7855 'arabic' is set and the value of 'arabicshape' will be ignored. | |
7856 Note that setting 'termbidi' has the immediate effect that | |
7857 'arabicshape' is ignored, but 'rightleft' isn't changed automatically. | |
7858 This option is reset when the GUI is started. | |
7859 For further details see |arabic.txt|. | |
7860 | |
7861 *'termencoding'* *'tenc'* | |
21825 | 7862 'termencoding' 'tenc' string (default ""; with GTK+ GUI: "utf-8") |
7 | 7863 global |
7864 Encoding used for the terminal. This specifies what character | |
7865 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
|
7866 the GUI it only applies to the keyboard ('encoding' is used for the |
21825 | 7867 display). |
19027
d72b30bf3a80
patch 8.2.0074: Python 3 unicode test someitmes fails
Bram Moolenaar <Bram@vim.org>
parents:
18972
diff
changeset
|
7868 *E617* *E950* |
10895
c391bfbdb452
Updated runtime files.
Christian Brabandt <cb@256bit.org>
parents:
10734
diff
changeset
|
7869 Note: This does not apply to the GTK+ GUI. After the GUI has been |
7 | 7870 successfully initialized, 'termencoding' is forcibly set to "utf-8". |
7871 Any attempts to set a different value will be rejected, and an error | |
7872 message is shown. | |
7080
1a34f5272977
commit https://github.com/vim/vim/commit/ac360bf2ca293735fc7c6654dc2b3066f4c62488
Christian Brabandt <cb@256bit.org>
parents:
7051
diff
changeset
|
7873 For the Win32 GUI and console versions 'termencoding' is not used, |
7 | 7874 because the Win32 system always passes Unicode characters. |
7875 When empty, the same encoding is used as for the 'encoding' option. | |
7876 This is the normal value. | |
7877 Not all combinations for 'termencoding' and 'encoding' are valid. See | |
7878 |encoding-table|. | |
7879 The value for this option must be supported by internal conversions or | |
7880 iconv(). When this is not possible no conversion will be done and you | |
7881 will probably experience problems with non-ASCII characters. | |
7882 Example: You are working with the locale set to euc-jp (Japanese) and | |
7883 want to edit a UTF-8 file: > | |
7884 :let &termencoding = &encoding | |
7885 :set encoding=utf-8 | |
7886 < You need to do this when your system has no locale support for UTF-8. | |
7887 | |
13314
65c3e8259124
patch 8.0.1531: cannot use 24 bit colors in MS-Windows console
Christian Brabandt <cb@256bit.org>
parents:
13234
diff
changeset
|
7888 *'termguicolors'* *'tgc'* *E954* |
9027
773d627cac0b
commit https://github.com/vim/vim/commit/61be73bb0f965a895bfb064ea3e55476ac175162
Christian Brabandt <cb@256bit.org>
parents:
8969
diff
changeset
|
7889 'termguicolors' 'tgc' boolean (default off) |
773d627cac0b
commit https://github.com/vim/vim/commit/61be73bb0f965a895bfb064ea3e55476ac175162
Christian Brabandt <cb@256bit.org>
parents:
8969
diff
changeset
|
7890 global |
773d627cac0b
commit https://github.com/vim/vim/commit/61be73bb0f965a895bfb064ea3e55476ac175162
Christian Brabandt <cb@256bit.org>
parents:
8969
diff
changeset
|
7891 {not available when compiled without the |
773d627cac0b
commit https://github.com/vim/vim/commit/61be73bb0f965a895bfb064ea3e55476ac175162
Christian Brabandt <cb@256bit.org>
parents:
8969
diff
changeset
|
7892 |+termguicolors| feature} |
773d627cac0b
commit https://github.com/vim/vim/commit/61be73bb0f965a895bfb064ea3e55476ac175162
Christian Brabandt <cb@256bit.org>
parents:
8969
diff
changeset
|
7893 When on, uses |highlight-guifg| and |highlight-guibg| attributes in |
13314
65c3e8259124
patch 8.0.1531: cannot use 24 bit colors in MS-Windows console
Christian Brabandt <cb@256bit.org>
parents:
13234
diff
changeset
|
7894 the terminal (thus using 24-bit color). |
13341
acd7eaa13d2b
Updated runtime files.
Christian Brabandt <cb@256bit.org>
parents:
13314
diff
changeset
|
7895 |
13314
65c3e8259124
patch 8.0.1531: cannot use 24 bit colors in MS-Windows console
Christian Brabandt <cb@256bit.org>
parents:
13234
diff
changeset
|
7896 Requires a ISO-8613-3 compatible terminal. If setting this option |
65c3e8259124
patch 8.0.1531: cannot use 24 bit colors in MS-Windows console
Christian Brabandt <cb@256bit.org>
parents:
13234
diff
changeset
|
7897 does not work (produces a colorless UI) reading |xterm-true-color| |
65c3e8259124
patch 8.0.1531: cannot use 24 bit colors in MS-Windows console
Christian Brabandt <cb@256bit.org>
parents:
13234
diff
changeset
|
7898 might help. |
65c3e8259124
patch 8.0.1531: cannot use 24 bit colors in MS-Windows console
Christian Brabandt <cb@256bit.org>
parents:
13234
diff
changeset
|
7899 |
65c3e8259124
patch 8.0.1531: cannot use 24 bit colors in MS-Windows console
Christian Brabandt <cb@256bit.org>
parents:
13234
diff
changeset
|
7900 For Win32 console, Windows 10 version 1703 (Creators Update) or later |
65c3e8259124
patch 8.0.1531: cannot use 24 bit colors in MS-Windows console
Christian Brabandt <cb@256bit.org>
parents:
13234
diff
changeset
|
7901 is required. Use this check to find out: > |
65c3e8259124
patch 8.0.1531: cannot use 24 bit colors in MS-Windows console
Christian Brabandt <cb@256bit.org>
parents:
13234
diff
changeset
|
7902 if has('vcon') |
13341
acd7eaa13d2b
Updated runtime files.
Christian Brabandt <cb@256bit.org>
parents:
13314
diff
changeset
|
7903 < This requires Vim to be built with the |+vtp| feature. |
acd7eaa13d2b
Updated runtime files.
Christian Brabandt <cb@256bit.org>
parents:
13314
diff
changeset
|
7904 |
11473 | 7905 Note that the "cterm" attributes are still used, not the "gui" ones. |
11160 | 7906 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
|
7907 |
13735 | 7908 *'termwinkey'* *'twk'* |
7909 'termwinkey' 'twk' string (default "") | |
11659
49c12c93abf3
Updated runtime files and translations.
Christian Brabandt <cb@256bit.org>
parents:
11529
diff
changeset
|
7910 local to window |
11914 | 7911 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
|
7912 are sent to the job running in the window. |
11914 | 7913 The <> notation can be used, e.g.: > |
13735 | 7914 :set termwinkey=<C-L> |
11914 | 7915 < The string must be one key stroke but can be multiple bytes. |
7916 When not set CTRL-W is used, so that CTRL-W : gets you to the command | |
13735 | 7917 line. If 'termwinkey' is set to CTRL-L then CTRL-L : gets you to the |
11914 | 7918 command line. |
11659
49c12c93abf3
Updated runtime files and translations.
Christian Brabandt <cb@256bit.org>
parents:
11529
diff
changeset
|
7919 |
16443
32a543152dc0
patch 8.1.1226: {not in Vi} remarks get in the way of useful help text
Bram Moolenaar <Bram@vim.org>
parents:
16439
diff
changeset
|
7920 *'termwinscroll'* *'twsl'* |
32a543152dc0
patch 8.1.1226: {not in Vi} remarks get in the way of useful help text
Bram Moolenaar <Bram@vim.org>
parents:
16439
diff
changeset
|
7921 'termwinscroll' 'twsl' number (default 10000) |
32a543152dc0
patch 8.1.1226: {not in Vi} remarks get in the way of useful help text
Bram Moolenaar <Bram@vim.org>
parents:
16439
diff
changeset
|
7922 local to buffer |
32a543152dc0
patch 8.1.1226: {not in Vi} remarks get in the way of useful help text
Bram Moolenaar <Bram@vim.org>
parents:
16439
diff
changeset
|
7923 {not available when compiled without the |
32a543152dc0
patch 8.1.1226: {not in Vi} remarks get in the way of useful help text
Bram Moolenaar <Bram@vim.org>
parents:
16439
diff
changeset
|
7924 |+terminal| feature} |
32a543152dc0
patch 8.1.1226: {not in Vi} remarks get in the way of useful help text
Bram Moolenaar <Bram@vim.org>
parents:
16439
diff
changeset
|
7925 Number of scrollback lines to keep. When going over this limit the |
32a543152dc0
patch 8.1.1226: {not in Vi} remarks get in the way of useful help text
Bram Moolenaar <Bram@vim.org>
parents:
16439
diff
changeset
|
7926 first 10% of the scrollback lines are deleted. This is just to reduce |
32a543152dc0
patch 8.1.1226: {not in Vi} remarks get in the way of useful help text
Bram Moolenaar <Bram@vim.org>
parents:
16439
diff
changeset
|
7927 the memory usage. See |Terminal-Normal|. |
32a543152dc0
patch 8.1.1226: {not in Vi} remarks get in the way of useful help text
Bram Moolenaar <Bram@vim.org>
parents:
16439
diff
changeset
|
7928 |
13735 | 7929 *'termwinsize'* *'tws'* |
7930 'termwinsize' 'tws' string (default "") | |
11659
49c12c93abf3
Updated runtime files and translations.
Christian Brabandt <cb@256bit.org>
parents:
11529
diff
changeset
|
7931 local to window |
22171 | 7932 Size used when opening the |terminal| window. Format: |
7933 {rows}x{columns} or {rows}*{columns}. | |
11659
49c12c93abf3
Updated runtime files and translations.
Christian Brabandt <cb@256bit.org>
parents:
11529
diff
changeset
|
7934 - When empty the terminal gets the size from the window. |
13700
b28d679b1843
patch 8.0.1722: cannot specify a minimal size for a terminal window
Christian Brabandt <cb@256bit.org>
parents:
13680
diff
changeset
|
7935 - When set with a "x" (e.g., "24x80") the terminal size is not |
b28d679b1843
patch 8.0.1722: cannot specify a minimal size for a terminal window
Christian Brabandt <cb@256bit.org>
parents:
13680
diff
changeset
|
7936 adjusted to the window size. If the window is smaller only the |
b28d679b1843
patch 8.0.1722: cannot specify a minimal size for a terminal window
Christian Brabandt <cb@256bit.org>
parents:
13680
diff
changeset
|
7937 top-left part is displayed. |
b28d679b1843
patch 8.0.1722: cannot specify a minimal size for a terminal window
Christian Brabandt <cb@256bit.org>
parents:
13680
diff
changeset
|
7938 - When set with a "*" (e.g., "10*50") the terminal size follows the |
b28d679b1843
patch 8.0.1722: cannot specify a minimal size for a terminal window
Christian Brabandt <cb@256bit.org>
parents:
13680
diff
changeset
|
7939 window size, but will not be smaller than the specified rows and/or |
b28d679b1843
patch 8.0.1722: cannot specify a minimal size for a terminal window
Christian Brabandt <cb@256bit.org>
parents:
13680
diff
changeset
|
7940 columns. |
b28d679b1843
patch 8.0.1722: cannot specify a minimal size for a terminal window
Christian Brabandt <cb@256bit.org>
parents:
13680
diff
changeset
|
7941 - When rows is zero then use the height of the window. |
b28d679b1843
patch 8.0.1722: cannot specify a minimal size for a terminal window
Christian Brabandt <cb@256bit.org>
parents:
13680
diff
changeset
|
7942 - When columns is zero then use the width of the window. |
b28d679b1843
patch 8.0.1722: cannot specify a minimal size for a terminal window
Christian Brabandt <cb@256bit.org>
parents:
13680
diff
changeset
|
7943 - Using "0x0" or "0*0" is the same as empty. |
22171 | 7944 - Can be overruled in the |term_start()| options with "term_rows" and |
7945 "term_cols". | |
13700
b28d679b1843
patch 8.0.1722: cannot specify a minimal size for a terminal window
Christian Brabandt <cb@256bit.org>
parents:
13680
diff
changeset
|
7946 |
b28d679b1843
patch 8.0.1722: cannot specify a minimal size for a terminal window
Christian Brabandt <cb@256bit.org>
parents:
13680
diff
changeset
|
7947 Examples: |
b28d679b1843
patch 8.0.1722: cannot specify a minimal size for a terminal window
Christian Brabandt <cb@256bit.org>
parents:
13680
diff
changeset
|
7948 "30x0" uses 30 rows and the current window width. |
b28d679b1843
patch 8.0.1722: cannot specify a minimal size for a terminal window
Christian Brabandt <cb@256bit.org>
parents:
13680
diff
changeset
|
7949 "20*0" uses at least 20 rows and the current window width. |
b28d679b1843
patch 8.0.1722: cannot specify a minimal size for a terminal window
Christian Brabandt <cb@256bit.org>
parents:
13680
diff
changeset
|
7950 "0*40" uses the current window height and at least 40 columns. |
11757
74abb6c84984
patch 8.0.0761: options not set properly for a terminal buffer
Christian Brabandt <cb@256bit.org>
parents:
11666
diff
changeset
|
7951 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
|
7952 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
|
7953 adjusted to that size, if possible. |
11659
49c12c93abf3
Updated runtime files and translations.
Christian Brabandt <cb@256bit.org>
parents:
11529
diff
changeset
|
7954 |
15746
c017195b121b
patch 8.1.0880: MS-Windows: inconsistent selection of winpty/conpty
Bram Moolenaar <Bram@vim.org>
parents:
15729
diff
changeset
|
7955 *'termwintype'* *'twt'* |
c017195b121b
patch 8.1.0880: MS-Windows: inconsistent selection of winpty/conpty
Bram Moolenaar <Bram@vim.org>
parents:
15729
diff
changeset
|
7956 'termwintype' 'twt' string (default "") |
c017195b121b
patch 8.1.0880: MS-Windows: inconsistent selection of winpty/conpty
Bram Moolenaar <Bram@vim.org>
parents:
15729
diff
changeset
|
7957 global |
c017195b121b
patch 8.1.0880: MS-Windows: inconsistent selection of winpty/conpty
Bram Moolenaar <Bram@vim.org>
parents:
15729
diff
changeset
|
7958 {only available when compiled with the |terminal| |
c017195b121b
patch 8.1.0880: MS-Windows: inconsistent selection of winpty/conpty
Bram Moolenaar <Bram@vim.org>
parents:
15729
diff
changeset
|
7959 feature on MS-Windows} |
c017195b121b
patch 8.1.0880: MS-Windows: inconsistent selection of winpty/conpty
Bram Moolenaar <Bram@vim.org>
parents:
15729
diff
changeset
|
7960 Specify the virtual console (pty) used when opening the terminal |
c017195b121b
patch 8.1.0880: MS-Windows: inconsistent selection of winpty/conpty
Bram Moolenaar <Bram@vim.org>
parents:
15729
diff
changeset
|
7961 window. |
c017195b121b
patch 8.1.0880: MS-Windows: inconsistent selection of winpty/conpty
Bram Moolenaar <Bram@vim.org>
parents:
15729
diff
changeset
|
7962 |
c017195b121b
patch 8.1.0880: MS-Windows: inconsistent selection of winpty/conpty
Bram Moolenaar <Bram@vim.org>
parents:
15729
diff
changeset
|
7963 Possible values are: |
15804
864ec0dd71b9
patch 8.1.0909: MS-Windows: using ConPTY even though it is not stable
Bram Moolenaar <Bram@vim.org>
parents:
15746
diff
changeset
|
7964 "" use ConPTY if it is stable, winpty otherwise |
15746
c017195b121b
patch 8.1.0880: MS-Windows: inconsistent selection of winpty/conpty
Bram Moolenaar <Bram@vim.org>
parents:
15729
diff
changeset
|
7965 "winpty" use winpty, fail if not supported |
c017195b121b
patch 8.1.0880: MS-Windows: inconsistent selection of winpty/conpty
Bram Moolenaar <Bram@vim.org>
parents:
15729
diff
changeset
|
7966 "conpty" use |ConPTY|, fail if not supported |
c017195b121b
patch 8.1.0880: MS-Windows: inconsistent selection of winpty/conpty
Bram Moolenaar <Bram@vim.org>
parents:
15729
diff
changeset
|
7967 |
15804
864ec0dd71b9
patch 8.1.0909: MS-Windows: using ConPTY even though it is not stable
Bram Moolenaar <Bram@vim.org>
parents:
15746
diff
changeset
|
7968 |ConPTY| support depends on the platform. Windows 10 October 2018 |
864ec0dd71b9
patch 8.1.0909: MS-Windows: using ConPTY even though it is not stable
Bram Moolenaar <Bram@vim.org>
parents:
15746
diff
changeset
|
7969 Update is the first version that supports ConPTY, however it is still |
864ec0dd71b9
patch 8.1.0909: MS-Windows: using ConPTY even though it is not stable
Bram Moolenaar <Bram@vim.org>
parents:
15746
diff
changeset
|
7970 considered unstable. ConPTY might become stable in the next release |
864ec0dd71b9
patch 8.1.0909: MS-Windows: using ConPTY even though it is not stable
Bram Moolenaar <Bram@vim.org>
parents:
15746
diff
changeset
|
7971 of Windows 10. winpty support needs to be installed. If neither is |
15746
c017195b121b
patch 8.1.0880: MS-Windows: inconsistent selection of winpty/conpty
Bram Moolenaar <Bram@vim.org>
parents:
15729
diff
changeset
|
7972 supported then you cannot open a terminal window. |
c017195b121b
patch 8.1.0880: MS-Windows: inconsistent selection of winpty/conpty
Bram Moolenaar <Bram@vim.org>
parents:
15729
diff
changeset
|
7973 |
7 | 7974 *'terse'* *'noterse'* |
7975 'terse' boolean (default off) | |
7976 global | |
7977 When set: Add 's' flag to 'shortmess' option (this makes the message | |
7978 for a search that hits the start or end of the file not being | |
7979 displayed). When reset: Remove 's' flag from 'shortmess' option. {Vi | |
7980 shortens a lot of messages} | |
7981 | |
7982 *'textauto'* *'ta'* *'notextauto'* *'nota'* | |
7983 'textauto' 'ta' boolean (Vim default: on, Vi default: off) | |
7984 global | |
7985 This option is obsolete. Use 'fileformats'. | |
7986 For backwards compatibility, when 'textauto' is set, 'fileformats' is | |
7987 set to the default value for the current system. When 'textauto' is | |
7988 reset, 'fileformats' is made empty. | |
7989 NOTE: This option is set to the Vi default value when 'compatible' is | |
7990 set and to the Vim default value when 'compatible' is reset. | |
7991 | |
7992 *'textmode'* *'tx'* *'notextmode'* *'notx'* | |
18912
ccd16426a1f9
patch 8.2.0017: OS/2 and MS-DOS are still mentioned
Bram Moolenaar <Bram@vim.org>
parents:
18879
diff
changeset
|
7993 'textmode' 'tx' boolean (Win32: default on, |
7 | 7994 others: default off) |
7995 local to buffer | |
7996 This option is obsolete. Use 'fileformat'. | |
7997 For backwards compatibility, when 'textmode' is set, 'fileformat' is | |
7998 set to "dos". When 'textmode' is reset, 'fileformat' is set to | |
7999 "unix". | |
8000 | |
8001 *'textwidth'* *'tw'* | |
8002 'textwidth' 'tw' number (default 0) | |
8003 local to buffer | |
8004 Maximum width of text that is being inserted. A longer line will be | |
8005 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
|
8006 this. |
c590de398af9
commit https://github.com/vim/vim/commit/ca63501fbcd1cf9c8aa9ff12c093c95b62a89ed7
Christian Brabandt <cb@256bit.org>
parents:
7080
diff
changeset
|
8007 '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
|
8008 when 'paste' is reset. |
c590de398af9
commit https://github.com/vim/vim/commit/ca63501fbcd1cf9c8aa9ff12c093c95b62a89ed7
Christian Brabandt <cb@256bit.org>
parents:
7080
diff
changeset
|
8009 When 'textwidth' is zero, 'wrapmargin' may be used. See also |
7 | 8010 'formatoptions' and |ins-textwidth|. |
838 | 8011 When 'formatexpr' is set it will be used to break the line. |
7 | 8012 NOTE: This option is set to 0 when 'compatible' is set. |
8013 | |
8014 *'thesaurus'* *'tsr'* | |
8015 'thesaurus' 'tsr' string (default "") | |
8016 global or local to buffer |global-local| | |
8017 List of file names, separated by commas, that are used to lookup words | |
15033 | 8018 for thesaurus completion commands |i_CTRL-X_CTRL-T|. |
8019 | |
8020 Each line in the file should contain words with similar meaning, | |
8021 separated by non-keyword characters (white space is preferred). | |
8022 Maximum line length is 510 bytes. | |
8023 | |
15131 | 8024 An English word list was added to this github issue: |
8025 https://github.com/vim/vim/issues/629#issuecomment-443293282 | |
8026 Unpack thesaurus_pkg.zip, put the thesaurus.txt file somewhere, e.g. | |
8027 ~/.vim/thesaurus/english.txt, and the 'thesaurus' option to this file | |
8028 name. | |
15033 | 8029 |
10 | 8030 To include a comma in a file name precede it with a backslash. Spaces |
7 | 8031 after a comma are ignored, otherwise spaces are included in the file |
8032 name. See |option-backslash| about using backslashes. | |
8033 The use of |:set+=| and |:set-=| is preferred when adding or removing | |
8034 directories from the list. This avoids problems when a future version | |
8035 uses another default. | |
8036 Backticks cannot be used in this option for security reasons. | |
8037 | |
25974
416237f1de22
patch 8.2.3520: cannot define a function for thesaurus completion
Bram Moolenaar <Bram@vim.org>
parents:
25973
diff
changeset
|
8038 *'thesaurusfunc'* *tsrfu'* |
416237f1de22
patch 8.2.3520: cannot define a function for thesaurus completion
Bram Moolenaar <Bram@vim.org>
parents:
25973
diff
changeset
|
8039 'thesaurusfunc' 'tsrfu' string (default: empty) |
416237f1de22
patch 8.2.3520: cannot define a function for thesaurus completion
Bram Moolenaar <Bram@vim.org>
parents:
25973
diff
changeset
|
8040 local to buffer |
416237f1de22
patch 8.2.3520: cannot define a function for thesaurus completion
Bram Moolenaar <Bram@vim.org>
parents:
25973
diff
changeset
|
8041 {not available when compiled without the |+eval| |
416237f1de22
patch 8.2.3520: cannot define a function for thesaurus completion
Bram Moolenaar <Bram@vim.org>
parents:
25973
diff
changeset
|
8042 feature} |
416237f1de22
patch 8.2.3520: cannot define a function for thesaurus completion
Bram Moolenaar <Bram@vim.org>
parents:
25973
diff
changeset
|
8043 This option specifies a function to be used for thesaurus completion |
416237f1de22
patch 8.2.3520: cannot define a function for thesaurus completion
Bram Moolenaar <Bram@vim.org>
parents:
25973
diff
changeset
|
8044 with CTRL-X CTRL-T. |i_CTRL-X_CTRL-T| |
416237f1de22
patch 8.2.3520: cannot define a function for thesaurus completion
Bram Moolenaar <Bram@vim.org>
parents:
25973
diff
changeset
|
8045 See |complete-functions| for an explanation of how the function is |
416237f1de22
patch 8.2.3520: cannot define a function for thesaurus completion
Bram Moolenaar <Bram@vim.org>
parents:
25973
diff
changeset
|
8046 invoked and what it should return. |
416237f1de22
patch 8.2.3520: cannot define a function for thesaurus completion
Bram Moolenaar <Bram@vim.org>
parents:
25973
diff
changeset
|
8047 This option cannot be set from a |modeline| or in the |sandbox|, for |
416237f1de22
patch 8.2.3520: cannot define a function for thesaurus completion
Bram Moolenaar <Bram@vim.org>
parents:
25973
diff
changeset
|
8048 security reasons. |
416237f1de22
patch 8.2.3520: cannot define a function for thesaurus completion
Bram Moolenaar <Bram@vim.org>
parents:
25973
diff
changeset
|
8049 |
7 | 8050 *'tildeop'* *'top'* *'notildeop'* *'notop'* |
8051 'tildeop' 'top' boolean (default off) | |
8052 global | |
8053 When on: The tilde command "~" behaves like an operator. | |
8054 NOTE: This option is reset when 'compatible' is set. | |
8055 | |
8056 *'timeout'* *'to'* *'notimeout'* *'noto'* | |
8057 'timeout' 'to' boolean (default on) | |
8058 global | |
8059 *'ttimeout'* *'nottimeout'* | |
11400
0f8713fe20dc
Updated runtime files.
Christian Brabandt <cb@256bit.org>
parents:
11262
diff
changeset
|
8060 'ttimeout' boolean (default off, set in |defaults.vim|) |
7 | 8061 global |
8062 These two options together determine the behavior when part of a | |
8063 mapped key sequence or keyboard code has been received: | |
8064 | |
8065 'timeout' 'ttimeout' action ~ | |
8066 off off do not time out | |
8067 on on or off time out on :mappings and key codes | |
8068 off on time out on key codes | |
8069 | |
8070 If both options are off, Vim will wait until either the complete | |
8071 mapping or key sequence has been received, or it is clear that there | |
8072 is no mapping or key sequence for the received characters. For | |
8073 example: if you have mapped "vl" and Vim has received 'v', the next | |
8074 character is needed to see if the 'v' is followed by an 'l'. | |
8075 When one of the options is on, Vim will wait for about 1 second for | |
8076 the next character to arrive. After that the already received | |
8077 characters are interpreted as single characters. The waiting time can | |
8078 be changed with the 'timeoutlen' option. | |
8079 On slow terminals or very busy systems timing out may cause | |
8080 malfunctioning cursor keys. If both options are off, Vim waits | |
8081 forever after an entered <Esc> if there are key codes that start | |
8082 with <Esc>. You will have to type <Esc> twice. If you do not have | |
8083 problems with key codes, but would like to have :mapped key | |
8084 sequences not timing out in 1 second, set the 'ttimeout' option and | |
8085 reset the 'timeout' option. | |
8086 | |
8087 NOTE: 'ttimeout' is reset when 'compatible' is set. | |
8088 | |
8089 *'timeoutlen'* *'tm'* | |
8090 'timeoutlen' 'tm' number (default 1000) | |
8091 global | |
16553
0e473e9e70c2
patch 8.1.1280: remarks about functionality not in Vi clutters the help
Bram Moolenaar <Bram@vim.org>
parents:
16533
diff
changeset
|
8092 |
7 | 8093 *'ttimeoutlen'* *'ttm'* |
11400
0f8713fe20dc
Updated runtime files.
Christian Brabandt <cb@256bit.org>
parents:
11262
diff
changeset
|
8094 'ttimeoutlen' 'ttm' number (default -1, set to 100 in |defaults.vim|) |
7 | 8095 global |
8096 The time in milliseconds that is waited for a key code or mapped key | |
8097 sequence to complete. Also used for CTRL-\ CTRL-N and CTRL-\ CTRL-G | |
8098 when part of a command has been typed. | |
8099 Normally only 'timeoutlen' is used and 'ttimeoutlen' is -1. When a | |
8100 different timeout value for key codes is desired set 'ttimeoutlen' to | |
8101 a non-negative number. | |
8102 | |
8103 ttimeoutlen mapping delay key code delay ~ | |
8104 < 0 'timeoutlen' 'timeoutlen' | |
8105 >= 0 'timeoutlen' 'ttimeoutlen' | |
8106 | |
8107 The timeout only happens when the 'timeout' and 'ttimeout' options | |
8108 tell so. A useful setting would be > | |
8109 :set timeout timeoutlen=3000 ttimeoutlen=100 | |
8110 < (time out on mapping after three seconds, time out on key codes after | |
8111 a tenth of a second). | |
8112 | |
8113 *'title'* *'notitle'* | |
8114 'title' boolean (default off, on when title can be restored) | |
8115 global | |
8116 {not available when compiled without the |+title| | |
8117 feature} | |
8118 When on, the title of the window will be set to the value of | |
8119 'titlestring' (if it is not empty), or to: | |
8120 filename [+=-] (path) - VIM | |
8121 Where: | |
8122 filename the name of the file being edited | |
8123 - indicates the file cannot be modified, 'ma' off | |
8124 + indicates the file was modified | |
8125 = indicates the file is read-only | |
8126 =+ indicates the file is read-only and modified | |
8127 (path) is the path of the file being edited | |
8128 - VIM the server name |v:servername| or "VIM" | |
8129 Only works if the terminal supports setting window titles | |
8130 (currently Amiga console, Win32 console, all GUI versions and | |
19968 | 8131 terminals with a non-empty 't_ts' option - these are Unix xterm and |
7 | 8132 iris-ansi by default, where 't_ts' is taken from the builtin termcap). |
8133 *X11* | |
8134 When Vim was compiled with HAVE_X11 defined, the original title will | |
8135 be restored if possible. The output of ":version" will include "+X11" | |
8136 when HAVE_X11 was defined, otherwise it will be "-X11". This also | |
8137 works for the icon name |'icon'|. | |
8138 But: When Vim was started with the |-X| argument, restoring the title | |
8139 will not work (except in the GUI). | |
8140 If the title cannot be restored, it is set to the value of 'titleold'. | |
8141 You might want to restore the title outside of Vim then. | |
8142 When using an xterm from a remote machine you can use this command: | |
8143 rsh machine_name xterm -display $DISPLAY & | |
8144 then the WINDOWID environment variable should be inherited and the | |
8145 title of the window should change back to what it should be after | |
8146 exiting Vim. | |
8147 | |
8148 *'titlelen'* | |
8149 'titlelen' number (default 85) | |
8150 global | |
8151 {not available when compiled without the |+title| | |
8152 feature} | |
8153 Gives the percentage of 'columns' to use for the length of the window | |
10 | 8154 title. When the title is longer, only the end of the path name is |
8155 shown. A '<' character before the path name is used to indicate this. | |
7 | 8156 Using a percentage makes this adapt to the width of the window. But |
8157 it won't work perfectly, because the actual number of characters | |
8158 available also depends on the font used and other things in the title | |
8159 bar. When 'titlelen' is zero the full path is used. Otherwise, | |
8160 values from 1 to 30000 percent can be used. | |
8161 'titlelen' is also used for the 'titlestring' option. | |
8162 | |
8163 *'titleold'* | |
8164 'titleold' string (default "Thanks for flying Vim") | |
8165 global | |
8166 {only available when compiled with the |+title| | |
8167 feature} | |
8168 This option will be used for the window title when exiting Vim if the | |
8169 original title cannot be restored. Only happens if 'title' is on or | |
8170 'titlestring' is not empty. | |
36 | 8171 This option cannot be set from a |modeline| or in the |sandbox|, for |
8172 security reasons. | |
7 | 8173 *'titlestring'* |
8174 'titlestring' string (default "") | |
8175 global | |
8176 {not available when compiled without the |+title| | |
8177 feature} | |
8178 When this option is not empty, it will be used for the title of the | |
8179 window. This happens only when the 'title' option is on. | |
8180 Only works if the terminal supports setting window titles (currently | |
8181 Amiga console, Win32 console, all GUI versions and terminals with a | |
8182 non-empty 't_ts' option). | |
8183 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
|
8184 be restored if possible, see |X11|. |
16728
e55c26aaf484
patch 8.1.1366: using expressions in a modeline is unsafe
Bram Moolenaar <Bram@vim.org>
parents:
16610
diff
changeset
|
8185 |
7 | 8186 When this option contains printf-style '%' items, they will be |
8187 expanded according to the rules used for 'statusline'. | |
16728
e55c26aaf484
patch 8.1.1366: using expressions in a modeline is unsafe
Bram Moolenaar <Bram@vim.org>
parents:
16610
diff
changeset
|
8188 This option cannot be set in a modeline when 'modelineexpr' is off. |
e55c26aaf484
patch 8.1.1366: using expressions in a modeline is unsafe
Bram Moolenaar <Bram@vim.org>
parents:
16610
diff
changeset
|
8189 |
7 | 8190 Example: > |
8191 :auto BufEnter * let &titlestring = hostname() . "/" . expand("%:p") | |
8192 :set title titlestring=%<%F%=%l/%L-%P titlelen=70 | |
8193 < The value of 'titlelen' is used to align items in the middle or right | |
8194 of the available space. | |
8195 Some people prefer to have the file name first: > | |
8196 :set titlestring=%t%(\ %M%)%(\ (%{expand(\"%:~:.:h\")})%)%(\ %a%) | |
8197 < Note the use of "%{ }" and an expression to get the path of the file, | |
10 | 8198 without the file name. The "%( %)" constructs are used to add a |
7 | 8199 separating space only when needed. |
8200 NOTE: Use of special characters in 'titlestring' may cause the display | |
8201 to be garbled (e.g., when it contains a CR or NL character). | |
8202 {not available when compiled without the |+statusline| feature} | |
8203 | |
8204 *'toolbar'* *'tb'* | |
8205 'toolbar' 'tb' string (default "icons,tooltips") | |
8206 global | |
8207 {only for |+GUI_GTK|, |+GUI_Athena|, |+GUI_Motif| and | |
8208 |+GUI_Photon|} | |
10 | 8209 The contents of this option controls various toolbar settings. The |
7 | 8210 possible values are: |
8211 icons Toolbar buttons are shown with icons. | |
8212 text Toolbar buttons shown with text. | |
8213 horiz Icon and text of a toolbar button are | |
10 | 8214 horizontally arranged. {only in GTK+ 2 GUI} |
7 | 8215 tooltips Tooltips are active for toolbar buttons. |
8216 Tooltips refer to the popup help text which appears after the mouse | |
8217 cursor is placed over a toolbar button for a brief moment. | |
8218 | |
8219 If you want the toolbar to be shown with icons as well as text, do the | |
8220 following: > | |
8221 :set tb=icons,text | |
8222 < Motif and Athena cannot display icons and text at the same time. They | |
8223 will show icons if both are requested. | |
8224 | |
8225 If none of the strings specified in 'toolbar' are valid or if | |
8226 'toolbar' is empty, this option is ignored. If you want to disable | |
8227 the toolbar, you need to set the 'guioptions' option. For example: > | |
8228 :set guioptions-=T | |
8229 < Also see |gui-toolbar|. | |
8230 | |
8231 *'toolbariconsize'* *'tbis'* | |
8232 'toolbariconsize' 'tbis' string (default "small") | |
8233 global | |
10895
c391bfbdb452
Updated runtime files.
Christian Brabandt <cb@256bit.org>
parents:
10734
diff
changeset
|
8234 {only in the GTK+ GUI} |
7 | 8235 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
|
8236 tiny Use tiny icons. |
da01d5da2cfa
commit https://github.com/vim/vim/commit/77cdfd10382e01cc51f4ba1a9177032351843151
Christian Brabandt <cb@256bit.org>
parents:
8246
diff
changeset
|
8237 small Use small icons (default). |
da01d5da2cfa
commit https://github.com/vim/vim/commit/77cdfd10382e01cc51f4ba1a9177032351843151
Christian Brabandt <cb@256bit.org>
parents:
8246
diff
changeset
|
8238 medium Use medium-sized icons. |
da01d5da2cfa
commit https://github.com/vim/vim/commit/77cdfd10382e01cc51f4ba1a9177032351843151
Christian Brabandt <cb@256bit.org>
parents:
8246
diff
changeset
|
8239 large Use large icons. |
da01d5da2cfa
commit https://github.com/vim/vim/commit/77cdfd10382e01cc51f4ba1a9177032351843151
Christian Brabandt <cb@256bit.org>
parents:
8246
diff
changeset
|
8240 huge Use even larger icons. |
da01d5da2cfa
commit https://github.com/vim/vim/commit/77cdfd10382e01cc51f4ba1a9177032351843151
Christian Brabandt <cb@256bit.org>
parents:
8246
diff
changeset
|
8241 giant Use very big icons. |
7 | 8242 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
|
8243 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
|
8244 large=24x24, medium=24x24, small=20x20 and tiny=16x16. |
7 | 8245 |
8246 If 'toolbariconsize' is empty, the global default size as determined | |
8247 by user preferences or the current theme is used. | |
8248 | |
8249 *'ttybuiltin'* *'tbi'* *'nottybuiltin'* *'notbi'* | |
8250 'ttybuiltin' 'tbi' boolean (default on) | |
8251 global | |
8252 When on, the builtin termcaps are searched before the external ones. | |
8253 When off the builtin termcaps are searched after the external ones. | |
8254 When this option is changed, you should set the 'term' option next for | |
8255 the change to take effect, for example: > | |
8256 :set notbi term=$TERM | |
8257 < See also |termcap|. | |
8258 Rationale: The default for this option is "on", because the builtin | |
8259 termcap entries are generally better (many systems contain faulty | |
8260 xterm entries...). | |
8261 | |
8262 *'ttyfast'* *'tf'* *'nottyfast'* *'notf'* | |
8263 'ttyfast' 'tf' boolean (default off, on when 'term' is xterm, hpterm, | |
8264 sun-cmd, screen, rxvt, dtterm or | |
8265 iris-ansi; also on when running Vim in | |
8266 a DOS console) | |
8267 global | |
8268 Indicates a fast terminal connection. More characters will be sent to | |
8269 the screen for redrawing, instead of using insert/delete line | |
8270 commands. Improves smoothness of redrawing when there are multiple | |
8271 windows and the terminal does not support a scrolling region. | |
8272 Also enables the extra writing of characters at the end of each screen | |
8273 line for lines that wrap. This helps when using copy/paste with the | |
8274 mouse in an xterm and other terminals. | |
8275 | |
8276 *'ttymouse'* *'ttym'* | |
8277 'ttymouse' 'ttym' string (default depends on 'term') | |
8278 global | |
8279 {only in Unix and VMS, doesn't work in the GUI; not | |
8280 available when compiled without |+mouse|} | |
8281 Name of the terminal type for which mouse codes are to be recognized. | |
1213 | 8282 Currently these strings are valid: |
7 | 8283 *xterm-mouse* |
8284 xterm xterm-like mouse handling. The mouse generates | |
8285 "<Esc>[Mscr", where "scr" is three bytes: | |
8286 "s" = button state | |
8287 "c" = column plus 33 | |
8288 "r" = row plus 33 | |
5908 | 8289 This only works up to 223 columns! See "dec", |
8290 "urxvt", and "sgr" for solutions. | |
7 | 8291 xterm2 Works like "xterm", but with the xterm reporting the |
8292 mouse position while the mouse is dragged. This works | |
8293 much faster and more precise. Your xterm must at | |
180 | 8294 least at patchlevel 88 / XFree 3.3.3 for this to |
7 | 8295 work. See below for how Vim detects this |
8296 automatically. | |
8297 *netterm-mouse* | |
16553
0e473e9e70c2
patch 8.1.1280: remarks about functionality not in Vi clutters the help
Bram Moolenaar <Bram@vim.org>
parents:
16533
diff
changeset
|
8298 netterm NetTerm mouse handling. A left mouse click generates |
7 | 8299 "<Esc>}r,c<CR>", where "r,c" are two decimal numbers |
16553
0e473e9e70c2
patch 8.1.1280: remarks about functionality not in Vi clutters the help
Bram Moolenaar <Bram@vim.org>
parents:
16533
diff
changeset
|
8300 for the row and column. No other mouse events are |
0e473e9e70c2
patch 8.1.1280: remarks about functionality not in Vi clutters the help
Bram Moolenaar <Bram@vim.org>
parents:
16533
diff
changeset
|
8301 supported. |
7 | 8302 *dec-mouse* |
8303 dec DEC terminal mouse handling. The mouse generates a | |
8304 rather complex sequence, starting with "<Esc>[". | |
189 | 8305 This is also available for an Xterm, if it was |
8306 configured with "--enable-dec-locator". | |
7 | 8307 *jsbterm-mouse* |
8308 jsbterm JSB term mouse handling. | |
8309 *pterm-mouse* | |
8310 pterm QNX pterm mouse handling. | |
3224 | 8311 *urxvt-mouse* |
8312 urxvt Mouse handling for the urxvt (rxvt-unicode) terminal. | |
5908 | 8313 The mouse works only if the terminal supports this |
8314 encoding style, but it does not have 223 columns limit | |
8315 unlike "xterm" or "xterm2". | |
3750 | 8316 *sgr-mouse* |
8317 sgr Mouse handling for the terminal that emits SGR-styled | |
5908 | 8318 mouse reporting. The mouse works even in columns |
8319 beyond 223. This option is backward compatible with | |
8320 "xterm2" because it can also decode "xterm2" style | |
8321 mouse codes. | |
7 | 8322 |
8323 The mouse handling must be enabled at compile time |+mouse_xterm| | |
5908 | 8324 |+mouse_dec| |+mouse_netterm| |+mouse_jsbterm| |+mouse_urxvt| |
8325 |+mouse_sgr|. | |
7 | 8326 Only "xterm"(2) is really recognized. NetTerm mouse codes are always |
8327 recognized, if enabled at compile time. DEC terminal mouse codes | |
8328 are recognized if enabled at compile time, and 'ttymouse' is not | |
5908 | 8329 "xterm", "xterm2", "urxvt" or "sgr" (because dec mouse codes conflict |
8330 with them). | |
7 | 8331 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
|
8332 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
|
8333 "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
|
8334 already. |
5908 | 8335 Additionally, if vim is compiled with the |+termresponse| feature and |
8336 |t_RV| is set to the escape sequence to request the xterm version | |
17229
f1c7b7a4d9e4
patch 8.1.1614: 'numberwidth' can only go up to 10
Bram Moolenaar <Bram@vim.org>
parents:
17161
diff
changeset
|
8337 number, more intelligent detection is done. |
7 | 8338 The "xterm2" value will be set if the xterm version is reported to be |
15131 | 8339 from 95 to 276. The "sgr" value will be set if Vim detects Mac |
8340 Terminal.app, iTerm2 or mintty, and when the xterm version is 277 or | |
8341 higher. | |
5908 | 8342 If you do not want 'ttymouse' to be set to "xterm2" or "sgr" |
8343 automatically, set t_RV to an empty string: > | |
7 | 8344 :set t_RV= |
8345 < | |
8346 *'ttyscroll'* *'tsl'* | |
8347 'ttyscroll' 'tsl' number (default 999) | |
8348 global | |
8349 Maximum number of lines to scroll the screen. If there are more lines | |
8350 to scroll the window is redrawn. For terminals where scrolling is | |
8351 very slow and redrawing is not slow this can be set to a small number, | |
8352 e.g., 3, to speed up displaying. | |
8353 | |
8354 *'ttytype'* *'tty'* | |
8355 'ttytype' 'tty' string (default from $TERM) | |
8356 global | |
8357 Alias for 'term', see above. | |
8358 | |
2214
f8222d1f9a73
Included patch for persistent undo. Lots of changes and added test.
Bram Moolenaar <bram@vim.org>
parents:
2209
diff
changeset
|
8359 *'undodir'* *'udir'* |
f8222d1f9a73
Included patch for persistent undo. Lots of changes and added test.
Bram Moolenaar <bram@vim.org>
parents:
2209
diff
changeset
|
8360 '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
|
8361 global |
2570
71b56b4e7785
Make the references to features in the help more consistent. (Sylvain Hitier)
Bram Moolenaar <bram@vim.org>
parents:
2561
diff
changeset
|
8362 {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
|
8363 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
|
8364 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
|
8365 "." 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
|
8366 "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
|
8367 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
|
8368 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
|
8369 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
|
8370 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
|
8371 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
|
8372 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
|
8373 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
|
8374 See |undo-persistence|. |
16728
e55c26aaf484
patch 8.1.1366: using expressions in a modeline is unsafe
Bram Moolenaar <Bram@vim.org>
parents:
16610
diff
changeset
|
8375 This option cannot be set from a |modeline| or in the |sandbox|, for |
e55c26aaf484
patch 8.1.1366: using expressions in a modeline is unsafe
Bram Moolenaar <Bram@vim.org>
parents:
16610
diff
changeset
|
8376 security reasons. |
2214
f8222d1f9a73
Included patch for persistent undo. Lots of changes and added test.
Bram Moolenaar <bram@vim.org>
parents:
2209
diff
changeset
|
8377 |
4681
2eb30f341e8d
Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents:
4502
diff
changeset
|
8378 *'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
|
8379 '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
|
8380 local to buffer |
2570
71b56b4e7785
Make the references to features in the help more consistent. (Sylvain Hitier)
Bram Moolenaar <bram@vim.org>
parents:
2561
diff
changeset
|
8381 {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
|
8382 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
|
8383 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
|
8384 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
|
8385 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
|
8386 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
|
8387 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
|
8388 before a reload to be saved for undo. |
3920 | 8389 When 'undofile' is turned off the undo file is NOT deleted. |
11160 | 8390 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
|
8391 |
7 | 8392 *'undolevels'* *'ul'* |
19116 | 8393 'undolevels' 'ul' number (default 100, 1000 for Unix, VMS and Win32) |
5446 | 8394 global or local to buffer |global-local| |
7 | 8395 Maximum number of changes that can be undone. Since undo information |
18186 | 8396 is kept in memory, higher numbers will cause more memory to be used. |
8397 Nevertheless, a single change can already use a large amount of memory. | |
7 | 8398 Set to 0 for Vi compatibility: One level of undo and "u" undoes |
8399 itself: > | |
8400 set ul=0 | |
8401 < But you can also get Vi compatibility by including the 'u' flag in | |
8402 '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
|
8403 Also see |undo-two-ways|. |
5446 | 8404 Set to -1 for no undo at all. You might want to do this only for the |
8405 current buffer: > | |
8406 setlocal ul=-1 | |
7 | 8407 < This helps when you run out of memory for a single change. |
6336 | 8408 |
8409 The local value is set to -123456 when the global value is to be used. | |
8410 | |
2249
6d3d35ff2c2b
Use full path in undofile(). Updated docs.
Bram Moolenaar <bram@vim.org>
parents:
2240
diff
changeset
|
8411 Also see |clear-undo|. |
7 | 8412 |
2394
a3aca345aafa
Add the 'undoreload' option to be able to undo a file reload.
Bram Moolenaar <bram@vim.org>
parents:
2382
diff
changeset
|
8413 *'undoreload'* *'ur'* |
a3aca345aafa
Add the 'undoreload' option to be able to undo a file reload.
Bram Moolenaar <bram@vim.org>
parents:
2382
diff
changeset
|
8414 '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
|
8415 global |
a3aca345aafa
Add the 'undoreload' option to be able to undo a file reload.
Bram Moolenaar <bram@vim.org>
parents:
2382
diff
changeset
|
8416 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
|
8417 ":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
|
8418 Vim. |FileChangedShell| |
12559 | 8419 The save only happens when this option is negative or when the number |
2394
a3aca345aafa
Add the 'undoreload' option to be able to undo a file reload.
Bram Moolenaar <bram@vim.org>
parents:
2382
diff
changeset
|
8420 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
|
8421 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
|
8422 |
a3aca345aafa
Add the 'undoreload' option to be able to undo a file reload.
Bram Moolenaar <bram@vim.org>
parents:
2382
diff
changeset
|
8423 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
|
8424 |
a3aca345aafa
Add the 'undoreload' option to be able to undo a file reload.
Bram Moolenaar <bram@vim.org>
parents:
2382
diff
changeset
|
8425 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
|
8426 this option to a lower value if you run out of memory. |
7 | 8427 |
8428 *'updatecount'* *'uc'* | |
8429 'updatecount' 'uc' number (default: 200) | |
8430 global | |
8431 After typing this many characters the swap file will be written to | |
8432 disk. When zero, no swap file will be created at all (see chapter on | |
8433 recovery |crash-recovery|). 'updatecount' is set to zero by starting | |
8434 Vim with the "-n" option, see |startup|. When editing in readonly | |
8435 mode this option will be initialized to 10000. | |
8436 The swapfile can be disabled per buffer with |'swapfile'|. | |
8437 When 'updatecount' is set from zero to non-zero, swap files are | |
8438 created for all buffers that have 'swapfile' set. When 'updatecount' | |
8439 is set to zero, existing swap files are not deleted. | |
8440 Also see |'swapsync'|. | |
8441 This option has no meaning in buffers where |'buftype'| is "nofile" | |
8442 or "nowrite". | |
8443 | |
8444 *'updatetime'* *'ut'* | |
8445 'updatetime' 'ut' number (default 4000) | |
8446 global | |
8447 If this many milliseconds nothing is typed the swap file will be | |
8448 written to disk (see |crash-recovery|). Also used for the | |
8449 |CursorHold| autocommand event. | |
8450 | |
14175
2ad722003b36
patch 8.1.0105: all tab stops are the same
Christian Brabandt <cb@256bit.org>
parents:
14019
diff
changeset
|
8451 *'varsofttabstop'* *'vsts'* |
2ad722003b36
patch 8.1.0105: all tab stops are the same
Christian Brabandt <cb@256bit.org>
parents:
14019
diff
changeset
|
8452 'varsofttabstop' 'vsts' string (default "") |
2ad722003b36
patch 8.1.0105: all tab stops are the same
Christian Brabandt <cb@256bit.org>
parents:
14019
diff
changeset
|
8453 local to buffer |
2ad722003b36
patch 8.1.0105: all tab stops are the same
Christian Brabandt <cb@256bit.org>
parents:
14019
diff
changeset
|
8454 {only available when compiled with the |+vartabs| |
2ad722003b36
patch 8.1.0105: all tab stops are the same
Christian Brabandt <cb@256bit.org>
parents:
14019
diff
changeset
|
8455 feature} |
2ad722003b36
patch 8.1.0105: all tab stops are the same
Christian Brabandt <cb@256bit.org>
parents:
14019
diff
changeset
|
8456 A list of the number of spaces that a <Tab> counts for while editing, |
2ad722003b36
patch 8.1.0105: all tab stops are the same
Christian Brabandt <cb@256bit.org>
parents:
14019
diff
changeset
|
8457 such as inserting a <Tab> or using <BS>. It "feels" like variable- |
2ad722003b36
patch 8.1.0105: all tab stops are the same
Christian Brabandt <cb@256bit.org>
parents:
14019
diff
changeset
|
8458 width <Tab>s are being inserted, while in fact a mixture of spaces |
2ad722003b36
patch 8.1.0105: all tab stops are the same
Christian Brabandt <cb@256bit.org>
parents:
14019
diff
changeset
|
8459 and <Tab>s is used. Tab widths are separated with commas, with the |
2ad722003b36
patch 8.1.0105: all tab stops are the same
Christian Brabandt <cb@256bit.org>
parents:
14019
diff
changeset
|
8460 final value applying to all subsequent tabs. |
2ad722003b36
patch 8.1.0105: all tab stops are the same
Christian Brabandt <cb@256bit.org>
parents:
14019
diff
changeset
|
8461 |
2ad722003b36
patch 8.1.0105: all tab stops are the same
Christian Brabandt <cb@256bit.org>
parents:
14019
diff
changeset
|
8462 For example, when editing assembly language files where statements |
14249
4543777545a3
Updated runtime and language files.
Christian Brabandt <cb@256bit.org>
parents:
14175
diff
changeset
|
8463 start in the 9th column and comments in the 41st, it may be useful |
14175
2ad722003b36
patch 8.1.0105: all tab stops are the same
Christian Brabandt <cb@256bit.org>
parents:
14019
diff
changeset
|
8464 to use the following: > |
2ad722003b36
patch 8.1.0105: all tab stops are the same
Christian Brabandt <cb@256bit.org>
parents:
14019
diff
changeset
|
8465 :set varsofttabstop=8,32,8 |
14249
4543777545a3
Updated runtime and language files.
Christian Brabandt <cb@256bit.org>
parents:
14175
diff
changeset
|
8466 < This will set soft tabstops with 8 and 8 + 32 spaces, and 8 more |
4543777545a3
Updated runtime and language files.
Christian Brabandt <cb@256bit.org>
parents:
14175
diff
changeset
|
8467 for every column thereafter. |
14175
2ad722003b36
patch 8.1.0105: all tab stops are the same
Christian Brabandt <cb@256bit.org>
parents:
14019
diff
changeset
|
8468 |
2ad722003b36
patch 8.1.0105: all tab stops are the same
Christian Brabandt <cb@256bit.org>
parents:
14019
diff
changeset
|
8469 Note that the value of |'softtabstop'| will be ignored while |
2ad722003b36
patch 8.1.0105: all tab stops are the same
Christian Brabandt <cb@256bit.org>
parents:
14019
diff
changeset
|
8470 'varsofttabstop' is set. |
2ad722003b36
patch 8.1.0105: all tab stops are the same
Christian Brabandt <cb@256bit.org>
parents:
14019
diff
changeset
|
8471 |
2ad722003b36
patch 8.1.0105: all tab stops are the same
Christian Brabandt <cb@256bit.org>
parents:
14019
diff
changeset
|
8472 *'vartabstop'* *'vts'* |
2ad722003b36
patch 8.1.0105: all tab stops are the same
Christian Brabandt <cb@256bit.org>
parents:
14019
diff
changeset
|
8473 'vartabstop' 'vts' string (default "") |
2ad722003b36
patch 8.1.0105: all tab stops are the same
Christian Brabandt <cb@256bit.org>
parents:
14019
diff
changeset
|
8474 local to buffer |
2ad722003b36
patch 8.1.0105: all tab stops are the same
Christian Brabandt <cb@256bit.org>
parents:
14019
diff
changeset
|
8475 {only available when compiled with the |+vartabs| |
2ad722003b36
patch 8.1.0105: all tab stops are the same
Christian Brabandt <cb@256bit.org>
parents:
14019
diff
changeset
|
8476 feature} |
2ad722003b36
patch 8.1.0105: all tab stops are the same
Christian Brabandt <cb@256bit.org>
parents:
14019
diff
changeset
|
8477 A list of the number of spaces that a <Tab> in the file counts for, |
2ad722003b36
patch 8.1.0105: all tab stops are the same
Christian Brabandt <cb@256bit.org>
parents:
14019
diff
changeset
|
8478 separated by commas. Each value corresponds to one tab, with the |
2ad722003b36
patch 8.1.0105: all tab stops are the same
Christian Brabandt <cb@256bit.org>
parents:
14019
diff
changeset
|
8479 final value applying to all subsequent tabs. For example: > |
2ad722003b36
patch 8.1.0105: all tab stops are the same
Christian Brabandt <cb@256bit.org>
parents:
14019
diff
changeset
|
8480 :set vartabstop=4,20,10,8 |
2ad722003b36
patch 8.1.0105: all tab stops are the same
Christian Brabandt <cb@256bit.org>
parents:
14019
diff
changeset
|
8481 < This will make the first tab 4 spaces wide, the second 20 spaces, |
2ad722003b36
patch 8.1.0105: all tab stops are the same
Christian Brabandt <cb@256bit.org>
parents:
14019
diff
changeset
|
8482 the third 10 spaces, and all following tabs 8 spaces. |
2ad722003b36
patch 8.1.0105: all tab stops are the same
Christian Brabandt <cb@256bit.org>
parents:
14019
diff
changeset
|
8483 |
2ad722003b36
patch 8.1.0105: all tab stops are the same
Christian Brabandt <cb@256bit.org>
parents:
14019
diff
changeset
|
8484 Note that the value of |'tabstop'| will be ignored while 'vartabstop' |
2ad722003b36
patch 8.1.0105: all tab stops are the same
Christian Brabandt <cb@256bit.org>
parents:
14019
diff
changeset
|
8485 is set. |
2ad722003b36
patch 8.1.0105: all tab stops are the same
Christian Brabandt <cb@256bit.org>
parents:
14019
diff
changeset
|
8486 |
7 | 8487 *'verbose'* *'vbs'* |
8488 'verbose' 'vbs' number (default 0) | |
8489 global | |
8490 When bigger than zero, Vim will give messages about what it is doing. | |
8491 Currently, these messages are given: | |
8492 >= 1 When the viminfo file is read or written. | |
8493 >= 2 When a file is ":source"'ed. | |
20265
d821c03b890c
patch 8.2.0688: output clobbered if setting 'verbose' to see shell commands
Bram Moolenaar <Bram@vim.org>
parents:
20069
diff
changeset
|
8494 >= 4 Shell commands. |
712 | 8495 >= 5 Every searched tags file and include file. |
7 | 8496 >= 8 Files for which a group of autocommands is executed. |
8497 >= 9 Every executed autocommand. | |
20265
d821c03b890c
patch 8.2.0688: output clobbered if setting 'verbose' to see shell commands
Bram Moolenaar <Bram@vim.org>
parents:
20069
diff
changeset
|
8498 >= 11 Finding items in a path |
7 | 8499 >= 12 Every executed function. |
8500 >= 13 When an exception is thrown, caught, finished, or discarded. | |
8501 >= 14 Anything pending in a ":finally" clause. | |
20575
501b72481d0a
patch 8.2.0841: 'verbose' value 16 causes duplicate output
Bram Moolenaar <Bram@vim.org>
parents:
20317
diff
changeset
|
8502 >= 15 Every executed Ex command from a script (truncated at 200 |
501b72481d0a
patch 8.2.0841: 'verbose' value 16 causes duplicate output
Bram Moolenaar <Bram@vim.org>
parents:
20317
diff
changeset
|
8503 characters). |
21676 | 8504 >= 16 Every executed Ex command. |
7 | 8505 |
8506 This option can also be set with the "-V" argument. See |-V|. | |
8507 This option is also set by the |:verbose| command. | |
8508 | |
293 | 8509 When the 'verbosefile' option is set then the verbose messages are not |
8510 displayed. | |
8511 | |
8512 *'verbosefile'* *'vfile'* | |
8513 'verbosefile' 'vfile' string (default empty) | |
8514 global | |
8515 When not empty all messages are written in a file with this name. | |
8516 When the file exists messages are appended. | |
8517 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
|
8518 empty. Writes are buffered, thus may not show up for some time. |
293 | 8519 Setting 'verbosefile' to a new value is like making it empty first. |
8520 The difference with |:redir| is that verbose messages are not | |
8521 displayed when 'verbosefile' is set. | |
8522 | |
7 | 8523 *'viewdir'* *'vdir'* |
18912
ccd16426a1f9
patch 8.2.0017: OS/2 and MS-DOS are still mentioned
Bram Moolenaar <Bram@vim.org>
parents:
18879
diff
changeset
|
8524 'viewdir' 'vdir' string (default for Amiga and Win32: |
7 | 8525 "$VIM/vimfiles/view", |
8526 for Unix: "~/.vim/view", | |
21825 | 8527 for macOS: "$VIM:vimfiles:view" |
18972 | 8528 for VMS: "sys$login:vimfiles/view") |
7 | 8529 global |
2570
71b56b4e7785
Make the references to features in the help more consistent. (Sylvain Hitier)
Bram Moolenaar <bram@vim.org>
parents:
2561
diff
changeset
|
8530 {not available when compiled without the |+mksession| |
7 | 8531 feature} |
8532 Name of the directory where to store files for |:mkview|. | |
8533 This option cannot be set from a |modeline| or in the |sandbox|, for | |
8534 security reasons. | |
8535 | |
8536 *'viewoptions'* *'vop'* | |
12824
79a754456110
patch 8.0.1289: mkview always includes the local directory
Christian Brabandt <cb@256bit.org>
parents:
12802
diff
changeset
|
8537 'viewoptions' 'vop' string (default: "folds,options,cursor,curdir") |
7 | 8538 global |
2570
71b56b4e7785
Make the references to features in the help more consistent. (Sylvain Hitier)
Bram Moolenaar <bram@vim.org>
parents:
2561
diff
changeset
|
8539 {not available when compiled without the |+mksession| |
7 | 8540 feature} |
8541 Changes the effect of the |:mkview| command. It is a comma separated | |
10 | 8542 list of words. Each word enables saving and restoring something: |
7 | 8543 word save and restore ~ |
8544 cursor cursor position in file and in window | |
8545 folds manually created folds, opened/closed folds and local | |
8546 fold options | |
8547 options options and mappings local to a window or buffer (not | |
8548 global values for local options) | |
6213 | 8549 localoptions same as "options" |
7 | 8550 slash backslashes in file names replaced with forward |
8551 slashes | |
8552 unix with Unix end-of-line format (single <NL>), even when | |
18912
ccd16426a1f9
patch 8.2.0017: OS/2 and MS-DOS are still mentioned
Bram Moolenaar <Bram@vim.org>
parents:
18879
diff
changeset
|
8553 on MS-Windows |
12824
79a754456110
patch 8.0.1289: mkview always includes the local directory
Christian Brabandt <cb@256bit.org>
parents:
12802
diff
changeset
|
8554 curdir the window-local directory, if set with `:lcd` |
7 | 8555 |
18912
ccd16426a1f9
patch 8.2.0017: OS/2 and MS-DOS are still mentioned
Bram Moolenaar <Bram@vim.org>
parents:
18879
diff
changeset
|
8556 "slash" and "unix" are useful on MS-Windows when sharing view files |
7 | 8557 with Unix. The Unix version of Vim cannot source dos format scripts, |
18912
ccd16426a1f9
patch 8.2.0017: OS/2 and MS-DOS are still mentioned
Bram Moolenaar <Bram@vim.org>
parents:
18879
diff
changeset
|
8558 but the MS-Windows version of Vim can source unix format scripts. |
7 | 8559 |
8560 *'viminfo'* *'vi'* *E526* *E527* *E528* | |
18912
ccd16426a1f9
patch 8.2.0017: OS/2 and MS-DOS are still mentioned
Bram Moolenaar <Bram@vim.org>
parents:
18879
diff
changeset
|
8561 'viminfo' 'vi' string (Vi default: "", Vim default for |
ccd16426a1f9
patch 8.2.0017: OS/2 and MS-DOS are still mentioned
Bram Moolenaar <Bram@vim.org>
parents:
18879
diff
changeset
|
8562 MS-Windows: '100,<50,s10,h,rA:,rB:, |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
8563 for Amiga: '100,<50,s10,h,rdf0:,rdf1:,rdf2: |
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
8564 for others: '100,<50,s10,h) |
7 | 8565 global |
2570
71b56b4e7785
Make the references to features in the help more consistent. (Sylvain Hitier)
Bram Moolenaar <bram@vim.org>
parents:
2561
diff
changeset
|
8566 {not available when compiled without the |+viminfo| |
7 | 8567 feature} |
8568 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
|
8569 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
|
8570 "NONE". |
5cd9ba96561d
patch 8.0.0716: not easy to start Vim cleanly
Christian Brabandt <cb@256bit.org>
parents:
11659
diff
changeset
|
8571 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
|
8572 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
|
8573 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
|
8574 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
|
8575 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
|
8576 identifying characters and the effect of their value. |
7 | 8577 CHAR VALUE ~ |
3224 | 8578 *viminfo-!* |
7 | 8579 ! When included, save and restore global variables that start |
8580 with an uppercase letter, and don't contain a lowercase | |
8581 letter. Thus "KEEPTHIS and "K_L_M" are stored, but "KeepThis" | |
2607 | 8582 and "_K_L_M" are not. Nested List and Dict items may not be |
2642 | 8583 read back correctly, you end up with an empty item. |
3224 | 8584 *viminfo-quote* |
7 | 8585 " Maximum number of lines saved for each register. Old name of |
8586 the '<' item, with the disadvantage that you need to put a | |
8587 backslash before the ", otherwise it will be recognized as the | |
8588 start of a comment! | |
3224 | 8589 *viminfo-%* |
7 | 8590 % When included, save and restore the buffer list. If Vim is |
8591 started with a file name argument, the buffer list is not | |
8592 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
|
8593 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
|
8594 ('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
|
8595 removable media (|viminfo-r|) are not saved. |
23 | 8596 When followed by a number, the number specifies the maximum |
8597 number of buffers that are stored. Without a number all | |
8598 buffers are stored. | |
3224 | 8599 *viminfo-'* |
7 | 8600 ' Maximum number of previously edited files for which the marks |
8601 are remembered. This parameter must always be included when | |
8602 'viminfo' is non-empty. | |
8603 Including this item also means that the |jumplist| and the | |
8604 |changelist| are stored in the viminfo file. | |
3224 | 8605 *viminfo-/* |
7 | 8606 / Maximum number of items in the search pattern history to be |
10 | 8607 saved. If non-zero, then the previous search and substitute |
7 | 8608 patterns are also saved. When not included, the value of |
8609 'history' is used. | |
3224 | 8610 *viminfo-:* |
7 | 8611 : Maximum number of items in the command-line history to be |
10 | 8612 saved. When not included, the value of 'history' is used. |
3224 | 8613 *viminfo-<* |
7 | 8614 < Maximum number of lines saved for each register. If zero then |
8615 registers are not saved. When not included, all lines are | |
8616 saved. '"' is the old name for this item. | |
8617 Also see the 's' item below: limit specified in Kbyte. | |
3224 | 8618 *viminfo-@* |
7 | 8619 @ Maximum number of items in the input-line history to be |
10 | 8620 saved. When not included, the value of 'history' is used. |
3224 | 8621 *viminfo-c* |
7 | 8622 c When included, convert the text in the viminfo file from the |
8623 'encoding' used when writing the file to the current | |
233 | 8624 'encoding'. See |viminfo-encoding|. |
3224 | 8625 *viminfo-f* |
7 | 8626 f Whether file marks need to be stored. If zero, file marks ('0 |
8627 to '9, 'A to 'Z) are not stored. When not present or when | |
10 | 8628 non-zero, they are all stored. '0 is used for the current |
7 | 8629 cursor position (when exiting or when doing ":wviminfo"). |
3224 | 8630 *viminfo-h* |
7 | 8631 h Disable the effect of 'hlsearch' when loading the viminfo |
8632 file. When not included, it depends on whether ":nohlsearch" | |
8633 has been used since the last search command. | |
3224 | 8634 *viminfo-n* |
7 | 8635 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
|
8636 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
|
8637 '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
|
8638 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
|
8639 expanded when opening the file, not when setting the option. |
3224 | 8640 *viminfo-r* |
7 | 8641 r Removable media. The argument is a string (up to the next |
8642 ','). This parameter can be given several times. Each | |
8643 specifies the start of a path for which no marks will be | |
18972 | 8644 stored. This is to avoid removable media. For MS-Windows you |
7 | 8645 could use "ra:,rb:", for Amiga "rdf0:,rdf1:,rdf2:". You can |
8646 also use it for temp files, e.g., for Unix: "r/tmp". Case is | |
8647 ignored. Maximum length of each 'r' argument is 50 | |
8648 characters. | |
3224 | 8649 *viminfo-s* |
7 | 8650 s Maximum size of an item in Kbyte. If zero then registers are |
8651 not saved. Currently only applies to registers. The default | |
8652 "s10" will exclude registers with more than 10 Kbyte of text. | |
8653 Also see the '<' item above: line count limit. | |
8654 | |
8655 Example: > | |
8656 :set viminfo='50,<1000,s100,:0,n~/vim/viminfo | |
8657 < | |
8658 '50 Marks will be remembered for the last 50 files you | |
8659 edited. | |
8660 <1000 Contents of registers (up to 1000 lines each) will be | |
8661 remembered. | |
8662 s100 Registers with more than 100 Kbyte text are skipped. | |
8663 :0 Command-line history will not be saved. | |
8664 n~/vim/viminfo The name of the file to use is "~/vim/viminfo". | |
8665 no / Since '/' is not specified, the default will be used, | |
8666 that is, save all of the search history, and also the | |
8667 previous search and substitute patterns. | |
8668 no % The buffer list will not be saved nor read back. | |
8669 no h 'hlsearch' highlighting will be restored. | |
8670 | |
8671 When setting 'viminfo' from an empty value you can use |:rviminfo| to | |
8672 load the contents of the file, this is not done automatically. | |
8673 | |
8674 This option cannot be set from a |modeline| or in the |sandbox|, for | |
8675 security reasons. | |
11160 | 8676 NOTE: This option is set to the Vim default value when 'compatible' |
8677 is reset. | |
7 | 8678 |
11666
5cd9ba96561d
patch 8.0.0716: not easy to start Vim cleanly
Christian Brabandt <cb@256bit.org>
parents:
11659
diff
changeset
|
8679 *'viminfofile'* *'vif'* |
5cd9ba96561d
patch 8.0.0716: not easy to start Vim cleanly
Christian Brabandt <cb@256bit.org>
parents:
11659
diff
changeset
|
8680 'viminfofile' 'vif' string (default: "") |
5cd9ba96561d
patch 8.0.0716: not easy to start Vim cleanly
Christian Brabandt <cb@256bit.org>
parents:
11659
diff
changeset
|
8681 global |
5cd9ba96561d
patch 8.0.0716: not easy to start Vim cleanly
Christian Brabandt <cb@256bit.org>
parents:
11659
diff
changeset
|
8682 {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
|
8683 feature} |
5cd9ba96561d
patch 8.0.0716: not easy to start Vim cleanly
Christian Brabandt <cb@256bit.org>
parents:
11659
diff
changeset
|
8684 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
|
8685 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
|
8686 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
|
8687 command line flag sets it to "NONE". |
16728
e55c26aaf484
patch 8.1.1366: using expressions in a modeline is unsafe
Bram Moolenaar <Bram@vim.org>
parents:
16610
diff
changeset
|
8688 This option cannot be set from a |modeline| or in the |sandbox|, for |
e55c26aaf484
patch 8.1.1366: using expressions in a modeline is unsafe
Bram Moolenaar <Bram@vim.org>
parents:
16610
diff
changeset
|
8689 security reasons. |
11666
5cd9ba96561d
patch 8.0.0716: not easy to start Vim cleanly
Christian Brabandt <cb@256bit.org>
parents:
11659
diff
changeset
|
8690 |
7 | 8691 *'virtualedit'* *'ve'* |
8692 'virtualedit' 've' string (default "") | |
25487
c26ff3203b43
patch 8.2.3280: 'virtualedit' local to buffer is not the best solution
Bram Moolenaar <Bram@vim.org>
parents:
25402
diff
changeset
|
8693 global or local to window |global-local| |
7 | 8694 A comma separated list of these words: |
8695 block Allow virtual editing in Visual block mode. | |
8696 insert Allow virtual editing in Insert mode. | |
8697 all Allow virtual editing in all modes. | |
772 | 8698 onemore Allow the cursor to move just past the end of the line |
25380
ac88cd21ae88
patch 8.2.3227: 'virtualedit' can only be set globally
Bram Moolenaar <Bram@vim.org>
parents:
25322
diff
changeset
|
8699 none When used as the local value, do not allow virtual |
ac88cd21ae88
patch 8.2.3227: 'virtualedit' can only be set globally
Bram Moolenaar <Bram@vim.org>
parents:
25322
diff
changeset
|
8700 editing even when the global value is set. When used |
ac88cd21ae88
patch 8.2.3227: 'virtualedit' can only be set globally
Bram Moolenaar <Bram@vim.org>
parents:
25322
diff
changeset
|
8701 as the global value, "none" is the same as "". |
ac88cd21ae88
patch 8.2.3227: 'virtualedit' can only be set globally
Bram Moolenaar <Bram@vim.org>
parents:
25322
diff
changeset
|
8702 NONE Alternative spelling of "none". |
782 | 8703 |
7 | 8704 Virtual editing means that the cursor can be positioned where there is |
1263 | 8705 no actual character. This can be halfway into a tab or beyond the end |
7 | 8706 of the line. Useful for selecting a rectangle in Visual mode and |
8707 editing a table. | |
772 | 8708 "onemore" is not the same, it will only allow moving the cursor just |
8709 after the last character of the line. This makes some commands more | |
8710 consistent. Previously the cursor was always past the end of the line | |
8711 if the line was empty. But it is far from Vi compatible. It may also | |
782 | 8712 break some plugins or Vim scripts. For example because |l| can move |
8713 the cursor after the last character. Use with care! | |
5220 | 8714 Using the `$` command will move to the last character in the line, not |
782 | 8715 past it. This may actually move the cursor to the left! |
5220 | 8716 The `g$` command will move to the end of the screen line. |
772 | 8717 It doesn't make sense to combine "all" with "onemore", but you will |
8718 not get a warning for it. | |
25402 | 8719 When combined with other words, "none" is ignored. |
11160 | 8720 NOTE: This option is set to "" when 'compatible' is set. |
7 | 8721 |
8722 *'visualbell'* *'vb'* *'novisualbell'* *'novb'* *beep* | |
8723 'visualbell' 'vb' boolean (default off) | |
8724 global | |
11659
49c12c93abf3
Updated runtime files and translations.
Christian Brabandt <cb@256bit.org>
parents:
11529
diff
changeset
|
8725 Use a visual bell instead of beeping. The terminal code to display the |
7 | 8726 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
|
8727 use: > |
49c12c93abf3
Updated runtime files and translations.
Christian Brabandt <cb@256bit.org>
parents:
11529
diff
changeset
|
8728 :set vb t_vb= |
49c12c93abf3
Updated runtime files and translations.
Christian Brabandt <cb@256bit.org>
parents:
11529
diff
changeset
|
8729 < 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
|
8730 :set vb t_vb=[?5h$<100>[?5l |
49c12c93abf3
Updated runtime files and translations.
Christian Brabandt <cb@256bit.org>
parents:
11529
diff
changeset
|
8731 < 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
|
8732 to get a shorter or longer flash. |
49c12c93abf3
Updated runtime files and translations.
Christian Brabandt <cb@256bit.org>
parents:
11529
diff
changeset
|
8733 |
49c12c93abf3
Updated runtime files and translations.
Christian Brabandt <cb@256bit.org>
parents:
11529
diff
changeset
|
8734 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
|
8735 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
|
8736 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
|
8737 set. |
49c12c93abf3
Updated runtime files and translations.
Christian Brabandt <cb@256bit.org>
parents:
11529
diff
changeset
|
8738 |
7 | 8739 In the GUI, 't_vb' defaults to "<Esc>|f", which inverts the display |
8740 for 20 msec. If you want to use a different time, use "<Esc>|40f", | |
8741 where 40 is the time in msec. | |
11659
49c12c93abf3
Updated runtime files and translations.
Christian Brabandt <cb@256bit.org>
parents:
11529
diff
changeset
|
8742 |
49c12c93abf3
Updated runtime files and translations.
Christian Brabandt <cb@256bit.org>
parents:
11529
diff
changeset
|
8743 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
|
8744 might want to set it again in your |gvimrc|. |
49c12c93abf3
Updated runtime files and translations.
Christian Brabandt <cb@256bit.org>
parents:
11529
diff
changeset
|
8745 |
7 | 8746 Does not work on the Amiga, you always get a screen flash. |
8747 Also see 'errorbells'. | |
8748 | |
8749 *'warn'* *'nowarn'* | |
8750 'warn' boolean (default on) | |
8751 global | |
8752 Give a warning message when a shell command is used while the buffer | |
8753 has been changed. | |
8754 | |
8755 *'weirdinvert'* *'wiv'* *'noweirdinvert'* *'nowiv'* | |
8756 'weirdinvert' 'wiv' boolean (default off) | |
8757 global | |
667 | 8758 This option has the same effect as the 't_xs' terminal option. |
7 | 8759 It is provided for backwards compatibility with version 4.x. |
8760 Setting 'weirdinvert' has the effect of making 't_xs' non-empty, and | |
8761 vice versa. Has no effect when the GUI is running. | |
8762 | |
8763 *'whichwrap'* *'ww'* | |
8764 'whichwrap' 'ww' string (Vim default: "b,s", Vi default: "") | |
8765 global | |
8766 Allow specified keys that move the cursor left/right to move to the | |
8767 previous/next line when the cursor is on the first/last character in | |
8768 the line. Concatenate characters to allow this for these keys: | |
8769 char key mode ~ | |
8770 b <BS> Normal and Visual | |
8771 s <Space> Normal and Visual | |
712 | 8772 h "h" Normal and Visual (not recommended) |
8773 l "l" Normal and Visual (not recommended) | |
7 | 8774 < <Left> Normal and Visual |
8775 > <Right> Normal and Visual | |
8776 ~ "~" Normal | |
8777 [ <Left> Insert and Replace | |
8778 ] <Right> Insert and Replace | |
8779 For example: > | |
8780 :set ww=<,>,[,] | |
8781 < allows wrap only when cursor keys are used. | |
8782 When the movement keys are used in combination with a delete or change | |
8783 operator, the <EOL> also counts for a character. This makes "3h" | |
8784 different from "3dh" when the cursor crosses the end of a line. This | |
8785 is also true for "x" and "X", because they do the same as "dl" and | |
8786 "dh". If you use this, you may also want to use the mapping | |
8787 ":map <BS> X" to make backspace delete the character in front of the | |
8788 cursor. | |
714 | 8789 When 'l' is included and it is used after an operator at the end of a |
18130 | 8790 line (not an empty line) then it will not move to the next line. This |
8791 makes "dl", "cl", "yl" etc. work normally. | |
7 | 8792 NOTE: This option is set to the Vi default value when 'compatible' is |
8793 set and to the Vim default value when 'compatible' is reset. | |
8794 | |
8795 *'wildchar'* *'wc'* | |
8796 'wildchar' 'wc' number (Vim default: <Tab>, Vi default: CTRL-E) | |
8797 global | |
8798 Character you have to type to start wildcard expansion in the | |
8799 command-line, as specified with 'wildmode'. | |
1621 | 8800 More info here: |cmdline-completion|. |
7 | 8801 The character is not recognized when used inside a macro. See |
8802 'wildcharm' for that. | |
25836 | 8803 Some keys will not work, such as CTRL-C, <CR> and Enter. |
7 | 8804 Although 'wc' is a number option, you can set it to a special key: > |
25836 | 8805 :set wc=<Tab> |
7 | 8806 < NOTE: This option is set to the Vi default value when 'compatible' is |
8807 set and to the Vim default value when 'compatible' is reset. | |
8808 | |
8809 *'wildcharm'* *'wcm'* | |
8810 'wildcharm' 'wcm' number (default: none (0)) | |
8811 global | |
8812 'wildcharm' works exactly like 'wildchar', except that it is | |
233 | 8813 recognized when used inside a macro. You can find "spare" command-line |
8814 keys suitable for this option by looking at |ex-edit-index|. Normally | |
7 | 8815 you'll never actually type 'wildcharm', just use it in mappings that |
8816 automatically invoke completion mode, e.g.: > | |
8817 :set wcm=<C-Z> | |
1621 | 8818 :cnoremap ss so $vim/sessions/*.vim<C-Z> |
7 | 8819 < Then after typing :ss you can use CTRL-P & CTRL-N. |
8820 | |
8821 *'wildignore'* *'wig'* | |
8822 'wildignore' 'wig' string (default "") | |
8823 global | |
8824 {not available when compiled without the |+wildignore| | |
8825 feature} | |
8826 A list of file patterns. A file that matches with one of these | |
3682 | 8827 patterns is ignored when expanding |wildcards|, completing file or |
8828 directory names, and influences the result of |expand()|, |glob()| and | |
8829 |globpath()| unless a flag is passed to disable this. | |
7 | 8830 The pattern is used like with |:autocmd|, see |autocmd-patterns|. |
8831 Also see 'suffixes'. | |
8832 Example: > | |
8833 :set wildignore=*.o,*.obj | |
8834 < The use of |:set+=| and |:set-=| is preferred when adding or removing | |
8835 a pattern from the list. This avoids problems when a future version | |
8836 uses another default. | |
8837 | |
2652 | 8838 |
2662 | 8839 *'wildignorecase'* *'wic'* *'nowildignorecase'* *'nowic'* |
2652 | 8840 'wildignorecase' 'wic' boolean (default off) |
8841 global | |
8842 When set case is ignored when completing file names and directories. | |
4242 | 8843 Has no effect when 'fileignorecase' is set. |
2652 | 8844 Does not apply when the shell is used to expand wildcards, which |
8845 happens when there are special characters. | |
8846 | |
8847 | |
7 | 8848 *'wildmenu'* *'wmnu'* *'nowildmenu'* *'nowmnu'* |
9669
284b4eb307fc
commit https://github.com/vim/vim/commit/8c08b5b569e2a9e9f63dea514591ecfa2d3bb392
Christian Brabandt <cb@256bit.org>
parents:
9665
diff
changeset
|
8849 'wildmenu' 'wmnu' boolean (default off, set in |defaults.vim|) |
7 | 8850 global |
8851 {not available if compiled without the |+wildmenu| | |
8852 feature} | |
8853 When 'wildmenu' is on, command-line completion operates in an enhanced | |
8854 mode. On pressing 'wildchar' (usually <Tab>) to invoke completion, | |
8855 the possible matches are shown just above the command line, with the | |
8856 first match highlighted (overwriting the status line, if there is | |
8857 one). Keys that show the previous/next match, such as <Tab> or | |
8858 CTRL-P/CTRL-N, cause the highlight to move to the appropriate match. | |
8859 When 'wildmode' is used, "wildmenu" mode is used where "full" is | |
8860 specified. "longest" and "list" do not start "wildmenu" mode. | |
4159 | 8861 You can check the current mode with |wildmenumode()|. |
7 | 8862 If there are more matches than can fit in the line, a ">" is shown on |
8863 the right and/or a "<" is shown on the left. The status line scrolls | |
8864 as needed. | |
8865 The "wildmenu" mode is abandoned when a key is hit that is not used | |
8866 for selecting a completion. | |
8867 While the "wildmenu" is active the following keys have special | |
8868 meanings: | |
8869 | |
8870 <Left> <Right> - select previous/next match (like CTRL-P/CTRL-N) | |
8871 <Down> - in filename/menu name completion: move into a | |
8872 subdirectory or submenu. | |
8873 <CR> - in menu completion, when the cursor is just after a | |
8874 dot: move into a submenu. | |
8875 <Up> - in filename/menu name completion: move up into | |
8876 parent directory or parent menu. | |
8877 | |
8878 This makes the menus accessible from the console |console-menus|. | |
8879 | |
8880 If you prefer the <Left> and <Right> keys to move the cursor instead | |
8881 of selecting a different match, use this: > | |
8882 :cnoremap <Left> <Space><BS><Left> | |
8883 :cnoremap <Right> <Space><BS><Right> | |
8884 < | |
8885 The "WildMenu" highlighting is used for displaying the current match | |
8886 |hl-WildMenu|. | |
8887 | |
8888 *'wildmode'* *'wim'* | |
8889 'wildmode' 'wim' string (Vim default: "full") | |
8890 global | |
8891 Completion mode that is used for the character specified with | |
10 | 8892 'wildchar'. It is a comma separated list of up to four parts. Each |
1152 | 8893 part specifies what to do for each consecutive use of 'wildchar'. The |
7 | 8894 first part specifies the behavior for the first use of 'wildchar', |
8895 The second part for the second use, etc. | |
24387 | 8896 |
8897 Each part consists of a colon separated list consisting of the | |
8898 following possible values: | |
7 | 8899 "" Complete only the first match. |
8900 "full" Complete the next full match. After the last match, | |
8901 the original string is used and then the first match | |
24387 | 8902 again. Will also start 'wildmenu' if it is enabled. |
7 | 8903 "longest" Complete till longest common string. If this doesn't |
8904 result in a longer string, use the next part. | |
24387 | 8905 "list" When more than one match, list all matches. |
8906 "lastused" When completing buffer names and more than one buffer | |
8907 matches, sort buffers by time last used (other than | |
8908 the current buffer). | |
8909 When there is only a single match, it is fully completed in all cases. | |
8910 | |
8911 Examples of useful colon-separated values: | |
7 | 8912 "longest:full" Like "longest", but also start 'wildmenu' if it is |
24387 | 8913 enabled. Will not complete to the next full match. |
7 | 8914 "list:full" When more than one match, list all matches and |
8915 complete first match. | |
8916 "list:longest" When more than one match, list all matches and | |
8917 complete till longest common string. | |
24387 | 8918 "list:lastused" When more than one buffer matches, list all matches |
8919 and sort buffers by time last used (other than the | |
8920 current buffer). | |
7 | 8921 |
8922 Examples: > | |
8923 :set wildmode=full | |
233 | 8924 < Complete first full match, next match, etc. (the default) > |
7 | 8925 :set wildmode=longest,full |
8926 < Complete longest common string, then each full match > | |
8927 :set wildmode=list:full | |
8928 < List all matches and complete each full match > | |
8929 :set wildmode=list,full | |
8930 < List all matches without completing, then each full match > | |
8931 :set wildmode=longest,list | |
8932 < Complete longest common string, then list alternatives. | |
1621 | 8933 More info here: |cmdline-completion|. |
7 | 8934 |
40 | 8935 *'wildoptions'* *'wop'* |
8936 'wildoptions' 'wop' string (default "") | |
8937 global | |
8938 {not available when compiled without the |+wildignore| | |
8939 feature} | |
8940 A list of words that change how command line completion is done. | |
8941 Currently only one word is allowed: | |
8942 tagfile When using CTRL-D to list matching tags, the kind of | |
856 | 8943 tag and the file of the tag is listed. Only one match |
40 | 8944 is displayed per line. Often used tag kinds are: |
8945 d #define | |
8946 f function | |
8947 Also see |cmdline-completion|. | |
8948 | |
7 | 8949 *'winaltkeys'* *'wak'* |
8950 'winaltkeys' 'wak' string (default "menu") | |
8951 global | |
8952 {only used in Win32, Motif, GTK and Photon GUI} | |
8953 Some GUI versions allow the access to menu entries by using the ALT | |
8954 key in combination with a character that appears underlined in the | |
8955 menu. This conflicts with the use of the ALT key for mappings and | |
8956 entering special characters. This option tells what to do: | |
8957 no Don't use ALT keys for menus. ALT key combinations can be | |
8958 mapped, but there is no automatic handling. This can then be | |
8959 done with the |:simalt| command. | |
8960 yes ALT key handling is done by the windowing system. ALT key | |
8961 combinations cannot be mapped. | |
8962 menu Using ALT in combination with a character that is a menu | |
10 | 8963 shortcut key, will be handled by the windowing system. Other |
7 | 8964 keys can be mapped. |
8965 If the menu is disabled by excluding 'm' from 'guioptions', the ALT | |
8966 key is never used for the menu. | |
36 | 8967 This option is not used for <F10>; on Win32 and with GTK <F10> will |
8968 select the menu, unless it has been mapped. | |
7 | 8969 |
16778
eda4d65f232c
patch 8.1.1391: no popup window support
Bram Moolenaar <Bram@vim.org>
parents:
16740
diff
changeset
|
8970 *'wincolor'* *'wcr'* |
eda4d65f232c
patch 8.1.1391: no popup window support
Bram Moolenaar <Bram@vim.org>
parents:
16740
diff
changeset
|
8971 'wincolor' 'wcr' string (default empty) |
eda4d65f232c
patch 8.1.1391: no popup window support
Bram Moolenaar <Bram@vim.org>
parents:
16740
diff
changeset
|
8972 local to window |
eda4d65f232c
patch 8.1.1391: no popup window support
Bram Moolenaar <Bram@vim.org>
parents:
16740
diff
changeset
|
8973 Highlight group name to use for this window instead of the Normal |
eda4d65f232c
patch 8.1.1391: no popup window support
Bram Moolenaar <Bram@vim.org>
parents:
16740
diff
changeset
|
8974 color |hl-Normal|. |
eda4d65f232c
patch 8.1.1391: no popup window support
Bram Moolenaar <Bram@vim.org>
parents:
16740
diff
changeset
|
8975 |
164 | 8976 *'window'* *'wi'* |
8977 'window' 'wi' number (default screen height - 1) | |
8978 global | |
24278 | 8979 Window height used for |CTRL-F| and |CTRL-B| when there is only one |
8980 window and the value is smaller than 'lines' minus one. The screen | |
8981 will scroll 'window' minus two lines, with a minimum of one. | |
164 | 8982 When 'window' is equal to 'lines' minus one CTRL-F and CTRL-B scroll |
8983 in a much smarter way, taking care of wrapping lines. | |
8984 When resizing the Vim window, the value is smaller than 1 or more than | |
8985 or equal to 'lines' it will be set to 'lines' minus 1. | |
24278 | 8986 Note: Do not confuse this with the height of the Vim window, use |
8987 'lines' for that. | |
164 | 8988 |
7 | 8989 *'winheight'* *'wh'* *E591* |
8990 'winheight' 'wh' number (default 1) | |
8991 global | |
8992 Minimal number of lines for the current window. This is not a hard | |
10 | 8993 minimum, Vim will use fewer lines if there is not enough room. If the |
1621 | 8994 focus goes to a window that is smaller, its size is increased, at the |
8995 cost of the height of other windows. | |
8996 Set 'winheight' to a small number for normal editing. | |
8997 Set it to 999 to make the current window fill most of the screen. | |
8998 Other windows will be only 'winminheight' high. This has the drawback | |
8999 that ":all" will create only two windows. To avoid "vim -o 1 2 3 4" | |
9000 to create only two windows, set the option after startup is done, | |
9001 using the |VimEnter| event: > | |
9002 au VimEnter * set winheight=999 | |
9003 < Minimum value is 1. | |
9004 The height is not adjusted after one of the commands that change the | |
7 | 9005 height of the current window. |
9006 'winheight' applies to the current window. Use 'winminheight' to set | |
9007 the minimal height for other windows. | |
9008 | |
9009 *'winfixheight'* *'wfh'* *'nowinfixheight'* *'nowfh'* | |
9010 'winfixheight' 'wfh' boolean (default off) | |
9011 local to window | |
9012 Keep the window height when windows are opened or closed and | |
1152 | 9013 'equalalways' is set. Also for |CTRL-W_=|. Set by default for the |
9014 |preview-window| and |quickfix-window|. | |
7 | 9015 The height may be changed anyway when running out of room. |
9016 | |
782 | 9017 *'winfixwidth'* *'wfw'* *'nowinfixwidth'* *'nowfw'* |
9018 'winfixwidth' 'wfw' boolean (default off) | |
9019 local to window | |
9020 Keep the window width when windows are opened or closed and | |
1152 | 9021 'equalalways' is set. Also for |CTRL-W_=|. |
782 | 9022 The width may be changed anyway when running out of room. |
9023 | |
7 | 9024 *'winminheight'* *'wmh'* |
9025 'winminheight' 'wmh' number (default 1) | |
9026 global | |
9027 The minimal height of a window, when it's not the current window. | |
9028 This is a hard minimum, windows will never become smaller. | |
9029 When set to zero, windows may be "squashed" to zero lines (i.e. just a | |
9030 status bar) if necessary. They will return to at least one line when | |
9031 they become active (since the cursor has to have somewhere to go.) | |
9032 Use 'winheight' to set the minimal height of the current window. | |
9033 This option is only checked when making a window smaller. Don't use a | |
9034 large number, it will cause errors when opening more than a few | |
9035 windows. A value of 0 to 3 is reasonable. | |
9036 | |
9037 *'winminwidth'* *'wmw'* | |
9038 'winminwidth' 'wmw' number (default 1) | |
9039 global | |
9040 The minimal width of a window, when it's not the current window. | |
9041 This is a hard minimum, windows will never become smaller. | |
9042 When set to zero, windows may be "squashed" to zero columns (i.e. just | |
9043 a vertical separator) if necessary. They will return to at least one | |
9044 line when they become active (since the cursor has to have somewhere | |
9045 to go.) | |
9046 Use 'winwidth' to set the minimal width of the current window. | |
9047 This option is only checked when making a window smaller. Don't use a | |
9048 large number, it will cause errors when opening more than a few | |
9049 windows. A value of 0 to 12 is reasonable. | |
9050 | |
12138
bee3751f3d4e
patch 8.0.0949: winpty.dll name is fixed
Christian Brabandt <cb@256bit.org>
parents:
11914
diff
changeset
|
9051 *'winptydll'* |
bee3751f3d4e
patch 8.0.0949: winpty.dll name is fixed
Christian Brabandt <cb@256bit.org>
parents:
11914
diff
changeset
|
9052 '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
|
9053 global |
bee3751f3d4e
patch 8.0.0949: winpty.dll name is fixed
Christian Brabandt <cb@256bit.org>
parents:
11914
diff
changeset
|
9054 {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
|
9055 feature on MS-Windows} |
bee3751f3d4e
patch 8.0.0949: winpty.dll name is fixed
Christian Brabandt <cb@256bit.org>
parents:
11914
diff
changeset
|
9056 Specifies the name of the winpty shared library, used for the |
21676 | 9057 |:terminal| command. The default depends on whether Vim was built as a |
12254 | 9058 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
|
9059 a fallback. |
bee3751f3d4e
patch 8.0.0949: winpty.dll name is fixed
Christian Brabandt <cb@256bit.org>
parents:
11914
diff
changeset
|
9060 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
|
9061 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
|
9062 security reasons. |
bee3751f3d4e
patch 8.0.0949: winpty.dll name is fixed
Christian Brabandt <cb@256bit.org>
parents:
11914
diff
changeset
|
9063 |
7 | 9064 *'winwidth'* *'wiw'* *E592* |
9065 'winwidth' 'wiw' number (default 20) | |
9066 global | |
9067 Minimal number of columns for the current window. This is not a hard | |
9068 minimum, Vim will use fewer columns if there is not enough room. If | |
9069 the current window is smaller, its size is increased, at the cost of | |
9070 the width of other windows. Set it to 999 to make the current window | |
9071 always fill the screen. Set it to a small number for normal editing. | |
9072 The width is not adjusted after one of the commands to change the | |
9073 width of the current window. | |
9074 'winwidth' applies to the current window. Use 'winminwidth' to set | |
9075 the minimal width for other windows. | |
9076 | |
9077 *'wrap'* *'nowrap'* | |
9078 'wrap' boolean (default on) | |
9079 local to window | |
9080 This option changes how text is displayed. It doesn't change the text | |
9081 in the buffer, see 'textwidth' for that. | |
9082 When on, lines longer than the width of the window will wrap and | |
10 | 9083 displaying continues on the next line. When off lines will not wrap |
9084 and only part of long lines will be displayed. When the cursor is | |
7 | 9085 moved to a part that is not shown, the screen will scroll |
9086 horizontally. | |
9087 The line will be broken in the middle of a word if necessary. See | |
9088 'linebreak' to get the break at a word boundary. | |
9089 To make scrolling horizontally a bit more useful, try this: > | |
9090 :set sidescroll=5 | |
9091 :set listchars+=precedes:<,extends:> | |
9092 < See 'sidescroll', 'listchars' and |wrap-off|. | |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
9093 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
|
9094 on. |
7 | 9095 |
9096 *'wrapmargin'* *'wm'* | |
9097 'wrapmargin' 'wm' number (default 0) | |
9098 local to buffer | |
9099 Number of characters from the right window border where wrapping | |
9100 starts. When typing text beyond this limit, an <EOL> will be inserted | |
9101 and inserting continues on the next line. | |
9102 Options that add a margin, such as 'number' and 'foldcolumn', cause | |
9103 the text width to be further reduced. This is Vi compatible. | |
9104 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
|
9105 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
|
9106 is reset. |
16610 | 9107 See also 'formatoptions' and |ins-textwidth|. |
7 | 9108 |
9109 *'wrapscan'* *'ws'* *'nowrapscan'* *'nows'* | |
9110 'wrapscan' 'ws' boolean (default on) *E384* *E385* | |
9111 global | |
500 | 9112 Searches wrap around the end of the file. Also applies to |]s| and |
9113 |[s|, searching for spelling mistakes. | |
7 | 9114 |
9115 *'write'* *'nowrite'* | |
9116 'write' boolean (default on) | |
9117 global | |
9118 Allows writing files. When not set, writing a file is not allowed. | |
9119 Can be used for a view-only mode, where modifications to the text are | |
10 | 9120 still allowed. Can be reset with the |-m| or |-M| command line |
7 | 9121 argument. Filtering text is still possible, even though this requires |
9122 writing a temporary file. | |
9123 | |
9124 *'writeany'* *'wa'* *'nowriteany'* *'nowa'* | |
9125 'writeany' 'wa' boolean (default off) | |
9126 global | |
9127 Allows writing to any file with no need for "!" override. | |
9128 | |
9129 *'writebackup'* *'wb'* *'nowritebackup'* *'nowb'* | |
9130 'writebackup' 'wb' boolean (default on with |+writebackup| feature, off | |
9131 otherwise) | |
9132 global | |
9133 Make a backup before overwriting a file. The backup is removed after | |
9134 the file was successfully written, unless the 'backup' option is | |
3513 | 9135 also on. |
9136 WARNING: Switching this option off means that when Vim fails to write | |
9137 your buffer correctly and then, for whatever reason, Vim exits, you | |
9138 lose both the original file and what you were writing. Only reset | |
9139 this option if your file system is almost full and it makes the write | |
9140 fail (and make sure not to exit Vim until the write was successful). | |
9141 See |backup-table| for another explanation. | |
7 | 9142 When the 'backupskip' pattern matches, a backup is not made anyway. |
18719 | 9143 Depending on 'backupcopy' the backup is a new file or the original |
9144 file renamed (and a new file is written). | |
7 | 9145 NOTE: This option is set to the default value when 'compatible' is |
9146 set. | |
9147 | |
9148 *'writedelay'* *'wd'* | |
9149 'writedelay' 'wd' number (default 0) | |
9150 global | |
9344
33c1b85d408c
commit https://github.com/vim/vim/commit/802a0d902fca423acb15f835d7b09183883d79a0
Christian Brabandt <cb@256bit.org>
parents:
9286
diff
changeset
|
9151 The number of milliseconds to wait for each character sent to the |
7 | 9152 screen. When non-zero, characters are sent to the terminal one by |
18972 | 9153 one. For debugging purposes. |
7 | 9154 |
14421 | 9155 vim:tw=78:ts=8:noet:ft=help:norl: |