annotate runtime/doc/options.txt @ 17229:f1c7b7a4d9e4 v8.1.1614

patch 8.1.1614: 'numberwidth' can only go up to 10 commit https://github.com/vim/vim/commit/f8a071265535b8cc43e50a81f4d5049883ca50e4 Author: Bram Moolenaar <Bram@vim.org> Date: Mon Jul 1 22:06:07 2019 +0200 patch 8.1.1614: 'numberwidth' can only go up to 10 Problem: 'numberwidth' can only go up to 10. Solution: Allow up to 20. (Charlie Stanton, closes https://github.com/vim/vim/issues/4584)
author Bram Moolenaar <Bram@vim.org>
date Mon, 01 Jul 2019 22:15:05 +0200
parents 9ccb1ea9b2fc
children b9bc47742df6
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
17229
f1c7b7a4d9e4 patch 8.1.1614: 'numberwidth' can only go up to 10
Bram Moolenaar <Bram@vim.org>
parents: 17161
diff changeset
1 *options.txt* For Vim version 8.1. Last change: 2019 Jun 27
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4 VIM REFERENCE MANUAL by Bram Moolenaar
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7 Options *options*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
9 1. Setting options |set-option|
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
10 2. Automatically setting options |auto-setting|
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11 3. Options summary |option-summary|
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
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
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
14
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
15 Vim has a number of internal variables and switches which can be set to
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
16 achieve special effects. These options come in three forms:
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
17 boolean can only be on or off *boolean* *toggle*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
18 number has a numeric value
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
19 string has a string value
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
20
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
21 ==============================================================================
523
a7ae7e043e43 updated for version 7.0146
vimboss
parents: 519
diff changeset
22 1. Setting options *set-option* *E764*
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
23
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
24 *:se* *:set*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
25 :se[t] Show all options that differ from their default value.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
26
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
27 :se[t] all Show all but terminal options.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
28
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
29 :se[t] termcap Show all terminal options. Note that in the GUI the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
30 key codes are not shown, because they are generated
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
31 internally and can't be changed. Changing the terminal
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
32 codes in the GUI is not useful either...
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
33
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
34 *E518* *E519*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
35 :se[t] {option}? Show value of {option}.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
36
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
37 :se[t] {option} Toggle option: set, switch it on.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
38 Number option: show value.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
39 String option: show value.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
40
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
41 :se[t] no{option} Toggle option: Reset, switch it off.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
42
2152
b9e314fe473f Updated runtime files.
Bram Moolenaar <bram@zimbu.org>
parents: 2033
diff changeset
43 *:set-!* *:set-inv*
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
44 :se[t] {option}! or
16443
32a543152dc0 patch 8.1.1226: {not in Vi} remarks get in the way of useful help text
Bram Moolenaar <Bram@vim.org>
parents: 16439
diff changeset
45 :se[t] inv{option} Toggle option: Invert value.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
46
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
47 *:set-default* *:set-&* *:set-&vi* *:set-&vim*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
48 :se[t] {option}& Reset option to its default value. May depend on the
16443
32a543152dc0 patch 8.1.1226: {not in Vi} remarks get in the way of useful help text
Bram Moolenaar <Bram@vim.org>
parents: 16439
diff changeset
49 current value of 'compatible'.
32a543152dc0 patch 8.1.1226: {not in Vi} remarks get in the way of useful help text
Bram Moolenaar <Bram@vim.org>
parents: 16439
diff changeset
50 :se[t] {option}&vi Reset option to its Vi default value.
32a543152dc0 patch 8.1.1226: {not in Vi} remarks get in the way of useful help text
Bram Moolenaar <Bram@vim.org>
parents: 16439
diff changeset
51 :se[t] {option}&vim Reset option to its Vim default value.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
52
13341
acd7eaa13d2b Updated runtime files.
Christian Brabandt <cb@256bit.org>
parents: 13314
diff changeset
53 :se[t] all& Set all options to their default value. The values of
7051
eff26a8620ce commit https://github.com/vim/vim/commit/88774fdd23f08355297bb8cda78856859051d3c7
Christian Brabandt <cb@256bit.org>
parents: 6949
diff changeset
54 these options are not changed:
eff26a8620ce commit https://github.com/vim/vim/commit/88774fdd23f08355297bb8cda78856859051d3c7
Christian Brabandt <cb@256bit.org>
parents: 6949
diff changeset
55 all terminal options, starting with t_
eff26a8620ce commit https://github.com/vim/vim/commit/88774fdd23f08355297bb8cda78856859051d3c7
Christian Brabandt <cb@256bit.org>
parents: 6949
diff changeset
56 'columns'
eff26a8620ce commit https://github.com/vim/vim/commit/88774fdd23f08355297bb8cda78856859051d3c7
Christian Brabandt <cb@256bit.org>
parents: 6949
diff changeset
57 'cryptmethod'
eff26a8620ce commit https://github.com/vim/vim/commit/88774fdd23f08355297bb8cda78856859051d3c7
Christian Brabandt <cb@256bit.org>
parents: 6949
diff changeset
58 'encoding'
eff26a8620ce commit https://github.com/vim/vim/commit/88774fdd23f08355297bb8cda78856859051d3c7
Christian Brabandt <cb@256bit.org>
parents: 6949
diff changeset
59 'key'
eff26a8620ce commit https://github.com/vim/vim/commit/88774fdd23f08355297bb8cda78856859051d3c7
Christian Brabandt <cb@256bit.org>
parents: 6949
diff changeset
60 'lines'
eff26a8620ce commit https://github.com/vim/vim/commit/88774fdd23f08355297bb8cda78856859051d3c7
Christian Brabandt <cb@256bit.org>
parents: 6949
diff changeset
61 'term'
eff26a8620ce commit https://github.com/vim/vim/commit/88774fdd23f08355297bb8cda78856859051d3c7
Christian Brabandt <cb@256bit.org>
parents: 6949
diff changeset
62 'ttymouse'
eff26a8620ce commit https://github.com/vim/vim/commit/88774fdd23f08355297bb8cda78856859051d3c7
Christian Brabandt <cb@256bit.org>
parents: 6949
diff changeset
63 'ttytype'
eff26a8620ce commit https://github.com/vim/vim/commit/88774fdd23f08355297bb8cda78856859051d3c7
Christian Brabandt <cb@256bit.org>
parents: 6949
diff changeset
64 Warning: This may have a lot of side effects.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
65
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
66 *:set-args* *E487* *E521*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
67 :se[t] {option}={value} or
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
68 :se[t] {option}:{value}
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
69 Set string or number option to {value}.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
70 For numeric options the value can be given in decimal,
8629
54ac275e3fc4 commit https://github.com/vim/vim/commit/3848e00e0177abdb31bc600234967863ec487233
Christian Brabandt <cb@256bit.org>
parents: 8560
diff changeset
71 hex (preceded with 0x) or octal (preceded with '0').
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
72 The old value can be inserted by typing 'wildchar' (by
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
73 default this is a <Tab> or CTRL-E if 'compatible' is
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
74 set). See |cmdline-completion|.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
75 White space between {option} and '=' is allowed and
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
76 will be ignored. White space between '=' and {value}
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
77 is not allowed.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
78 See |option-backslash| for using white space and
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
79 backslashes in {value}.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
80
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
81 :se[t] {option}+={value} *:set+=*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
82 Add the {value} to a number option, or append the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
83 {value} to a string option. When the option is a
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
84 comma separated list, a comma is added, unless the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
85 value was empty.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
86 If the option is a list of flags, superfluous flags
557
862863033fdd updated for version 7.0158
vimboss
parents: 548
diff changeset
87 are removed. When adding a flag that was already
862863033fdd updated for version 7.0158
vimboss
parents: 548
diff changeset
88 present the option value doesn't change.
809
4f1b94b51e99 updated for version 7.0b02
vimboss
parents: 804
diff changeset
89 Also see |:set-args| above.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
90
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
91 :se[t] {option}^={value} *:set^=*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
92 Multiply the {value} to a number option, or prepend
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
93 the {value} to a string option. When the option is a
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
94 comma separated list, a comma is added, unless the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
95 value was empty.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
96 Also see |:set-args| above.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
97
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
98 :se[t] {option}-={value} *:set-=*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
99 Subtract the {value} from a number option, or remove
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
100 the {value} from a string option, if it is there.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
101 If the {value} is not found in a string option, there
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
102 is no error or warning. When the option is a comma
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
103 separated list, a comma is deleted, unless the option
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
104 becomes empty.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
105 When the option is a list of flags, {value} must be
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
106 exactly as they appear in the option. Remove flags
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
107 one by one to avoid problems.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
108 Also see |:set-args| above.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
109
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
110 The {option} arguments to ":set" may be repeated. For example: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
111 :set ai nosi sw=3 ts=3
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
112 If you make an error in one of the arguments, an error message will be given
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
113 and the following arguments will be ignored.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
114
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
115 *:set-verbose*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
116 When 'verbose' is non-zero, displaying an option value will also tell where it
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
117 was last set. Example: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
118 :verbose set shiftwidth cindent?
14864
40ef13331e02 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 14702
diff changeset
119 < shiftwidth=4 ~
40ef13331e02 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 14702
diff changeset
120 Last set from modeline line 1 ~
40ef13331e02 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 14702
diff changeset
121 cindent ~
40ef13331e02 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 14702
diff changeset
122 Last set from /usr/local/share/vim/vim60/ftplugin/c.vim line 30 ~
1621
82b5078be2dd updated for version 7.2a
vimboss
parents: 1564
diff changeset
123 This is only done when specific option values are requested, not for ":verbose
82b5078be2dd updated for version 7.2a
vimboss
parents: 1564
diff changeset
124 set all" or ":verbose set" without an argument.
82b5078be2dd updated for version 7.2a
vimboss
parents: 1564
diff changeset
125 When the option was set by hand there is no "Last set" message.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
126 When the option was set while executing a function, user command or
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
127 autocommand, the script in which it was defined is reported.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
128 Note that an option may also have been set as a side effect of setting
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
129 'compatible'.
1621
82b5078be2dd updated for version 7.2a
vimboss
parents: 1564
diff changeset
130 A few special texts:
14864
40ef13331e02 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 14702
diff changeset
131 Last set from modeline line 1 ~
1621
82b5078be2dd updated for version 7.2a
vimboss
parents: 1564
diff changeset
132 Option was set in a |modeline|.
82b5078be2dd updated for version 7.2a
vimboss
parents: 1564
diff changeset
133 Last set from --cmd argument ~
82b5078be2dd updated for version 7.2a
vimboss
parents: 1564
diff changeset
134 Option was set with command line argument |--cmd| or +.
82b5078be2dd updated for version 7.2a
vimboss
parents: 1564
diff changeset
135 Last set from -c argument ~
82b5078be2dd updated for version 7.2a
vimboss
parents: 1564
diff changeset
136 Option was set with command line argument |-c|, +, |-S| or
82b5078be2dd updated for version 7.2a
vimboss
parents: 1564
diff changeset
137 |-q|.
82b5078be2dd updated for version 7.2a
vimboss
parents: 1564
diff changeset
138 Last set from environment variable ~
82b5078be2dd updated for version 7.2a
vimboss
parents: 1564
diff changeset
139 Option was set from an environment variable, $VIMINIT,
82b5078be2dd updated for version 7.2a
vimboss
parents: 1564
diff changeset
140 $GVIMINIT or $EXINIT.
82b5078be2dd updated for version 7.2a
vimboss
parents: 1564
diff changeset
141 Last set from error handler ~
82b5078be2dd updated for version 7.2a
vimboss
parents: 1564
diff changeset
142 Option was cleared when evaluating it resulted in an error.
82b5078be2dd updated for version 7.2a
vimboss
parents: 1564
diff changeset
143
2570
71b56b4e7785 Make the references to features in the help more consistent. (Sylvain Hitier)
Bram Moolenaar <bram@vim.org>
parents: 2561
diff changeset
144 {not available when compiled without the |+eval| feature}
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
145
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
146 *:set-termcap* *E522*
667
9090f866cd57 updated for version 7.0197
vimboss
parents: 665
diff changeset
147 For {option} the form "t_xx" may be used to set a terminal option. This will
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
148 override the value from the termcap. You can then use it in a mapping. If
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
149 the "xx" part contains special characters, use the <t_xx> form: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
150 :set <t_#4>=^[Ot
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
151 This can also be used to translate a special code for a normal key. For
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
152 example, if Alt-b produces <Esc>b, use this: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
153 :set <M-b>=^[b
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
154 (the ^[ is a real <Esc> here, use CTRL-V <Esc> to enter it)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
155 The advantage over a mapping is that it works in all situations.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
156
2726
0d201adaf9c5 updated for version 7.3.141
Bram Moolenaar <bram@vim.org>
parents: 2709
diff changeset
157 You can define any key codes, e.g.: >
0d201adaf9c5 updated for version 7.3.141
Bram Moolenaar <bram@vim.org>
parents: 2709
diff changeset
158 :set t_xy=^[foo;
0d201adaf9c5 updated for version 7.3.141
Bram Moolenaar <bram@vim.org>
parents: 2709
diff changeset
159 There is no warning for using a name that isn't recognized. You can map these
0d201adaf9c5 updated for version 7.3.141
Bram Moolenaar <bram@vim.org>
parents: 2709
diff changeset
160 codes as you like: >
0d201adaf9c5 updated for version 7.3.141
Bram Moolenaar <bram@vim.org>
parents: 2709
diff changeset
161 :map <t_xy> something
0d201adaf9c5 updated for version 7.3.141
Bram Moolenaar <bram@vim.org>
parents: 2709
diff changeset
162 < *E846*
0d201adaf9c5 updated for version 7.3.141
Bram Moolenaar <bram@vim.org>
parents: 2709
diff changeset
163 When a key code is not set, it's like it does not exist. Trying to get its
0d201adaf9c5 updated for version 7.3.141
Bram Moolenaar <bram@vim.org>
parents: 2709
diff changeset
164 value will result in an error: >
0d201adaf9c5 updated for version 7.3.141
Bram Moolenaar <bram@vim.org>
parents: 2709
diff changeset
165 :set t_kb=
0d201adaf9c5 updated for version 7.3.141
Bram Moolenaar <bram@vim.org>
parents: 2709
diff changeset
166 :set t_kb
0d201adaf9c5 updated for version 7.3.141
Bram Moolenaar <bram@vim.org>
parents: 2709
diff changeset
167 E846: Key code not set: t_kb
0d201adaf9c5 updated for version 7.3.141
Bram Moolenaar <bram@vim.org>
parents: 2709
diff changeset
168
36
125e80798a85 updated for version 7.0021
vimboss
parents: 33
diff changeset
169 The t_xx options cannot be set from a |modeline| or in the |sandbox|, for
125e80798a85 updated for version 7.0021
vimboss
parents: 33
diff changeset
170 security reasons.
125e80798a85 updated for version 7.0021
vimboss
parents: 33
diff changeset
171
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
172 The listing from ":set" looks different from Vi. Long string options are put
10
4e2284e71352 updated for version 7.0002
vimboss
parents: 8
diff changeset
173 at the end of the list. The number of options is quite large. The output of
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
174 "set all" probably does not fit on the screen, causing Vim to give the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
175 |more-prompt|.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
176
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
177 *option-backslash*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
178 To include white space in a string option value it has to be preceded with a
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
179 backslash. To include a backslash you have to use two. Effectively this
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
180 means that the number of backslashes in an option value is halved (rounded
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
181 down).
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
182 A few examples: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
183 :set tags=tags\ /usr/tags results in "tags /usr/tags"
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
184 :set tags=tags\\,file results in "tags\,file"
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
185 :set tags=tags\\\ file results in "tags\ file"
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
186
10
4e2284e71352 updated for version 7.0002
vimboss
parents: 8
diff changeset
187 The "|" character separates a ":set" command from a following command. To
4e2284e71352 updated for version 7.0002
vimboss
parents: 8
diff changeset
188 include the "|" in the option value, use "\|" instead. This example sets the
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
189 'titlestring' option to "hi|there": >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
190 :set titlestring=hi\|there
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
191 This sets the 'titlestring' option to "hi" and 'iconstring' to "there": >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
192 :set titlestring=hi|set iconstring=there
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
193
642
2392a6da4aa4 updated for version 7.0186
vimboss
parents: 634
diff changeset
194 Similarly, the double quote character starts a comment. To include the '"' in
2392a6da4aa4 updated for version 7.0186
vimboss
parents: 634
diff changeset
195 the option value, use '\"' instead. This example sets the 'titlestring'
2392a6da4aa4 updated for version 7.0186
vimboss
parents: 634
diff changeset
196 option to 'hi "there"': >
2392a6da4aa4 updated for version 7.0186
vimboss
parents: 634
diff changeset
197 :set titlestring=hi\ \"there\"
2392a6da4aa4 updated for version 7.0186
vimboss
parents: 634
diff changeset
198
10
4e2284e71352 updated for version 7.0002
vimboss
parents: 8
diff changeset
199 For MS-DOS and WIN32 backslashes in file names are mostly not removed. More
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
200 precise: For options that expect a file name (those where environment
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
201 variables are expanded) a backslash before a normal file name character is not
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
202 removed. But a backslash before a special character (space, backslash, comma,
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
203 etc.) is used like explained above.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
204 There is one special situation, when the value starts with "\\": >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
205 :set dir=\\machine\path results in "\\machine\path"
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
206 :set dir=\\\\machine\\path results in "\\machine\path"
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
207 :set dir=\\path\\file results in "\\path\file" (wrong!)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
208 For the first one the start is kept, but for the second one the backslashes
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
209 are halved. This makes sure it works both when you expect backslashes to be
10
4e2284e71352 updated for version 7.0002
vimboss
parents: 8
diff changeset
210 halved and when you expect the backslashes to be kept. The third gives a
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
211 result which is probably not what you want. Avoid it.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
212
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
213 *add-option-flags* *remove-option-flags*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
214 *E539* *E550* *E551* *E552*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
215 Some options are a list of flags. When you want to add a flag to such an
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
216 option, without changing the existing ones, you can do it like this: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
217 :set guioptions+=a
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
218 Remove a flag from an option like this: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
219 :set guioptions-=a
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
220 This removes the 'a' flag from 'guioptions'.
10
4e2284e71352 updated for version 7.0002
vimboss
parents: 8
diff changeset
221 Note that you should add or remove one flag at a time. If 'guioptions' has
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
222 the value "ab", using "set guioptions-=ba" won't work, because the string "ba"
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
223 doesn't appear.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
224
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
225 *:set_env* *expand-env* *expand-environment-var*
22
cc049b00ee70 updated for version 7.0014
vimboss
parents: 20
diff changeset
226 Environment variables in specific string options will be expanded. If the
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
227 environment variable exists the '$' and the following environment variable
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
228 name is replaced with its value. If it does not exist the '$' and the name
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
229 are not modified. Any non-id character (not a letter, digit or '_') may
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
230 follow the environment variable name. That character and what follows is
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
231 appended to the value of the environment variable. Examples: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
232 :set term=$TERM.new
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
233 :set path=/usr/$INCLUDE,$HOME/include,.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
234 When adding or removing a string from an option with ":set opt-=val" or ":set
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
235 opt+=val" the expansion is done before the adding or removing.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
236
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
237
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
238 Handling of local options *local-options*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
239
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
240 Some of the options only apply to a window or buffer. Each window or buffer
10449
222b1432814e commit https://github.com/vim/vim/commit/5162822914372fc916a93f85848c0c82209e7cec
Christian Brabandt <cb@256bit.org>
parents: 10272
diff changeset
241 has its own copy of this option, thus each can have its own value. This
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
242 allows you to set 'list' in one window but not in another. And set
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
243 'shiftwidth' to 3 in one buffer and 4 in another.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
244
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
245 The following explains what happens to these local options in specific
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
246 situations. You don't really need to know all of this, since Vim mostly uses
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
247 the option values you would expect. Unfortunately, doing what the user
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
248 expects is a bit complicated...
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
249
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
250 When splitting a window, the local options are copied to the new window. Thus
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
251 right after the split the contents of the two windows look the same.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
252
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
253 When editing a new buffer, its local option values must be initialized. Since
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
254 the local options of the current buffer might be specifically for that buffer,
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
255 these are not used. Instead, for each buffer-local option there also is a
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
256 global value, which is used for new buffers. With ":set" both the local and
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
257 global value is changed. With "setlocal" only the local value is changed,
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
258 thus this value is not used when editing a new buffer.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
259
9852
4eea48b76d03 commit https://github.com/vim/vim/commit/95ec9d6a6ab3117d60ff638670a803d43974ba51
Christian Brabandt <cb@256bit.org>
parents: 9737
diff changeset
260 When editing a buffer that has been edited before, the options from the window
4eea48b76d03 commit https://github.com/vim/vim/commit/95ec9d6a6ab3117d60ff638670a803d43974ba51
Christian Brabandt <cb@256bit.org>
parents: 9737
diff changeset
261 that was last closed are used again. If this buffer has been edited in this
4eea48b76d03 commit https://github.com/vim/vim/commit/95ec9d6a6ab3117d60ff638670a803d43974ba51
Christian Brabandt <cb@256bit.org>
parents: 9737
diff changeset
262 window, the values from back then are used. Otherwise the values from the
4eea48b76d03 commit https://github.com/vim/vim/commit/95ec9d6a6ab3117d60ff638670a803d43974ba51
Christian Brabandt <cb@256bit.org>
parents: 9737
diff changeset
263 last closed window where the buffer was edited last are used.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
264
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
265 It's possible to set a local window option specifically for a type of buffer.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
266 When you edit another buffer in the same window, you don't want to keep
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
267 using these local window options. Therefore Vim keeps a global value of the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
268 local window options, which is used when editing another buffer. Each window
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
269 has its own copy of these values. Thus these are local to the window, but
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
270 global to all buffers in the window. With this you can do: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
271 :e one
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
272 :set list
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
273 :e two
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
274 Now the 'list' option will also be set in "two", since with the ":set list"
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
275 command you have also set the global value. >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
276 :set nolist
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
277 :e one
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
278 :setlocal list
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
279 :e two
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
280 Now the 'list' option is not set, because ":set nolist" resets the global
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
281 value, ":setlocal list" only changes the local value and ":e two" gets the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
282 global value. Note that if you do this next: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
283 :e one
4358
cf1d93a3914a Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 4264
diff changeset
284 You will get back the 'list' value as it was the last time you edited "one".
cf1d93a3914a Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 4264
diff changeset
285 The options local to a window are remembered for each buffer. This also
cf1d93a3914a Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 4264
diff changeset
286 happens when the buffer is not loaded, but they are lost when the buffer is
cf1d93a3914a Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 4264
diff changeset
287 wiped out |:bwipe|.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
288
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
289 *:setl* *:setlocal*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
290 :setl[ocal] ... Like ":set" but set only the value local to the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
291 current buffer or window. Not all options have a
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
292 local value. If the option does not have a local
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
293 value the global value is set.
2413
f766a1c87f69 7.3b -> 7.3c
Bram Moolenaar <bram@vim.org>
parents: 2411
diff changeset
294 With the "all" argument: display local values for all
f766a1c87f69 7.3b -> 7.3c
Bram Moolenaar <bram@vim.org>
parents: 2411
diff changeset
295 local options.
f766a1c87f69 7.3b -> 7.3c
Bram Moolenaar <bram@vim.org>
parents: 2411
diff changeset
296 Without argument: Display local values for all local
f766a1c87f69 7.3b -> 7.3c
Bram Moolenaar <bram@vim.org>
parents: 2411
diff changeset
297 options which are different from the default.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
298 When displaying a specific local option, show the
1621
82b5078be2dd updated for version 7.2a
vimboss
parents: 1564
diff changeset
299 local value. For a global/local boolean option, when
82b5078be2dd updated for version 7.2a
vimboss
parents: 1564
diff changeset
300 the global value is being used, "--" is displayed
82b5078be2dd updated for version 7.2a
vimboss
parents: 1564
diff changeset
301 before the option name.
82b5078be2dd updated for version 7.2a
vimboss
parents: 1564
diff changeset
302 For a global option the global value is
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
303 shown (but that might change in the future).
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
304
809
4f1b94b51e99 updated for version 7.0b02
vimboss
parents: 804
diff changeset
305 :setl[ocal] {option}< Set the local value of {option} to its global value by
4f1b94b51e99 updated for version 7.0b02
vimboss
parents: 804
diff changeset
306 copying the value.
4f1b94b51e99 updated for version 7.0b02
vimboss
parents: 804
diff changeset
307
3281
af1e8a1714c2 Update runtime files.
Bram Moolenaar <bram@vim.org>
parents: 3237
diff changeset
308 :se[t] {option}< For |global-local| options: Remove the local value of
af1e8a1714c2 Update runtime files.
Bram Moolenaar <bram@vim.org>
parents: 3237
diff changeset
309 {option}, so that the global value will be used.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
310
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
311 *:setg* *:setglobal*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
312 :setg[lobal] ... Like ":set" but set only the global value for a local
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
313 option without changing the local value.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
314 When displaying an option, the global value is shown.
2413
f766a1c87f69 7.3b -> 7.3c
Bram Moolenaar <bram@vim.org>
parents: 2411
diff changeset
315 With the "all" argument: display global values for all
f766a1c87f69 7.3b -> 7.3c
Bram Moolenaar <bram@vim.org>
parents: 2411
diff changeset
316 local options.
f766a1c87f69 7.3b -> 7.3c
Bram Moolenaar <bram@vim.org>
parents: 2411
diff changeset
317 Without argument: display global values for all local
f766a1c87f69 7.3b -> 7.3c
Bram Moolenaar <bram@vim.org>
parents: 2411
diff changeset
318 options which are different from the default.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
319
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
320 For buffer-local and window-local options:
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
321 Command global value local value ~
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
322 :set option=value set set
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
323 :setlocal option=value - set
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
324 :setglobal option=value set -
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
325 :set option? - display
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
326 :setlocal option? - display
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
327 :setglobal option? display -
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
328
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
329
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
330 Global options with a local value *global-local*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
331
40
f1d2a58883b9 updated for version 7.0024
vimboss
parents: 39
diff changeset
332 Options are global when you mostly use one value for all buffers and windows.
f1d2a58883b9 updated for version 7.0024
vimboss
parents: 39
diff changeset
333 For some global options it's useful to sometimes have a different local value.
f1d2a58883b9 updated for version 7.0024
vimboss
parents: 39
diff changeset
334 You can set the local value with ":setlocal". That buffer or window will then
f1d2a58883b9 updated for version 7.0024
vimboss
parents: 39
diff changeset
335 use the local value, while other buffers and windows continue using the global
f1d2a58883b9 updated for version 7.0024
vimboss
parents: 39
diff changeset
336 value.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
337
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
338 For example, you have two windows, both on C source code. They use the global
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
339 'makeprg' option. If you do this in one of the two windows: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
340 :set makeprg=gmake
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
341 then the other window will switch to the same value. There is no need to set
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
342 the 'makeprg' option in the other C source window too.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
343 However, if you start editing a Perl file in a new window, you want to use
1152
e1787f5b90da updated for version 7.1a
vimboss
parents: 1111
diff changeset
344 another 'makeprg' for it, without changing the value used for the C source
10
4e2284e71352 updated for version 7.0002
vimboss
parents: 8
diff changeset
345 files. You use this command: >
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
346 :setlocal makeprg=perlmake
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
347 You can switch back to using the global value by making the local value empty: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
348 :setlocal makeprg=
15729
fe57e4f0eac1 Update runtime files.
Bram Moolenaar <Bram@vim.org>
parents: 15725
diff changeset
349 This only works for a string option. For a number or boolean option you need
fe57e4f0eac1 Update runtime files.
Bram Moolenaar <Bram@vim.org>
parents: 15725
diff changeset
350 to use the "<" flag, like this: >
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
351 :setlocal autoread<
15729
fe57e4f0eac1 Update runtime files.
Bram Moolenaar <Bram@vim.org>
parents: 15725
diff changeset
352 Note that for non-boolean and non-number options using "<" copies the global
fe57e4f0eac1 Update runtime files.
Bram Moolenaar <Bram@vim.org>
parents: 15725
diff changeset
353 value to the local value, it doesn't switch back to using the global value
fe57e4f0eac1 Update runtime files.
Bram Moolenaar <Bram@vim.org>
parents: 15725
diff changeset
354 (that matters when the global value changes later). You can also use: >
809
4f1b94b51e99 updated for version 7.0b02
vimboss
parents: 804
diff changeset
355 :set path<
4f1b94b51e99 updated for version 7.0b02
vimboss
parents: 804
diff changeset
356 This will make the local value of 'path' empty, so that the global value is
4f1b94b51e99 updated for version 7.0b02
vimboss
parents: 804
diff changeset
357 used. Thus it does the same as: >
4f1b94b51e99 updated for version 7.0b02
vimboss
parents: 804
diff changeset
358 :setlocal path=
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
359 Note: In the future more global options can be made global-local. Using
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
360 ":setlocal" on a global option might work differently then.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
361
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
362
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
363 Setting the filetype
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
364
11473
bd6ff5246c71 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 11442
diff changeset
365 :setf[iletype] [FALLBACK] {filetype} *:setf* *:setfiletype*
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
366 Set the 'filetype' option to {filetype}, but only if
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
367 not done yet in a sequence of (nested) autocommands.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
368 This is short for: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
369 :if !did_filetype()
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
370 : setlocal filetype={filetype}
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
371 :endif
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
372 < This command is used in a filetype.vim file to avoid
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
373 setting the 'filetype' option twice, causing different
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
374 settings and syntax files to be loaded.
11473
bd6ff5246c71 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 11442
diff changeset
375
bd6ff5246c71 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 11442
diff changeset
376 When the optional FALLBACK argument is present, a
bd6ff5246c71 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 11442
diff changeset
377 later :setfiletype command will override the
16023
dc766e1b0c95 Update runtime files.
Bram Moolenaar <Bram@vim.org>
parents: 15932
diff changeset
378 'filetype'. This is to be used for filetype
dc766e1b0c95 Update runtime files.
Bram Moolenaar <Bram@vim.org>
parents: 15932
diff changeset
379 detections that are just a guess. |did_filetype()|
dc766e1b0c95 Update runtime files.
Bram Moolenaar <Bram@vim.org>
parents: 15932
diff changeset
380 will return false after this command.
11473
bd6ff5246c71 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 11442
diff changeset
381
2698
b6471224d2af Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents: 2681
diff changeset
382 *option-window* *optwin*
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
383 :bro[wse] se[t] *:set-browse* *:browse-set* *:opt* *:options*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
384 :opt[ions] Open a window for viewing and setting all options.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
385 Options are grouped by function.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
386 Offers short help for each option. Hit <CR> on the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
387 short help to open a help window with more help for
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
388 the option.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
389 Modify the value of the option and hit <CR> on the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
390 "set" line to set the new value. For window and
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
391 buffer specific options, the last accessed window is
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
392 used to set the option value in, unless this is a help
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
393 window, in which case the window below help window is
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
394 used (skipping the option-window).
13437
02b3f719eacb Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 13341
diff changeset
395 {not available when compiled without the |+eval|
02b3f719eacb Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 13341
diff changeset
396 feature}
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
397
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
398 *$HOME*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
399 Using "~" is like using "$HOME", but it is only recognized at the start of an
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
400 option and after a space or comma.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
401
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
402 On Unix systems "~user" can be used too. It is replaced by the home directory
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
403 of user "user". Example: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
404 :set path=~mool/include,/usr/include,.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
405
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
406 On Unix systems the form "${HOME}" can be used too. The name between {} can
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
407 contain non-id characters then. Note that if you want to use this for the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
408 "gf" command, you need to add the '{' and '}' characters to 'isfname'.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
409
12254
8d76a56861ec Update runtime files
Christian Brabandt <cb@256bit.org>
parents: 12138
diff changeset
410 NOTE: expanding environment variables and "~/" is only done with the ":set"
8d76a56861ec Update runtime files
Christian Brabandt <cb@256bit.org>
parents: 12138
diff changeset
411 command, not when assigning a value to an option with ":let".
8d76a56861ec Update runtime files
Christian Brabandt <cb@256bit.org>
parents: 12138
diff changeset
412
8d76a56861ec Update runtime files
Christian Brabandt <cb@256bit.org>
parents: 12138
diff changeset
413 *$HOME-windows*
3224
8b8ef1fed009 Update runtime files.
Bram Moolenaar <bram@vim.org>
parents: 3153
diff changeset
414 On MS-Windows, if $HOME is not defined as an environment variable, then
8b8ef1fed009 Update runtime files.
Bram Moolenaar <bram@vim.org>
parents: 3153
diff changeset
415 at runtime Vim will set it to the expansion of $HOMEDRIVE$HOMEPATH.
12499
d91cf2e26ef0 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 12469
diff changeset
416 If $HOMEDRIVE is not set then $USERPROFILE is used.
d91cf2e26ef0 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 12469
diff changeset
417
d91cf2e26ef0 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 12469
diff changeset
418 This expanded value is not exported to the environment, this matters when
d91cf2e26ef0 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 12469
diff changeset
419 running an external command: >
d91cf2e26ef0 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 12469
diff changeset
420 :echo system('set | findstr ^HOME=')
d91cf2e26ef0 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 12469
diff changeset
421 and >
d91cf2e26ef0 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 12469
diff changeset
422 :echo luaeval('os.getenv("HOME")')
d91cf2e26ef0 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 12469
diff changeset
423 should echo nothing (an empty string) despite exists('$HOME') being true.
d91cf2e26ef0 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 12469
diff changeset
424 When setting $HOME to a non-empty string it will be exported to the
d91cf2e26ef0 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 12469
diff changeset
425 subprocesses.
3224
8b8ef1fed009 Update runtime files.
Bram Moolenaar <bram@vim.org>
parents: 3153
diff changeset
426
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
427
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
428 Note the maximum length of an expanded option is limited. How much depends on
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
429 the system, mostly it is something like 256 or 1024 characters.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
430
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
431 *:fix* *:fixdel*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
432 :fix[del] Set the value of 't_kD':
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
433 't_kb' is 't_kD' becomes ~
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
434 CTRL-? CTRL-H
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
435 not CTRL-? CTRL-?
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
436
16443
32a543152dc0 patch 8.1.1226: {not in Vi} remarks get in the way of useful help text
Bram Moolenaar <Bram@vim.org>
parents: 16439
diff changeset
437 (CTRL-? is 0177 octal, 0x7f hex)
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
438
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
439 If your delete key terminal code is wrong, but the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
440 code for backspace is alright, you can put this in
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
441 your .vimrc: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
442 :fixdel
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
443 < This works no matter what the actual code for
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
444 backspace is.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
445
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
446 If the backspace key terminal code is wrong you can
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
447 use this: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
448 :if &term == "termname"
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
449 : set t_kb=^V<BS>
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
450 : fixdel
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
451 :endif
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
452 < Where "^V" is CTRL-V and "<BS>" is the backspace key
10
4e2284e71352 updated for version 7.0002
vimboss
parents: 8
diff changeset
453 (don't type four characters!). Replace "termname"
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
454 with your terminal name.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
455
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
456 If your <Delete> key sends a strange key sequence (not
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
457 CTRL-? or CTRL-H) you cannot use ":fixdel". Then use: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
458 :if &term == "termname"
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
459 : set t_kD=^V<Delete>
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
460 :endif
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
461 < Where "^V" is CTRL-V and "<Delete>" is the delete key
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
462 (don't type eight characters!). Replace "termname"
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
463 with your terminal name.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
464
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
465 *Linux-backspace*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
466 Note about Linux: By default the backspace key
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
467 produces CTRL-?, which is wrong. You can fix it by
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
468 putting this line in your rc.local: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
469 echo "keycode 14 = BackSpace" | loadkeys
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
470 <
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
471 *NetBSD-backspace*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
472 Note about NetBSD: If your backspace doesn't produce
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
473 the right code, try this: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
474 xmodmap -e "keycode 22 = BackSpace"
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
475 < If this works, add this in your .Xmodmap file: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
476 keysym 22 = BackSpace
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
477 < You need to restart for this to take effect.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
478
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
479 ==============================================================================
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
480 2. Automatically setting options *auto-setting*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
481
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
482 Besides changing options with the ":set" command, there are three alternatives
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
483 to set options automatically for one or more files:
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
484
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
485 1. When starting Vim initializations are read from various places. See
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
486 |initialization|. Most of them are performed for all editing sessions,
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
487 and some of them depend on the directory where Vim is started.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
488 You can create an initialization file with |:mkvimrc|, |:mkview| and
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
489 |:mksession|.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
490 2. If you start editing a new file, the automatic commands are executed.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
491 This can be used to set options for files matching a particular pattern and
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
492 many other things. See |autocommand|.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
493 3. If you start editing a new file, and the 'modeline' option is on, a
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
494 number of lines at the beginning and end of the file are checked for
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
495 modelines. This is explained here.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
496
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
497 *modeline* *vim:* *vi:* *ex:* *E520*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
498 There are two forms of modelines. The first form:
5055
c458ff35497e Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 5024
diff changeset
499 [text]{white}{vi:|vim:|ex:}[white]{options}
5024
7a2ffd685c0e Update runtime files. Remove duplicate tags in help.
Bram Moolenaar <bram@vim.org>
parents: 5008
diff changeset
500
7a2ffd685c0e Update runtime files. Remove duplicate tags in help.
Bram Moolenaar <bram@vim.org>
parents: 5008
diff changeset
501 [text] any text or empty
7a2ffd685c0e Update runtime files. Remove duplicate tags in help.
Bram Moolenaar <bram@vim.org>
parents: 5008
diff changeset
502 {white} at least one blank character (<Space> or <Tab>)
5055
c458ff35497e Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 5024
diff changeset
503 {vi:|vim:|ex:} the string "vi:", "vim:" or "ex:"
5024
7a2ffd685c0e Update runtime files. Remove duplicate tags in help.
Bram Moolenaar <bram@vim.org>
parents: 5008
diff changeset
504 [white] optional white space
7a2ffd685c0e Update runtime files. Remove duplicate tags in help.
Bram Moolenaar <bram@vim.org>
parents: 5008
diff changeset
505 {options} a list of option settings, separated with white space
7a2ffd685c0e Update runtime files. Remove duplicate tags in help.
Bram Moolenaar <bram@vim.org>
parents: 5008
diff changeset
506 or ':', where each part between ':' is the argument
7a2ffd685c0e Update runtime files. Remove duplicate tags in help.
Bram Moolenaar <bram@vim.org>
parents: 5008
diff changeset
507 for a ":set" command (can be empty)
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
508
5055
c458ff35497e Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 5024
diff changeset
509 Examples:
782
d20041a02ee5 updated for version 7.0228
vimboss
parents: 777
diff changeset
510 vi:noai:sw=3 ts=6 ~
5055
c458ff35497e Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 5024
diff changeset
511 vim: tw=77 ~
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
512
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
513 The second form (this is compatible with some versions of Vi):
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
514
5024
7a2ffd685c0e Update runtime files. Remove duplicate tags in help.
Bram Moolenaar <bram@vim.org>
parents: 5008
diff changeset
515 [text]{white}{vi:|vim:|Vim:|ex:}[white]se[t] {options}:[text]
7a2ffd685c0e Update runtime files. Remove duplicate tags in help.
Bram Moolenaar <bram@vim.org>
parents: 5008
diff changeset
516
7a2ffd685c0e Update runtime files. Remove duplicate tags in help.
Bram Moolenaar <bram@vim.org>
parents: 5008
diff changeset
517 [text] any text or empty
7a2ffd685c0e Update runtime files. Remove duplicate tags in help.
Bram Moolenaar <bram@vim.org>
parents: 5008
diff changeset
518 {white} at least one blank character (<Space> or <Tab>)
7a2ffd685c0e Update runtime files. Remove duplicate tags in help.
Bram Moolenaar <bram@vim.org>
parents: 5008
diff changeset
519 {vi:|vim:|Vim:|ex:} the string "vi:", "vim:", "Vim:" or "ex:"
7a2ffd685c0e Update runtime files. Remove duplicate tags in help.
Bram Moolenaar <bram@vim.org>
parents: 5008
diff changeset
520 [white] optional white space
5055
c458ff35497e Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 5024
diff changeset
521 se[t] the string "set " or "se " (note the space); When
c458ff35497e Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 5024
diff changeset
522 "Vim" is used it must be "set".
5024
7a2ffd685c0e Update runtime files. Remove duplicate tags in help.
Bram Moolenaar <bram@vim.org>
parents: 5008
diff changeset
523 {options} a list of options, separated with white space, which
7a2ffd685c0e Update runtime files. Remove duplicate tags in help.
Bram Moolenaar <bram@vim.org>
parents: 5008
diff changeset
524 is the argument for a ":set" command
7a2ffd685c0e Update runtime files. Remove duplicate tags in help.
Bram Moolenaar <bram@vim.org>
parents: 5008
diff changeset
525 : a colon
7a2ffd685c0e Update runtime files. Remove duplicate tags in help.
Bram Moolenaar <bram@vim.org>
parents: 5008
diff changeset
526 [text] any text or empty
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
527
5055
c458ff35497e Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 5024
diff changeset
528 Examples:
782
d20041a02ee5 updated for version 7.0228
vimboss
parents: 777
diff changeset
529 /* vim: set ai tw=75: */ ~
5055
c458ff35497e Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 5024
diff changeset
530 /* Vim: set ai tw=75: */ ~
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
531
5024
7a2ffd685c0e Update runtime files. Remove duplicate tags in help.
Bram Moolenaar <bram@vim.org>
parents: 5008
diff changeset
532 The white space before {vi:|vim:|Vim:|ex:} is required. This minimizes the
7a2ffd685c0e Update runtime files. Remove duplicate tags in help.
Bram Moolenaar <bram@vim.org>
parents: 5008
diff changeset
533 chance that a normal word like "lex:" is caught. There is one exception:
7a2ffd685c0e Update runtime files. Remove duplicate tags in help.
Bram Moolenaar <bram@vim.org>
parents: 5008
diff changeset
534 "vi:" and "vim:" can also be at the start of the line (for compatibility with
7a2ffd685c0e Update runtime files. Remove duplicate tags in help.
Bram Moolenaar <bram@vim.org>
parents: 5008
diff changeset
535 version 3.0). Using "ex:" at the start of the line will be ignored (this
7a2ffd685c0e Update runtime files. Remove duplicate tags in help.
Bram Moolenaar <bram@vim.org>
parents: 5008
diff changeset
536 could be short for "example:").
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
537
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
538 *modeline-local*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
539 The options are set like with ":setlocal": The new value only applies to the
11
4424b47a0797 updated for version 7.0003
vimboss
parents: 10
diff changeset
540 buffer and window that contain the file. Although it's possible to set global
4424b47a0797 updated for version 7.0003
vimboss
parents: 10
diff changeset
541 options from a modeline, this is unusual. If you have two windows open and
4424b47a0797 updated for version 7.0003
vimboss
parents: 10
diff changeset
542 the files in it set the same global option to a different value, the result
4424b47a0797 updated for version 7.0003
vimboss
parents: 10
diff changeset
543 depends on which one was opened last.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
544
23
3f44e9abe4ec updated for version 7.0015
vimboss
parents: 22
diff changeset
545 When editing a file that was already loaded, only the window-local options
3f44e9abe4ec updated for version 7.0015
vimboss
parents: 22
diff changeset
546 from the modeline are used. Thus if you manually changed a buffer-local
3f44e9abe4ec updated for version 7.0015
vimboss
parents: 22
diff changeset
547 option after opening the file, it won't be changed if you edit the same buffer
3f44e9abe4ec updated for version 7.0015
vimboss
parents: 22
diff changeset
548 in another window. But window-local options will be set.
3f44e9abe4ec updated for version 7.0015
vimboss
parents: 22
diff changeset
549
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
550 *modeline-version*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
551 If the modeline is only to be used for some versions of Vim, the version
5024
7a2ffd685c0e Update runtime files. Remove duplicate tags in help.
Bram Moolenaar <bram@vim.org>
parents: 5008
diff changeset
552 number can be specified where "vim:" or "Vim:" is used:
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
553 vim{vers}: version {vers} or later
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
554 vim<{vers}: version before {vers}
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
555 vim={vers}: version {vers}
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
556 vim>{vers}: version after {vers}
6647
3af822eb4da5 Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 6583
diff changeset
557 {vers} is 700 for Vim 7.0 (hundred times the major version plus minor).
3af822eb4da5 Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 6583
diff changeset
558 For example, to use a modeline only for Vim 7.0:
3af822eb4da5 Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 6583
diff changeset
559 /* vim700: set foldmethod=marker */ ~
3af822eb4da5 Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 6583
diff changeset
560 To use a modeline for Vim after version 7.2:
3af822eb4da5 Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 6583
diff changeset
561 /* vim>702: set cole=2: */ ~
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
562 There can be no blanks between "vim" and the ":".
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
563
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
564
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
565 The number of lines that are checked can be set with the 'modelines' option.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
566 If 'modeline' is off or 'modelines' is 0 no lines are checked.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
567
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
568 Note that for the first form all of the rest of the line is used, thus a line
782
d20041a02ee5 updated for version 7.0228
vimboss
parents: 777
diff changeset
569 like:
d20041a02ee5 updated for version 7.0228
vimboss
parents: 777
diff changeset
570 /* vi:ts=4: */ ~
d20041a02ee5 updated for version 7.0228
vimboss
parents: 777
diff changeset
571 will give an error message for the trailing "*/". This line is OK:
d20041a02ee5 updated for version 7.0228
vimboss
parents: 777
diff changeset
572 /* vi:set ts=4: */ ~
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
573
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
574 If an error is detected the rest of the line is skipped.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
575
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
576 If you want to include a ':' in a set command precede it with a '\'. The
782
d20041a02ee5 updated for version 7.0228
vimboss
parents: 777
diff changeset
577 backslash in front of the ':' will be removed. Example:
d20041a02ee5 updated for version 7.0228
vimboss
parents: 777
diff changeset
578 /* vi:set dir=c\:\tmp: */ ~
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
579 This sets the 'dir' option to "c:\tmp". Only a single backslash before the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
580 ':' 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
581 *E992*
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
582 No other commands than "set" are supported, for security reasons (somebody
1111
53fd0a213cff updated for version 7.0-237
vimboss
parents: 1004
diff changeset
583 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
584 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
585 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
586 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
587
e55c26aaf484 patch 8.1.1366: using expressions in a modeline is unsafe
Bram Moolenaar <Bram@vim.org>
parents: 16610
diff changeset
588 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
589 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
590 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
591 this, for example.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
592
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
593 Hint: If you would like to do something else than setting an option, you could
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
594 define an autocommand that checks the file for a specific string. For
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
595 example: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
596 au BufReadPost * if getline(1) =~ "VAR" | call SetVar() | endif
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
597 And define a function SetVar() that does something with the line containing
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
598 "VAR".
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
599
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
600 ==============================================================================
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
601 3. Options summary *option-summary*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
602
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
603 In the list below all the options are mentioned with their full name and with
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
604 an abbreviation if there is one. Both forms may be used.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
605
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
606 In this document when a boolean option is "set" that means that ":set option"
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
607 is entered. When an option is "reset", ":set nooption" is used.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
608
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
609 For some options there are two default values: The "Vim default", which is
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
610 used when 'compatible' is not set, and the "Vi default", which is used when
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
611 'compatible' is set.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
612
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
613 Most options are the same in all windows and buffers. There are a few that
10
4e2284e71352 updated for version 7.0002
vimboss
parents: 8
diff changeset
614 are specific to how the text is presented in a window. These can be set to a
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
615 different value in each window. For example the 'list' option can be set in
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
616 one window and reset in another for the same text, giving both types of view
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
617 at the same time. There are a few options that are specific to a certain
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
618 file. These can have a different value for each file or buffer. For example
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
619 the 'textwidth' option can be 78 for a normal text file and 0 for a C
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
620 program.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
621
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
622 global one option for all buffers and windows
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
623 local to window each window has its own copy of this option
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
624 local to buffer each buffer has its own copy of this option
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
625
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
626 When creating a new window the option values from the currently active window
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
627 are used as a default value for the window-specific options. For the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
628 buffer-specific options this depends on the 's' and 'S' flags in the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
629 'cpoptions' option. If 's' is included (which is the default) the values for
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
630 buffer options are copied from the currently active buffer when a buffer is
10
4e2284e71352 updated for version 7.0002
vimboss
parents: 8
diff changeset
631 first entered. If 'S' is present the options are copied each time the buffer
4e2284e71352 updated for version 7.0002
vimboss
parents: 8
diff changeset
632 is entered, this is almost like having global options. If 's' and 'S' are not
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
633 present, the options are copied from the currently active buffer when the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
634 buffer is created.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
635
519
d50452846776 updated for version 7.0145
vimboss
parents: 515
diff changeset
636 Hidden options *hidden-options*
d50452846776 updated for version 7.0145
vimboss
parents: 515
diff changeset
637
d50452846776 updated for version 7.0145
vimboss
parents: 515
diff changeset
638 Not all options are supported in all versions. This depends on the supported
d50452846776 updated for version 7.0145
vimboss
parents: 515
diff changeset
639 features and sometimes on the system. A remark about this is in curly braces
d50452846776 updated for version 7.0145
vimboss
parents: 515
diff changeset
640 below. When an option is not supported it may still be set without getting an
d50452846776 updated for version 7.0145
vimboss
parents: 515
diff changeset
641 error, this is called a hidden option. You can't get the value of a hidden
d50452846776 updated for version 7.0145
vimboss
parents: 515
diff changeset
642 option though, it is not stored.
d50452846776 updated for version 7.0145
vimboss
parents: 515
diff changeset
643
d50452846776 updated for version 7.0145
vimboss
parents: 515
diff changeset
644 To test if option "foo" can be used with ":set" use something like this: >
d50452846776 updated for version 7.0145
vimboss
parents: 515
diff changeset
645 if exists('&foo')
d50452846776 updated for version 7.0145
vimboss
parents: 515
diff changeset
646 This also returns true for a hidden option. To test if option "foo" is really
d50452846776 updated for version 7.0145
vimboss
parents: 515
diff changeset
647 supported use something like this: >
d50452846776 updated for version 7.0145
vimboss
parents: 515
diff changeset
648 if exists('+foo')
d50452846776 updated for version 7.0145
vimboss
parents: 515
diff changeset
649 <
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
650 *E355*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
651 A jump table for the options with a short description can be found at |Q_op|.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
652
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
653 *'aleph'* *'al'* *aleph* *Aleph*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
654 'aleph' 'al' number (default 128 for MS-DOS, 224 otherwise)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
655 global
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
656 {only available when compiled with the |+rightleft|
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
657 feature}
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
658 The ASCII code for the first letter of the Hebrew alphabet. The
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
659 routine that maps the keyboard in Hebrew mode, both in Insert mode
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
660 (when hkmap is set) and on the command-line (when hitting CTRL-_)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
661 outputs the Hebrew characters in the range [aleph..aleph+26].
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
662 aleph=128 applies to PC code, and aleph=224 applies to ISO 8859-8.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
663 See |rileft.txt|.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
664
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
665 *'allowrevins'* *'ari'* *'noallowrevins'* *'noari'*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
666 'allowrevins' 'ari' boolean (default off)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
667 global
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
668 {only available when compiled with the |+rightleft|
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
669 feature}
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
670 Allow CTRL-_ in Insert and Command-line mode. This is default off, to
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
671 avoid that users that accidentally type CTRL-_ instead of SHIFT-_ get
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
672 into reverse Insert mode, and don't know how to get out. See
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
673 'revins'.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
674 NOTE: This option is reset when 'compatible' is set.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
675
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
676 *'altkeymap'* *'akm'* *'noaltkeymap'* *'noakm'*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
677 'altkeymap' 'akm' boolean (default off)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
678 global
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
679 {only available when compiled with the |+farsi|
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
680 feature}
15850
a6ca8cf07a98 patch 8.1.0932: Farsi support is outdated and unused
Bram Moolenaar <Bram@vim.org>
parents: 15840
diff changeset
681 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
682 |farsi.txt|.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
683
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
684 *'ambiwidth'* *'ambw'*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
685 'ambiwidth' 'ambw' string (default: "single")
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
686 global
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
687 Only effective when 'encoding' is "utf-8" or another Unicode encoding.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
688 Tells Vim what to do with characters with East Asian Width Class
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
689 Ambiguous (such as Euro, Registered Sign, Copyright Sign, Greek
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
690 letters, Cyrillic letters).
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
691
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
692 There are currently two possible values:
233
fca8a9b65afa updated for version 7.0065
vimboss
parents: 227
diff changeset
693 "single": Use the same width as characters in US-ASCII. This is
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
694 expected by most users.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
695 "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
696 *E834* *E835*
c945fdb34ce3 Disallow setting 'ambiwidth' to "double" when 'listchars' or 'fillchars'
Bram Moolenaar <bram@vim.org>
parents: 2490
diff changeset
697 The value "double" cannot be used if 'listchars' or 'fillchars'
c945fdb34ce3 Disallow setting 'ambiwidth' to "double" when 'listchars' or 'fillchars'
Bram Moolenaar <bram@vim.org>
parents: 2490
diff changeset
698 contains a character that would be double width.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
699
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
700 There are a number of CJK fonts for which the width of glyphs for
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
701 those characters are solely based on how many octets they take in
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
702 legacy/traditional CJK encodings. In those encodings, Euro,
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
703 Registered sign, Greek/Cyrillic letters are represented by two octets,
233
fca8a9b65afa updated for version 7.0065
vimboss
parents: 227
diff changeset
704 therefore those fonts have "wide" glyphs for them. This is also
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
705 true of some line drawing characters used to make tables in text
233
fca8a9b65afa updated for version 7.0065
vimboss
parents: 227
diff changeset
706 file. Therefore, when a CJK font is used for GUI Vim or
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
707 Vim is running inside a terminal (emulators) that uses a CJK font
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
708 (or Vim is run inside an xterm invoked with "-cjkwidth" option.),
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
709 this option should be set to "double" to match the width perceived
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
710 by Vim with the width of glyphs in the font. Perhaps it also has
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
711 to be set to "double" under CJK Windows 9x/ME or Windows 2k/XP
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
712 when the system locale is set to one of CJK locales. See Unicode
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
713 Standard Annex #11 (http://www.unicode.org/reports/tr11).
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
714
4229
fa4089df54bc Update runtime files.
Bram Moolenaar <bram@vim.org>
parents: 4186
diff changeset
715 Vim may set this option automatically at startup time when Vim is
fa4089df54bc Update runtime files.
Bram Moolenaar <bram@vim.org>
parents: 4186
diff changeset
716 compiled with the |+termresponse| feature and if |t_u7| is set to the
12499
d91cf2e26ef0 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 12469
diff changeset
717 escape sequence to request cursor position report. The response can
d91cf2e26ef0 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 12469
diff changeset
718 be found in |v:termu7resp|.
4229
fa4089df54bc Update runtime files.
Bram Moolenaar <bram@vim.org>
parents: 4186
diff changeset
719
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
720 *'antialias'* *'anti'* *'noantialias'* *'noanti'*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
721 'antialias' 'anti' boolean (default: off)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
722 global
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
723 {only available when compiled with GUI enabled
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
724 on Mac OS X}
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
725 This option only has an effect in the GUI version of Vim on Mac OS X
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
726 v10.2 or later. When on, Vim will use smooth ("antialiased") fonts,
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
727 which can be easier to read at certain sizes on certain displays.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
728 Setting this option can sometimes cause problems if 'guifont' is set
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
729 to its default (empty string).
11160
d0a20101ecb2 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 11063
diff changeset
730 NOTE: This option is reset when 'compatible' is set.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
731
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
732 *'autochdir'* *'acd'* *'noautochdir'* *'noacd'*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
733 'autochdir' 'acd' boolean (default off)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
734 global
2152
b9e314fe473f Updated runtime files.
Bram Moolenaar <bram@zimbu.org>
parents: 2033
diff changeset
735 {only available when compiled with it, use
b9e314fe473f Updated runtime files.
Bram Moolenaar <bram@zimbu.org>
parents: 2033
diff changeset
736 exists("+autochdir") to check}
438
59b7b7e99c95 updated for version 7.0113
vimboss
parents: 435
diff changeset
737 When on, Vim will change the current working directory whenever you
59b7b7e99c95 updated for version 7.0113
vimboss
parents: 435
diff changeset
738 open a file, switch buffers, delete a buffer or open/close a window.
59b7b7e99c95 updated for version 7.0113
vimboss
parents: 435
diff changeset
739 It will change to the directory containing the file which was opened
59b7b7e99c95 updated for version 7.0113
vimboss
parents: 435
diff changeset
740 or selected.
819
23f82b5d2814 updated for version 7.0c10
vimboss
parents: 818
diff changeset
741 Note: When this option is on some plugins may not work.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
742
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
743 *'arabic'* *'arab'* *'noarabic'* *'noarab'*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
744 'arabic' 'arab' boolean (default off)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
745 local to window
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
746 {only available when compiled with the |+arabic|
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
747 feature}
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
748 This option can be set to start editing Arabic text.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
749 Setting this option will:
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
750 - Set the 'rightleft' option, unless 'termbidi' is set.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
751 - Set the 'arabicshape' option, unless 'termbidi' is set.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
752 - Set the 'keymap' option to "arabic"; in Insert mode CTRL-^ toggles
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
753 between typing English and Arabic key mapping.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
754 - Set the 'delcombine' option
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
755 Note that 'encoding' must be "utf-8" for working with Arabic text.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
756
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
757 Resetting this option will:
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
758 - Reset the 'rightleft' option.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
759 - Disable the use of 'keymap' (without changing its value).
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
760 Note that 'arabicshape' and 'delcombine' are not reset (it is a global
3557
9cb3a75a20b9 Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 3513
diff changeset
761 option).
11160
d0a20101ecb2 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 11063
diff changeset
762 NOTE: This option is reset when 'compatible' is set.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
763 Also see |arabic.txt|.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
764
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
765 *'arabicshape'* *'arshape'*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
766 *'noarabicshape'* *'noarshape'*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
767 'arabicshape' 'arshape' boolean (default on)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
768 global
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
769 {only available when compiled with the |+arabic|
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
770 feature}
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
771 When on and 'termbidi' is off, the required visual character
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
772 corrections that need to take place for displaying the Arabic language
3893
c3036f1dca68 Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 3750
diff changeset
773 take effect. Shaping, in essence, gets enabled; the term is a broad
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
774 one which encompasses:
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
775 a) the changing/morphing of characters based on their location
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
776 within a word (initial, medial, final and stand-alone).
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
777 b) the enabling of the ability to compose characters
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
778 c) the enabling of the required combining of some characters
2033
de5a43c5eedc Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents: 1904
diff changeset
779 When disabled the display shows each character's true stand-alone
de5a43c5eedc Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents: 1904
diff changeset
780 form.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
781 Arabic is a complex language which requires other settings, for
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
782 further details see |arabic.txt|.
11160
d0a20101ecb2 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 11063
diff changeset
783 NOTE: This option is set when 'compatible' is set.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
784
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
785 *'autoindent'* *'ai'* *'noautoindent'* *'noai'*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
786 'autoindent' 'ai' boolean (default off)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
787 local to buffer
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
788 Copy indent from current line when starting a new line (typing <CR>
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
789 in Insert mode or when using the "o" or "O" command). If you do not
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
790 type anything on the new line except <BS> or CTRL-D and then type
1152
e1787f5b90da updated for version 7.1a
vimboss
parents: 1111
diff changeset
791 <Esc>, CTRL-O or <CR>, the indent is deleted again. Moving the cursor
e1787f5b90da updated for version 7.1a
vimboss
parents: 1111
diff changeset
792 to another line has the same effect, unless the 'I' flag is included
e1787f5b90da updated for version 7.1a
vimboss
parents: 1111
diff changeset
793 in 'cpoptions'.
10
4e2284e71352 updated for version 7.0002
vimboss
parents: 8
diff changeset
794 When autoindent is on, formatting (with the "gq" command or when you
4e2284e71352 updated for version 7.0002
vimboss
parents: 8
diff changeset
795 reach 'textwidth' in Insert mode) uses the indentation of the first
4e2284e71352 updated for version 7.0002
vimboss
parents: 8
diff changeset
796 line.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
797 When 'smartindent' or 'cindent' is on the indent is changed in
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
798 a different way.
7147
c590de398af9 commit https://github.com/vim/vim/commit/ca63501fbcd1cf9c8aa9ff12c093c95b62a89ed7
Christian Brabandt <cb@256bit.org>
parents: 7080
diff changeset
799 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
800 restored when 'paste' is reset.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
801
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
802 *'autoread'* *'ar'* *'noautoread'* *'noar'*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
803 'autoread' 'ar' boolean (default off)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
804 global or local to buffer |global-local|
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
805 When a file has been detected to have been changed outside of Vim and
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
806 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
807 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
808 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
809 |timestamp|
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
810 If this option has a local value, use this command to switch back to
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
811 using the global value: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
812 :set autoread<
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
813 <
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
814 *'autowrite'* *'aw'* *'noautowrite'* *'noaw'*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
815 'autowrite' 'aw' boolean (default off)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
816 global
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
817 Write the contents of the file, if it has been modified, on each
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
818 :next, :rewind, :last, :first, :previous, :stop, :suspend, :tag, :!,
864
bc620d6bdf06 updated for version 7.0g03
vimboss
parents: 859
diff changeset
819 :make, CTRL-] and CTRL-^ command; and when a :buffer, CTRL-O, CTRL-I,
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
820 '{A-Z0-9}, or `{A-Z0-9} command takes one to another file.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
821 Note that for some commands the 'autowrite' option is not used, see
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
822 'autowriteall' for that.
14695
b178e2039b2d Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 14668
diff changeset
823 Some buffers will not be written, specifically when 'buftype' is
14668
34fd018452ed Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 14637
diff changeset
824 "nowrite", "nofile", "terminal" or "prompt".
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
825
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
826 *'autowriteall'* *'awa'* *'noautowriteall'* *'noawa'*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
827 'autowriteall' 'awa' boolean (default off)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
828 global
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
829 Like 'autowrite', but also used for commands ":edit", ":enew", ":quit",
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
830 ":qall", ":exit", ":xit", ":recover" and closing the Vim window.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
831 Setting this option also implies that Vim behaves like 'autowrite' has
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
832 been set.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
833
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
834 *'background'* *'bg'*
2826
3c7da93eb7f9 Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 2788
diff changeset
835 'background' 'bg' string (default "dark" or "light", see below)
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
836 global
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
837 When set to "dark", Vim will try to use colors that look good on a
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
838 dark background. When set to "light", Vim will try to use colors that
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
839 look good on a light background. Any other value is illegal.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
840 Vim tries to set the default value according to the terminal used.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
841 This will not always be correct.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
842 Setting this option does not change the background color, it tells Vim
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
843 what the background color looks like. For changing the background
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
844 color, see |:hi-normal|.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
845
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
846 When 'background' is set Vim will adjust the default color groups for
10
4e2284e71352 updated for version 7.0002
vimboss
parents: 8
diff changeset
847 the new value. But the colors used for syntax highlighting will not
1621
82b5078be2dd updated for version 7.2a
vimboss
parents: 1564
diff changeset
848 change. *g:colors_name*
2033
de5a43c5eedc Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents: 1904
diff changeset
849 When a color scheme is loaded (the "g:colors_name" variable is set)
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
850 setting 'background' will cause the color scheme to be reloaded. If
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
851 the color scheme adjusts to the value of 'background' this will work.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
852 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
853 be undone. First delete the "g:colors_name" variable when needed.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
854
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
855 When setting 'background' to the default value with: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
856 :set background&
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
857 < Vim will guess the value. In the GUI this should work correctly,
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
858 in other cases Vim might not be able to guess the right value.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
859
12499
d91cf2e26ef0 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 12469
diff changeset
860 When the |t_RB| option is set, Vim will use it to request the background
11442
d183d629509e Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 11400
diff changeset
861 color from the terminal. If the returned RGB value is dark/light and
d183d629509e Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 11400
diff changeset
862 'background' is not dark/light, 'background' will be set and the
d183d629509e Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 11400
diff changeset
863 screen is redrawn. This may have side effects, make t_BG empty in
12499
d91cf2e26ef0 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 12469
diff changeset
864 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
865 be found in |v:termrbgresp|.
11442
d183d629509e Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 11400
diff changeset
866
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
867 When starting the GUI, the default value for 'background' will be
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
868 "light". When the value is not set in the .gvimrc, and Vim detects
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
869 that the background is actually quite dark, 'background' is set to
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
870 "dark". But this happens only AFTER the .gvimrc file has been read
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
871 (because the window needs to be opened to find the actual background
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
872 color). To get around this, force the GUI window to be opened by
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
873 putting a ":gui" command in the .gvimrc file, before where the value
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
874 of 'background' is used (e.g., before ":syntax on").
2826
3c7da93eb7f9 Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 2788
diff changeset
875
3c7da93eb7f9 Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 2788
diff changeset
876 For MS-DOS, Windows and OS/2 the default is "dark".
3c7da93eb7f9 Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 2788
diff changeset
877 For other systems "dark" is used when 'term' is "linux",
3c7da93eb7f9 Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 2788
diff changeset
878 "screen.linux", "cygwin" or "putty", or $COLORFGBG suggests a dark
3c7da93eb7f9 Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 2788
diff changeset
879 background. Otherwise the default is "light".
3c7da93eb7f9 Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 2788
diff changeset
880
12254
8d76a56861ec Update runtime files
Christian Brabandt <cb@256bit.org>
parents: 12138
diff changeset
881 The |:terminal| command and the |term_start()| function use the
8d76a56861ec Update runtime files
Christian Brabandt <cb@256bit.org>
parents: 12138
diff changeset
882 'background' value to decide whether the terminal window will start
8d76a56861ec Update runtime files
Christian Brabandt <cb@256bit.org>
parents: 12138
diff changeset
883 with a white or black background.
8d76a56861ec Update runtime files
Christian Brabandt <cb@256bit.org>
parents: 12138
diff changeset
884
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
885 Normally this option would be set in the .vimrc file. Possibly
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
886 depending on the terminal name. Example: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
887 :if &term == "pcterm"
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
888 : set background=dark
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
889 :endif
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
890 < When this option is set, the default settings for the highlight groups
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
891 will change. To use other settings, place ":highlight" commands AFTER
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
892 the setting of the 'background' option.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
893 This option is also used in the "$VIMRUNTIME/syntax/syntax.vim" file
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
894 to select the colors for syntax highlighting. After changing this
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
895 option, you must load syntax.vim again to see the result. This can be
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
896 done with ":syntax on".
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
897
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
898 *'backspace'* *'bs'*
9669
284b4eb307fc commit https://github.com/vim/vim/commit/8c08b5b569e2a9e9f63dea514591ecfa2d3bb392
Christian Brabandt <cb@256bit.org>
parents: 9665
diff changeset
899 '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
900 in |defaults.vim|)
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
901 global
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
902 Influences the working of <BS>, <Del>, CTRL-W and CTRL-U in Insert
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
903 mode. This is a list of items, separated by commas. Each item allows
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
904 a way to backspace over something:
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
905 value effect ~
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
906 indent allow backspacing over autoindent
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
907 eol allow backspacing over line breaks (join lines)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
908 start allow backspacing over the start of insert; CTRL-W and CTRL-U
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
909 stop once at the start of insert.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
910
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
911 When the value is empty, Vi compatible backspacing is used.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
912
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
913 For backwards compatibility with version 5.4 and earlier:
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
914 value effect ~
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
915 0 same as ":set backspace=" (Vi compatible)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
916 1 same as ":set backspace=indent,eol"
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
917 2 same as ":set backspace=indent,eol,start"
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
918
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
919 See |:fixdel| if your <BS> or <Del> key does not do what you want.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
920 NOTE: This option is set to "" when 'compatible' is set.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
921
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
922 *'backup'* *'bk'* *'nobackup'* *'nobk'*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
923 'backup' 'bk' boolean (default off)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
924 global
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
925 Make a backup before overwriting a file. Leave it around after the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
926 file has been successfully written. If you do not want to keep the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
927 backup file, but you do want a backup while the file is being
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
928 written, reset this option and set the 'writebackup' option (this is
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
929 the default). If you do not want a backup file at all reset both
10
4e2284e71352 updated for version 7.0002
vimboss
parents: 8
diff changeset
930 options (use this if your file system is almost full). See the
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
931 |backup-table| for more explanations.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
932 When the 'backupskip' pattern matches, a backup is not made anyway.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
933 When 'patchmode' is set, the backup may be renamed to become the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
934 oldest version of a file.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
935 NOTE: This option is reset when 'compatible' is set.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
936
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
937 *'backupcopy'* *'bkc'*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
938 'backupcopy' 'bkc' string (Vi default for Unix: "yes", otherwise: "auto")
6243
54194bd6ed60 updated for version 7.4.456
Bram Moolenaar <bram@vim.org>
parents: 6213
diff changeset
939 global or local to buffer |global-local|
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
940 When writing a file and a backup is made, this option tells how it's
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
941 done. This is a comma separated list of words.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
942
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
943 The main values are:
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
944 "yes" make a copy of the file and overwrite the original one
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
945 "no" rename the file and write a new one
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
946 "auto" one of the previous, what works best
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
947
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
948 Extra values that can be combined with the ones above are:
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
949 "breaksymlink" always break symlinks when writing
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
950 "breakhardlink" always break hardlinks when writing
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
951
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
952 Making a copy and overwriting the original file:
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
953 - Takes extra time to copy the file.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
954 + When the file has special attributes, is a (hard/symbolic) link or
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
955 has a resource fork, all this is preserved.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
956 - When the file is a link the backup will have the name of the link,
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
957 not of the real file.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
958
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
959 Renaming the file and writing a new one:
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
960 + It's fast.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
961 - Sometimes not all attributes of the file can be copied to the new
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
962 file.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
963 - When the file is a link the new file will not be a link.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
964
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
965 The "auto" value is the middle way: When Vim sees that renaming file
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
966 is possible without side effects (the attributes can be passed on and
1152
e1787f5b90da updated for version 7.1a
vimboss
parents: 1111
diff changeset
967 the file is not a link) that is used. When problems are expected, a
e1787f5b90da updated for version 7.1a
vimboss
parents: 1111
diff changeset
968 copy will be made.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
969
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
970 The "breaksymlink" and "breakhardlink" values can be used in
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
971 combination with any of "yes", "no" and "auto". When included, they
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
972 force Vim to always break either symbolic or hard links by doing
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
973 exactly what the "no" option does, renaming the original file to
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
974 become the backup and writing a new file in its place. This can be
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
975 useful for example in source trees where all the files are symbolic or
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
976 hard links and any changes should stay in the local source tree, not
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
977 be propagated back to the original source.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
978 *crontab*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
979 One situation where "no" and "auto" will cause problems: A program
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
980 that opens a file, invokes Vim to edit that file, and then tests if
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
981 the open file was changed (through the file descriptor) will check the
10
4e2284e71352 updated for version 7.0002
vimboss
parents: 8
diff changeset
982 backup file instead of the newly created file. "crontab -e" is an
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
983 example.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
984
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
985 When a copy is made, the original file is truncated and then filled
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
986 with the new text. This means that protection bits, owner and
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
987 symbolic links of the original file are unmodified. The backup file
10
4e2284e71352 updated for version 7.0002
vimboss
parents: 8
diff changeset
988 however, is a new file, owned by the user who edited the file. The
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
989 group of the backup is set to the group of the original file. If this
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
990 fails, the protection bits for the group are made the same as for
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
991 others.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
992
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
993 When the file is renamed this is the other way around: The backup has
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
994 the same attributes of the original file, and the newly written file
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
995 is owned by the current user. When the file was a (hard/symbolic)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
996 link, the new file will not! That's why the "auto" value doesn't
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
997 rename when the file is a link. The owner and group of the newly
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
998 written file will be set to the same ones as the original file, but
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
999 the system may refuse to do this. In that case the "auto" value will
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1000 again not rename the file.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1001
11160
d0a20101ecb2 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 11063
diff changeset
1002 NOTE: This option is set to the Vi default value when 'compatible' is
d0a20101ecb2 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 11063
diff changeset
1003 set and to the Vim default value when 'compatible' is reset.
d0a20101ecb2 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 11063
diff changeset
1004
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1005 *'backupdir'* *'bdir'*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1006 'backupdir' 'bdir' string (default for Amiga: ".,t:",
5555
7818ca6de3d0 Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 5487
diff changeset
1007 for MS-DOS and Win32: ".,$TEMP,c:/tmp,c:/temp"
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1008 for Unix: ".,~/tmp,~/")
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1009 global
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1010 List of directories for the backup file, separated with commas.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1011 - 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
1012 where this is possible. The directory must exist, Vim will not
de5a43c5eedc Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents: 1904
diff changeset
1013 create it for you.
8629
54ac275e3fc4 commit https://github.com/vim/vim/commit/3848e00e0177abdb31bc600234967863ec487233
Christian Brabandt <cb@256bit.org>
parents: 8560
diff changeset
1014 - Empty means that no backup file will be created ('patchmode' is
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1015 impossible!). Writing may fail because of this.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1016 - A directory "." means to put the backup file in the same directory
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1017 as the edited file.
33
f6033dcbaf31 updated for version 7.0020
vimboss
parents: 29
diff changeset
1018 - A directory starting with "./" (or ".\" for MS-DOS et al.) means to
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1019 put the backup file relative to where the edited file is. The
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1020 leading "." is replaced with the path name of the edited file.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1021 ("." inside a directory name has no special meaning).
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1022 - Spaces after the comma are ignored, other spaces are considered part
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1023 of the directory name. To have a space at the start of a directory
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1024 name, precede it with a backslash.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1025 - To include a comma in a directory name precede it with a backslash.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1026 - 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
1027 - For Unix and Win32, if a directory ends in two path separators "//",
15033
f8b0f1e42f2c Update runtime files.
Bram Moolenaar <Bram@vim.org>
parents: 14999
diff changeset
1028 the backup file name will be built from the complete path to the
f8b0f1e42f2c Update runtime files.
Bram Moolenaar <Bram@vim.org>
parents: 14999
diff changeset
1029 file with all path separators changed to percent '%' signs. This
f8b0f1e42f2c Update runtime files.
Bram Moolenaar <Bram@vim.org>
parents: 14999
diff changeset
1030 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
1031 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
1032 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
1033 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
1034 use '//', instead of '\\'.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1035 - Environment variables are expanded |:set_env|.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1036 - Careful with '\' characters, type one before a space, type two to
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1037 get one in the option (see |option-backslash|), for example: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1038 :set bdir=c:\\tmp,\ dir\\,with\\,commas,\\\ dir\ with\ spaces
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1039 < - For backwards compatibility with Vim version 3.0 a '>' at the start
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1040 of the option is removed.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1041 See also 'backup' and 'writebackup' options.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1042 If you want to hide your backup files on Unix, consider this value: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1043 :set backupdir=./.backup,~/.backup,.,/tmp
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1044 < You must create a ".backup" directory in each directory and in your
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1045 home directory for this to work properly.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1046 The use of |:set+=| and |:set-=| is preferred when adding or removing
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1047 directories from the list. This avoids problems when a future version
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1048 uses another default.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1049 This option cannot be set from a |modeline| or in the |sandbox|, for
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1050 security reasons.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1051
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1052 *'backupext'* *'bex'* *E589*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1053 'backupext' 'bex' string (default "~", for VMS: "_")
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1054 global
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1055 String which is appended to a file name to make the name of the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1056 backup file. The default is quite unusual, because this avoids
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1057 accidentally overwriting existing files with a backup file. You might
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1058 prefer using ".bak", but make sure that you don't have files with
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1059 ".bak" that you want to keep.
36
125e80798a85 updated for version 7.0021
vimboss
parents: 33
diff changeset
1060 Only normal file name characters can be used, "/\*?[|<>" are illegal.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1061
26
404aac550f35 updated for version 7.0017
vimboss
parents: 23
diff changeset
1062 If you like to keep a lot of backups, you could use a BufWritePre
404aac550f35 updated for version 7.0017
vimboss
parents: 23
diff changeset
1063 autocommand to change 'backupext' just before writing the file to
404aac550f35 updated for version 7.0017
vimboss
parents: 23
diff changeset
1064 include a timestamp. >
404aac550f35 updated for version 7.0017
vimboss
parents: 23
diff changeset
1065 :au BufWritePre * let &bex = '-' . strftime("%Y%b%d%X") . '~'
404aac550f35 updated for version 7.0017
vimboss
parents: 23
diff changeset
1066 < Use 'backupdir' to put the backup in a different directory.
404aac550f35 updated for version 7.0017
vimboss
parents: 23
diff changeset
1067
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1068 *'backupskip'* *'bsk'*
13664
f64c5e636c9f patch 8.0.1704: 'backupskip' default doesn't work for Mac
Christian Brabandt <cb@256bit.org>
parents: 13482
diff changeset
1069 '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
1070 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
1071 Mac: "/private/tmp/*,$TMPDIR/*,$TMP/*,$TEMP/*")
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1072 global
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1073 {not available when compiled without the |+wildignore|
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1074 feature}
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1075 A list of file patterns. When one of the patterns matches with the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1076 name of the file which is written, no backup file is created. Both
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1077 the specified file name and the full path name of the file are used.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1078 The pattern is used like with |:autocmd|, see |autocmd-patterns|.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1079 Watch out for special characters, see |option-backslash|.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1080 When $TMPDIR, $TMP or $TEMP is not defined, it is not used for the
233
fca8a9b65afa updated for version 7.0065
vimboss
parents: 227
diff changeset
1081 default value. "/tmp/*" is only used for Unix.
1152
e1787f5b90da updated for version 7.1a
vimboss
parents: 1111
diff changeset
1082
3513
1b584a6f446c Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 3496
diff changeset
1083 WARNING: Not having a backup file means that when Vim fails to write
1b584a6f446c Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 3496
diff changeset
1084 your buffer correctly and then, for whatever reason, Vim exits, you
1b584a6f446c Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 3496
diff changeset
1085 lose both the original file and what you were writing. Only disable
1b584a6f446c Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 3496
diff changeset
1086 backups if you don't care about losing the file.
1b584a6f446c Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 3496
diff changeset
1087
1152
e1787f5b90da updated for version 7.1a
vimboss
parents: 1111
diff changeset
1088 Note that environment variables are not expanded. If you want to use
e1787f5b90da updated for version 7.1a
vimboss
parents: 1111
diff changeset
1089 $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
1090 :let &backupskip = escape(expand('$HOME'), '\') . '/tmp/*'
1152
e1787f5b90da updated for version 7.1a
vimboss
parents: 1111
diff changeset
1091
e1787f5b90da updated for version 7.1a
vimboss
parents: 1111
diff changeset
1092 < Note that the default also makes sure that "crontab -e" works (when a
557
862863033fdd updated for version 7.0158
vimboss
parents: 548
diff changeset
1093 backup would be made by renaming the original file crontab won't see
862863033fdd updated for version 7.0158
vimboss
parents: 548
diff changeset
1094 the newly created file). Also see 'backupcopy' and |crontab|.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1095
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1096 *'balloondelay'* *'bdlay'*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1097 'balloondelay' 'bdlay' number (default: 600)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1098 global
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1099 {only available when compiled with the |+balloon_eval|
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1100 feature}
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1101 Delay in milliseconds before a balloon may pop up. See |balloon-eval|.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1102
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1103 *'ballooneval'* *'beval'* *'noballooneval'* *'nobeval'*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1104 'ballooneval' 'beval' boolean (default off)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1105 global
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1106 {only available when compiled with the |+balloon_eval|
189
504c627f7474 updated for version 7.0057
vimboss
parents: 180
diff changeset
1107 feature}
12865
ebb4f6c93598 patch 8.0.1309: cannot use 'balloonexpr' in a terminal
Christian Brabandt <cb@256bit.org>
parents: 12826
diff changeset
1108 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
1109
ebb4f6c93598 patch 8.0.1309: cannot use 'balloonexpr' in a terminal
Christian Brabandt <cb@256bit.org>
parents: 12826
diff changeset
1110 *'balloonevalterm'* *'bevalterm'* *'noballoonevalterm'*
ebb4f6c93598 patch 8.0.1309: cannot use 'balloonexpr' in a terminal
Christian Brabandt <cb@256bit.org>
parents: 12826
diff changeset
1111 *'nobevalterm'*
ebb4f6c93598 patch 8.0.1309: cannot use 'balloonexpr' in a terminal
Christian Brabandt <cb@256bit.org>
parents: 12826
diff changeset
1112 '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
1113 global
ebb4f6c93598 patch 8.0.1309: cannot use 'balloonexpr' in a terminal
Christian Brabandt <cb@256bit.org>
parents: 12826
diff changeset
1114 {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
1115 |+balloon_eval_term| feature}
ebb4f6c93598 patch 8.0.1309: cannot use 'balloonexpr' in a terminal
Christian Brabandt <cb@256bit.org>
parents: 12826
diff changeset
1116 Switch on the |balloon-eval| functionality for the terminal.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1117
189
504c627f7474 updated for version 7.0057
vimboss
parents: 180
diff changeset
1118 *'balloonexpr'* *'bexpr'*
504c627f7474 updated for version 7.0057
vimboss
parents: 180
diff changeset
1119 'balloonexpr' 'bexpr' string (default "")
790
c8680debe1cc updated for version 7.0230
vimboss
parents: 782
diff changeset
1120 global or local to buffer |global-local|
189
504c627f7474 updated for version 7.0057
vimboss
parents: 180
diff changeset
1121 {only available when compiled with the |+balloon_eval|
504c627f7474 updated for version 7.0057
vimboss
parents: 180
diff changeset
1122 feature}
782
d20041a02ee5 updated for version 7.0228
vimboss
parents: 777
diff changeset
1123 Expression for text to show in evaluation balloon. It is only used
16610
1eaf34420bb3 Update runtime files
Bram Moolenaar <Bram@vim.org>
parents: 16553
diff changeset
1124 when 'ballooneval' or 'balloonevalterm' is on. These variables can be
1eaf34420bb3 Update runtime files
Bram Moolenaar <Bram@vim.org>
parents: 16553
diff changeset
1125 used:
189
504c627f7474 updated for version 7.0057
vimboss
parents: 180
diff changeset
1126
504c627f7474 updated for version 7.0057
vimboss
parents: 180
diff changeset
1127 v:beval_bufnr number of the buffer in which balloon is going to show
504c627f7474 updated for version 7.0057
vimboss
parents: 180
diff changeset
1128 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
1129 v:beval_winid ID of the window
189
504c627f7474 updated for version 7.0057
vimboss
parents: 180
diff changeset
1130 v:beval_lnum line number
504c627f7474 updated for version 7.0057
vimboss
parents: 180
diff changeset
1131 v:beval_col column number (byte index)
504c627f7474 updated for version 7.0057
vimboss
parents: 180
diff changeset
1132 v:beval_text word under or after the mouse pointer
504c627f7474 updated for version 7.0057
vimboss
parents: 180
diff changeset
1133
504c627f7474 updated for version 7.0057
vimboss
parents: 180
diff changeset
1134 The evaluation of the expression must not have side effects!
504c627f7474 updated for version 7.0057
vimboss
parents: 180
diff changeset
1135 Example: >
16610
1eaf34420bb3 Update runtime files
Bram Moolenaar <Bram@vim.org>
parents: 16553
diff changeset
1136 function MyBalloonExpr()
435
73f016dbb279 updated for version 7.0112
vimboss
parents: 419
diff changeset
1137 return 'Cursor is at line ' . v:beval_lnum .
189
504c627f7474 updated for version 7.0057
vimboss
parents: 180
diff changeset
1138 \', column ' . v:beval_col .
504c627f7474 updated for version 7.0057
vimboss
parents: 180
diff changeset
1139 \ ' of file ' . bufname(v:beval_bufnr) .
504c627f7474 updated for version 7.0057
vimboss
parents: 180
diff changeset
1140 \ ' on word "' . v:beval_text . '"'
504c627f7474 updated for version 7.0057
vimboss
parents: 180
diff changeset
1141 endfunction
504c627f7474 updated for version 7.0057
vimboss
parents: 180
diff changeset
1142 set bexpr=MyBalloonExpr()
504c627f7474 updated for version 7.0057
vimboss
parents: 180
diff changeset
1143 set ballooneval
504c627f7474 updated for version 7.0057
vimboss
parents: 180
diff changeset
1144 <
11062
1218c5353e2b Runtime file updates.
Christian Brabandt <cb@256bit.org>
parents: 10895
diff changeset
1145 Also see |balloon_show()|, can be used if the content of the balloon
1218c5353e2b Runtime file updates.
Christian Brabandt <cb@256bit.org>
parents: 10895
diff changeset
1146 is to be fetched asynchronously.
1218c5353e2b Runtime file updates.
Christian Brabandt <cb@256bit.org>
parents: 10895
diff changeset
1147
189
504c627f7474 updated for version 7.0057
vimboss
parents: 180
diff changeset
1148 NOTE: The balloon is displayed only if the cursor is on a text
504c627f7474 updated for version 7.0057
vimboss
parents: 180
diff changeset
1149 character. If the result of evaluating 'balloonexpr' is not empty,
504c627f7474 updated for version 7.0057
vimboss
parents: 180
diff changeset
1150 Vim does not try to send a message to an external debugger (Netbeans
504c627f7474 updated for version 7.0057
vimboss
parents: 180
diff changeset
1151 or Sun Workshop).
504c627f7474 updated for version 7.0057
vimboss
parents: 180
diff changeset
1152
3682
11d40fc82f11 Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 3674
diff changeset
1153 The expression will be evaluated in the |sandbox| when set from a
11d40fc82f11 Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 3674
diff changeset
1154 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
1155 This option cannot be set in a modeline when 'modelineexpr' is off.
634
1c586ee8dd45 updated for version 7.0183
vimboss
parents: 632
diff changeset
1156
1c586ee8dd45 updated for version 7.0183
vimboss
parents: 632
diff changeset
1157 It is not allowed to change text or jump to another window while
1c586ee8dd45 updated for version 7.0183
vimboss
parents: 632
diff changeset
1158 evaluating 'balloonexpr' |textlock|.
1c586ee8dd45 updated for version 7.0183
vimboss
parents: 632
diff changeset
1159
446
7472c565592a updated for version 7.0117
vimboss
parents: 438
diff changeset
1160 To check whether line breaks in the balloon text work use this check: >
435
73f016dbb279 updated for version 7.0112
vimboss
parents: 419
diff changeset
1161 if has("balloon_multiline")
714
0f9f4761ad9c updated for version 7.0216
vimboss
parents: 712
diff changeset
1162 < When they are supported "\n" characters will start a new line. If the
0f9f4761ad9c updated for version 7.0216
vimboss
parents: 712
diff changeset
1163 expression evaluates to a |List| this is equal to using each List item
0f9f4761ad9c updated for version 7.0216
vimboss
parents: 712
diff changeset
1164 as a string and putting "\n" in between them.
11160
d0a20101ecb2 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 11063
diff changeset
1165 NOTE: This option is set to "" when 'compatible' is set.
714
0f9f4761ad9c updated for version 7.0216
vimboss
parents: 712
diff changeset
1166
6949
1e621b31948b patch 7.4.793
Bram Moolenaar <bram@vim.org>
parents: 6933
diff changeset
1167 *'belloff'* *'bo'*
1e621b31948b patch 7.4.793
Bram Moolenaar <bram@vim.org>
parents: 6933
diff changeset
1168 'belloff' 'bo' string (default "")
1e621b31948b patch 7.4.793
Bram Moolenaar <bram@vim.org>
parents: 6933
diff changeset
1169 global
1e621b31948b patch 7.4.793
Bram Moolenaar <bram@vim.org>
parents: 6933
diff changeset
1170 Specifies for which events the bell will not be rung. It is a comma
1e621b31948b patch 7.4.793
Bram Moolenaar <bram@vim.org>
parents: 6933
diff changeset
1171 separated list of items. For each item that is present, the bell
1e621b31948b patch 7.4.793
Bram Moolenaar <bram@vim.org>
parents: 6933
diff changeset
1172 will be silenced. This is most useful to specify specific events in
1e621b31948b patch 7.4.793
Bram Moolenaar <bram@vim.org>
parents: 6933
diff changeset
1173 insert mode to be silenced.
1e621b31948b patch 7.4.793
Bram Moolenaar <bram@vim.org>
parents: 6933
diff changeset
1174
1e621b31948b patch 7.4.793
Bram Moolenaar <bram@vim.org>
parents: 6933
diff changeset
1175 item meaning when present ~
1e621b31948b patch 7.4.793
Bram Moolenaar <bram@vim.org>
parents: 6933
diff changeset
1176 all All events.
1e621b31948b patch 7.4.793
Bram Moolenaar <bram@vim.org>
parents: 6933
diff changeset
1177 backspace When hitting <BS> or <Del> and deleting results in an
1e621b31948b patch 7.4.793
Bram Moolenaar <bram@vim.org>
parents: 6933
diff changeset
1178 error.
1e621b31948b patch 7.4.793
Bram Moolenaar <bram@vim.org>
parents: 6933
diff changeset
1179 cursor Fail to move around using the cursor keys or
1e621b31948b patch 7.4.793
Bram Moolenaar <bram@vim.org>
parents: 6933
diff changeset
1180 <PageUp>/<PageDown> in |Insert-mode|.
1e621b31948b patch 7.4.793
Bram Moolenaar <bram@vim.org>
parents: 6933
diff changeset
1181 complete Error occurred when using |i_CTRL-X_CTRL-K| or
1e621b31948b patch 7.4.793
Bram Moolenaar <bram@vim.org>
parents: 6933
diff changeset
1182 |i_CTRL-X_CTRL-T|.
1e621b31948b patch 7.4.793
Bram Moolenaar <bram@vim.org>
parents: 6933
diff changeset
1183 copy Cannot copy char from insert mode using |i_CTRL-Y| or
1e621b31948b patch 7.4.793
Bram Moolenaar <bram@vim.org>
parents: 6933
diff changeset
1184 |i_CTRL-E|.
1e621b31948b patch 7.4.793
Bram Moolenaar <bram@vim.org>
parents: 6933
diff changeset
1185 ctrlg Unknown Char after <C-G> in Insert mode.
1e621b31948b patch 7.4.793
Bram Moolenaar <bram@vim.org>
parents: 6933
diff changeset
1186 error Other Error occurred (e.g. try to join last line)
1e621b31948b patch 7.4.793
Bram Moolenaar <bram@vim.org>
parents: 6933
diff changeset
1187 (mostly used in |Normal-mode| or |Cmdline-mode|).
1e621b31948b patch 7.4.793
Bram Moolenaar <bram@vim.org>
parents: 6933
diff changeset
1188 esc hitting <Esc> in |Normal-mode|.
1e621b31948b patch 7.4.793
Bram Moolenaar <bram@vim.org>
parents: 6933
diff changeset
1189 ex In |Visual-mode|, hitting |Q| results in an error.
1e621b31948b patch 7.4.793
Bram Moolenaar <bram@vim.org>
parents: 6933
diff changeset
1190 hangul Error occurred when using hangul input.
1e621b31948b patch 7.4.793
Bram Moolenaar <bram@vim.org>
parents: 6933
diff changeset
1191 insertmode Pressing <Esc> in 'insertmode'.
1e621b31948b patch 7.4.793
Bram Moolenaar <bram@vim.org>
parents: 6933
diff changeset
1192 lang Calling the beep module for Lua/Mzscheme/TCL.
1e621b31948b patch 7.4.793
Bram Moolenaar <bram@vim.org>
parents: 6933
diff changeset
1193 mess No output available for |g<|.
1e621b31948b patch 7.4.793
Bram Moolenaar <bram@vim.org>
parents: 6933
diff changeset
1194 showmatch Error occurred for 'showmatch' function.
1e621b31948b patch 7.4.793
Bram Moolenaar <bram@vim.org>
parents: 6933
diff changeset
1195 operator Empty region error |cpo-E|.
1e621b31948b patch 7.4.793
Bram Moolenaar <bram@vim.org>
parents: 6933
diff changeset
1196 register Unknown register after <C-R> in |Insert-mode|.
1e621b31948b patch 7.4.793
Bram Moolenaar <bram@vim.org>
parents: 6933
diff changeset
1197 shell Bell from shell output |:!|.
1e621b31948b patch 7.4.793
Bram Moolenaar <bram@vim.org>
parents: 6933
diff changeset
1198 spell Error happened on spell suggest.
1e621b31948b patch 7.4.793
Bram Moolenaar <bram@vim.org>
parents: 6933
diff changeset
1199 wildmode More matches in |cmdline-completion| available
1e621b31948b patch 7.4.793
Bram Moolenaar <bram@vim.org>
parents: 6933
diff changeset
1200 (depends on the 'wildmode' setting).
1e621b31948b patch 7.4.793
Bram Moolenaar <bram@vim.org>
parents: 6933
diff changeset
1201
11160
d0a20101ecb2 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 11063
diff changeset
1202 This is most useful to fine tune when in Insert mode the bell should
d0a20101ecb2 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 11063
diff changeset
1203 be rung. For Normal mode and Ex commands, the bell is often rung to
6949
1e621b31948b patch 7.4.793
Bram Moolenaar <bram@vim.org>
parents: 6933
diff changeset
1204 indicate that an error occurred. It can be silenced by adding the
1e621b31948b patch 7.4.793
Bram Moolenaar <bram@vim.org>
parents: 6933
diff changeset
1205 "error" keyword.
1e621b31948b patch 7.4.793
Bram Moolenaar <bram@vim.org>
parents: 6933
diff changeset
1206
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1207 *'binary'* *'bin'* *'nobinary'* *'nobin'*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1208 'binary' 'bin' boolean (default off)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1209 local to buffer
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1210 This option should be set before editing a binary file. You can also
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1211 use the |-b| Vim argument. When this option is switched on a few
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1212 options will be changed (also when it already was on):
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1213 'textwidth' will be set to 0
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1214 'wrapmargin' will be set to 0
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1215 'modeline' will be off
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1216 'expandtab' will be off
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1217 Also, 'fileformat' and 'fileformats' options will not be used, the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1218 file is read and written like 'fileformat' was "unix" (a single <NL>
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1219 separates lines).
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1220 The 'fileencoding' and 'fileencodings' options will not be used, the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1221 file is read without conversion.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1222 NOTE: When you start editing a(nother) file while the 'bin' option is
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1223 on, settings from autocommands may change the settings again (e.g.,
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1224 'textwidth'), causing trouble when editing. You might want to set
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1225 'bin' again when the file has been loaded.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1226 The previous values of these options are remembered and restored when
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1227 'bin' is switched from on to off. Each buffer has its own set of
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1228 saved option values.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1229 To edit a file with 'binary' set you can use the |++bin| argument.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1230 This avoids you have to do ":set bin", which would have effect for all
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1231 files you edit.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1232 When writing a file the <EOL> for the last line is only written if
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1233 there was one in the original file (normally Vim appends an <EOL> to
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1234 the last line if there is none; this would make the file longer). See
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1235 the 'endofline' option.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1236
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1237 *'bioskey'* *'biosk'* *'nobioskey'* *'nobiosk'*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1238 'bioskey' 'biosk' boolean (default on)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1239 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
1240 {only for MS-DOS}
8246
f16bfe02cef1 commit https://github.com/vim/vim/commit/f391327adbbffb11180cf6038a92af1ed144e907
Christian Brabandt <cb@256bit.org>
parents: 8182
diff changeset
1241 This was for MS-DOS and is no longer supported.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1242
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1243 *'bomb'* *'nobomb'*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1244 'bomb' boolean (default off)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1245 local to buffer
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1246 When writing a file and the following conditions are met, a BOM (Byte
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1247 Order Mark) is prepended to the file:
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1248 - this option is on
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1249 - the 'binary' option is off
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1250 - 'fileencoding' is "utf-8", "ucs-2", "ucs-4" or one of the little/big
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1251 endian variants.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1252 Some applications use the BOM to recognize the encoding of the file.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1253 Often used for UCS-2 files on MS-Windows. For other applications it
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1254 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
1255 appear halfway the resulting file. Gcc doesn't accept a BOM.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1256 When Vim reads a file and 'fileencodings' starts with "ucs-bom", a
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1257 check for the presence of the BOM is done and 'bomb' set accordingly.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1258 Unless 'binary' is set, it is removed from the first line, so that you
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1259 don't see it when editing. When you don't change the options, the BOM
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1260 will be restored when writing the file.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1261
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1262 *'breakat'* *'brk'*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1263 'breakat' 'brk' string (default " ^I!@*-+;:,./?")
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1264 global
2570
71b56b4e7785 Make the references to features in the help more consistent. (Sylvain Hitier)
Bram Moolenaar <bram@vim.org>
parents: 2561
diff changeset
1265 {not available when compiled without the |+linebreak|
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1266 feature}
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1267 This option lets you choose which characters might cause a line
500
4772a5e3f9fa updated for version 7.0138
vimboss
parents: 493
diff changeset
1268 break if 'linebreak' is on. Only works for ASCII and also for 8-bit
4772a5e3f9fa updated for version 7.0138
vimboss
parents: 493
diff changeset
1269 characters when 'encoding' is an 8-bit encoding.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1270
8835
c1a5623cfc86 commit https://github.com/vim/vim/commit/7c1c6dbb6817640fd3956a0d5417da23fde336d8
Christian Brabandt <cb@256bit.org>
parents: 8748
diff changeset
1271 *'breakindent'* *'bri'* *'nobreakindent'* *'nobri'*
6009
7b83c190d370 Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 5991
diff changeset
1272 'breakindent' 'bri' boolean (default off)
7b83c190d370 Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 5991
diff changeset
1273 local to window
7b83c190d370 Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 5991
diff changeset
1274 {not available when compiled without the |+linebreak|
7b83c190d370 Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 5991
diff changeset
1275 feature}
7b83c190d370 Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 5991
diff changeset
1276 Every wrapped line will continue visually indented (same amount of
7b83c190d370 Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 5991
diff changeset
1277 space as the beginning of that line), thus preserving horizontal blocks
7b83c190d370 Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 5991
diff changeset
1278 of text.
11160
d0a20101ecb2 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 11063
diff changeset
1279 NOTE: This option is reset when 'compatible' is set.
6009
7b83c190d370 Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 5991
diff changeset
1280
7b83c190d370 Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 5991
diff changeset
1281 *'breakindentopt'* *'briopt'*
7b83c190d370 Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 5991
diff changeset
1282 'breakindentopt' 'briopt' string (default empty)
7b83c190d370 Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 5991
diff changeset
1283 local to window
7b83c190d370 Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 5991
diff changeset
1284 {not available when compiled without the |+linebreak|
7b83c190d370 Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 5991
diff changeset
1285 feature}
7b83c190d370 Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 5991
diff changeset
1286 Settings for 'breakindent'. It can consist of the following optional
6026
d42a1d3b74d4 updated for version 7.4.353
Bram Moolenaar <bram@vim.org>
parents: 6009
diff changeset
1287 items and must be separated by a comma:
6009
7b83c190d370 Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 5991
diff changeset
1288 min:{n} Minimum text width that will be kept after
7b83c190d370 Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 5991
diff changeset
1289 applying 'breakindent', even if the resulting
7b83c190d370 Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 5991
diff changeset
1290 text should normally be narrower. This prevents
7b83c190d370 Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 5991
diff changeset
1291 text indented almost to the right window border
7b83c190d370 Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 5991
diff changeset
1292 occupying lot of vertical space when broken.
6026
d42a1d3b74d4 updated for version 7.4.353
Bram Moolenaar <bram@vim.org>
parents: 6009
diff changeset
1293 shift:{n} After applying 'breakindent', the wrapped line's
d42a1d3b74d4 updated for version 7.4.353
Bram Moolenaar <bram@vim.org>
parents: 6009
diff changeset
1294 beginning will be shifted by the given number of
d42a1d3b74d4 updated for version 7.4.353
Bram Moolenaar <bram@vim.org>
parents: 6009
diff changeset
1295 characters. It permits dynamic French paragraph
6009
7b83c190d370 Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 5991
diff changeset
1296 indentation (negative) or emphasizing the line
7b83c190d370 Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 5991
diff changeset
1297 continuation (positive).
13341
acd7eaa13d2b Updated runtime files.
Christian Brabandt <cb@256bit.org>
parents: 13314
diff changeset
1298 sbr Display the 'showbreak' value before applying the
6009
7b83c190d370 Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 5991
diff changeset
1299 additional indent.
7b83c190d370 Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 5991
diff changeset
1300 The default value for min is 20 and shift is 0.
7b83c190d370 Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 5991
diff changeset
1301
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1302 *'browsedir'* *'bsdir'*
29
ac33b7c03fac updated for version 7.0018
vimboss
parents: 26
diff changeset
1303 'browsedir' 'bsdir' string (default: "last")
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1304 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
1305 {only for Motif, Athena, GTK, Mac and Win32 GUI}
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1306 Which directory to use for the file browser:
1621
82b5078be2dd updated for version 7.2a
vimboss
parents: 1564
diff changeset
1307 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
1308 file was opened or saved.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1309 buffer Use the directory of the related buffer.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1310 current Use the current directory.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1311 {path} Use the specified directory
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1312
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1313 *'bufhidden'* *'bh'*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1314 'bufhidden' 'bh' string (default: "")
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1315 local to buffer
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1316 This option specifies what happens when a buffer is no longer
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1317 displayed in a window:
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1318 <empty> follow the global 'hidden' option
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1319 hide hide the buffer (don't unload it), also when 'hidden'
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1320 is not set
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1321 unload unload the buffer, also when 'hidden' is set or using
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1322 |:hide|
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1323 delete delete the buffer from the buffer list, also when
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1324 'hidden' is set or using |:hide|, like using
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1325 |:bdelete|
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1326 wipe wipe out the buffer from the buffer list, also when
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1327 'hidden' is set or using |:hide|, like using
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1328 |:bwipeout|
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1329
82
366d9947baf2 updated for version 7.0033
vimboss
parents: 75
diff changeset
1330 CAREFUL: when "unload", "delete" or "wipe" is used changes in a buffer
3224
8b8ef1fed009 Update runtime files.
Bram Moolenaar <bram@vim.org>
parents: 3153
diff changeset
1331 are lost without a warning. Also, these values may break autocommands
8b8ef1fed009 Update runtime files.
Bram Moolenaar <bram@vim.org>
parents: 3153
diff changeset
1332 that switch between buffers temporarily.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1333 This option is used together with 'buftype' and 'swapfile' to specify
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1334 special kinds of buffers. See |special-buffers|.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1335
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1336 *'buflisted'* *'bl'* *'nobuflisted'* *'nobl'* *E85*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1337 'buflisted' 'bl' boolean (default: on)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1338 local to buffer
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1339 When this option is set, the buffer shows up in the buffer list. If
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1340 it is reset it is not used for ":bnext", "ls", the Buffers menu, etc.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1341 This option is reset by Vim for buffers that are only used to remember
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1342 a file name or marks. Vim sets it when starting to edit a buffer.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1343 But not when moving to a buffer with ":buffer".
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1344
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1345 *'buftype'* *'bt'* *E382*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1346 'buftype' 'bt' string (default: "")
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1347 local to buffer
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1348 The value of this option specifies the type of a buffer:
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1349 <empty> normal buffer
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1350 nofile buffer which is not related to a file and will not be
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1351 written
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1352 nowrite buffer which will not be written
17
9be87deaeb52 updated for version 7.0009
vimboss
parents: 15
diff changeset
1353 acwrite buffer which will always be written with BufWriteCmd
13437
02b3f719eacb Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 13341
diff changeset
1354 autocommands.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1355 quickfix quickfix buffer, contains list of errors |:cwindow|
648
9032e4668296 updated for version 7.0189
vimboss
parents: 642
diff changeset
1356 or list of locations |:lwindow|
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1357 help help buffer (you are not supposed to set this
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1358 manually)
11757
74abb6c84984 patch 8.0.0761: options not set properly for a terminal buffer
Christian Brabandt <cb@256bit.org>
parents: 11666
diff changeset
1359 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
1360 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
1361 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
1362 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
1363 {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
1364 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
1365 {only when compiled with the |+textprop| feature}
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1366
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1367 This option is used together with 'bufhidden' and 'swapfile' to
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1368 specify special kinds of buffers. See |special-buffers|.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1369
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1370 Be careful with changing this option, it can have many side effects!
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1371
648
9032e4668296 updated for version 7.0189
vimboss
parents: 642
diff changeset
1372 A "quickfix" buffer is only used for the error list and the location
9032e4668296 updated for version 7.0189
vimboss
parents: 642
diff changeset
1373 list. This value is set by the |:cwindow| and |:lwindow| commands and
9032e4668296 updated for version 7.0189
vimboss
parents: 642
diff changeset
1374 you are not supposed to change it.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1375
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1376 "nofile" and "nowrite" buffers are similar:
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1377 both: The buffer is not to be written to disk, ":w" doesn't
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1378 work (":w filename" does work though).
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1379 both: The buffer is never considered to be |'modified'|.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1380 There is no warning when the changes will be lost, for
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1381 example when you quit Vim.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1382 both: A swap file is only created when using too much memory
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1383 (when 'swapfile' has been reset there is never a swap
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1384 file).
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1385 nofile only: The buffer name is fixed, it is not handled like a
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1386 file name. It is not modified in response to a |:cd|
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1387 command.
6647
3af822eb4da5 Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 6583
diff changeset
1388 both: When using ":e bufname" and already editing "bufname"
3af822eb4da5 Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 6583
diff changeset
1389 the buffer is made empty and autocommands are
3af822eb4da5 Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 6583
diff changeset
1390 triggered as usual for |:edit|.
17
9be87deaeb52 updated for version 7.0009
vimboss
parents: 15
diff changeset
1391 *E676*
9be87deaeb52 updated for version 7.0009
vimboss
parents: 15
diff changeset
1392 "acwrite" implies that the buffer name is not related to a file, like
9be87deaeb52 updated for version 7.0009
vimboss
parents: 15
diff changeset
1393 "nofile", but it will be written. Thus, in contrast to "nofile" and
9be87deaeb52 updated for version 7.0009
vimboss
parents: 15
diff changeset
1394 "nowrite", ":w" does work and a modified buffer can't be abandoned
9be87deaeb52 updated for version 7.0009
vimboss
parents: 15
diff changeset
1395 without saving. For writing there must be matching |BufWriteCmd|,
9be87deaeb52 updated for version 7.0009
vimboss
parents: 15
diff changeset
1396 |FileWriteCmd| or |FileAppendCmd| autocommands.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1397
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1398 *'casemap'* *'cmp'*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1399 'casemap' 'cmp' string (default: "internal,keepascii")
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1400 global
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1401 Specifies details about changing the case of letters. It may contain
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1402 these words, separated by a comma:
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1403 internal Use internal case mapping functions, the current
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1404 locale does not change the case mapping. This only
493
06364aa0d597 updated for version 7.0135
vimboss
parents: 488
diff changeset
1405 matters when 'encoding' is a Unicode encoding,
06364aa0d597 updated for version 7.0135
vimboss
parents: 488
diff changeset
1406 "latin1" or "iso-8859-15". When "internal" is
06364aa0d597 updated for version 7.0135
vimboss
parents: 488
diff changeset
1407 omitted, the towupper() and towlower() system library
06364aa0d597 updated for version 7.0135
vimboss
parents: 488
diff changeset
1408 functions are used when available.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1409 keepascii For the ASCII characters (0x00 to 0x7f) use the US
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1410 case mapping, the current locale is not effective.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1411 This probably only matters for Turkish.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1412
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1413 *'cdpath'* *'cd'* *E344* *E346*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1414 'cdpath' 'cd' string (default: equivalent to $CDPATH or ",,")
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1415 global
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1416 {not available when compiled without the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1417 |+file_in_path| feature}
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1418 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
1419 |: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
1420 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
1421 "/", "./" or "../", the 'cdpath' option is not used then.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1422 The 'cdpath' option's value has the same form and semantics as
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1423 |'path'|. Also see |file-searching|.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1424 The default value is taken from $CDPATH, with a "," prepended to look
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1425 in the current directory first.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1426 If the default value taken from $CDPATH is not what you want, include
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1427 a modified version of the following command in your vimrc file to
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1428 override it: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1429 :let &cdpath = ',' . substitute(substitute($CDPATH, '[, ]', '\\\0', 'g'), ':', ',', 'g')
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1430 < This option cannot be set from a |modeline| or in the |sandbox|, for
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1431 security reasons.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1432 (parts of 'cdpath' can be passed to the shell to expand file names).
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1433
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1434 *'cedit'*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1435 'cedit' string (Vi default: "", Vim default: CTRL-F)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1436 global
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1437 {not available when compiled without the |+vertsplit|
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1438 feature}
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1439 The key used in Command-line Mode to open the command-line window.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1440 The default is CTRL-F when 'compatible' is off.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1441 Only non-printable keys are allowed.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1442 The key can be specified as a single character, but it is difficult to
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1443 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
1444 :exe "set cedit=\<C-Y>"
619a98a67f67 commit https://github.com/vim/vim/commit/e18dbe865d190e74fb5d43ac8bc6ac22507d0223
Christian Brabandt <cb@256bit.org>
parents: 9344
diff changeset
1445 :exe "set cedit=\<Esc>"
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1446 < |Nvi| also has this option, but it only uses the first character.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1447 See |cmdwin|.
11160
d0a20101ecb2 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 11063
diff changeset
1448 NOTE: This option is set to the Vim default value when 'compatible'
d0a20101ecb2 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 11063
diff changeset
1449 is reset.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1450
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1451 *'charconvert'* *'ccv'* *E202* *E214* *E513*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1452 'charconvert' 'ccv' string (default "")
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1453 global
15878
314694a2e74a Update runtime files.
Bram Moolenaar <Bram@vim.org>
parents: 15850
diff changeset
1454 {only available when compiled with the |+eval| feature}
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1455 An expression that is used for character encoding conversion. It is
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1456 evaluated when a file that is to be read or has been written has a
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1457 different encoding from what is desired.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1458 'charconvert' is not used when the internal iconv() function is
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1459 supported and is able to do the conversion. Using iconv() is
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1460 preferred, because it is much faster.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1461 'charconvert' is not used when reading stdin |--|, because there is no
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1462 file to convert from. You will have to save the text in a file first.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1463 The expression must return zero or an empty string for success,
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1464 non-zero for failure.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1465 The possible encoding names encountered are in 'encoding'.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1466 Additionally, names given in 'fileencodings' and 'fileencoding' are
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1467 used.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1468 Conversion between "latin1", "unicode", "ucs-2", "ucs-4" and "utf-8"
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1469 is done internally by Vim, 'charconvert' is not used for this.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1470 'charconvert' is also used to convert the viminfo file, if the 'c'
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1471 flag is present in 'viminfo'. Also used for Unicode conversion.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1472 Example: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1473 set charconvert=CharConvert()
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1474 fun CharConvert()
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1475 system("recode "
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1476 \ . v:charconvert_from . ".." . v:charconvert_to
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1477 \ . " <" . v:fname_in . " >" v:fname_out)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1478 return v:shell_error
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1479 endfun
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1480 < The related Vim variables are:
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1481 v:charconvert_from name of the current encoding
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1482 v:charconvert_to name of the desired encoding
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1483 v:fname_in name of the input file
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1484 v:fname_out name of the output file
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1485 Note that v:fname_in and v:fname_out will never be the same.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1486 Note that v:charconvert_from and v:charconvert_to may be different
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1487 from 'encoding'. Vim internally uses UTF-8 instead of UCS-2 or UCS-4.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1488 Encryption is not done by Vim when using 'charconvert'. If you want
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1489 to encrypt the file after conversion, 'charconvert' should take care
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1490 of this.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1491 This option cannot be set from a |modeline| or in the |sandbox|, for
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1492 security reasons.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1493
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1494 *'cindent'* *'cin'* *'nocindent'* *'nocin'*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1495 'cindent' 'cin' boolean (default off)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1496 local to buffer
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1497 {not available when compiled without the |+cindent|
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1498 feature}
1621
82b5078be2dd updated for version 7.2a
vimboss
parents: 1564
diff changeset
1499 Enables automatic C program indenting. See 'cinkeys' to set the keys
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1500 that trigger reindenting in insert mode and 'cinoptions' to set your
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1501 preferred indent style.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1502 If 'indentexpr' is not empty, it overrules 'cindent'.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1503 If 'lisp' is not on and both 'indentexpr' and 'equalprg' are empty,
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1504 the "=" operator indents using this algorithm rather than calling an
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1505 external program.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1506 See |C-indenting|.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1507 When you don't like the way 'cindent' works, try the 'smartindent'
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1508 option or 'indentexpr'.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1509 This option is not used when 'paste' is set.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1510 NOTE: This option is reset when 'compatible' is set.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1511
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1512 *'cinkeys'* *'cink'*
15701
9cd11f6beb70 patch 8.1.0858: 'indentkeys' and 'cinkeys' defaults are different
Bram Moolenaar <Bram@vim.org>
parents: 15512
diff changeset
1513 'cinkeys' 'cink' string (default "0{,0},0),0],:,0#,!^F,o,O,e")
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1514 local to buffer
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1515 {not available when compiled without the |+cindent|
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1516 feature}
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1517 A list of keys that, when typed in Insert mode, cause reindenting of
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1518 the current line. Only used if 'cindent' is on and 'indentexpr' is
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1519 empty.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1520 For the format of this option see |cinkeys-format|.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1521 See |C-indenting|.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1522
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1523 *'cinoptions'* *'cino'*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1524 'cinoptions' 'cino' string (default "")
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1525 local to buffer
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1526 {not available when compiled without the |+cindent|
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1527 feature}
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1528 The 'cinoptions' affect the way 'cindent' reindents lines in a C
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1529 program. See |cinoptions-values| for the values of this option, and
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1530 |C-indenting| for info on C indenting in general.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1531
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1532
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1533 *'cinwords'* *'cinw'*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1534 'cinwords' 'cinw' string (default "if,else,while,do,for,switch")
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1535 local to buffer
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1536 {not available when compiled without both the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1537 |+cindent| and the |+smartindent| features}
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1538 These keywords start an extra indent in the next line when
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1539 'smartindent' or 'cindent' is set. For 'cindent' this is only done at
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1540 an appropriate place (inside {}).
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1541 Note that 'ignorecase' isn't used for 'cinwords'. If case doesn't
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1542 matter, include the keyword both the uppercase and lowercase:
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1543 "if,If,IF".
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1544
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1545 *'clipboard'* *'cb'*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1546 'clipboard' 'cb' string (default "autoselect,exclude:cons\|linux"
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1547 for X-windows, "" otherwise)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1548 global
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1549 {only in GUI versions or when the |+xterm_clipboard|
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1550 feature is included}
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1551 This option is a list of comma separated names.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1552 These names are recognized:
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1553
3674
b9aa7fb4a928 updated for version 7.3.597
Bram Moolenaar <bram@vim.org>
parents: 3557
diff changeset
1554 *clipboard-unnamed*
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1555 unnamed When included, Vim will use the clipboard register '*'
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1556 for all yank, delete, change and put operations which
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1557 would normally go to the unnamed register. When a
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1558 register is explicitly specified, it will always be
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1559 used regardless of whether "unnamed" is in 'clipboard'
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1560 or not. The clipboard register can always be
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1561 explicitly accessed using the "* notation. Also see
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1562 |gui-clipboard|.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1563
3682
11d40fc82f11 Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 3674
diff changeset
1564 *clipboard-unnamedplus*
4119
61bcafd8c648 Update runtime files.
Bram Moolenaar <bram@vim.org>
parents: 4073
diff changeset
1565 unnamedplus A variant of the "unnamed" flag which uses the
61bcafd8c648 Update runtime files.
Bram Moolenaar <bram@vim.org>
parents: 4073
diff changeset
1566 clipboard register '+' (|quoteplus|) instead of
61bcafd8c648 Update runtime files.
Bram Moolenaar <bram@vim.org>
parents: 4073
diff changeset
1567 register '*' for all yank, delete, change and put
61bcafd8c648 Update runtime files.
Bram Moolenaar <bram@vim.org>
parents: 4073
diff changeset
1568 operations which would normally go to the unnamed
61bcafd8c648 Update runtime files.
Bram Moolenaar <bram@vim.org>
parents: 4073
diff changeset
1569 register. When "unnamed" is also included to the
61bcafd8c648 Update runtime files.
Bram Moolenaar <bram@vim.org>
parents: 4073
diff changeset
1570 option, yank operations (but not delete, change or
61bcafd8c648 Update runtime files.
Bram Moolenaar <bram@vim.org>
parents: 4073
diff changeset
1571 put) will additionally copy the text into register
61bcafd8c648 Update runtime files.
Bram Moolenaar <bram@vim.org>
parents: 4073
diff changeset
1572 '*'.
2662
916c90b37ea9 Update runtime files.
Bram Moolenaar <bram@vim.org>
parents: 2654
diff changeset
1573 Only available with the |+X11| feature.
2654
2b475ed86e64 updated for version 7.3.074
Bram Moolenaar <bram@vim.org>
parents: 2652
diff changeset
1574 Availability can be checked with: >
2b475ed86e64 updated for version 7.3.074
Bram Moolenaar <bram@vim.org>
parents: 2652
diff changeset
1575 if has('unnamedplus')
2b475ed86e64 updated for version 7.3.074
Bram Moolenaar <bram@vim.org>
parents: 2652
diff changeset
1576 <
3682
11d40fc82f11 Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 3674
diff changeset
1577 *clipboard-autoselect*
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1578 autoselect Works like the 'a' flag in 'guioptions': If present,
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1579 then whenever Visual mode is started, or the Visual
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1580 area extended, Vim tries to become the owner of the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1581 windowing system's global selection or put the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1582 selected text on the clipboard used by the selection
14999
2b30a2b4bde2 Update runtime files
Bram Moolenaar <Bram@vim.org>
parents: 14945
diff changeset
1583 register "*. See |'go-a'| and |quotestar| for details.
2b30a2b4bde2 Update runtime files
Bram Moolenaar <Bram@vim.org>
parents: 14945
diff changeset
1584 When the GUI is active, the 'a' flag in 'guioptions'
2b30a2b4bde2 Update runtime files
Bram Moolenaar <Bram@vim.org>
parents: 14945
diff changeset
1585 is used, when the GUI is not active, this "autoselect"
2b30a2b4bde2 Update runtime files
Bram Moolenaar <Bram@vim.org>
parents: 14945
diff changeset
1586 flag is used.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1587 Also applies to the modeless selection.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1588
3674
b9aa7fb4a928 updated for version 7.3.597
Bram Moolenaar <bram@vim.org>
parents: 3557
diff changeset
1589 *clipboard-autoselectplus*
b9aa7fb4a928 updated for version 7.3.597
Bram Moolenaar <bram@vim.org>
parents: 3557
diff changeset
1590 autoselectplus Like "autoselect" but using the + register instead of
b9aa7fb4a928 updated for version 7.3.597
Bram Moolenaar <bram@vim.org>
parents: 3557
diff changeset
1591 the * register. Compare to the 'P' flag in
b9aa7fb4a928 updated for version 7.3.597
Bram Moolenaar <bram@vim.org>
parents: 3557
diff changeset
1592 'guioptions'.
b9aa7fb4a928 updated for version 7.3.597
Bram Moolenaar <bram@vim.org>
parents: 3557
diff changeset
1593
b9aa7fb4a928 updated for version 7.3.597
Bram Moolenaar <bram@vim.org>
parents: 3557
diff changeset
1594 *clipboard-autoselectml*
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1595 autoselectml Like "autoselect", but for the modeless selection
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1596 only. Compare to the 'A' flag in 'guioptions'.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1597
3674
b9aa7fb4a928 updated for version 7.3.597
Bram Moolenaar <bram@vim.org>
parents: 3557
diff changeset
1598 *clipboard-html*
1904
062104a823df updated for version 7.2-201
vimboss
parents: 1811
diff changeset
1599 html When the clipboard contains HTML, use this when
062104a823df updated for version 7.2-201
vimboss
parents: 1811
diff changeset
1600 pasting. When putting text on the clipboard, mark it
062104a823df updated for version 7.2-201
vimboss
parents: 1811
diff changeset
1601 as HTML. This works to copy rendered HTML from
062104a823df updated for version 7.2-201
vimboss
parents: 1811
diff changeset
1602 Firefox, paste it as raw HTML in Vim, select the HTML
062104a823df updated for version 7.2-201
vimboss
parents: 1811
diff changeset
1603 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
1604 You probably want to add this only temporarily,
6b4879aea261 Add test for gettabvar() and settabvar().
Bram Moolenaar <bram@vim.org>
parents: 2220
diff changeset
1605 possibly use BufEnter autocommands.
1904
062104a823df updated for version 7.2-201
vimboss
parents: 1811
diff changeset
1606 Only supported for GTK version 2 and later.
062104a823df updated for version 7.2-201
vimboss
parents: 1811
diff changeset
1607
3674
b9aa7fb4a928 updated for version 7.3.597
Bram Moolenaar <bram@vim.org>
parents: 3557
diff changeset
1608 *clipboard-exclude*
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1609 exclude:{pattern}
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1610 Defines a pattern that is matched against the name of
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1611 the terminal 'term'. If there is a match, no
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1612 connection will be made to the X server. This is
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1613 useful in this situation:
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1614 - Running Vim in a console.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1615 - $DISPLAY is set to start applications on another
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1616 display.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1617 - You do not want to connect to the X server in the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1618 console, but do want this in a terminal emulator.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1619 To never connect to the X server use: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1620 exclude:.*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1621 < This has the same effect as using the |-X| argument.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1622 Note that when there is no connection to the X server
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1623 the window title won't be restored and the clipboard
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1624 cannot be accessed.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1625 The value of 'magic' is ignored, {pattern} is
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1626 interpreted as if 'magic' was on.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1627 The rest of the option value will be used for
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1628 {pattern}, this must be the last entry.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1629
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1630 *'cmdheight'* *'ch'*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1631 'cmdheight' 'ch' number (default 1)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1632 global
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1633 Number of screen lines to use for the command-line. Helps avoiding
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1634 |hit-enter| prompts.
824
8dd456c1e283 updated for version 7.0c13
vimboss
parents: 819
diff changeset
1635 The value of this option is stored with the tab page, so that each tab
8dd456c1e283 updated for version 7.0c13
vimboss
parents: 819
diff changeset
1636 page can have a different value.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1637
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1638 *'cmdwinheight'* *'cwh'*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1639 'cmdwinheight' 'cwh' number (default 7)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1640 global
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1641 {not available when compiled without the |+vertsplit|
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1642 feature}
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1643 Number of screen lines to use for the command-line window. |cmdwin|
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1644
2608
7d8af31066c8 Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents: 2607
diff changeset
1645 *'colorcolumn'* *'cc'*
7d8af31066c8 Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents: 2607
diff changeset
1646 'colorcolumn' 'cc' string (default "")
7d8af31066c8 Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents: 2607
diff changeset
1647 local to window
7d8af31066c8 Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents: 2607
diff changeset
1648 {not available when compiled without the |+syntax|
7d8af31066c8 Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents: 2607
diff changeset
1649 feature}
7d8af31066c8 Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents: 2607
diff changeset
1650 '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
1651 highlighted with ColorColumn |hl-ColorColumn|. Useful to align
7d8af31066c8 Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents: 2607
diff changeset
1652 text. Will make screen redrawing slower.
7d8af31066c8 Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents: 2607
diff changeset
1653 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
1654 '+' or '-', which is added to or subtracted from 'textwidth'. >
7d8af31066c8 Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents: 2607
diff changeset
1655
7d8af31066c8 Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents: 2607
diff changeset
1656 :set cc=+1 " highlight column after 'textwidth'
7d8af31066c8 Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents: 2607
diff changeset
1657 :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
1658 :hi ColorColumn ctermbg=lightgrey guibg=lightgrey
7d8af31066c8 Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents: 2607
diff changeset
1659 <
7d8af31066c8 Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents: 2607
diff changeset
1660 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
1661 A maximum of 256 columns are highlighted.
7d8af31066c8 Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents: 2607
diff changeset
1662
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1663 *'columns'* *'co'* *E594*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1664 'columns' 'co' number (default 80 or terminal width)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1665 global
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1666 Number of columns of the screen. Normally this is set by the terminal
161
6df0106fc595 updated for version 7.0049
vimboss
parents: 148
diff changeset
1667 initialization and does not have to be set by hand. Also see
6df0106fc595 updated for version 7.0049
vimboss
parents: 148
diff changeset
1668 |posix-screen-size|.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1669 When Vim is running in the GUI or in a resizable window, setting this
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1670 option will cause the window size to be changed. When you only want
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1671 to use the size for the GUI, put the command in your |gvimrc| file.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1672 When you set this option and Vim is unable to change the physical
1152
e1787f5b90da updated for version 7.1a
vimboss
parents: 1111
diff changeset
1673 number of columns of the display, the display may be messed up. For
e1787f5b90da updated for version 7.1a
vimboss
parents: 1111
diff changeset
1674 the GUI it is always possible and Vim limits the number of columns to
e1787f5b90da updated for version 7.1a
vimboss
parents: 1111
diff changeset
1675 what fits on the screen. You can use this command to get the widest
e1787f5b90da updated for version 7.1a
vimboss
parents: 1111
diff changeset
1676 window possible: >
e1787f5b90da updated for version 7.1a
vimboss
parents: 1111
diff changeset
1677 :set columns=9999
e1787f5b90da updated for version 7.1a
vimboss
parents: 1111
diff changeset
1678 < Minimum value is 12, maximum value is 10000.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1679
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1680 *'comments'* *'com'* *E524* *E525*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1681 'comments' 'com' string (default
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1682 "s1:/*,mb:*,ex:*/,://,b:#,:%,:XCOMM,n:>,fb:-")
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1683 local to buffer
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1684 {not available when compiled without the |+comments|
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1685 feature}
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1686 A comma separated list of strings that can start a comment line. See
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1687 |format-comments|. See |option-backslash| about using backslashes to
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1688 insert a space.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1689
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1690 *'commentstring'* *'cms'* *E537*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1691 'commentstring' 'cms' string (default "/*%s*/")
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1692 local to buffer
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1693 {not available when compiled without the |+folding|
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1694 feature}
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1695 A template for a comment. The "%s" in the value is replaced with the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1696 comment text. Currently only used to add markers for folding, see
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1697 |fold-marker|.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1698
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1699 *'compatible'* *'cp'* *'nocompatible'* *'nocp'*
819
23f82b5d2814 updated for version 7.0c10
vimboss
parents: 818
diff changeset
1700 '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
1701 file is found, reset in |defaults.vim|)
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1702 global
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1703 This option has the effect of making Vim either more Vi-compatible, or
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1704 make Vim behave in a more useful way.
11062
1218c5353e2b Runtime file updates.
Christian Brabandt <cb@256bit.org>
parents: 10895
diff changeset
1705
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1706 This is a special kind of option, because when it's set or reset,
11062
1218c5353e2b Runtime file updates.
Christian Brabandt <cb@256bit.org>
parents: 10895
diff changeset
1707 other options are also changed as a side effect.
1218c5353e2b Runtime file updates.
Christian Brabandt <cb@256bit.org>
parents: 10895
diff changeset
1708 NOTE: Setting or resetting this option can have a lot of unexpected
1218c5353e2b Runtime file updates.
Christian Brabandt <cb@256bit.org>
parents: 10895
diff changeset
1709 effects: Mappings are interpreted in another way, undo behaves
1218c5353e2b Runtime file updates.
Christian Brabandt <cb@256bit.org>
parents: 10895
diff changeset
1710 differently, etc. If you set this option in your vimrc file, you
1218c5353e2b Runtime file updates.
Christian Brabandt <cb@256bit.org>
parents: 10895
diff changeset
1711 should probably put it at the very start.
1218c5353e2b Runtime file updates.
Christian Brabandt <cb@256bit.org>
parents: 10895
diff changeset
1712
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1713 By default this option is on and the Vi defaults are used for the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1714 options. This default was chosen for those people who want to use Vim
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1715 just like Vi, and don't even (want to) know about the 'compatible'
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1716 option.
819
23f82b5d2814 updated for version 7.0c10
vimboss
parents: 818
diff changeset
1717 When a |vimrc| or |gvimrc| file is found while Vim is starting up,
378
6b49757d378c updated for version 7.0098
vimboss
parents: 374
diff changeset
1718 this option is switched off, and all options that have not been
6b49757d378c updated for version 7.0098
vimboss
parents: 374
diff changeset
1719 modified will be set to the Vim defaults. Effectively, this means
819
23f82b5d2814 updated for version 7.0c10
vimboss
parents: 818
diff changeset
1720 that when a |vimrc| or |gvimrc| file exists, Vim will use the Vim
378
6b49757d378c updated for version 7.0098
vimboss
parents: 374
diff changeset
1721 defaults, otherwise it will use the Vi defaults. (Note: This doesn't
1152
e1787f5b90da updated for version 7.1a
vimboss
parents: 1111
diff changeset
1722 happen for the system-wide vimrc or gvimrc file, nor for a file given
e1787f5b90da updated for version 7.1a
vimboss
parents: 1111
diff changeset
1723 with the |-u| argument). Also see |compatible-default| and
e1787f5b90da updated for version 7.1a
vimboss
parents: 1111
diff changeset
1724 |posix-compliance|.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1725 You can also set this option with the "-C" argument, and reset it with
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1726 "-N". See |-C| and |-N|.
11062
1218c5353e2b Runtime file updates.
Christian Brabandt <cb@256bit.org>
parents: 10895
diff changeset
1727 See 'cpoptions' for more fine tuning of Vi compatibility.
1218c5353e2b Runtime file updates.
Christian Brabandt <cb@256bit.org>
parents: 10895
diff changeset
1728
1218c5353e2b Runtime file updates.
Christian Brabandt <cb@256bit.org>
parents: 10895
diff changeset
1729 When this option is set, numerous other options are set to make Vim as
1218c5353e2b Runtime file updates.
Christian Brabandt <cb@256bit.org>
parents: 10895
diff changeset
1730 Vi-compatible as possible. When this option is unset, various options
1218c5353e2b Runtime file updates.
Christian Brabandt <cb@256bit.org>
parents: 10895
diff changeset
1731 are set to make Vim more useful. The table below lists all the
1218c5353e2b Runtime file updates.
Christian Brabandt <cb@256bit.org>
parents: 10895
diff changeset
1732 options affected.
1218c5353e2b Runtime file updates.
Christian Brabandt <cb@256bit.org>
parents: 10895
diff changeset
1733 The {?} column indicates when the options are affected:
1218c5353e2b Runtime file updates.
Christian Brabandt <cb@256bit.org>
parents: 10895
diff changeset
1734 + Means that the option is set to the value given in {set value} when
1218c5353e2b Runtime file updates.
Christian Brabandt <cb@256bit.org>
parents: 10895
diff changeset
1735 'compatible' is set.
1218c5353e2b Runtime file updates.
Christian Brabandt <cb@256bit.org>
parents: 10895
diff changeset
1736 & Means that the option is set to the value given in {set value} when
1218c5353e2b Runtime file updates.
Christian Brabandt <cb@256bit.org>
parents: 10895
diff changeset
1737 'compatible' is set AND is set to its Vim default value when
1218c5353e2b Runtime file updates.
Christian Brabandt <cb@256bit.org>
parents: 10895
diff changeset
1738 'compatible' is unset.
1218c5353e2b Runtime file updates.
Christian Brabandt <cb@256bit.org>
parents: 10895
diff changeset
1739 - Means the option is NOT changed when setting 'compatible' but IS
1218c5353e2b Runtime file updates.
Christian Brabandt <cb@256bit.org>
parents: 10895
diff changeset
1740 set to its Vim default when 'compatible' is unset.
1218c5353e2b Runtime file updates.
Christian Brabandt <cb@256bit.org>
parents: 10895
diff changeset
1741 The {effect} column summarises the change when 'compatible' is set.
1218c5353e2b Runtime file updates.
Christian Brabandt <cb@256bit.org>
parents: 10895
diff changeset
1742
11160
d0a20101ecb2 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 11063
diff changeset
1743 option ? set value effect ~
11062
1218c5353e2b Runtime file updates.
Christian Brabandt <cb@256bit.org>
parents: 10895
diff changeset
1744
1218c5353e2b Runtime file updates.
Christian Brabandt <cb@256bit.org>
parents: 10895
diff changeset
1745 'allowrevins' + off no CTRL-_ command
1218c5353e2b Runtime file updates.
Christian Brabandt <cb@256bit.org>
parents: 10895
diff changeset
1746 'antialias' + off don't use antialiased fonts
1218c5353e2b Runtime file updates.
Christian Brabandt <cb@256bit.org>
parents: 10895
diff changeset
1747 'arabic' + off reset arabic-related options
1218c5353e2b Runtime file updates.
Christian Brabandt <cb@256bit.org>
parents: 10895
diff changeset
1748 'arabicshape' + on correct character shapes
1218c5353e2b Runtime file updates.
Christian Brabandt <cb@256bit.org>
parents: 10895
diff changeset
1749 'backspace' + "" normal backspace
1218c5353e2b Runtime file updates.
Christian Brabandt <cb@256bit.org>
parents: 10895
diff changeset
1750 'backup' + off no backup file
1218c5353e2b Runtime file updates.
Christian Brabandt <cb@256bit.org>
parents: 10895
diff changeset
1751 'backupcopy' & Unix: "yes" backup file is a copy
1218c5353e2b Runtime file updates.
Christian Brabandt <cb@256bit.org>
parents: 10895
diff changeset
1752 else: "auto" copy or rename backup file
1218c5353e2b Runtime file updates.
Christian Brabandt <cb@256bit.org>
parents: 10895
diff changeset
1753 'balloonexpr' + "" text to show in evaluation balloon
1218c5353e2b Runtime file updates.
Christian Brabandt <cb@256bit.org>
parents: 10895
diff changeset
1754 'breakindent' + off don't indent when wrapping lines
1218c5353e2b Runtime file updates.
Christian Brabandt <cb@256bit.org>
parents: 10895
diff changeset
1755 'cedit' - {unchanged} {set vim default only on resetting 'cp'}
1218c5353e2b Runtime file updates.
Christian Brabandt <cb@256bit.org>
parents: 10895
diff changeset
1756 'cindent' + off no C code indentation
1218c5353e2b Runtime file updates.
Christian Brabandt <cb@256bit.org>
parents: 10895
diff changeset
1757 'compatible' - {unchanged} {set vim default only on resetting 'cp'}
1218c5353e2b Runtime file updates.
Christian Brabandt <cb@256bit.org>
parents: 10895
diff changeset
1758 'copyindent' + off don't copy indent structure
1218c5353e2b Runtime file updates.
Christian Brabandt <cb@256bit.org>
parents: 10895
diff changeset
1759 'cpoptions' & (all flags) Vi-compatible flags
1218c5353e2b Runtime file updates.
Christian Brabandt <cb@256bit.org>
parents: 10895
diff changeset
1760 'cscopepathcomp'+ 0 don't show directories in tags list
13341
acd7eaa13d2b Updated runtime files.
Christian Brabandt <cb@256bit.org>
parents: 13314
diff changeset
1761 'cscoperelative'+ off don't use basename of path as prefix
11062
1218c5353e2b Runtime file updates.
Christian Brabandt <cb@256bit.org>
parents: 10895
diff changeset
1762 'cscopetag' + off don't use cscope for ":tag"
11160
d0a20101ecb2 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 11063
diff changeset
1763 'cscopetagorder'+ 0 see |cscopetagorder|
11062
1218c5353e2b Runtime file updates.
Christian Brabandt <cb@256bit.org>
parents: 10895
diff changeset
1764 'cscopeverbose' + off see |cscopeverbose|
1218c5353e2b Runtime file updates.
Christian Brabandt <cb@256bit.org>
parents: 10895
diff changeset
1765 'delcombine' + off unicode: delete whole char combination
1218c5353e2b Runtime file updates.
Christian Brabandt <cb@256bit.org>
parents: 10895
diff changeset
1766 'digraph' + off no digraphs
1218c5353e2b Runtime file updates.
Christian Brabandt <cb@256bit.org>
parents: 10895
diff changeset
1767 'esckeys' & off no <Esc>-keys in Insert mode
1218c5353e2b Runtime file updates.
Christian Brabandt <cb@256bit.org>
parents: 10895
diff changeset
1768 'expandtab' + off tabs not expanded to spaces
1218c5353e2b Runtime file updates.
Christian Brabandt <cb@256bit.org>
parents: 10895
diff changeset
1769 'fileformats' & "" no automatic file format detection,
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1770 "dos,unix" except for DOS, Windows and OS/2
11062
1218c5353e2b Runtime file updates.
Christian Brabandt <cb@256bit.org>
parents: 10895
diff changeset
1771 'formatexpr' + "" use 'formatprg' for auto-formatting
1218c5353e2b Runtime file updates.
Christian Brabandt <cb@256bit.org>
parents: 10895
diff changeset
1772 'formatoptions' & "vt" Vi compatible formatting
1218c5353e2b Runtime file updates.
Christian Brabandt <cb@256bit.org>
parents: 10895
diff changeset
1773 'gdefault' + off no default 'g' flag for ":s"
1218c5353e2b Runtime file updates.
Christian Brabandt <cb@256bit.org>
parents: 10895
diff changeset
1774 'history' & 0 no commandline history
1218c5353e2b Runtime file updates.
Christian Brabandt <cb@256bit.org>
parents: 10895
diff changeset
1775 'hkmap' + off no Hebrew keyboard mapping
1218c5353e2b Runtime file updates.
Christian Brabandt <cb@256bit.org>
parents: 10895
diff changeset
1776 'hkmapp' + off no phonetic Hebrew keyboard mapping
1218c5353e2b Runtime file updates.
Christian Brabandt <cb@256bit.org>
parents: 10895
diff changeset
1777 'hlsearch' + off no highlighting of search matches
1218c5353e2b Runtime file updates.
Christian Brabandt <cb@256bit.org>
parents: 10895
diff changeset
1778 'incsearch' + off no incremental searching
1218c5353e2b Runtime file updates.
Christian Brabandt <cb@256bit.org>
parents: 10895
diff changeset
1779 'indentexpr' + "" no indenting by expression
1218c5353e2b Runtime file updates.
Christian Brabandt <cb@256bit.org>
parents: 10895
diff changeset
1780 'insertmode' + off do not start in Insert mode
1218c5353e2b Runtime file updates.
Christian Brabandt <cb@256bit.org>
parents: 10895
diff changeset
1781 'iskeyword' & "@,48-57,_" keywords contain alphanumeric
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1782 characters and '_'
11062
1218c5353e2b Runtime file updates.
Christian Brabandt <cb@256bit.org>
parents: 10895
diff changeset
1783 'joinspaces' + on insert 2 spaces after period
1218c5353e2b Runtime file updates.
Christian Brabandt <cb@256bit.org>
parents: 10895
diff changeset
1784 'modeline' & off no modelines
1218c5353e2b Runtime file updates.
Christian Brabandt <cb@256bit.org>
parents: 10895
diff changeset
1785 'more' & off no pauses in listings
1218c5353e2b Runtime file updates.
Christian Brabandt <cb@256bit.org>
parents: 10895
diff changeset
1786 'mzquantum' - {unchanged} {set vim default only on resetting 'cp'}
1218c5353e2b Runtime file updates.
Christian Brabandt <cb@256bit.org>
parents: 10895
diff changeset
1787 'numberwidth' & 8 min number of columns for line number
1218c5353e2b Runtime file updates.
Christian Brabandt <cb@256bit.org>
parents: 10895
diff changeset
1788 'preserveindent'+ off don't preserve current indent structure
1218c5353e2b Runtime file updates.
Christian Brabandt <cb@256bit.org>
parents: 10895
diff changeset
1789 when changing it
1218c5353e2b Runtime file updates.
Christian Brabandt <cb@256bit.org>
parents: 10895
diff changeset
1790 'revins' + off no reverse insert
1218c5353e2b Runtime file updates.
Christian Brabandt <cb@256bit.org>
parents: 10895
diff changeset
1791 'ruler' + off no ruler
1218c5353e2b Runtime file updates.
Christian Brabandt <cb@256bit.org>
parents: 10895
diff changeset
1792 'scrolljump' + 1 no jump scroll
1218c5353e2b Runtime file updates.
Christian Brabandt <cb@256bit.org>
parents: 10895
diff changeset
1793 'scrolloff' + 0 no scroll offset
1218c5353e2b Runtime file updates.
Christian Brabandt <cb@256bit.org>
parents: 10895
diff changeset
1794 'shelltemp' - {unchanged} {set vim default only on resetting 'cp'}
1218c5353e2b Runtime file updates.
Christian Brabandt <cb@256bit.org>
parents: 10895
diff changeset
1795 '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
1796 'shortmess' & "S" no shortening of messages
11062
1218c5353e2b Runtime file updates.
Christian Brabandt <cb@256bit.org>
parents: 10895
diff changeset
1797 'showcmd' & off command characters not shown
1218c5353e2b Runtime file updates.
Christian Brabandt <cb@256bit.org>
parents: 10895
diff changeset
1798 'showmode' & off current mode not shown
1218c5353e2b Runtime file updates.
Christian Brabandt <cb@256bit.org>
parents: 10895
diff changeset
1799 'sidescrolloff' + 0 cursor moves to edge of screen in scroll
1218c5353e2b Runtime file updates.
Christian Brabandt <cb@256bit.org>
parents: 10895
diff changeset
1800 'smartcase' + off no automatic ignore case switch
1218c5353e2b Runtime file updates.
Christian Brabandt <cb@256bit.org>
parents: 10895
diff changeset
1801 'smartindent' + off no smart indentation
1218c5353e2b Runtime file updates.
Christian Brabandt <cb@256bit.org>
parents: 10895
diff changeset
1802 'smarttab' + off no smart tab size
1218c5353e2b Runtime file updates.
Christian Brabandt <cb@256bit.org>
parents: 10895
diff changeset
1803 'softtabstop' + 0 tabs are always 'tabstop' positions
1218c5353e2b Runtime file updates.
Christian Brabandt <cb@256bit.org>
parents: 10895
diff changeset
1804 'startofline' + on goto startofline with some commands
1218c5353e2b Runtime file updates.
Christian Brabandt <cb@256bit.org>
parents: 10895
diff changeset
1805 'tagcase' & "followic" 'ignorecase' when searching tags file
1218c5353e2b Runtime file updates.
Christian Brabandt <cb@256bit.org>
parents: 10895
diff changeset
1806 'tagrelative' & off tag file names are not relative
1218c5353e2b Runtime file updates.
Christian Brabandt <cb@256bit.org>
parents: 10895
diff changeset
1807 'termguicolors' + off don't use highlight-(guifg|guibg)
1218c5353e2b Runtime file updates.
Christian Brabandt <cb@256bit.org>
parents: 10895
diff changeset
1808 'textauto' & off no automatic textmode detection
1218c5353e2b Runtime file updates.
Christian Brabandt <cb@256bit.org>
parents: 10895
diff changeset
1809 'textwidth' + 0 no automatic line wrap
1218c5353e2b Runtime file updates.
Christian Brabandt <cb@256bit.org>
parents: 10895
diff changeset
1810 'tildeop' + off tilde is not an operator
1218c5353e2b Runtime file updates.
Christian Brabandt <cb@256bit.org>
parents: 10895
diff changeset
1811 'ttimeout' + off no terminal timeout
1218c5353e2b Runtime file updates.
Christian Brabandt <cb@256bit.org>
parents: 10895
diff changeset
1812 'undofile' + off don't use an undo file
11160
d0a20101ecb2 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 11063
diff changeset
1813 'viminfo' - {unchanged} {set Vim default only on resetting 'cp'}
11062
1218c5353e2b Runtime file updates.
Christian Brabandt <cb@256bit.org>
parents: 10895
diff changeset
1814 'virtualedit' + "" cursor can only be placed on characters
1218c5353e2b Runtime file updates.
Christian Brabandt <cb@256bit.org>
parents: 10895
diff changeset
1815 'whichwrap' & "" left-right movements don't wrap
1218c5353e2b Runtime file updates.
Christian Brabandt <cb@256bit.org>
parents: 10895
diff changeset
1816 'wildchar' & CTRL-E only when the current value is <Tab>
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1817 use CTRL-E for cmdline completion
11062
1218c5353e2b Runtime file updates.
Christian Brabandt <cb@256bit.org>
parents: 10895
diff changeset
1818 'writebackup' + on or off depends on the |+writebackup| feature
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1819
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1820 *'complete'* *'cpt'* *E535*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1821 'complete' 'cpt' string (default: ".,w,b,u,t,i")
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1822 local to buffer
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1823 This option specifies how keyword completion |ins-completion| works
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1824 when CTRL-P or CTRL-N are used. It is also used for whole-line
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1825 completion |i_CTRL-X_CTRL-L|. It indicates the type of completion
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1826 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
1827 . scan the current buffer ('wrapscan' is ignored)
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1828 w scan buffers from other windows
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1829 b scan other loaded buffers that are in the buffer list
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1830 u scan the unloaded buffers that are in the buffer list
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1831 U scan the buffers that are not in the buffer list
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1832 k scan the files given with the 'dictionary' option
703
2fae45239fb3 updated for version 7.0212
vimboss
parents: 699
diff changeset
1833 kspell use the currently active spell checking |spell|
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1834 k{dict} scan the file {dict}. Several "k" flags can be given,
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1835 patterns are valid too. For example: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1836 :set cpt=k/usr/dict/*,k~/spanish
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1837 < s scan the files given with the 'thesaurus' option
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1838 s{tsr} scan the file {tsr}. Several "s" flags can be given, patterns
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1839 are valid too.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1840 i scan current and included files
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1841 d scan current and included files for defined name or macro
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1842 |i_CTRL-X_CTRL-D|
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1843 ] tag completion
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1844 t same as "]"
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1845
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1846 Unloaded buffers are not loaded, thus their autocmds |:autocmd| are
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1847 not executed, this may lead to unexpected completions from some files
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1848 (gzipped files for example). Unloaded buffers are not scanned for
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1849 whole-line completion.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1850
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1851 The default is ".,w,b,u,t,i", which means to scan:
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1852 1. the current buffer
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1853 2. buffers in other windows
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1854 3. other loaded buffers
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1855 4. unloaded buffers
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1856 5. tags
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1857 6. included files
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1858
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1859 As you can see, CTRL-N and CTRL-P can be used to do any 'iskeyword'-
233
fca8a9b65afa updated for version 7.0065
vimboss
parents: 227
diff changeset
1860 based expansion (e.g., dictionary |i_CTRL-X_CTRL-K|, included patterns
fca8a9b65afa updated for version 7.0065
vimboss
parents: 227
diff changeset
1861 |i_CTRL-X_CTRL-I|, tags |i_CTRL-X_CTRL-]| and normal expansions).
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1862
12
bdeee1504ac1 updated for version 7.0004
vimboss
parents: 11
diff changeset
1863 *'completefunc'* *'cfu'*
bdeee1504ac1 updated for version 7.0004
vimboss
parents: 11
diff changeset
1864 'completefunc' 'cfu' string (default: empty)
bdeee1504ac1 updated for version 7.0004
vimboss
parents: 11
diff changeset
1865 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
1866 {not available when compiled without the |+eval|
71b56b4e7785 Make the references to features in the help more consistent. (Sylvain Hitier)
Bram Moolenaar <bram@vim.org>
parents: 2561
diff changeset
1867 or |+insert_expand| features}
623
bd2fe62c9d77 updated for version 7.0178
vimboss
parents: 596
diff changeset
1868 This option specifies a function to be used for Insert mode completion
bd2fe62c9d77 updated for version 7.0178
vimboss
parents: 596
diff changeset
1869 with CTRL-X CTRL-U. |i_CTRL-X_CTRL-U|
648
9032e4668296 updated for version 7.0189
vimboss
parents: 642
diff changeset
1870 See |complete-functions| for an explanation of how the function is
9032e4668296 updated for version 7.0189
vimboss
parents: 642
diff changeset
1871 invoked and what it should return.
2642
840c3cadb842 Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 2625
diff changeset
1872 This option cannot be set from a |modeline| or in the |sandbox|, for
840c3cadb842 Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 2625
diff changeset
1873 security reasons.
14
946da5994c01 updated for version 7.0006
vimboss
parents: 13
diff changeset
1874
540
2df7f3a5eb96 updated for version 7.0153
vimboss
parents: 534
diff changeset
1875 *'completeopt'* *'cot'*
730
44348703ab1b updated for version 7.0221
vimboss
parents: 717
diff changeset
1876 'completeopt' 'cot' string (default: "menu,preview")
540
2df7f3a5eb96 updated for version 7.0153
vimboss
parents: 534
diff changeset
1877 global
766
f0d0d3d3a1e2 updated for version 7.0225
vimboss
parents: 743
diff changeset
1878 {not available when compiled without the
f0d0d3d3a1e2 updated for version 7.0225
vimboss
parents: 743
diff changeset
1879 |+insert_expand| feature}
665
21ab9abf0f08 updated for version 7.0196
vimboss
parents: 657
diff changeset
1880 A comma separated list of options for Insert mode completion
21ab9abf0f08 updated for version 7.0196
vimboss
parents: 657
diff changeset
1881 |ins-completion|. The supported values are:
540
2df7f3a5eb96 updated for version 7.0153
vimboss
parents: 534
diff changeset
1882
2df7f3a5eb96 updated for version 7.0153
vimboss
parents: 534
diff changeset
1883 menu Use a popup menu to show the possible completions. The
2df7f3a5eb96 updated for version 7.0153
vimboss
parents: 534
diff changeset
1884 menu is only shown when there is more than one match and
2df7f3a5eb96 updated for version 7.0153
vimboss
parents: 534
diff changeset
1885 sufficient colors are available. |ins-completion-menu|
2df7f3a5eb96 updated for version 7.0153
vimboss
parents: 534
diff changeset
1886
707
111b7dcc8a17 updated for version 7.0213
vimboss
parents: 703
diff changeset
1887 menuone Use the popup menu also when there is only one match.
856
8cd729851562 updated for version 7.0g
vimboss
parents: 853
diff changeset
1888 Useful when there is additional information about the
707
111b7dcc8a17 updated for version 7.0213
vimboss
parents: 703
diff changeset
1889 match, e.g., what file it comes from.
111b7dcc8a17 updated for version 7.0213
vimboss
parents: 703
diff changeset
1890
836
5a7843c57316 updated for version 7.0e02
vimboss
parents: 834
diff changeset
1891 longest Only insert the longest common text of the matches. If
5a7843c57316 updated for version 7.0e02
vimboss
parents: 834
diff changeset
1892 the menu is displayed you can use CTRL-L to add more
5a7843c57316 updated for version 7.0e02
vimboss
parents: 834
diff changeset
1893 characters. Whether case is ignored depends on the kind
5a7843c57316 updated for version 7.0e02
vimboss
parents: 834
diff changeset
1894 of completion. For buffer text the 'ignorecase' option is
5a7843c57316 updated for version 7.0e02
vimboss
parents: 834
diff changeset
1895 used.
665
21ab9abf0f08 updated for version 7.0196
vimboss
parents: 657
diff changeset
1896
730
44348703ab1b updated for version 7.0221
vimboss
parents: 717
diff changeset
1897 preview Show extra information about the currently selected
1152
e1787f5b90da updated for version 7.1a
vimboss
parents: 1111
diff changeset
1898 completion in the preview window. Only works in
e1787f5b90da updated for version 7.1a
vimboss
parents: 1111
diff changeset
1899 combination with "menu" or "menuone".
e1787f5b90da updated for version 7.1a
vimboss
parents: 1111
diff changeset
1900
6911
e09a7ff88046 patch 7.4.775
Bram Moolenaar <bram@vim.org>
parents: 6855
diff changeset
1901 noinsert Do not insert any text for a match until the user selects
e09a7ff88046 patch 7.4.775
Bram Moolenaar <bram@vim.org>
parents: 6855
diff changeset
1902 a match from the menu. Only works in combination with
e09a7ff88046 patch 7.4.775
Bram Moolenaar <bram@vim.org>
parents: 6855
diff changeset
1903 "menu" or "menuone". No effect if "longest" is present.
e09a7ff88046 patch 7.4.775
Bram Moolenaar <bram@vim.org>
parents: 6855
diff changeset
1904
e09a7ff88046 patch 7.4.775
Bram Moolenaar <bram@vim.org>
parents: 6855
diff changeset
1905 noselect Do not select a match in the menu, force the user to
e09a7ff88046 patch 7.4.775
Bram Moolenaar <bram@vim.org>
parents: 6855
diff changeset
1906 select one from the menu. Only works in combination with
e09a7ff88046 patch 7.4.775
Bram Moolenaar <bram@vim.org>
parents: 6855
diff changeset
1907 "menu" or "menuone".
e09a7ff88046 patch 7.4.775
Bram Moolenaar <bram@vim.org>
parents: 6855
diff changeset
1908
730
44348703ab1b updated for version 7.0221
vimboss
parents: 717
diff changeset
1909
2378
85b7dc8da5eb Add the 'concealcursor' option to decide when the cursor line is to be
Bram Moolenaar <bram@vim.org>
parents: 2365
diff changeset
1910 *'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
1911 '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
1912 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
1913 {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
1914 feature}
85b7dc8da5eb Add the 'concealcursor' option to decide when the cursor line is to be
Bram Moolenaar <bram@vim.org>
parents: 2365
diff changeset
1915 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
1916 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
1917 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
1918 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
1919 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
1920 i Insert mode
2382
3a5ededa240a Add the 'c' flag to 'concealcursor'.
Bram Moolenaar <bram@vim.org>
parents: 2380
diff changeset
1921 c Command line editing, for 'incsearch'
3a5ededa240a Add the 'c' flag to 'concealcursor'.
Bram Moolenaar <bram@vim.org>
parents: 2380
diff changeset
1922
2400
e6f1424dd66a Let 'v' flag in 'concealcursor' apply to all lines in the Visual area.
Bram Moolenaar <bram@vim.org>
parents: 2394
diff changeset
1923 '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
1924 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
1925 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
1926 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
1927 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
1928 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
1929 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
1930
85b7dc8da5eb Add the 'concealcursor' option to decide when the cursor line is to be
Bram Moolenaar <bram@vim.org>
parents: 2365
diff changeset
1931
14864
40ef13331e02 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 14702
diff changeset
1932 *'conceallevel'* *'cole'*
40ef13331e02 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 14702
diff changeset
1933 'conceallevel' 'cole' number (default 0)
2250
1bac28a53fae Add the conceal patch from Vince Negri.
Bram Moolenaar <bram@vim.org>
parents: 2249
diff changeset
1934 local to window
1bac28a53fae Add the conceal patch from Vince Negri.
Bram Moolenaar <bram@vim.org>
parents: 2249
diff changeset
1935 {not available when compiled without the |+conceal|
1bac28a53fae Add the conceal patch from Vince Negri.
Bram Moolenaar <bram@vim.org>
parents: 2249
diff changeset
1936 feature}
2340
99c1eba60b2d Make automatic prototype generation work with more interfaces.
Bram Moolenaar <bram@vim.org>
parents: 2337
diff changeset
1937 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
1938 is shown:
99c1eba60b2d Make automatic prototype generation work with more interfaces.
Bram Moolenaar <bram@vim.org>
parents: 2337
diff changeset
1939
99c1eba60b2d Make automatic prototype generation work with more interfaces.
Bram Moolenaar <bram@vim.org>
parents: 2337
diff changeset
1940 Value Effect ~
2250
1bac28a53fae Add the conceal patch from Vince Negri.
Bram Moolenaar <bram@vim.org>
parents: 2249
diff changeset
1941 0 Text is shown normally
2426
e52d87a2bb3e More runtime file updates.
Bram Moolenaar <bram@vim.org>
parents: 2413
diff changeset
1942 1 Each block of concealed text is replaced with one
e52d87a2bb3e More runtime file updates.
Bram Moolenaar <bram@vim.org>
parents: 2413
diff changeset
1943 character. If the syntax item does not have a custom
e52d87a2bb3e More runtime file updates.
Bram Moolenaar <bram@vim.org>
parents: 2413
diff changeset
1944 replacement character defined (see |:syn-cchar|) the
e52d87a2bb3e More runtime file updates.
Bram Moolenaar <bram@vim.org>
parents: 2413
diff changeset
1945 character defined in 'listchars' is used (default is a
e52d87a2bb3e More runtime file updates.
Bram Moolenaar <bram@vim.org>
parents: 2413
diff changeset
1946 space).
e52d87a2bb3e More runtime file updates.
Bram Moolenaar <bram@vim.org>
parents: 2413
diff changeset
1947 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
1948 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
1949 custom replacement character defined (see
2426
e52d87a2bb3e More runtime file updates.
Bram Moolenaar <bram@vim.org>
parents: 2413
diff changeset
1950 |: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
1951 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
1952
586a459f3980 Never hide text for conceal in cursor line. Do hide when there is
Bram Moolenaar <bram@vim.org>
parents: 2348
diff changeset
1953 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
1954 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
1955 option.
2250
1bac28a53fae Add the conceal patch from Vince Negri.
Bram Moolenaar <bram@vim.org>
parents: 2249
diff changeset
1956
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1957 *'confirm'* *'cf'* *'noconfirm'* *'nocf'*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1958 'confirm' 'cf' boolean (default off)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1959 global
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1960 When 'confirm' is on, certain operations that would normally
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1961 fail because of unsaved changes to a buffer, e.g. ":q" and ":e",
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1962 instead raise a |dialog| asking if you wish to save the current
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1963 file(s). You can still use a ! to unconditionally |abandon| a buffer.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1964 If 'confirm' is off you can still activate confirmation for one
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1965 command only (this is most useful in mappings) with the |:confirm|
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1966 command.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1967 Also see the |confirm()| function and the 'v' flag in 'guioptions'.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1968
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1969 *'conskey'* *'consk'* *'noconskey'* *'noconsk'*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1970 'conskey' 'consk' boolean (default off)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1971 global
8246
f16bfe02cef1 commit https://github.com/vim/vim/commit/f391327adbbffb11180cf6038a92af1ed144e907
Christian Brabandt <cb@256bit.org>
parents: 8182
diff changeset
1972 This was for MS-DOS and is no longer supported.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1973
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1974 *'copyindent'* *'ci'* *'nocopyindent'* *'noci'*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1975 'copyindent' 'ci' boolean (default off)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1976 local to buffer
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1977 Copy the structure of the existing lines indent when autoindenting a
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1978 new line. Normally the new indent is reconstructed by a series of
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1979 tabs followed by spaces as required (unless |'expandtab'| is enabled,
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1980 in which case only spaces are used). Enabling this option makes the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1981 new line copy whatever characters were used for indenting on the
1621
82b5078be2dd updated for version 7.2a
vimboss
parents: 1564
diff changeset
1982 existing line. 'expandtab' has no effect on these characters, a Tab
82b5078be2dd updated for version 7.2a
vimboss
parents: 1564
diff changeset
1983 remains a Tab. If the new indent is greater than on the existing
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1984 line, the remaining space is filled in the normal manner.
11160
d0a20101ecb2 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 11063
diff changeset
1985 NOTE: This option is reset when 'compatible' is set.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1986 Also see 'preserveindent'.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1987
8148
f5da459c5698 commit https://github.com/vim/vim/commit/e0fa3742ead676a3074a10edadbc955e1a89153d
Christian Brabandt <cb@256bit.org>
parents: 8061
diff changeset
1988 *'cpoptions'* *'cpo'* *cpo*
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1989 'cpoptions' 'cpo' string (Vim default: "aABceFs",
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1990 Vi default: all flags)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1991 global
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1992 A sequence of single character flags. When a character is present
5340
22da5ab9aaa1 Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 5294
diff changeset
1993 this indicates Vi-compatible behavior. This is used for things where
22da5ab9aaa1 Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 5294
diff changeset
1994 not being Vi-compatible is mostly or sometimes preferred.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1995 'cpoptions' stands for "compatible-options".
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1996 Commas can be added for readability.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1997 To avoid problems with flags that are added in the future, use the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1998 "+=" and "-=" feature of ":set" |add-option-flags|.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1999 NOTE: This option is set to the Vi default value when 'compatible' is
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2000 set and to the Vim default value when 'compatible' is reset.
164
8b0ee9d57d7f updated for version 7.0050
vimboss
parents: 161
diff changeset
2001 NOTE: This option is set to the POSIX default value at startup when
8b0ee9d57d7f updated for version 7.0050
vimboss
parents: 161
diff changeset
2002 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
2003 variable exists |posix|. This means Vim tries to behave like the
de5a43c5eedc Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents: 1904
diff changeset
2004 POSIX specification.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2005
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2006 contains behavior ~
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2007 *cpo-a*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2008 a When included, a ":read" command with a file name
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2009 argument will set the alternate file name for the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2010 current window.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2011 *cpo-A*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2012 A When included, a ":write" command with a file name
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2013 argument will set the alternate file name for the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2014 current window.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2015 *cpo-b*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2016 b "\|" in a ":map" command is recognized as the end of
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2017 the map command. The '\' is included in the mapping,
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2018 the text after the '|' is interpreted as the next
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2019 command. Use a CTRL-V instead of a backslash to
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2020 include the '|' in the mapping. Applies to all
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2021 mapping, abbreviation, menu and autocmd commands.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2022 See also |map_bar|.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2023 *cpo-B*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2024 B A backslash has no special meaning in mappings,
14372
2a4a2dc35c55 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 14298
diff changeset
2025 abbreviations, user commands and the "to" part of the
2a4a2dc35c55 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 14298
diff changeset
2026 menu commands. Remove this flag to be able to use a
2a4a2dc35c55 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 14298
diff changeset
2027 backslash like a CTRL-V. For example, the command
2a4a2dc35c55 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 14298
diff changeset
2028 ":map X \<Esc>" results in X being mapped to:
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2029 'B' included: "\^[" (^[ is a real <Esc>)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2030 'B' excluded: "<Esc>" (5 characters)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2031 ('<' excluded in both cases)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2032 *cpo-c*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2033 c Searching continues at the end of any match at the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2034 cursor position, but not further than the start of the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2035 next line. When not present searching continues
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2036 one character from the cursor position. With 'c'
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2037 "abababababab" only gets three matches when repeating
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2038 "/abab", without 'c' there are five matches.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2039 *cpo-C*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2040 C Do not concatenate sourced lines that start with a
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2041 backslash. See |line-continuation|.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2042 *cpo-d*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2043 d Using "./" in the 'tags' option doesn't mean to use
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2044 the tags file relative to the current file, but the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2045 tags file in the current directory.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2046 *cpo-D*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2047 D Can't use CTRL-K to enter a digraph after Normal mode
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2048 commands with a character argument, like |r|, |f| and
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2049 |t|.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2050 *cpo-e*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2051 e When executing a register with ":@r", always add a
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2052 <CR> to the last line, also when the register is not
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2053 linewise. If this flag is not present, the register
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2054 is not linewise and the last line does not end in a
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2055 <CR>, then the last line is put on the command-line
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2056 and can be edited before hitting <CR>.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2057 *cpo-E*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2058 E It is an error when using "y", "d", "c", "g~", "gu" or
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2059 "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
2060 at least one character is to be operated on. Example:
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2061 This makes "y0" fail in the first column.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2062 *cpo-f*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2063 f When included, a ":read" command with a file name
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2064 argument will set the file name for the current buffer,
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2065 if the current buffer doesn't have a file name yet.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2066 *cpo-F*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2067 F When included, a ":write" command with a file name
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2068 argument will set the file name for the current
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2069 buffer, if the current buffer doesn't have a file name
590
de152391f6f9 updated for version 7.0167
vimboss
parents: 571
diff changeset
2070 yet. Also see |cpo-P|.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2071 *cpo-g*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2072 g Goto line 1 when using ":edit" without argument.
164
8b0ee9d57d7f updated for version 7.0050
vimboss
parents: 161
diff changeset
2073 *cpo-H*
8b0ee9d57d7f updated for version 7.0050
vimboss
parents: 161
diff changeset
2074 H When using "I" on a line with only blanks, insert
8b0ee9d57d7f updated for version 7.0050
vimboss
parents: 161
diff changeset
2075 before the last blank. Without this flag insert after
8b0ee9d57d7f updated for version 7.0050
vimboss
parents: 161
diff changeset
2076 the last blank.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2077 *cpo-i*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2078 i When included, interrupting the reading of a file will
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2079 leave it modified.
10
4e2284e71352 updated for version 7.0002
vimboss
parents: 8
diff changeset
2080 *cpo-I*
4e2284e71352 updated for version 7.0002
vimboss
parents: 8
diff changeset
2081 I When moving the cursor up or down just after inserting
4e2284e71352 updated for version 7.0002
vimboss
parents: 8
diff changeset
2082 indent for 'autoindent', do not delete the indent.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2083 *cpo-j*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2084 j When joining lines, only add two spaces after a '.',
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2085 not after '!' or '?'. Also see 'joinspaces'.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2086 *cpo-J*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2087 J A |sentence| has to be followed by two spaces after
233
fca8a9b65afa updated for version 7.0065
vimboss
parents: 227
diff changeset
2088 the '.', '!' or '?'. A <Tab> is not recognized as
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2089 white space.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2090 *cpo-k*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2091 k Disable the recognition of raw key codes in
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2092 mappings, abbreviations, and the "to" part of menu
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2093 commands. For example, if <Key> sends ^[OA (where ^[
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2094 is <Esc>), the command ":map X ^[OA" results in X
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2095 being mapped to:
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2096 'k' included: "^[OA" (3 characters)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2097 'k' excluded: "<Key>" (one key code)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2098 Also see the '<' flag below.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2099 *cpo-K*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2100 K Don't wait for a key code to complete when it is
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2101 halfway a mapping. This breaks mapping <F1><F1> when
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2102 only part of the second <F1> has been read. It
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2103 enables cancelling the mapping by typing <F1><Esc>.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2104 *cpo-l*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2105 l Backslash in a [] range in a search pattern is taken
168
4d9eabb1396e updated for version 7.0051
vimboss
parents: 164
diff changeset
2106 literally, only "\]", "\^", "\-" and "\\" are special.
4d9eabb1396e updated for version 7.0051
vimboss
parents: 164
diff changeset
2107 See |/[]|
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2108 'l' included: "/[ \t]" finds <Space>, '\' and 't'
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2109 'l' excluded: "/[ \t]" finds <Space> and <Tab>
168
4d9eabb1396e updated for version 7.0051
vimboss
parents: 164
diff changeset
2110 Also see |cpo-\|.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2111 *cpo-L*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2112 L When the 'list' option is set, 'wrapmargin',
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2113 'textwidth', 'softtabstop' and Virtual Replace mode
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2114 (see |gR|) count a <Tab> as two characters, instead of
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2115 the normal behavior of a <Tab>.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2116 *cpo-m*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2117 m When included, a showmatch will always wait half a
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2118 second. When not included, a showmatch will wait half
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2119 a second or until a character is typed. |'showmatch'|
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2120 *cpo-M*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2121 M When excluded, "%" matching will take backslashes into
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2122 account. Thus in "( \( )" and "\( ( \)" the outer
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2123 parenthesis match. When included "%" ignores
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2124 backslashes, which is Vi compatible.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2125 *cpo-n*
2178
c6f1aa1e9f32 Add 'relativenumber' patch from Markus Heidelberg.
Bram Moolenaar <bram@vim.org>
parents: 2154
diff changeset
2126 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
2127 '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
2128 lines.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2129 *cpo-o*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2130 o Line offset to search command is not remembered for
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2131 next search.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2132 *cpo-O*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2133 O Don't complain if a file is being overwritten, even
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2134 when it didn't exist when editing it. This is a
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2135 protection against a file unexpectedly created by
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2136 someone else. Vi didn't complain about this.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2137 *cpo-p*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2138 p Vi compatible Lisp indenting. When not present, a
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2139 slightly better algorithm is used.
590
de152391f6f9 updated for version 7.0167
vimboss
parents: 571
diff changeset
2140 *cpo-P*
de152391f6f9 updated for version 7.0167
vimboss
parents: 571
diff changeset
2141 P When included, a ":write" command that appends to a
de152391f6f9 updated for version 7.0167
vimboss
parents: 571
diff changeset
2142 file will set the file name for the current buffer, if
de152391f6f9 updated for version 7.0167
vimboss
parents: 571
diff changeset
2143 the current buffer doesn't have a file name yet and
de152391f6f9 updated for version 7.0167
vimboss
parents: 571
diff changeset
2144 the 'F' flag is also included |cpo-F|.
164
8b0ee9d57d7f updated for version 7.0050
vimboss
parents: 161
diff changeset
2145 *cpo-q*
8b0ee9d57d7f updated for version 7.0050
vimboss
parents: 161
diff changeset
2146 q When joining multiple lines leave the cursor at the
8b0ee9d57d7f updated for version 7.0050
vimboss
parents: 161
diff changeset
2147 position where it would be when joining two lines.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2148 *cpo-r*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2149 r Redo ("." command) uses "/" to repeat a search
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2150 command, instead of the actually used search string.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2151 *cpo-R*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2152 R Remove marks from filtered lines. Without this flag
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2153 marks are kept like |:keepmarks| was used.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2154 *cpo-s*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2155 s Set buffer options when entering the buffer for the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2156 first time. This is like it is in Vim version 3.0.
10
4e2284e71352 updated for version 7.0002
vimboss
parents: 8
diff changeset
2157 And it is the default. If not present the options are
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2158 set when the buffer is created.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2159 *cpo-S*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2160 S Set buffer options always when entering a buffer
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2161 (except 'readonly', 'fileformat', 'filetype' and
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2162 'syntax'). This is the (most) Vi compatible setting.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2163 The options are set to the values in the current
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2164 buffer. When you change an option and go to another
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2165 buffer, the value is copied. Effectively makes the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2166 buffer options global to all buffers.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2167
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2168 's' 'S' copy buffer options
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2169 no no when buffer created
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2170 yes no when buffer first entered (default)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2171 X yes each time when buffer entered (vi comp.)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2172 *cpo-t*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2173 t Search pattern for the tag command is remembered for
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2174 "n" command. Otherwise Vim only puts the pattern in
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2175 the history for search pattern, but doesn't change the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2176 last used search pattern.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2177 *cpo-u*
10
4e2284e71352 updated for version 7.0002
vimboss
parents: 8
diff changeset
2178 u Undo is Vi compatible. See |undo-two-ways|.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2179 *cpo-v*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2180 v Backspaced characters remain visible on the screen in
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2181 Insert mode. Without this flag the characters are
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2182 erased from the screen right away. With this flag the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2183 screen newly typed text overwrites backspaced
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2184 characters.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2185 *cpo-w*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2186 w When using "cw" on a blank character, only change one
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2187 character and not all blanks until the start of the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2188 next word.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2189 *cpo-W*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2190 W Don't overwrite a readonly file. When omitted, ":w!"
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2191 overwrites a readonly file, if possible.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2192 *cpo-x*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2193 x <Esc> on the command-line executes the command-line.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2194 The default in Vim is to abandon the command-line,
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2195 because <Esc> normally aborts a command. |c_<Esc>|
164
8b0ee9d57d7f updated for version 7.0050
vimboss
parents: 161
diff changeset
2196 *cpo-X*
8b0ee9d57d7f updated for version 7.0050
vimboss
parents: 161
diff changeset
2197 X When using a count with "R" the replaced text is
8b0ee9d57d7f updated for version 7.0050
vimboss
parents: 161
diff changeset
2198 deleted only once. Also when repeating "R" with "."
8b0ee9d57d7f updated for version 7.0050
vimboss
parents: 161
diff changeset
2199 and a count.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2200 *cpo-y*
15512
f0f06837a699 Update runtime files.
Bram Moolenaar <Bram@vim.org>
parents: 15502
diff changeset
2201 y A yank command can be redone with ".". Think twice if
f0f06837a699 Update runtime files.
Bram Moolenaar <Bram@vim.org>
parents: 15502
diff changeset
2202 you really want to use this, it may break some
f0f06837a699 Update runtime files.
Bram Moolenaar <Bram@vim.org>
parents: 15502
diff changeset
2203 plugins, since most people expect "." to only repeat a
f0f06837a699 Update runtime files.
Bram Moolenaar <Bram@vim.org>
parents: 15502
diff changeset
2204 change.
164
8b0ee9d57d7f updated for version 7.0050
vimboss
parents: 161
diff changeset
2205 *cpo-Z*
8b0ee9d57d7f updated for version 7.0050
vimboss
parents: 161
diff changeset
2206 Z When using "w!" while the 'readonly' option is set,
8b0ee9d57d7f updated for version 7.0050
vimboss
parents: 161
diff changeset
2207 don't reset 'readonly'.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2208 *cpo-!*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2209 ! When redoing a filter command, use the last used
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2210 external command, whatever it was. Otherwise the last
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2211 used -filter- command is used.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2212 *cpo-$*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2213 $ When making a change to one line, don't redisplay the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2214 line, but put a '$' at the end of the changed text.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2215 The changed text will be overwritten when you type the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2216 new text. The line is redisplayed if you type any
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2217 command that moves the cursor from the insertion
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2218 point.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2219 *cpo-%*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2220 % Vi-compatible matching is done for the "%" command.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2221 Does not recognize "#if", "#endif", etc.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2222 Does not recognize "/*" and "*/".
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2223 Parens inside single and double quotes are also
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2224 counted, causing a string that contains a paren to
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2225 disturb the matching. For example, in a line like
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2226 "if (strcmp("foo(", s))" the first paren does not
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2227 match the last one. When this flag is not included,
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2228 parens inside single and double quotes are treated
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2229 specially. When matching a paren outside of quotes,
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2230 everything inside quotes is ignored. When matching a
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2231 paren inside quotes, it will find the matching one (if
10
4e2284e71352 updated for version 7.0002
vimboss
parents: 8
diff changeset
2232 there is one). This works very well for C programs.
36
125e80798a85 updated for version 7.0021
vimboss
parents: 33
diff changeset
2233 This flag is also used for other features, such as
125e80798a85 updated for version 7.0021
vimboss
parents: 33
diff changeset
2234 C-indenting.
161
6df0106fc595 updated for version 7.0049
vimboss
parents: 148
diff changeset
2235 *cpo--*
6df0106fc595 updated for version 7.0049
vimboss
parents: 148
diff changeset
2236 - When included, a vertical movement command fails when
632
b6632d553df3 updated for version 7.0182
vimboss
parents: 625
diff changeset
2237 it would go above the first line or below the last
b6632d553df3 updated for version 7.0182
vimboss
parents: 625
diff changeset
2238 line. Without it the cursor moves to the first or
b6632d553df3 updated for version 7.0182
vimboss
parents: 625
diff changeset
2239 last line, unless it already was in that line.
161
6df0106fc595 updated for version 7.0049
vimboss
parents: 148
diff changeset
2240 Applies to the commands "-", "k", CTRL-P, "+", "j",
632
b6632d553df3 updated for version 7.0182
vimboss
parents: 625
diff changeset
2241 CTRL-N, CTRL-J and ":1234".
39
410fa1a31baf updated for version 7.0023
vimboss
parents: 36
diff changeset
2242 *cpo-+*
410fa1a31baf updated for version 7.0023
vimboss
parents: 36
diff changeset
2243 + When included, a ":write file" command will reset the
410fa1a31baf updated for version 7.0023
vimboss
parents: 36
diff changeset
2244 'modified' flag of the buffer, even though the buffer
410fa1a31baf updated for version 7.0023
vimboss
parents: 36
diff changeset
2245 itself may still be different from its file.
856
8cd729851562 updated for version 7.0g
vimboss
parents: 853
diff changeset
2246 *cpo-star*
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2247 * Use ":*" in the same way as ":@". When not included,
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2248 ":*" is an alias for ":'<,'>", select the Visual area.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2249 *cpo-<*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2250 < Disable the recognition of special key codes in |<>|
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2251 form in mappings, abbreviations, and the "to" part of
10
4e2284e71352 updated for version 7.0002
vimboss
parents: 8
diff changeset
2252 menu commands. For example, the command
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2253 ":map X <Tab>" results in X being mapped to:
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2254 '<' included: "<Tab>" (5 characters)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2255 '<' excluded: "^I" (^I is a real <Tab>)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2256 Also see the 'k' flag above.
164
8b0ee9d57d7f updated for version 7.0050
vimboss
parents: 161
diff changeset
2257 *cpo->*
8b0ee9d57d7f updated for version 7.0050
vimboss
parents: 161
diff changeset
2258 > When appending to a register, put a line break before
8b0ee9d57d7f updated for version 7.0050
vimboss
parents: 161
diff changeset
2259 the appended text.
2925
441d364773dc updated for version 7.3.235
Bram Moolenaar <bram@vim.org>
parents: 2908
diff changeset
2260 *cpo-;*
441d364773dc updated for version 7.3.235
Bram Moolenaar <bram@vim.org>
parents: 2908
diff changeset
2261 ; When using |,| or |;| to repeat the last |t| search
441d364773dc updated for version 7.3.235
Bram Moolenaar <bram@vim.org>
parents: 2908
diff changeset
2262 and the cursor is right in front of the searched
441d364773dc updated for version 7.3.235
Bram Moolenaar <bram@vim.org>
parents: 2908
diff changeset
2263 character, the cursor won't move. When not included,
441d364773dc updated for version 7.3.235
Bram Moolenaar <bram@vim.org>
parents: 2908
diff changeset
2264 the cursor would skip over it and jump to the
3557
9cb3a75a20b9 Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 3513
diff changeset
2265 following occurrence.
164
8b0ee9d57d7f updated for version 7.0050
vimboss
parents: 161
diff changeset
2266
8b0ee9d57d7f updated for version 7.0050
vimboss
parents: 161
diff changeset
2267 POSIX flags. These are not included in the Vi default value, except
8b0ee9d57d7f updated for version 7.0050
vimboss
parents: 161
diff changeset
2268 when $VIM_POSIX was set on startup. |posix|
8b0ee9d57d7f updated for version 7.0050
vimboss
parents: 161
diff changeset
2269
8b0ee9d57d7f updated for version 7.0050
vimboss
parents: 161
diff changeset
2270 contains behavior ~
856
8cd729851562 updated for version 7.0g
vimboss
parents: 853
diff changeset
2271 *cpo-#*
164
8b0ee9d57d7f updated for version 7.0050
vimboss
parents: 161
diff changeset
2272 # A count before "D", "o" and "O" has no effect.
168
4d9eabb1396e updated for version 7.0051
vimboss
parents: 164
diff changeset
2273 *cpo-&*
4d9eabb1396e updated for version 7.0051
vimboss
parents: 164
diff changeset
2274 & When ":preserve" was used keep the swap file when
4d9eabb1396e updated for version 7.0051
vimboss
parents: 164
diff changeset
2275 exiting normally while this buffer is still loaded.
4d9eabb1396e updated for version 7.0051
vimboss
parents: 164
diff changeset
2276 This flag is tested when exiting.
4d9eabb1396e updated for version 7.0051
vimboss
parents: 164
diff changeset
2277 *cpo-\*
4d9eabb1396e updated for version 7.0051
vimboss
parents: 164
diff changeset
2278 \ Backslash in a [] range in a search pattern is taken
4d9eabb1396e updated for version 7.0051
vimboss
parents: 164
diff changeset
2279 literally, only "\]" is special See |/[]|
488
f00f0af2a320 updated for version 7.0133
vimboss
parents: 484
diff changeset
2280 '\' included: "/[ \-]" finds <Space>, '\' and '-'
f00f0af2a320 updated for version 7.0133
vimboss
parents: 484
diff changeset
2281 '\' excluded: "/[ \-]" finds <Space> and '-'
f00f0af2a320 updated for version 7.0133
vimboss
parents: 484
diff changeset
2282 Also see |cpo-l|.
168
4d9eabb1396e updated for version 7.0051
vimboss
parents: 164
diff changeset
2283 *cpo-/*
4d9eabb1396e updated for version 7.0051
vimboss
parents: 164
diff changeset
2284 / When "%" is used as the replacement string in a |:s|
4d9eabb1396e updated for version 7.0051
vimboss
parents: 164
diff changeset
2285 command, use the previous replacement string. |:s%|
164
8b0ee9d57d7f updated for version 7.0050
vimboss
parents: 161
diff changeset
2286 *cpo-{*
8b0ee9d57d7f updated for version 7.0050
vimboss
parents: 161
diff changeset
2287 { The |{| and |}| commands also stop at a "{" character
8b0ee9d57d7f updated for version 7.0050
vimboss
parents: 161
diff changeset
2288 at the start of a line.
168
4d9eabb1396e updated for version 7.0051
vimboss
parents: 164
diff changeset
2289 *cpo-.*
4d9eabb1396e updated for version 7.0051
vimboss
parents: 164
diff changeset
2290 . The ":chdir" and ":cd" commands fail if the current
4d9eabb1396e updated for version 7.0051
vimboss
parents: 164
diff changeset
2291 buffer is modified, unless ! is used. Vim doesn't
4d9eabb1396e updated for version 7.0051
vimboss
parents: 164
diff changeset
2292 need this, since it remembers the full path of an
4d9eabb1396e updated for version 7.0051
vimboss
parents: 164
diff changeset
2293 opened file.
164
8b0ee9d57d7f updated for version 7.0050
vimboss
parents: 161
diff changeset
2294 *cpo-bar*
8b0ee9d57d7f updated for version 7.0050
vimboss
parents: 161
diff changeset
2295 | The value of the $LINES and $COLUMNS environment
8b0ee9d57d7f updated for version 7.0050
vimboss
parents: 161
diff changeset
2296 variables overrule the terminal size values obtained
8b0ee9d57d7f updated for version 7.0050
vimboss
parents: 161
diff changeset
2297 with system specific functions.
8b0ee9d57d7f updated for version 7.0050
vimboss
parents: 161
diff changeset
2298
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2299
2180
f60a0c9cbe6c Add the blowfish encryption patch from Mohsin Ahmed. Needs more work.
Bram Moolenaar <bram@vim.org>
parents: 2178
diff changeset
2300 *'cryptmethod'* *'cm'*
15192
690da0a83419 patch 8.1.0606: 'cryptmethod' defaults to a very old method
Bram Moolenaar <Bram@vim.org>
parents: 15131
diff changeset
2301 '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
2302 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
2303 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
2304 *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
2305 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
2306 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
2307 *blowfish*
6122
18ac55444b37 updated for version 7.4.399
Bram Moolenaar <bram@vim.org>
parents: 6110
diff changeset
2308 blowfish Blowfish method. Medium strong encryption but it has
18ac55444b37 updated for version 7.4.399
Bram Moolenaar <bram@vim.org>
parents: 6110
diff changeset
2309 an implementation flaw. Requires Vim 7.3 or later,
18ac55444b37 updated for version 7.4.399
Bram Moolenaar <bram@vim.org>
parents: 6110
diff changeset
2310 files can NOT be read by Vim 7.2 and older. This adds
18ac55444b37 updated for version 7.4.399
Bram Moolenaar <bram@vim.org>
parents: 6110
diff changeset
2311 a "seed" to the file, every time you write the file
18ac55444b37 updated for version 7.4.399
Bram Moolenaar <bram@vim.org>
parents: 6110
diff changeset
2312 the encrypted bytes will be different.
18ac55444b37 updated for version 7.4.399
Bram Moolenaar <bram@vim.org>
parents: 6110
diff changeset
2313 *blowfish2*
18ac55444b37 updated for version 7.4.399
Bram Moolenaar <bram@vim.org>
parents: 6110
diff changeset
2314 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
2315 Vim 7.4.401 or later, files can NOT be read by Vim 7.3
6122
18ac55444b37 updated for version 7.4.399
Bram Moolenaar <bram@vim.org>
parents: 6110
diff changeset
2316 and older. This adds a "seed" to the file, every time
18ac55444b37 updated for version 7.4.399
Bram Moolenaar <bram@vim.org>
parents: 6110
diff changeset
2317 you write the file the encrypted bytes will be
18ac55444b37 updated for version 7.4.399
Bram Moolenaar <bram@vim.org>
parents: 6110
diff changeset
2318 different. The whole undo file is encrypted, not just
18ac55444b37 updated for version 7.4.399
Bram Moolenaar <bram@vim.org>
parents: 6110
diff changeset
2319 the pieces of text.
2204
c493d6bfde09 A few more changes for encryption. Add test that encrypted file can be read.
Bram Moolenaar <bram@vim.org>
parents: 2184
diff changeset
2320
8748
b1a19a2f73f0 commit https://github.com/vim/vim/commit/4f3f668c8486444e53163c29d2fc79bf47eb3c82
Christian Brabandt <cb@256bit.org>
parents: 8629
diff changeset
2321 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
2322
2180
f60a0c9cbe6c Add the blowfish encryption patch from Mohsin Ahmed. Needs more work.
Bram Moolenaar <bram@vim.org>
parents: 2178
diff changeset
2323 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
2324 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
2325 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
2326 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
2327 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
2328 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
2329
d8e4b27cef80 Change 'cryptmethod' from a number to a string option. Make it global-local.
Bram Moolenaar <bram@vim.org>
parents: 2350
diff changeset
2330 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
2331 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
2332 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
2333
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
2334 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
2335 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
2336 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
2337
f60a0c9cbe6c Add the blowfish encryption patch from Mohsin Ahmed. Needs more work.
Bram Moolenaar <bram@vim.org>
parents: 2178
diff changeset
2338
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2339 *'cscopepathcomp'* *'cspc'*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2340 'cscopepathcomp' 'cspc' number (default 0)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2341 global
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2342 {not available when compiled without the |+cscope|
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2343 feature}
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2344 Determines how many components of the path to show in a list of tags.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2345 See |cscopepathcomp|.
11160
d0a20101ecb2 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 11063
diff changeset
2346 NOTE: This option is set to 0 when 'compatible' is set.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2347
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2348 *'cscopeprg'* *'csprg'*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2349 'cscopeprg' 'csprg' string (default "cscope")
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2350 global
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2351 {not available when compiled without the |+cscope|
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2352 feature}
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2353 Specifies the command to execute cscope. See |cscopeprg|.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2354 This option cannot be set from a |modeline| or in the |sandbox|, for
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2355 security reasons.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2356
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2357 *'cscopequickfix'* *'csqf'*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2358 'cscopequickfix' 'csqf' string (default "")
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2359 global
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2360 {not available when compiled without the |+cscope|
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2361 or |+quickfix| features}
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2362 Specifies whether to use quickfix window to show cscope results.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2363 See |cscopequickfix|.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2364
4869
a5352e73dc00 Update runtime files.
Bram Moolenaar <bram@vim.org>
parents: 4780
diff changeset
2365 *'cscoperelative'* *'csre'* *'nocscoperelative'* *'nocsre'*
2873
eeb1ac4f66d1 updated for version 7.3.210
Bram Moolenaar <bram@vim.org>
parents: 2833
diff changeset
2366 'cscoperelative' 'csre' boolean (default off)
eeb1ac4f66d1 updated for version 7.3.210
Bram Moolenaar <bram@vim.org>
parents: 2833
diff changeset
2367 global
eeb1ac4f66d1 updated for version 7.3.210
Bram Moolenaar <bram@vim.org>
parents: 2833
diff changeset
2368 {not available when compiled without the |+cscope|
eeb1ac4f66d1 updated for version 7.3.210
Bram Moolenaar <bram@vim.org>
parents: 2833
diff changeset
2369 feature}
eeb1ac4f66d1 updated for version 7.3.210
Bram Moolenaar <bram@vim.org>
parents: 2833
diff changeset
2370 In the absence of a prefix (-P) for cscope. setting this option enables
eeb1ac4f66d1 updated for version 7.3.210
Bram Moolenaar <bram@vim.org>
parents: 2833
diff changeset
2371 to use the basename of cscope.out path as the prefix.
eeb1ac4f66d1 updated for version 7.3.210
Bram Moolenaar <bram@vim.org>
parents: 2833
diff changeset
2372 See |cscoperelative|.
11160
d0a20101ecb2 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 11063
diff changeset
2373 NOTE: This option is reset when 'compatible' is set.
2873
eeb1ac4f66d1 updated for version 7.3.210
Bram Moolenaar <bram@vim.org>
parents: 2833
diff changeset
2374
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2375 *'cscopetag'* *'cst'* *'nocscopetag'* *'nocst'*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2376 'cscopetag' 'cst' boolean (default off)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2377 global
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2378 {not available when compiled without the |+cscope|
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2379 feature}
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2380 Use cscope for tag commands. See |cscope-options|.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2381 NOTE: This option is reset when 'compatible' is set.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2382
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2383 *'cscopetagorder'* *'csto'*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2384 'cscopetagorder' 'csto' number (default 0)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2385 global
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2386 {not available when compiled without the |+cscope|
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2387 feature}
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2388 Determines the order in which ":cstag" performs a search. See
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2389 |cscopetagorder|.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2390 NOTE: This option is set to 0 when 'compatible' is set.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2391
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2392 *'cscopeverbose'* *'csverb'*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2393 *'nocscopeverbose'* *'nocsverb'*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2394 'cscopeverbose' 'csverb' boolean (default off)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2395 global
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2396 {not available when compiled without the |+cscope|
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2397 feature}
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2398 Give messages when adding a cscope database. See |cscopeverbose|.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2399 NOTE: This option is reset when 'compatible' is set.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2400
2250
1bac28a53fae Add the conceal patch from Vince Negri.
Bram Moolenaar <bram@vim.org>
parents: 2249
diff changeset
2401 *'cursorbind'* *'crb'* *'nocursorbind'* *'nocrb'*
1bac28a53fae Add the conceal patch from Vince Negri.
Bram Moolenaar <bram@vim.org>
parents: 2249
diff changeset
2402 'cursorbind' 'crb' boolean (default off)
1bac28a53fae Add the conceal patch from Vince Negri.
Bram Moolenaar <bram@vim.org>
parents: 2249
diff changeset
2403 local to window
1bac28a53fae Add the conceal patch from Vince Negri.
Bram Moolenaar <bram@vim.org>
parents: 2249
diff changeset
2404 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
2405 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
2406 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
2407 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
2408 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
2409 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
2410 taken into account.
2250
1bac28a53fae Add the conceal patch from Vince Negri.
Bram Moolenaar <bram@vim.org>
parents: 2249
diff changeset
2411
743
afac7b58ed46 updated for version 7.0222
vimboss
parents: 730
diff changeset
2412
afac7b58ed46 updated for version 7.0222
vimboss
parents: 730
diff changeset
2413 *'cursorcolumn'* *'cuc'* *'nocursorcolumn'* *'nocuc'*
afac7b58ed46 updated for version 7.0222
vimboss
parents: 730
diff changeset
2414 'cursorcolumn' 'cuc' boolean (default off)
afac7b58ed46 updated for version 7.0222
vimboss
parents: 730
diff changeset
2415 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
2416 {not available when compiled without the |+syntax|
743
afac7b58ed46 updated for version 7.0222
vimboss
parents: 730
diff changeset
2417 feature}
afac7b58ed46 updated for version 7.0222
vimboss
parents: 730
diff changeset
2418 Highlight the screen column of the cursor with CursorColumn
afac7b58ed46 updated for version 7.0222
vimboss
parents: 730
diff changeset
2419 |hl-CursorColumn|. Useful to align text. Will make screen redrawing
afac7b58ed46 updated for version 7.0222
vimboss
parents: 730
diff changeset
2420 slower.
826
1cdd2661f34c updated for version 7.0d01
vimboss
parents: 825
diff changeset
2421 If you only want the highlighting in the current window you can use
1cdd2661f34c updated for version 7.0d01
vimboss
parents: 825
diff changeset
2422 these autocommands: >
1cdd2661f34c updated for version 7.0d01
vimboss
parents: 825
diff changeset
2423 au WinLeave * set nocursorline nocursorcolumn
1cdd2661f34c updated for version 7.0d01
vimboss
parents: 825
diff changeset
2424 au WinEnter * set cursorline cursorcolumn
1cdd2661f34c updated for version 7.0d01
vimboss
parents: 825
diff changeset
2425 <
743
afac7b58ed46 updated for version 7.0222
vimboss
parents: 730
diff changeset
2426
afac7b58ed46 updated for version 7.0222
vimboss
parents: 730
diff changeset
2427 *'cursorline'* *'cul'* *'nocursorline'* *'nocul'*
afac7b58ed46 updated for version 7.0222
vimboss
parents: 730
diff changeset
2428 'cursorline' 'cul' boolean (default off)
afac7b58ed46 updated for version 7.0222
vimboss
parents: 730
diff changeset
2429 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
2430 {not available when compiled without the |+syntax|
743
afac7b58ed46 updated for version 7.0222
vimboss
parents: 730
diff changeset
2431 feature}
afac7b58ed46 updated for version 7.0222
vimboss
parents: 730
diff changeset
2432 Highlight the screen line of the cursor with CursorLine
afac7b58ed46 updated for version 7.0222
vimboss
parents: 730
diff changeset
2433 |hl-CursorLine|. Useful to easily spot the cursor. Will make screen
afac7b58ed46 updated for version 7.0222
vimboss
parents: 730
diff changeset
2434 redrawing slower.
818
1f929f3ca806 updated for version 7.0c03
vimboss
parents: 810
diff changeset
2435 When Visual mode is active the highlighting isn't used to make it
825
6675076019ae updated for version 7.0d
vimboss
parents: 824
diff changeset
2436 easier to see the selected text.
743
afac7b58ed46 updated for version 7.0222
vimboss
parents: 730
diff changeset
2437
afac7b58ed46 updated for version 7.0222
vimboss
parents: 730
diff changeset
2438
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2439 *'debug'*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2440 'debug' string (default "")
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2441 global
839
1f3b1021f002 updated for version 7.0e05
vimboss
parents: 838
diff changeset
2442 These values can be used:
1f3b1021f002 updated for version 7.0e05
vimboss
parents: 838
diff changeset
2443 msg Error messages that would otherwise be omitted will be given
1f3b1021f002 updated for version 7.0e05
vimboss
parents: 838
diff changeset
2444 anyway.
1f3b1021f002 updated for version 7.0e05
vimboss
parents: 838
diff changeset
2445 throw Error messages that would otherwise be omitted will be given
1f3b1021f002 updated for version 7.0e05
vimboss
parents: 838
diff changeset
2446 anyway and also throw an exception and set |v:errmsg|.
1f3b1021f002 updated for version 7.0e05
vimboss
parents: 838
diff changeset
2447 beep A message will be given when otherwise only a beep would be
1f3b1021f002 updated for version 7.0e05
vimboss
parents: 838
diff changeset
2448 produced.
168
4d9eabb1396e updated for version 7.0051
vimboss
parents: 164
diff changeset
2449 The values can be combined, separated by a comma.
839
1f3b1021f002 updated for version 7.0e05
vimboss
parents: 838
diff changeset
2450 "msg" and "throw" are useful for debugging 'foldexpr', 'formatexpr' or
1f3b1021f002 updated for version 7.0e05
vimboss
parents: 838
diff changeset
2451 'indentexpr'.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2452
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2453 *'define'* *'def'*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2454 'define' 'def' string (default "^\s*#\s*define")
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2455 global or local to buffer |global-local|
10
4e2284e71352 updated for version 7.0002
vimboss
parents: 8
diff changeset
2456 Pattern to be used to find a macro definition. It is a search
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2457 pattern, just like for the "/" command. This option is used for the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2458 commands like "[i" and "[d" |include-search|. The 'isident' option is
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2459 used to recognize the defined name after the match:
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2460 {match with 'define'}{non-ID chars}{defined name}{non-ID char}
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2461 See |option-backslash| about inserting backslashes to include a space
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2462 or backslash.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2463 The default value is for C programs. For C++ this value would be
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2464 useful, to include const type declarations: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2465 ^\(#\s*define\|[a-z]*\s*const\s*[a-z]*\)
16086
bd7461db24b3 Update runtime files.
Bram Moolenaar <Bram@vim.org>
parents: 16023
diff changeset
2466 < You can also use "\ze" just before the name and continue the pattern
bd7461db24b3 Update runtime files.
Bram Moolenaar <Bram@vim.org>
parents: 16023
diff changeset
2467 to check what is following. E.g. for Javascript, if a function is
bd7461db24b3 Update runtime files.
Bram Moolenaar <Bram@vim.org>
parents: 16023
diff changeset
2468 defined with "func_name = function(args)": >
bd7461db24b3 Update runtime files.
Bram Moolenaar <Bram@vim.org>
parents: 16023
diff changeset
2469 ^\s*\ze\i\+\s*=\s*function(
bd7461db24b3 Update runtime files.
Bram Moolenaar <Bram@vim.org>
parents: 16023
diff changeset
2470 < If the function is defined with "func_name : function() {...": >
bd7461db24b3 Update runtime files.
Bram Moolenaar <Bram@vim.org>
parents: 16023
diff changeset
2471 ^\s*\ze\i\+\s*[:]\s*(*function\s*(
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2472 < When using the ":set" command, you need to double the backslashes!
16086
bd7461db24b3 Update runtime files.
Bram Moolenaar <Bram@vim.org>
parents: 16023
diff changeset
2473 To avoid that use `:let` with a single quote string: >
bd7461db24b3 Update runtime files.
Bram Moolenaar <Bram@vim.org>
parents: 16023
diff changeset
2474 let &l:define = '^\s*\ze\k\+\s*=\s*function('
16380
5ad204d8a2f2 Update runtime files
Bram Moolenaar <Bram@vim.org>
parents: 16086
diff changeset
2475 <
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2476
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2477 *'delcombine'* *'deco'* *'nodelcombine'* *'nodeco'*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2478 'delcombine' 'deco' boolean (default off)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2479 global
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2480 If editing Unicode and this option is set, backspace and Normal mode
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2481 "x" delete each combining character on its own. When it is off (the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2482 default) the character along with its combining characters are
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2483 deleted.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2484 Note: When 'delcombine' is set "xx" may work different from "2x"!
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2485
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2486 This is useful for Arabic, Hebrew and many other languages where one
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2487 may have combining characters overtop of base characters, and want
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2488 to remove only the combining ones.
11160
d0a20101ecb2 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 11063
diff changeset
2489 NOTE: This option is reset when 'compatible' is set.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2490
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2491 *'dictionary'* *'dict'*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2492 'dictionary' 'dict' string (default "")
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2493 global or local to buffer |global-local|
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2494 List of file names, separated by commas, that are used to lookup words
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2495 for keyword completion commands |i_CTRL-X_CTRL-K|. Each file should
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2496 contain a list of words. This can be one word per line, or several
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2497 words per line, separated by non-keyword characters (white space is
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2498 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
2499
741b1feeac9f patch 8.0.1845: various comment updates needed, missing white space
Christian Brabandt <cb@256bit.org>
parents: 13818
diff changeset
2500 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
2501 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
2502 '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
2503
10
4e2284e71352 updated for version 7.0002
vimboss
parents: 8
diff changeset
2504 To include a comma in a file name precede it with a backslash. Spaces
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2505 after a comma are ignored, otherwise spaces are included in the file
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2506 name. See |option-backslash| about using backslashes.
99
04f2e519ab18 updated for version 7.0038
vimboss
parents: 82
diff changeset
2507 This has nothing to do with the |Dictionary| variable type.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2508 Where to find a list of words?
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2509 - On FreeBSD, there is the file "/usr/share/dict/words".
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2510 - In the Simtel archive, look in the "msdos/linguist" directory.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2511 - In "miscfiles" of the GNU collection.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2512 The use of |:set+=| and |:set-=| is preferred when adding or removing
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2513 directories from the list. This avoids problems when a future version
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2514 uses another default.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2515 Backticks cannot be used in this option for security reasons.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2516
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2517 *'diff'* *'nodiff'*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2518 'diff' boolean (default off)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2519 local to window
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2520 {not available when compiled without the |+diff|
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2521 feature}
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2522 Join the current window in the group of windows that shows differences
10
4e2284e71352 updated for version 7.0002
vimboss
parents: 8
diff changeset
2523 between files. See |vimdiff|.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2524
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2525 *'dex'* *'diffexpr'*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2526 'diffexpr' 'dex' string (default "")
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2527 global
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2528 {not available when compiled without the |+diff|
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2529 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
2530 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
2531 or unified-style) from two versions of a file. See |diff-diffexpr|.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2532 This option cannot be set from a |modeline| or in the |sandbox|, for
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2533 security reasons.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2534
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2535 *'dip'* *'diffopt'*
14702
daf8afe6279b patch 8.1.0363: internal diff isn't used by default as advertised
Christian Brabandt <cb@256bit.org>
parents: 14696
diff changeset
2536 'diffopt' 'dip' string (default "internal,filler")
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2537 global
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2538 {not available when compiled without the |+diff|
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2539 feature}
10
4e2284e71352 updated for version 7.0002
vimboss
parents: 8
diff changeset
2540 Option settings for diff mode. It can consist of the following items.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2541 All are optional. Items must be separated by a comma.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2542
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2543 filler Show filler lines, to keep the text
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2544 synchronized with a window that has inserted
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2545 lines at the same position. Mostly useful
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2546 when windows are side-by-side and 'scrollbind'
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2547 is set.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2548
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2549 context:{n} Use a context of {n} lines between a change
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2550 and a fold that contains unchanged lines.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2551 When omitted a context of six lines is used.
15932
c3c1abe7aff2 Update runtime files
Bram Moolenaar <Bram@vim.org>
parents: 15878
diff changeset
2552 When using zero the context is actually one,
c3c1abe7aff2 Update runtime files
Bram Moolenaar <Bram@vim.org>
parents: 15878
diff changeset
2553 since folds require a line in between, also
c3c1abe7aff2 Update runtime files
Bram Moolenaar <Bram@vim.org>
parents: 15878
diff changeset
2554 for a deleted line.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2555 See |fold-diff|.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2556
14864
40ef13331e02 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 14702
diff changeset
2557 iblank Ignore changes where lines are all blank. Adds
40ef13331e02 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 14702
diff changeset
2558 the "-B" flag to the "diff" command if
40ef13331e02 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 14702
diff changeset
2559 'diffexpr' is empty. Check the documentation
40ef13331e02 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 14702
diff changeset
2560 of the "diff" command for what this does
40ef13331e02 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 14702
diff changeset
2561 exactly.
40ef13331e02 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 14702
diff changeset
2562 NOTE: the diff windows will get out of sync,
40ef13331e02 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 14702
diff changeset
2563 because no differences between blank lines are
40ef13331e02 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 14702
diff changeset
2564 taken into account.
40ef13331e02 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 14702
diff changeset
2565
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2566 icase Ignore changes in case of text. "a" and "A"
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2567 are considered the same. Adds the "-i" flag
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2568 to the "diff" command if 'diffexpr' is empty.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2569
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2570 iwhite Ignore changes in amount of white space. Adds
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2571 the "-b" flag to the "diff" command if
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2572 'diffexpr' is empty. Check the documentation
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2573 of the "diff" command for what this does
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2574 exactly. It should ignore adding trailing
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2575 white space, but not leading white space.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2576
14864
40ef13331e02 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 14702
diff changeset
2577 iwhiteall Ignore all white space changes. Adds
40ef13331e02 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 14702
diff changeset
2578 the "-w" flag to the "diff" command if
40ef13331e02 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 14702
diff changeset
2579 'diffexpr' is empty. Check the documentation
40ef13331e02 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 14702
diff changeset
2580 of the "diff" command for what this does
40ef13331e02 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 14702
diff changeset
2581 exactly.
40ef13331e02 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 14702
diff changeset
2582
40ef13331e02 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 14702
diff changeset
2583 iwhiteeol Ignore white space changes at end of line.
40ef13331e02 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 14702
diff changeset
2584 Adds the "-Z" flag to the "diff" command if
40ef13331e02 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 14702
diff changeset
2585 'diffexpr' is empty. Check the documentation
40ef13331e02 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 14702
diff changeset
2586 of the "diff" command for what this does
40ef13331e02 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 14702
diff changeset
2587 exactly.
40ef13331e02 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 14702
diff changeset
2588
766
f0d0d3d3a1e2 updated for version 7.0225
vimboss
parents: 743
diff changeset
2589 horizontal Start diff mode with horizontal splits (unless
f0d0d3d3a1e2 updated for version 7.0225
vimboss
parents: 743
diff changeset
2590 explicitly specified otherwise).
f0d0d3d3a1e2 updated for version 7.0225
vimboss
parents: 743
diff changeset
2591
f0d0d3d3a1e2 updated for version 7.0225
vimboss
parents: 743
diff changeset
2592 vertical Start diff mode with vertical splits (unless
f0d0d3d3a1e2 updated for version 7.0225
vimboss
parents: 743
diff changeset
2593 explicitly specified otherwise).
f0d0d3d3a1e2 updated for version 7.0225
vimboss
parents: 743
diff changeset
2594
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
2595 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
2596 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
2597
766
f0d0d3d3a1e2 updated for version 7.0225
vimboss
parents: 743
diff changeset
2598 foldcolumn:{n} Set the 'foldcolumn' option to {n} when
f0d0d3d3a1e2 updated for version 7.0225
vimboss
parents: 743
diff changeset
2599 starting diff mode. Without this 2 is used.
f0d0d3d3a1e2 updated for version 7.0225
vimboss
parents: 743
diff changeset
2600
14696
195e8b1fcbbf patch 8.1.0360: using an external diff program is slow and inflexible
Christian Brabandt <cb@256bit.org>
parents: 14695
diff changeset
2601 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
2602 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
2603 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
2604 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
2605 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
2606 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
2607
195e8b1fcbbf patch 8.1.0360: using an external diff program is slow and inflexible
Christian Brabandt <cb@256bit.org>
parents: 14695
diff changeset
2608 indent-heuristic
15033
f8b0f1e42f2c Update runtime files.
Bram Moolenaar <Bram@vim.org>
parents: 14999
diff changeset
2609 Use the indent heuristic for the internal
f8b0f1e42f2c Update runtime files.
Bram Moolenaar <Bram@vim.org>
parents: 14999
diff changeset
2610 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
2611
195e8b1fcbbf patch 8.1.0360: using an external diff program is slow and inflexible
Christian Brabandt <cb@256bit.org>
parents: 14695
diff changeset
2612 algorithm:{text} Use the specified diff algorithm with the
15033
f8b0f1e42f2c Update runtime files.
Bram Moolenaar <Bram@vim.org>
parents: 14999
diff changeset
2613 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
2614 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
2615 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
2616 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
2617 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
2618 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
2619 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
2620
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2621 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
2622 :set diffopt=internal,filler,context:4
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2623 :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
2624 :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
2625 :set diffopt-=internal " do NOT use the internal diff parser
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2626 <
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2627 *'digraph'* *'dg'* *'nodigraph'* *'nodg'*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2628 'digraph' 'dg' boolean (default off)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2629 global
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2630 {not available when compiled without the |+digraphs|
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2631 feature}
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2632 Enable the entering of digraphs in Insert mode with {char1} <BS>
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2633 {char2}. See |digraphs|.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2634 NOTE: This option is reset when 'compatible' is set.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2635
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2636 *'directory'* *'dir'*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2637 'directory' 'dir' string (default for Amiga: ".,t:",
5555
7818ca6de3d0 Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 5487
diff changeset
2638 for MS-DOS and Win32: ".,$TEMP,c:\tmp,c:\temp"
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2639 for Unix: ".,~/tmp,/var/tmp,/tmp")
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2640 global
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2641 List of directory names for the swap file, separated with commas.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2642 - The swap file will be created in the first directory where this is
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2643 possible.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2644 - Empty means that no swap file will be used (recovery is
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2645 impossible!).
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2646 - A directory "." means to put the swap file in the same directory as
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2647 the edited file. On Unix, a dot is prepended to the file name, so
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2648 it doesn't show in a directory listing. On MS-Windows the "hidden"
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2649 attribute is set and a dot prepended if possible.
33
f6033dcbaf31 updated for version 7.0020
vimboss
parents: 29
diff changeset
2650 - A directory starting with "./" (or ".\" for MS-DOS et al.) means to
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2651 put the swap file relative to where the edited file is. The leading
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2652 "." 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
2653 - 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
2654 the swap file name will be built from the complete path to the file
dddba3937532 patch 8.1.0251: using full path is not supported for 'backupdir'
Christian Brabandt <cb@256bit.org>
parents: 14421
diff changeset
2655 with all path separators substituted to percent '%' signs. This will
dddba3937532 patch 8.1.0251: using full path is not supported for 'backupdir'
Christian Brabandt <cb@256bit.org>
parents: 14421
diff changeset
2656 ensure file name uniqueness in the preserve directory.
dddba3937532 patch 8.1.0251: using full path is not supported for 'backupdir'
Christian Brabandt <cb@256bit.org>
parents: 14421
diff changeset
2657 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
2658 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
2659 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
2660 use '//', instead of '\\'.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2661 - Spaces after the comma are ignored, other spaces are considered part
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2662 of the directory name. To have a space at the start of a directory
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2663 name, precede it with a backslash.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2664 - To include a comma in a directory name precede it with a backslash.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2665 - A directory name may end in an ':' or '/'.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2666 - Environment variables are expanded |:set_env|.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2667 - Careful with '\' characters, type one before a space, type two to
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2668 get one in the option (see |option-backslash|), for example: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2669 :set dir=c:\\tmp,\ dir\\,with\\,commas,\\\ dir\ with\ spaces
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2670 < - For backwards compatibility with Vim version 3.0 a '>' at the start
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2671 of the option is removed.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2672 Using "." first in the list is recommended. This means that editing
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2673 the same file twice will result in a warning. Using "/tmp" on Unix is
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2674 discouraged: When the system crashes you lose the swap file.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2675 "/var/tmp" is often not cleared when rebooting, thus is a better
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2676 choice than "/tmp". But it can contain a lot of files, your swap
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2677 files get lost in the crowd. That is why a "tmp" directory in your
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2678 home directory is tried first.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2679 The use of |:set+=| and |:set-=| is preferred when adding or removing
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2680 directories from the list. This avoids problems when a future version
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2681 uses another default.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2682 This option cannot be set from a |modeline| or in the |sandbox|, for
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2683 security reasons.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2684
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2685 *'display'* *'dy'*
9737
35ce559b8553 commit https://github.com/vim/vim/commit/bc8801c9317eb721a2ee91322669f2dd5d136380
Christian Brabandt <cb@256bit.org>
parents: 9669
diff changeset
2686 '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
2687 |defaults.vim|)
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2688 global
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2689 Change the way text is displayed. This is comma separated list of
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2690 flags:
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2691 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
2692 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
2693 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
2694 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
2695 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
2696 column of the last screen line. Overrules "lastline".
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2697 uhex Show unprintable characters hexadecimal as <xx>
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2698 instead of using ^C and ~C.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2699
10211
b7da8d4c594c commit https://github.com/vim/vim/commit/d07969093a9b3051511c478d71c36de6fc33c0d6
Christian Brabandt <cb@256bit.org>
parents: 10198
diff changeset
2700 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
2701 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
2702
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2703 *'eadirection'* *'ead'*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2704 'eadirection' 'ead' string (default "both")
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2705 global
2570
71b56b4e7785 Make the references to features in the help more consistent. (Sylvain Hitier)
Bram Moolenaar <bram@vim.org>
parents: 2561
diff changeset
2706 {not available when compiled without the |+vertsplit|
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2707 feature}
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2708 Tells when the 'equalalways' option applies:
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2709 ver vertically, width of windows is not affected
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2710 hor horizontally, height of windows is not affected
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2711 both width and height of windows is affected
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2712
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2713 *'ed'* *'edcompatible'* *'noed'* *'noedcompatible'*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2714 'edcompatible' 'ed' boolean (default off)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2715 global
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2716 Makes the 'g' and 'c' flags of the ":substitute" command to be
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2717 toggled each time the flag is given. See |complex-change|. See
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2718 also 'gdefault' option.
11442
d183d629509e Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 11400
diff changeset
2719 Switching this option on may break plugins!
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2720
8876
47f17f66da3d commit https://github.com/vim/vim/commit/03413f44167c4b5cd0012def9bb331e2518c83cf
Christian Brabandt <cb@256bit.org>
parents: 8835
diff changeset
2721 *'emoji'* *'emo'* *'noemoji'* *'noemo'*
8629
54ac275e3fc4 commit https://github.com/vim/vim/commit/3848e00e0177abdb31bc600234967863ec487233
Christian Brabandt <cb@256bit.org>
parents: 8560
diff changeset
2722 'emoji' 'emo' boolean (default: on)
54ac275e3fc4 commit https://github.com/vim/vim/commit/3848e00e0177abdb31bc600234967863ec487233
Christian Brabandt <cb@256bit.org>
parents: 8560
diff changeset
2723 global
54ac275e3fc4 commit https://github.com/vim/vim/commit/3848e00e0177abdb31bc600234967863ec487233
Christian Brabandt <cb@256bit.org>
parents: 8560
diff changeset
2724 When on all Unicode emoji characters are considered to be full width.
54ac275e3fc4 commit https://github.com/vim/vim/commit/3848e00e0177abdb31bc600234967863ec487233
Christian Brabandt <cb@256bit.org>
parents: 8560
diff changeset
2725
54ac275e3fc4 commit https://github.com/vim/vim/commit/3848e00e0177abdb31bc600234967863ec487233
Christian Brabandt <cb@256bit.org>
parents: 8560
diff changeset
2726
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2727 *'encoding'* *'enc'* *E543*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2728 'encoding' 'enc' string (default: "latin1" or value from $LANG)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2729 global
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2730 Sets the character encoding used inside Vim. It applies to text in
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2731 the buffers, registers, Strings in expressions, text stored in the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2732 viminfo file, etc. It sets the kind of characters which Vim can work
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2733 with. See |encoding-names| for the possible values.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2734
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2735 NOTE: Changing this option will not change the encoding of the
39
410fa1a31baf updated for version 7.0023
vimboss
parents: 36
diff changeset
2736 existing text in Vim. It may cause non-ASCII text to become invalid.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2737 It should normally be kept at its default value, or set when Vim
1152
e1787f5b90da updated for version 7.1a
vimboss
parents: 1111
diff changeset
2738 starts up. See |multibyte|. To reload the menus see |:menutrans|.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2739
2317
2b2cd34569eb Disallow setting 'enc' in a modeline. (Patrick Texier)
Bram Moolenaar <bram@vim.org>
parents: 2314
diff changeset
2740 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
2741 corrupt the text.
2b2cd34569eb Disallow setting 'enc' in a modeline. (Patrick Texier)
Bram Moolenaar <bram@vim.org>
parents: 2314
diff changeset
2742
10895
c391bfbdb452 Updated runtime files.
Christian Brabandt <cb@256bit.org>
parents: 10734
diff changeset
2743 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
2744 to "utf-8". Although care has been taken to allow different values of
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2745 'encoding', "utf-8" is the natural choice for the environment and
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2746 avoids unnecessary conversion overhead. "utf-8" has not been made
10
4e2284e71352 updated for version 7.0002
vimboss
parents: 8
diff changeset
2747 the default to prevent different behavior of the GUI and terminal
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2748 versions, and to avoid changing the encoding of newly created files
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2749 without your knowledge (in case 'fileencodings' is empty).
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2750
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2751 The character encoding of files can be different from 'encoding'.
10
4e2284e71352 updated for version 7.0002
vimboss
parents: 8
diff changeset
2752 This is specified with 'fileencoding'. The conversion is done with
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2753 iconv() or as specified with 'charconvert'.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2754
2033
de5a43c5eedc Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents: 1904
diff changeset
2755 If you need to know whether 'encoding' is a multi-byte encoding, you
de5a43c5eedc Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents: 1904
diff changeset
2756 can use: >
de5a43c5eedc Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents: 1904
diff changeset
2757 if has("multi_byte_encoding")
de5a43c5eedc Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents: 1904
diff changeset
2758 <
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2759 Normally 'encoding' will be equal to your current locale. This will
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2760 be the default if Vim recognizes your environment settings. If
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2761 'encoding' is not set to the current locale, 'termencoding' must be
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2762 set to convert typed and displayed text. See |encoding-table|.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2763
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2764 When you set this option, it fires the |EncodingChanged| autocommand
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2765 event so that you can set up fonts if necessary.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2766
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2767 When the option is set, the value is converted to lowercase. Thus
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2768 you can set it with uppercase values too. Underscores are translated
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2769 to '-' signs.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2770 When the encoding is recognized, it is changed to the standard name.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2771 For example "Latin-1" becomes "latin1", "ISO_88592" becomes
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2772 "iso-8859-2" and "utf8" becomes "utf-8".
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2773
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2774 Note: "latin1" is also used when the encoding could not be detected.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2775 This only works when editing files in the same encoding! When the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2776 actual character set is not latin1, make sure 'fileencoding' and
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2777 'fileencodings' are empty. When conversion is needed, switch to using
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2778 utf-8.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2779
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2780 When "unicode", "ucs-2" or "ucs-4" is used, Vim internally uses utf-8.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2781 You don't notice this while editing, but it does matter for the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2782 |viminfo-file|. And Vim expects the terminal to use utf-8 too. Thus
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2783 setting 'encoding' to one of these values instead of utf-8 only has
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2784 effect for encoding used for files when 'fileencoding' is empty.
448
dd9db57ee7ce updated for version 7.0118
vimboss
parents: 446
diff changeset
2785
dd9db57ee7ce updated for version 7.0118
vimboss
parents: 446
diff changeset
2786 When 'encoding' is set to a Unicode encoding, and 'fileencodings' was
dd9db57ee7ce updated for version 7.0118
vimboss
parents: 446
diff changeset
2787 not set yet, the default for 'fileencodings' is changed.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2788
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2789 *'endofline'* *'eol'* *'noendofline'* *'noeol'*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2790 'endofline' 'eol' boolean (default on)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2791 local to buffer
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2792 When writing a file and this option is off and the 'binary' option
6933
62ba356c2d4e patch 7.4.785
Bram Moolenaar <bram@vim.org>
parents: 6918
diff changeset
2793 is on, or 'fixeol' option is off, no <EOL> will be written for the
62ba356c2d4e patch 7.4.785
Bram Moolenaar <bram@vim.org>
parents: 6918
diff changeset
2794 last line in the file. This option is automatically set or reset when
62ba356c2d4e patch 7.4.785
Bram Moolenaar <bram@vim.org>
parents: 6918
diff changeset
2795 starting to edit a new file, depending on whether file has an <EOL>
62ba356c2d4e patch 7.4.785
Bram Moolenaar <bram@vim.org>
parents: 6918
diff changeset
2796 for the last line in the file. Normally you don't have to set or
62ba356c2d4e patch 7.4.785
Bram Moolenaar <bram@vim.org>
parents: 6918
diff changeset
2797 reset this option.
62ba356c2d4e patch 7.4.785
Bram Moolenaar <bram@vim.org>
parents: 6918
diff changeset
2798 When 'binary' is off and 'fixeol' is on the value is not used when
62ba356c2d4e patch 7.4.785
Bram Moolenaar <bram@vim.org>
parents: 6918
diff changeset
2799 writing the file. When 'binary' is on or 'fixeol' is off it is used
62ba356c2d4e patch 7.4.785
Bram Moolenaar <bram@vim.org>
parents: 6918
diff changeset
2800 to remember the presence of a <EOL> for the last line in the file, so
62ba356c2d4e patch 7.4.785
Bram Moolenaar <bram@vim.org>
parents: 6918
diff changeset
2801 that when you write the file the situation from the original file can
62ba356c2d4e patch 7.4.785
Bram Moolenaar <bram@vim.org>
parents: 6918
diff changeset
2802 be kept. But you can change it if you want to.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2803
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2804 *'equalalways'* *'ea'* *'noequalalways'* *'noea'*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2805 'equalalways' 'ea' boolean (default on)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2806 global
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2807 When on, all the windows are automatically made the same size after
33
f6033dcbaf31 updated for version 7.0020
vimboss
parents: 29
diff changeset
2808 splitting or closing a window. This also happens the moment the
f6033dcbaf31 updated for version 7.0020
vimboss
parents: 29
diff changeset
2809 option is switched on. When off, splitting a window will reduce the
f6033dcbaf31 updated for version 7.0020
vimboss
parents: 29
diff changeset
2810 size of the current window and leave the other windows the same. When
f6033dcbaf31 updated for version 7.0020
vimboss
parents: 29
diff changeset
2811 closing a window the extra lines are given to the window next to it
f6033dcbaf31 updated for version 7.0020
vimboss
parents: 29
diff changeset
2812 (depending on 'splitbelow' and 'splitright').
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2813 When mixing vertically and horizontally split windows, a minimal size
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2814 is computed and some windows may be larger if there is room. The
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2815 'eadirection' option tells in which direction the size is affected.
1354
10a1b67c0885 updated for version 7.1-068
vimboss
parents: 1263
diff changeset
2816 Changing the height and width of a window can be avoided by setting
10a1b67c0885 updated for version 7.1-068
vimboss
parents: 1263
diff changeset
2817 'winfixheight' and 'winfixwidth', respectively.
2033
de5a43c5eedc Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents: 1904
diff changeset
2818 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
2819 currently not equalized (it's complicated, but may be implemented in
de5a43c5eedc Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents: 1904
diff changeset
2820 the future).
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2821
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2822 *'equalprg'* *'ep'*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2823 'equalprg' 'ep' string (default "")
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2824 global or local to buffer |global-local|
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2825 External program to use for "=" command. When this option is empty
1621
82b5078be2dd updated for version 7.2a
vimboss
parents: 1564
diff changeset
2826 the internal formatting functions are used; either 'lisp', 'cindent'
2033
de5a43c5eedc Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents: 1904
diff changeset
2827 or 'indentexpr'. When Vim was compiled without internal formatting,
de5a43c5eedc Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents: 1904
diff changeset
2828 the "indent" program is used.
10
4e2284e71352 updated for version 7.0002
vimboss
parents: 8
diff changeset
2829 Environment variables are expanded |:set_env|. See |option-backslash|
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2830 about including spaces and backslashes.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2831 This option cannot be set from a |modeline| or in the |sandbox|, for
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2832 security reasons.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2833
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2834 *'errorbells'* *'eb'* *'noerrorbells'* *'noeb'*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2835 'errorbells' 'eb' boolean (default off)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2836 global
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2837 Ring the bell (beep or screen flash) for error messages. This only
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2838 makes a difference for error messages, the bell will be used always
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2839 for a lot of errors without a message (e.g., hitting <Esc> in Normal
10
4e2284e71352 updated for version 7.0002
vimboss
parents: 8
diff changeset
2840 mode). See 'visualbell' on how to make the bell behave like a beep,
6949
1e621b31948b patch 7.4.793
Bram Moolenaar <bram@vim.org>
parents: 6933
diff changeset
2841 screen flash or do nothing. See 'belloff' to finetune when to ring the
1e621b31948b patch 7.4.793
Bram Moolenaar <bram@vim.org>
parents: 6933
diff changeset
2842 bell.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2843
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2844 *'errorfile'* *'ef'*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2845 'errorfile' 'ef' string (Amiga default: "AztecC.Err",
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2846 others: "errors.err")
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2847 global
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2848 {not available when compiled without the |+quickfix|
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2849 feature}
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2850 Name of the errorfile for the QuickFix mode (see |:cf|).
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2851 When the "-q" command-line argument is used, 'errorfile' is set to the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2852 following argument. See |-q|.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2853 NOT used for the ":make" command. See 'makeef' for that.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2854 Environment variables are expanded |:set_env|.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2855 See |option-backslash| about including spaces and backslashes.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2856 This option cannot be set from a |modeline| or in the |sandbox|, for
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2857 security reasons.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2858
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2859 *'errorformat'* *'efm'*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2860 'errorformat' 'efm' string (default is very long)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2861 global or local to buffer |global-local|
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2862 {not available when compiled without the |+quickfix|
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2863 feature}
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2864 Scanf-like description of the format for the lines in the error file
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2865 (see |errorformat|).
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2866
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2867 *'esckeys'* *'ek'* *'noesckeys'* *'noek'*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2868 'esckeys' 'ek' boolean (Vim default: on, Vi default: off)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2869 global
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2870 Function keys that start with an <Esc> are recognized in Insert
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2871 mode. When this option is off, the cursor and function keys cannot be
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2872 used in Insert mode if they start with an <Esc>. The advantage of
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2873 this is that the single <Esc> is recognized immediately, instead of
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2874 after one second. Instead of resetting this option, you might want to
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2875 try changing the values for 'timeoutlen' and 'ttimeoutlen'. Note that
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2876 when 'esckeys' is off, you can still map anything, but the cursor keys
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2877 won't work by default.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2878 NOTE: This option is set to the Vi default value when 'compatible' is
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2879 set and to the Vim default value when 'compatible' is reset.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2880
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2881 *'eventignore'* *'ei'*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2882 'eventignore' 'ei' string (default "")
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2883 global
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2884 A list of autocommand event names, which are to be ignored.
844
d3bbb5dd3913 updated for version 7.0f02
vimboss
parents: 843
diff changeset
2885 When set to "all" or when "all" is one of the items, all autocommand
d3bbb5dd3913 updated for version 7.0f02
vimboss
parents: 843
diff changeset
2886 events are ignored, autocommands will not be executed.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2887 Otherwise this is a comma separated list of event names. Example: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2888 :set ei=WinEnter,WinLeave
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2889 <
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2890 *'expandtab'* *'et'* *'noexpandtab'* *'noet'*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2891 'expandtab' 'et' boolean (default off)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2892 local to buffer
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2893 In Insert mode: Use the appropriate number of spaces to insert a
10
4e2284e71352 updated for version 7.0002
vimboss
parents: 8
diff changeset
2894 <Tab>. Spaces are used in indents with the '>' and '<' commands and
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2895 when 'autoindent' is on. To insert a real tab when 'expandtab' is
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2896 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
2897 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
2898 the 'paste' option is reset.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2899 NOTE: This option is reset when 'compatible' is set.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2900
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2901 *'exrc'* *'ex'* *'noexrc'* *'noex'*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2902 'exrc' 'ex' boolean (default off)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2903 global
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2904 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
2905 directory.
018fead968c1 commit https://github.com/vim/vim/commit/36f44c21da2e912c008683a0c4447fca2a071e9a
Christian Brabandt <cb@256bit.org>
parents: 9975
diff changeset
2906
018fead968c1 commit https://github.com/vim/vim/commit/36f44c21da2e912c008683a0c4447fca2a071e9a
Christian Brabandt <cb@256bit.org>
parents: 9975
diff changeset
2907 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
2908 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
2909 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
2910 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
2911 matching directory.
018fead968c1 commit https://github.com/vim/vim/commit/36f44c21da2e912c008683a0c4447fca2a071e9a
Christian Brabandt <cb@256bit.org>
parents: 9975
diff changeset
2912
018fead968c1 commit https://github.com/vim/vim/commit/36f44c21da2e912c008683a0c4447fca2a071e9a
Christian Brabandt <cb@256bit.org>
parents: 9975
diff changeset
2913 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
2914 'secure' option (see |initialization|).
018fead968c1 commit https://github.com/vim/vim/commit/36f44c21da2e912c008683a0c4447fca2a071e9a
Christian Brabandt <cb@256bit.org>
parents: 9975
diff changeset
2915 Also see |.vimrc| and |gui-init|.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2916 This option cannot be set from a |modeline| or in the |sandbox|, for
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2917 security reasons.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2918
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2919 *'fileencoding'* *'fenc'* *E213*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2920 'fileencoding' 'fenc' string (default: "")
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2921 local to buffer
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2922 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
2923
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2924 When 'fileencoding' is different from 'encoding', conversion will be
2033
de5a43c5eedc Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents: 1904
diff changeset
2925 done when writing the file. For reading see below.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2926 When 'fileencoding' is empty, the same value as 'encoding' will be
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2927 used (no conversion when reading or writing a file).
11062
1218c5353e2b Runtime file updates.
Christian Brabandt <cb@256bit.org>
parents: 10895
diff changeset
2928 No error will be given when the value is set, only when it is used,
1218c5353e2b Runtime file updates.
Christian Brabandt <cb@256bit.org>
parents: 10895
diff changeset
2929 only when writing a file.
2033
de5a43c5eedc Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents: 1904
diff changeset
2930 Conversion will also be done when 'encoding' and 'fileencoding' are
de5a43c5eedc Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents: 1904
diff changeset
2931 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
2932 because internally Unicode is always stored as utf-8.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2933 WARNING: Conversion can cause loss of information! When
2033
de5a43c5eedc Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents: 1904
diff changeset
2934 'encoding' is "utf-8" or another Unicode encoding, conversion
de5a43c5eedc Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents: 1904
diff changeset
2935 is most likely done in a way that the reverse conversion
de5a43c5eedc Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents: 1904
diff changeset
2936 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
2937 characters may be lost!
2317
2b2cd34569eb Disallow setting 'enc' in a modeline. (Patrick Texier)
Bram Moolenaar <bram@vim.org>
parents: 2314
diff changeset
2938
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2939 See 'encoding' for the possible values. Additionally, values may be
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2940 specified that can be handled by the converter, see
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2941 |mbyte-conversion|.
2317
2b2cd34569eb Disallow setting 'enc' in a modeline. (Patrick Texier)
Bram Moolenaar <bram@vim.org>
parents: 2314
diff changeset
2942
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2943 When reading a file 'fileencoding' will be set from 'fileencodings'.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2944 To read a file in a certain encoding it won't work by setting
1152
e1787f5b90da updated for version 7.1a
vimboss
parents: 1111
diff changeset
2945 'fileencoding', use the |++enc| argument. One exception: when
e1787f5b90da updated for version 7.1a
vimboss
parents: 1111
diff changeset
2946 'fileencodings' is empty the value of 'fileencoding' is used.
692
a28f83d37113 updated for version 7.0208
vimboss
parents: 688
diff changeset
2947 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
2948
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2949 Prepending "8bit-" and "2byte-" has no meaning here, they are ignored.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2950 When the option is set, the value is converted to lowercase. Thus
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2951 you can set it with uppercase values too. '_' characters are
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2952 replaced with '-'. If a name is recognized from the list for
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2953 'encoding', it is replaced by the standard name. For example
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2954 "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
2955
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2956 When this option is set, after starting to edit a file, the 'modified'
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2957 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
2958
2b2cd34569eb Disallow setting 'enc' in a modeline. (Patrick Texier)
Bram Moolenaar <bram@vim.org>
parents: 2314
diff changeset
2959 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
2960 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
2961 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
2962 '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
2963
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2964 This option can not be changed when 'modifiable' is off.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2965
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2966 *'fe'*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2967 NOTE: Before version 6.0 this option specified the encoding for the
10
4e2284e71352 updated for version 7.0002
vimboss
parents: 8
diff changeset
2968 whole of Vim, this was a mistake. Now use 'encoding' instead. The
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2969 old short name was 'fe', which is no longer used.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2970
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2971 *'fileencodings'* *'fencs'*
39
410fa1a31baf updated for version 7.0023
vimboss
parents: 36
diff changeset
2972 'fileencodings' 'fencs' string (default: "ucs-bom",
410fa1a31baf updated for version 7.0023
vimboss
parents: 36
diff changeset
2973 "ucs-bom,utf-8,default,latin1" when
410fa1a31baf updated for version 7.0023
vimboss
parents: 36
diff changeset
2974 'encoding' is set to a Unicode value)
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2975 global
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2976 This is a list of character encodings considered when starting to edit
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2977 an existing file. When a file is read, Vim tries to use the first
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2978 mentioned character encoding. If an error is detected, the next one
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2979 in the list is tried. When an encoding is found that works,
10
4e2284e71352 updated for version 7.0002
vimboss
parents: 8
diff changeset
2980 'fileencoding' is set to it. If all fail, 'fileencoding' is set to
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2981 an empty string, which means the value of 'encoding' is used.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2982 WARNING: Conversion can cause loss of information! When
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2983 'encoding' is "utf-8" (or one of the other Unicode variants)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2984 conversion is most likely done in a way that the reverse
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2985 conversion results in the same text. When 'encoding' is not
596
e612bbdb670f updated for version 7.0169
vimboss
parents: 593
diff changeset
2986 "utf-8" some non-ASCII characters may be lost! You can use
e612bbdb670f updated for version 7.0169
vimboss
parents: 593
diff changeset
2987 the |++bad| argument to specify what is done with characters
e612bbdb670f updated for version 7.0169
vimboss
parents: 593
diff changeset
2988 that can't be converted.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2989 For an empty file or a file with only ASCII characters most encodings
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2990 will work and the first entry of 'fileencodings' will be used (except
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2991 "ucs-bom", which requires the BOM to be present). If you prefer
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2992 another encoding use an BufReadPost autocommand event to test if your
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2993 preferred encoding is to be used. Example: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2994 au BufReadPost * if search('\S', 'w') == 0 |
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2995 \ set fenc=iso-2022-jp | endif
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2996 < This sets 'fileencoding' to "iso-2022-jp" if the file does not contain
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2997 non-blank characters.
596
e612bbdb670f updated for version 7.0169
vimboss
parents: 593
diff changeset
2998 When the |++enc| argument is used then the value of 'fileencodings' is
e612bbdb670f updated for version 7.0169
vimboss
parents: 593
diff changeset
2999 not used.
692
a28f83d37113 updated for version 7.0208
vimboss
parents: 688
diff changeset
3000 Note that 'fileencodings' is not used for a new file, the global value
a28f83d37113 updated for version 7.0208
vimboss
parents: 688
diff changeset
3001 of 'fileencoding' is used instead. You can set it with: >
a28f83d37113 updated for version 7.0208
vimboss
parents: 688
diff changeset
3002 :setglobal fenc=iso-8859-2
a28f83d37113 updated for version 7.0208
vimboss
parents: 688
diff changeset
3003 < This means that a non-existing file may get a different encoding than
a28f83d37113 updated for version 7.0208
vimboss
parents: 688
diff changeset
3004 an empty file.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3005 The special value "ucs-bom" can be used to check for a Unicode BOM
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3006 (Byte Order Mark) at the start of the file. It must not be preceded
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3007 by "utf-8" or another Unicode encoding for this to work properly.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3008 An entry for an 8-bit encoding (e.g., "latin1") should be the last,
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3009 because Vim cannot detect an error, thus the encoding is always
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3010 accepted.
39
410fa1a31baf updated for version 7.0023
vimboss
parents: 36
diff changeset
3011 The special value "default" can be used for the encoding from the
410fa1a31baf updated for version 7.0023
vimboss
parents: 36
diff changeset
3012 environment. This is the default value for 'encoding'. It is useful
410fa1a31baf updated for version 7.0023
vimboss
parents: 36
diff changeset
3013 when 'encoding' is set to "utf-8" and your environment uses a
410fa1a31baf updated for version 7.0023
vimboss
parents: 36
diff changeset
3014 non-latin1 encoding, such as Russian.
777
f664cc974a7a updated for version 7.0227
vimboss
parents: 772
diff changeset
3015 When 'encoding' is "utf-8" and a file contains an illegal byte
f664cc974a7a updated for version 7.0227
vimboss
parents: 772
diff changeset
3016 sequence it won't be recognized as UTF-8. You can use the |8g8|
f664cc974a7a updated for version 7.0227
vimboss
parents: 772
diff changeset
3017 command to find the illegal byte sequence.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3018 WRONG VALUES: WHAT'S WRONG:
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3019 latin1,utf-8 "latin1" will always be used
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3020 utf-8,ucs-bom,latin1 BOM won't be recognized in an utf-8
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3021 file
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3022 cp1250,latin1 "cp1250" will always be used
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3023 If 'fileencodings' is empty, 'fileencoding' is not modified.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3024 See 'fileencoding' for the possible values.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3025 Setting this option does not have an effect until the next time a file
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3026 is read.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3027
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3028 *'fileformat'* *'ff'*
15840
734b1928a5aa patch 8.1.0927: USE_CR is never defined
Bram Moolenaar <Bram@vim.org>
parents: 15804
diff changeset
3029 '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
3030 Unix, macOS default: "unix")
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3031 local to buffer
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3032 This gives the <EOL> of the current buffer, which is used for
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3033 reading/writing the buffer from/to a file:
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3034 dos <CR> <NL>
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3035 unix <NL>
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3036 mac <CR>
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3037 When "dos" is used, CTRL-Z at the end of a file is ignored.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3038 See |file-formats| and |file-read|.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3039 For the character encoding of the file see 'fileencoding'.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3040 When 'binary' is set, the value of 'fileformat' is ignored, file I/O
4264
2d1383658bb4 Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 4242
diff changeset
3041 works like it was set to "unix".
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3042 This option is set automatically when starting to edit a file and
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3043 'fileformats' is not empty and 'binary' is off.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3044 When this option is set, after starting to edit a file, the 'modified'
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3045 option is set, because the file would be different when written.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3046 This option can not be changed when 'modifiable' is off.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3047 For backwards compatibility: When this option is set to "dos",
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3048 'textmode' is set, otherwise 'textmode' is reset.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3049
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3050 *'fileformats'* *'ffs'*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3051 'fileformats' 'ffs' string (default:
15840
734b1928a5aa patch 8.1.0927: USE_CR is never defined
Bram Moolenaar <Bram@vim.org>
parents: 15804
diff changeset
3052 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
3053 Vim Unix, macOS: "unix,dos",
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3054 Vi Cygwin: "unix,dos",
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3055 Vi others: "")
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3056 global
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3057 This gives the end-of-line (<EOL>) formats that will be tried when
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3058 starting to edit a new buffer and when reading a file into an existing
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3059 buffer:
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3060 - When empty, the format defined with 'fileformat' will be used
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3061 always. It is not set automatically.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3062 - When set to one name, that format will be used whenever a new buffer
10
4e2284e71352 updated for version 7.0002
vimboss
parents: 8
diff changeset
3063 is opened. 'fileformat' is set accordingly for that buffer. The
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3064 'fileformats' name will be used when a file is read into an existing
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3065 buffer, no matter what 'fileformat' for that buffer is set to.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3066 - When more than one name is present, separated by commas, automatic
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3067 <EOL> detection will be done when reading a file. When starting to
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3068 edit a file, a check is done for the <EOL>:
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3069 1. If all lines end in <CR><NL>, and 'fileformats' includes "dos",
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3070 'fileformat' is set to "dos".
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3071 2. If a <NL> is found and 'fileformats' includes "unix", 'fileformat'
10
4e2284e71352 updated for version 7.0002
vimboss
parents: 8
diff changeset
3072 is set to "unix". Note that when a <NL> is found without a
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3073 preceding <CR>, "unix" is preferred over "dos".
6647
3af822eb4da5 Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 6583
diff changeset
3074 3. If 'fileformat' has not yet been set, and if a <CR> is found, and
3af822eb4da5 Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 6583
diff changeset
3075 if 'fileformats' includes "mac", 'fileformat' is set to "mac".
2587
d0049ff5969e Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 2577
diff changeset
3076 This means that "mac" is only chosen when:
d0049ff5969e Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 2577
diff changeset
3077 "unix" is not present or no <NL> is found in the file, and
d0049ff5969e Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 2577
diff changeset
3078 "dos" is not present or no <CR><NL> is found in the file.
d0049ff5969e Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 2577
diff changeset
3079 Except: if "unix" was chosen, but there is a <CR> before
d0049ff5969e Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 2577
diff changeset
3080 the first <NL>, and there appear to be more <CR>s than <NL>s in
2642
840c3cadb842 Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 2625
diff changeset
3081 the first few lines, "mac" is used.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3082 4. If 'fileformat' is still not set, the first name from
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3083 'fileformats' is used.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3084 When reading a file into an existing buffer, the same is done, but
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3085 this happens like 'fileformat' has been set appropriately for that
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3086 file only, the option is not changed.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3087 When 'binary' is set, the value of 'fileformats' is not used.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3088
8748
b1a19a2f73f0 commit https://github.com/vim/vim/commit/4f3f668c8486444e53163c29d2fc79bf47eb3c82
Christian Brabandt <cb@256bit.org>
parents: 8629
diff changeset
3089 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
3090 can overrule this by setting 'fileformat' in your .vimrc.
2662
916c90b37ea9 Update runtime files.
Bram Moolenaar <bram@vim.org>
parents: 2654
diff changeset
3091
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3092 For systems with a Dos-like <EOL> (<CR><NL>), when reading files that
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3093 are ":source"ed and for vimrc files, automatic <EOL> detection may be
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3094 done:
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3095 - When 'fileformats' is empty, there is no automatic detection. Dos
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3096 format will be used.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3097 - When 'fileformats' is set to one or more names, automatic detection
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3098 is done. This is based on the first <NL> in the file: If there is a
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3099 <CR> in front of it, Dos format is used, otherwise Unix format is
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3100 used.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3101 Also see |file-formats|.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3102 For backwards compatibility: When this option is set to an empty
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3103 string or one format (no comma is included), 'textauto' is reset,
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3104 otherwise 'textauto' is set.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3105 NOTE: This option is set to the Vi default value when 'compatible' is
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3106 set and to the Vim default value when 'compatible' is reset.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3107
4264
2d1383658bb4 Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 4242
diff changeset
3108 *'fileignorecase'* *'fic'* *'nofileignorecase'* *'nofic'*
2d1383658bb4 Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 4242
diff changeset
3109 'fileignorecase' 'fic' boolean (default on for systems where case in file
2d1383658bb4 Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 4242
diff changeset
3110 names is normally ignored)
4242
edd0bc1f26bd updated for version 7.3.872
Bram Moolenaar <bram@vim.org>
parents: 4229
diff changeset
3111 global
edd0bc1f26bd updated for version 7.3.872
Bram Moolenaar <bram@vim.org>
parents: 4229
diff changeset
3112 When set case is ignored when using file names and directories.
edd0bc1f26bd updated for version 7.3.872
Bram Moolenaar <bram@vim.org>
parents: 4229
diff changeset
3113 See 'wildignorecase' for only ignoring case when doing completion.
edd0bc1f26bd updated for version 7.3.872
Bram Moolenaar <bram@vim.org>
parents: 4229
diff changeset
3114
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3115 *'filetype'* *'ft'*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3116 'filetype' 'ft' string (default: "")
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3117 local to buffer
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3118 When this option is set, the FileType autocommand event is triggered.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3119 All autocommands that match with the value of this option will be
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3120 executed. Thus the value of 'filetype' is used in place of the file
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3121 name.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3122 Otherwise this option does not always reflect the current file type.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3123 This option is normally set when the file type is detected. To enable
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3124 this use the ":filetype on" command. |:filetype|
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3125 Setting this option to a different value is most useful in a modeline,
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3126 for a file for which the file type is not automatically recognized.
782
d20041a02ee5 updated for version 7.0228
vimboss
parents: 777
diff changeset
3127 Example, for in an IDL file:
d20041a02ee5 updated for version 7.0228
vimboss
parents: 777
diff changeset
3128 /* vim: set filetype=idl : */ ~
d20041a02ee5 updated for version 7.0228
vimboss
parents: 777
diff changeset
3129 |FileType| |filetypes|
d20041a02ee5 updated for version 7.0228
vimboss
parents: 777
diff changeset
3130 When a dot appears in the value then this separates two filetype
d20041a02ee5 updated for version 7.0228
vimboss
parents: 777
diff changeset
3131 names. Example:
d20041a02ee5 updated for version 7.0228
vimboss
parents: 777
diff changeset
3132 /* vim: set filetype=c.doxygen : */ ~
d20041a02ee5 updated for version 7.0228
vimboss
parents: 777
diff changeset
3133 This will use the "c" filetype first, then the "doxygen" filetype.
d20041a02ee5 updated for version 7.0228
vimboss
parents: 777
diff changeset
3134 This works both for filetype plugins and for syntax files. More than
d20041a02ee5 updated for version 7.0228
vimboss
parents: 777
diff changeset
3135 one dot may appear.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3136 This option is not copied to another buffer, independent of the 's' or
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3137 'S' flag in 'cpoptions'.
36
125e80798a85 updated for version 7.0021
vimboss
parents: 33
diff changeset
3138 Only normal file name characters can be used, "/\*?[|<>" are illegal.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3139
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3140 *'fillchars'* *'fcs'*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3141 'fillchars' 'fcs' string (default "vert:|,fold:-")
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3142 global
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3143 {not available when compiled without the |+windows|
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3144 and |+folding| features}
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3145 Characters to fill the statuslines and vertical separators.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3146 It is a comma separated list of items:
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3147
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3148 item default Used for ~
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3149 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
3150 stlnc:c ' ' or '=' statusline of the non-current windows
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3151 vert:c '|' vertical separators |:vsplit|
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3152 fold:c '-' filling 'foldtext'
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3153 diff:c '-' deleted lines of the 'diff' option
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3154
10
4e2284e71352 updated for version 7.0002
vimboss
parents: 8
diff changeset
3155 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
3156 "stlnc" the space will be used when there is highlighting, '^' or '='
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3157 otherwise.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3158
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3159 Example: >
8061
abd64cf67bcf commit https://github.com/vim/vim/commit/38a55639d603823efcf2d2fdf542dbffdeb60b75
Christian Brabandt <cb@256bit.org>
parents: 7876
diff changeset
3160 :set fillchars=stl:^,stlnc:=,vert:\|,fold:-,diff:-
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3161 < This is similar to the default, except that these characters will also
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3162 be used when there is highlighting.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3163
819
23f82b5d2814 updated for version 7.0c10
vimboss
parents: 818
diff changeset
3164 for "stl" and "stlnc" only single-byte values are supported.
23f82b5d2814 updated for version 7.0c10
vimboss
parents: 818
diff changeset
3165
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3166 The highlighting used for these items:
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3167 item highlight group ~
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3168 stl:c StatusLine |hl-StatusLine|
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3169 stlnc:c StatusLineNC |hl-StatusLineNC|
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3170 vert:c VertSplit |hl-VertSplit|
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3171 fold:c Folded |hl-Folded|
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3172 diff:c DiffDelete |hl-DiffDelete|
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3173
6933
62ba356c2d4e patch 7.4.785
Bram Moolenaar <bram@vim.org>
parents: 6918
diff changeset
3174 *'fixendofline'* *'fixeol'* *'nofixendofline'* *'nofixeol'*
62ba356c2d4e patch 7.4.785
Bram Moolenaar <bram@vim.org>
parents: 6918
diff changeset
3175 'fixendofline' 'fixeol' boolean (default on)
62ba356c2d4e patch 7.4.785
Bram Moolenaar <bram@vim.org>
parents: 6918
diff changeset
3176 local to buffer
62ba356c2d4e patch 7.4.785
Bram Moolenaar <bram@vim.org>
parents: 6918
diff changeset
3177 When writing a file and this option is on, <EOL> at the end of file
62ba356c2d4e patch 7.4.785
Bram Moolenaar <bram@vim.org>
parents: 6918
diff changeset
3178 will be restored if missing. Turn this option off if you want to
62ba356c2d4e patch 7.4.785
Bram Moolenaar <bram@vim.org>
parents: 6918
diff changeset
3179 preserve the situation from the original file.
62ba356c2d4e patch 7.4.785
Bram Moolenaar <bram@vim.org>
parents: 6918
diff changeset
3180 When the 'binary' option is set the value of this option doesn't
62ba356c2d4e patch 7.4.785
Bram Moolenaar <bram@vim.org>
parents: 6918
diff changeset
3181 matter.
62ba356c2d4e patch 7.4.785
Bram Moolenaar <bram@vim.org>
parents: 6918
diff changeset
3182 See the 'endofline' option.
62ba356c2d4e patch 7.4.785
Bram Moolenaar <bram@vim.org>
parents: 6918
diff changeset
3183
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3184 *'fkmap'* *'fk'* *'nofkmap'* *'nofk'*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3185 'fkmap' 'fk' boolean (default off) *E198*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3186 global
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3187 {only available when compiled with the |+rightleft|
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3188 feature}
15850
a6ca8cf07a98 patch 8.1.0932: Farsi support is outdated and unused
Bram Moolenaar <Bram@vim.org>
parents: 15840
diff changeset
3189 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
3190 |farsi.txt|.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3191
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3192 *'foldclose'* *'fcl'*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3193 'foldclose' 'fcl' string (default "")
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3194 global
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3195 {not available when compiled without the |+folding|
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3196 feature}
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3197 When set to "all", a fold is closed when the cursor isn't in it and
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3198 its level is higher than 'foldlevel'. Useful if you want folds to
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3199 automatically close when moving out of them.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3200
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3201 *'foldcolumn'* *'fdc'*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3202 'foldcolumn' 'fdc' number (default 0)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3203 local to window
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3204 {not available when compiled without the |+folding|
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3205 feature}
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3206 When non-zero, a column with the specified width is shown at the side
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3207 of the window which indicates open and closed folds. The maximum
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3208 value is 12.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3209 See |folding|.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3210
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3211 *'foldenable'* *'fen'* *'nofoldenable'* *'nofen'*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3212 'foldenable' 'fen' boolean (default on)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3213 local to window
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3214 {not available when compiled without the |+folding|
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3215 feature}
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3216 When off, all folds are open. This option can be used to quickly
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3217 switch between showing all text unfolded and viewing the text with
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3218 folds (including manually opened or closed folds). It can be toggled
10
4e2284e71352 updated for version 7.0002
vimboss
parents: 8
diff changeset
3219 with the |zi| command. The 'foldcolumn' will remain blank when
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3220 'foldenable' is off.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3221 This option is set by commands that create a new fold or close a fold.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3222 See |folding|.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3223
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3224 *'foldexpr'* *'fde'*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3225 'foldexpr' 'fde' string (default: "0")
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3226 local to window
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3227 {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
3228 or |+eval| features}
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3229 The expression used for when 'foldmethod' is "expr". It is evaluated
634
1c586ee8dd45 updated for version 7.0183
vimboss
parents: 632
diff changeset
3230 for each line to obtain its fold level. See |fold-expr|.
782
d20041a02ee5 updated for version 7.0228
vimboss
parents: 777
diff changeset
3231
3682
11d40fc82f11 Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 3674
diff changeset
3232 The expression will be evaluated in the |sandbox| if set from a
11d40fc82f11 Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 3674
diff changeset
3233 modeline, see |sandbox-option|.
2033
de5a43c5eedc Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents: 1904
diff changeset
3234 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
3235 on or the 'modelineexpr' option is off.
634
1c586ee8dd45 updated for version 7.0183
vimboss
parents: 632
diff changeset
3236
1c586ee8dd45 updated for version 7.0183
vimboss
parents: 632
diff changeset
3237 It is not allowed to change text or jump to another window while
1c586ee8dd45 updated for version 7.0183
vimboss
parents: 632
diff changeset
3238 evaluating 'foldexpr' |textlock|.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3239
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3240 *'foldignore'* *'fdi'*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3241 'foldignore' 'fdi' string (default: "#")
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3242 local to window
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3243 {not available when compiled without the |+folding|
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3244 feature}
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3245 Used only when 'foldmethod' is "indent". Lines starting with
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3246 characters in 'foldignore' will get their fold level from surrounding
10
4e2284e71352 updated for version 7.0002
vimboss
parents: 8
diff changeset
3247 lines. White space is skipped before checking for this character.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3248 The default "#" works well for C programs. See |fold-indent|.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3249
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3250 *'foldlevel'* *'fdl'*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3251 'foldlevel' 'fdl' number (default: 0)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3252 local to window
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3253 {not available when compiled without the |+folding|
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3254 feature}
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3255 Sets the fold level: Folds with a higher level will be closed.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3256 Setting this option to zero will close all folds. Higher numbers will
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3257 close fewer folds.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3258 This option is set by commands like |zm|, |zM| and |zR|.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3259 See |fold-foldlevel|.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3260
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3261 *'foldlevelstart'* *'fdls'*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3262 'foldlevelstart' 'fdls' number (default: -1)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3263 global
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3264 {not available when compiled without the |+folding|
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3265 feature}
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3266 Sets 'foldlevel' when starting to edit another buffer in a window.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3267 Useful to always start editing with all folds closed (value zero),
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3268 some folds closed (one) or no folds closed (99).
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3269 This is done before reading any modeline, thus a setting in a modeline
10
4e2284e71352 updated for version 7.0002
vimboss
parents: 8
diff changeset
3270 overrules this option. Starting to edit a file for |diff-mode| also
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3271 ignores this option and closes all folds.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3272 It is also done before BufReadPre autocommands, to allow an autocmd to
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3273 overrule the 'foldlevel' value for specific files.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3274 When the value is negative, it is not used.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3275
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3276 *'foldmarker'* *'fmr'* *E536*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3277 'foldmarker' 'fmr' string (default: "{{{,}}}")
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3278 local to window
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3279 {not available when compiled without the |+folding|
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3280 feature}
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3281 The start and end marker used when 'foldmethod' is "marker". There
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3282 must be one comma, which separates the start and end marker. The
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3283 marker is a literal string (a regular expression would be too slow).
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3284 See |fold-marker|.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3285
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3286 *'foldmethod'* *'fdm'*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3287 'foldmethod' 'fdm' string (default: "manual")
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3288 local to window
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3289 {not available when compiled without the |+folding|
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3290 feature}
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3291 The kind of folding used for the current window. Possible values:
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3292 |fold-manual| manual Folds are created manually.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3293 |fold-indent| indent Lines with equal indent form a fold.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3294 |fold-expr| expr 'foldexpr' gives the fold level of a line.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3295 |fold-marker| marker Markers are used to specify folds.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3296 |fold-syntax| syntax Syntax highlighting items specify folds.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3297 |fold-diff| diff Fold text that is not changed.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3298
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3299 *'foldminlines'* *'fml'*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3300 'foldminlines' 'fml' number (default: 1)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3301 local to window
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3302 {not available when compiled without the |+folding|
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3303 feature}
2709
b01a37ab556b Runtime file updates.
Bram Moolenaar <bram@vim.org>
parents: 2698
diff changeset
3304 Sets the number of screen lines above which a fold can be displayed
b01a37ab556b Runtime file updates.
Bram Moolenaar <bram@vim.org>
parents: 2698
diff changeset
3305 closed. Also for manually closed folds. With the default value of
b01a37ab556b Runtime file updates.
Bram Moolenaar <bram@vim.org>
parents: 2698
diff changeset
3306 one a fold can only be closed if it takes up two or more screen lines.
b01a37ab556b Runtime file updates.
Bram Moolenaar <bram@vim.org>
parents: 2698
diff changeset
3307 Set to zero to be able to close folds of just one screen line.
2826
3c7da93eb7f9 Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 2788
diff changeset
3308 Note that this only has an effect on what is displayed. After using
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3309 "zc" to close a fold, which is displayed open because it's smaller
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3310 than 'foldminlines', a following "zc" may close a containing fold.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3311
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3312 *'foldnestmax'* *'fdn'*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3313 'foldnestmax' 'fdn' number (default: 20)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3314 local to window
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3315 {not available when compiled without the |+folding|
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3316 feature}
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3317 Sets the maximum nesting of folds for the "indent" and "syntax"
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3318 methods. This avoids that too many folds will be created. Using more
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3319 than 20 doesn't work, because the internal limit is 20.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3320
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3321 *'foldopen'* *'fdo'*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3322 'foldopen' 'fdo' string (default: "block,hor,mark,percent,quickfix,
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3323 search,tag,undo")
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3324 global
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3325 {not available when compiled without the |+folding|
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3326 feature}
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3327 Specifies for which type of commands folds will be opened, if the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3328 command moves the cursor into a closed fold. It is a comma separated
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3329 list of items.
2625
0aa21d63aba0 Updated runtile files.
Bram Moolenaar <bram@vim.org>
parents: 2608
diff changeset
3330 NOTE: When the command is part of a mapping this option is not used.
0aa21d63aba0 Updated runtile files.
Bram Moolenaar <bram@vim.org>
parents: 2608
diff changeset
3331 Add the |zv| command to the mapping to get the same effect.
0aa21d63aba0 Updated runtile files.
Bram Moolenaar <bram@vim.org>
parents: 2608
diff changeset
3332 (rationale: the mapping may want to control opening folds itself)
0aa21d63aba0 Updated runtile files.
Bram Moolenaar <bram@vim.org>
parents: 2608
diff changeset
3333
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3334 item commands ~
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3335 all any
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3336 block "(", "{", "[[", "[{", etc.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3337 hor horizontal movements: "l", "w", "fx", etc.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3338 insert any command in Insert mode
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3339 jump far jumps: "G", "gg", etc.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3340 mark jumping to a mark: "'m", CTRL-O, etc.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3341 percent "%"
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3342 quickfix ":cn", ":crew", ":make", etc.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3343 search search for a pattern: "/", "n", "*", "gd", etc.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3344 (not for a search pattern in a ":" command)
819
23f82b5d2814 updated for version 7.0c10
vimboss
parents: 818
diff changeset
3345 Also for |[s| and |]s|.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3346 tag jumping to a tag: ":ta", CTRL-T, etc.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3347 undo undo or redo: "u" and CTRL-R
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3348 When a movement command is used for an operator (e.g., "dl" or "y%")
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3349 this option is not used. This means the operator will include the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3350 whole closed fold.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3351 Note that vertical movements are not here, because it would make it
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3352 very difficult to move onto a closed fold.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3353 In insert mode the folds containing the cursor will always be open
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3354 when text is inserted.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3355 To close folds you can re-apply 'foldlevel' with the |zx| command or
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3356 set the 'foldclose' option to "all".
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3357
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3358 *'foldtext'* *'fdt'*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3359 'foldtext' 'fdt' string (default: "foldtext()")
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3360 local to window
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3361 {not available when compiled without the |+folding|
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3362 feature}
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3363 An expression which is used to specify the text displayed for a closed
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3364 fold. See |fold-foldtext|.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3365
3682
11d40fc82f11 Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 3674
diff changeset
3366 The expression will be evaluated in the |sandbox| if set from a
11d40fc82f11 Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 3674
diff changeset
3367 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
3368 This option cannot be set in a modeline when 'modelineexpr' is off.
634
1c586ee8dd45 updated for version 7.0183
vimboss
parents: 632
diff changeset
3369
1c586ee8dd45 updated for version 7.0183
vimboss
parents: 632
diff changeset
3370 It is not allowed to change text or jump to another window while
1c586ee8dd45 updated for version 7.0183
vimboss
parents: 632
diff changeset
3371 evaluating 'foldtext' |textlock|.
1c586ee8dd45 updated for version 7.0183
vimboss
parents: 632
diff changeset
3372
9286
64035abb986b commit https://github.com/vim/vim/commit/c95a302a4c42ec8230473cd4a5e0064d0a143aa8
Christian Brabandt <cb@256bit.org>
parents: 9227
diff changeset
3373 *'formatexpr'* *'fex'*
64035abb986b commit https://github.com/vim/vim/commit/c95a302a4c42ec8230473cd4a5e0064d0a143aa8
Christian Brabandt <cb@256bit.org>
parents: 9227
diff changeset
3374 'formatexpr' 'fex' string (default "")
64035abb986b commit https://github.com/vim/vim/commit/c95a302a4c42ec8230473cd4a5e0064d0a143aa8
Christian Brabandt <cb@256bit.org>
parents: 9227
diff changeset
3375 local to buffer
64035abb986b commit https://github.com/vim/vim/commit/c95a302a4c42ec8230473cd4a5e0064d0a143aa8
Christian Brabandt <cb@256bit.org>
parents: 9227
diff changeset
3376 {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
3377 feature}
64035abb986b commit https://github.com/vim/vim/commit/c95a302a4c42ec8230473cd4a5e0064d0a143aa8
Christian Brabandt <cb@256bit.org>
parents: 9227
diff changeset
3378 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
3379 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
3380 option is empty 'formatprg' is used.
64035abb986b commit https://github.com/vim/vim/commit/c95a302a4c42ec8230473cd4a5e0064d0a143aa8
Christian Brabandt <cb@256bit.org>
parents: 9227
diff changeset
3381
64035abb986b commit https://github.com/vim/vim/commit/c95a302a4c42ec8230473cd4a5e0064d0a143aa8
Christian Brabandt <cb@256bit.org>
parents: 9227
diff changeset
3382 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
3383 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
3384 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
3385 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
3386 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
3387 it yet!
64035abb986b commit https://github.com/vim/vim/commit/c95a302a4c42ec8230473cd4a5e0064d0a143aa8
Christian Brabandt <cb@256bit.org>
parents: 9227
diff changeset
3388
64035abb986b commit https://github.com/vim/vim/commit/c95a302a4c42ec8230473cd4a5e0064d0a143aa8
Christian Brabandt <cb@256bit.org>
parents: 9227
diff changeset
3389 Example: >
64035abb986b commit https://github.com/vim/vim/commit/c95a302a4c42ec8230473cd4a5e0064d0a143aa8
Christian Brabandt <cb@256bit.org>
parents: 9227
diff changeset
3390 :set formatexpr=mylang#Format()
64035abb986b commit https://github.com/vim/vim/commit/c95a302a4c42ec8230473cd4a5e0064d0a143aa8
Christian Brabandt <cb@256bit.org>
parents: 9227
diff changeset
3391 < 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
3392 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
3393
64035abb986b commit https://github.com/vim/vim/commit/c95a302a4c42ec8230473cd4a5e0064d0a143aa8
Christian Brabandt <cb@256bit.org>
parents: 9227
diff changeset
3394 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
3395 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
3396 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
3397 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
3398 return "i" or "R" in this situation.
13341
acd7eaa13d2b Updated runtime files.
Christian Brabandt <cb@256bit.org>
parents: 13314
diff changeset
3399
9286
64035abb986b commit https://github.com/vim/vim/commit/c95a302a4c42ec8230473cd4a5e0064d0a143aa8
Christian Brabandt <cb@256bit.org>
parents: 9227
diff changeset
3400 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
3401 the internal format mechanism.
64035abb986b commit https://github.com/vim/vim/commit/c95a302a4c42ec8230473cd4a5e0064d0a143aa8
Christian Brabandt <cb@256bit.org>
parents: 9227
diff changeset
3402
64035abb986b commit https://github.com/vim/vim/commit/c95a302a4c42ec8230473cd4a5e0064d0a143aa8
Christian Brabandt <cb@256bit.org>
parents: 9227
diff changeset
3403 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
3404 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
3405 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
3406 This option cannot be set in a modeline when 'modelineexpr' is off.
11160
d0a20101ecb2 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 11063
diff changeset
3407 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
3408
41
f529edb9bab3 updated for version 7.0025
vimboss
parents: 40
diff changeset
3409 *'formatlistpat'* *'flp'*
f529edb9bab3 updated for version 7.0025
vimboss
parents: 40
diff changeset
3410 'formatlistpat' 'flp' string (default: "^\s*\d\+[\]:.)}\t ]\s*")
f529edb9bab3 updated for version 7.0025
vimboss
parents: 40
diff changeset
3411 local to buffer
f529edb9bab3 updated for version 7.0025
vimboss
parents: 40
diff changeset
3412 A pattern that is used to recognize a list header. This is used for
f529edb9bab3 updated for version 7.0025
vimboss
parents: 40
diff changeset
3413 the "n" flag in 'formatoptions'.
f529edb9bab3 updated for version 7.0025
vimboss
parents: 40
diff changeset
3414 The pattern must match exactly the text that will be the indent for
140
8ecb0db93e9a updated for version 7.0045
vimboss
parents: 99
diff changeset
3415 the line below it. You can use |/\ze| to mark the end of the match
41
f529edb9bab3 updated for version 7.0025
vimboss
parents: 40
diff changeset
3416 while still checking more characters. There must be a character
f529edb9bab3 updated for version 7.0025
vimboss
parents: 40
diff changeset
3417 following the pattern, when it matches the whole line it is handled
f529edb9bab3 updated for version 7.0025
vimboss
parents: 40
diff changeset
3418 like there is no match.
f529edb9bab3 updated for version 7.0025
vimboss
parents: 40
diff changeset
3419 The default recognizes a number, followed by an optional punctuation
f529edb9bab3 updated for version 7.0025
vimboss
parents: 40
diff changeset
3420 character and white space.
f529edb9bab3 updated for version 7.0025
vimboss
parents: 40
diff changeset
3421
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
3422 *'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
3423 '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
3424 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
3425 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
3426 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
3427 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
3428 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
3429 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
3430 "+=" 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
3431 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
3432 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
3433
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3434 *'formatprg'* *'fp'*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3435 '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
3436 global or local to buffer |global-local|
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3437 The name of an external program that will be used to format the lines
667
9090f866cd57 updated for version 7.0197
vimboss
parents: 665
diff changeset
3438 selected with the |gq| operator. The program must take the input on
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3439 stdin and produce the output on stdout. The Unix program "fmt" is
557
862863033fdd updated for version 7.0158
vimboss
parents: 548
diff changeset
3440 such a program.
667
9090f866cd57 updated for version 7.0197
vimboss
parents: 665
diff changeset
3441 If the 'formatexpr' option is not empty it will be used instead.
9090f866cd57 updated for version 7.0197
vimboss
parents: 665
diff changeset
3442 Otherwise, if 'formatprg' option is an empty string, the internal
9090f866cd57 updated for version 7.0197
vimboss
parents: 665
diff changeset
3443 format function will be used |C-indenting|.
557
862863033fdd updated for version 7.0158
vimboss
parents: 548
diff changeset
3444 Environment variables are expanded |:set_env|. See |option-backslash|
862863033fdd updated for version 7.0158
vimboss
parents: 548
diff changeset
3445 about including spaces and backslashes.
3682
11d40fc82f11 Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 3674
diff changeset
3446 This option cannot be set from a |modeline| or in the |sandbox|, for
11d40fc82f11 Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 3674
diff changeset
3447 security reasons.
667
9090f866cd57 updated for version 7.0197
vimboss
parents: 665
diff changeset
3448
7196
42717d048817 commit https://github.com/vim/vim/commit/d94464ee294a351ce7b6ba18e8bd3f24f1bef920
Christian Brabandt <cb@256bit.org>
parents: 7147
diff changeset
3449 *'fsync'* *'fs'* *'nofsync'* *'nofs'*
36
125e80798a85 updated for version 7.0021
vimboss
parents: 33
diff changeset
3450 'fsync' 'fs' boolean (default on)
125e80798a85 updated for version 7.0021
vimboss
parents: 33
diff changeset
3451 global
125e80798a85 updated for version 7.0021
vimboss
parents: 33
diff changeset
3452 When on, the library function fsync() will be called after writing a
125e80798a85 updated for version 7.0021
vimboss
parents: 33
diff changeset
3453 file. This will flush a file to disk, ensuring that it is safely
125e80798a85 updated for version 7.0021
vimboss
parents: 33
diff changeset
3454 written even on filesystems which do metadata-only journaling. This
125e80798a85 updated for version 7.0021
vimboss
parents: 33
diff changeset
3455 will force the harddrive to spin up on Linux systems running in laptop
125e80798a85 updated for version 7.0021
vimboss
parents: 33
diff changeset
3456 mode, so it may be undesirable in some situations. Be warned that
125e80798a85 updated for version 7.0021
vimboss
parents: 33
diff changeset
3457 turning this off increases the chances of data loss after a crash. On
125e80798a85 updated for version 7.0021
vimboss
parents: 33
diff changeset
3458 systems without an fsync() implementation, this variable is always
125e80798a85 updated for version 7.0021
vimboss
parents: 33
diff changeset
3459 off.
125e80798a85 updated for version 7.0021
vimboss
parents: 33
diff changeset
3460 Also see 'swapsync' for controlling fsync() on swap files.
12865
ebb4f6c93598 patch 8.0.1309: cannot use 'balloonexpr' in a terminal
Christian Brabandt <cb@256bit.org>
parents: 12826
diff changeset
3461 'fsync' also applies to |writefile()|, unless a flag is used to
ebb4f6c93598 patch 8.0.1309: cannot use 'balloonexpr' in a terminal
Christian Brabandt <cb@256bit.org>
parents: 12826
diff changeset
3462 overrule it.
16728
e55c26aaf484 patch 8.1.1366: using expressions in a modeline is unsafe
Bram Moolenaar <Bram@vim.org>
parents: 16610
diff changeset
3463 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
3464 security reasons.
36
125e80798a85 updated for version 7.0021
vimboss
parents: 33
diff changeset
3465
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3466 *'gdefault'* *'gd'* *'nogdefault'* *'nogd'*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3467 'gdefault' 'gd' boolean (default off)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3468 global
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3469 When on, the ":substitute" flag 'g' is default on. This means that
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3470 all matches in a line are substituted instead of one. When a 'g' flag
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3471 is given to a ":substitute" command, this will toggle the substitution
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3472 of all or one match. See |complex-change|.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3473
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3474 command 'gdefault' on 'gdefault' off ~
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3475 :s/// subst. all subst. one
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3476 :s///g subst. one subst. all
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3477 :s///gg subst. all subst. one
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3478
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3479 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
3480 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
3481 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
3482 has the opposite effect of that it normally does.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3483
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3484 *'grepformat'* *'gfm'*
6213
37c24033b260 Update runtime files.
Bram Moolenaar <bram@vim.org>
parents: 6153
diff changeset
3485 'grepformat' 'gfm' string (default "%f:%l:%m,%f:%l%m,%f %l%m")
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3486 global
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3487 Format to recognize for the ":grep" command output.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3488 This is a scanf-like string that uses the same format as the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3489 'errorformat' option: see |errorformat|.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3490
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3491 *'grepprg'* *'gp'*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3492 'grepprg' 'gp' string (default "grep -n ",
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3493 Unix: "grep -n $* /dev/null",
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3494 Win32: "findstr /n" or "grep -n",
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3495 VMS: "SEARCH/NUMBERS ")
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3496 global or local to buffer |global-local|
233
fca8a9b65afa updated for version 7.0065
vimboss
parents: 227
diff changeset
3497 Program to use for the |:grep| command. This option may contain '%'
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3498 and '#' characters, which are expanded like when used in a command-
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3499 line. The placeholder "$*" is allowed to specify where the arguments
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3500 will be included. Environment variables are expanded |:set_env|. See
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3501 |option-backslash| about including spaces and backslashes.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3502 When your "grep" accepts the "-H" argument, use this to make ":grep"
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3503 also work well with a single file: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3504 :set grepprg=grep\ -nH
161
6df0106fc595 updated for version 7.0049
vimboss
parents: 148
diff changeset
3505 < Special value: When 'grepprg' is set to "internal" the |:grep| command
657
b112ec5c73f0 updated for version 7.0193
vimboss
parents: 653
diff changeset
3506 works like |:vimgrep|, |:lgrep| like |:lvimgrep|, |:grepadd| like
b112ec5c73f0 updated for version 7.0193
vimboss
parents: 653
diff changeset
3507 |:vimgrepadd| and |:lgrepadd| like |:lvimgrepadd|.
41
f529edb9bab3 updated for version 7.0025
vimboss
parents: 40
diff changeset
3508 See also the section |:make_makeprg|, since most of the comments there
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3509 apply equally to 'grepprg'.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3510 For Win32, the default is "findstr /n" if "findstr.exe" can be found,
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3511 otherwise it's "grep -n".
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3512 This option cannot be set from a |modeline| or in the |sandbox|, for
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3513 security reasons.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3514
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3515 *'guicursor'* *'gcr'* *E545* *E546* *E548* *E549*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3516 'guicursor' 'gcr' string (default "n-v-c:block-Cursor/lCursor,
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3517 ve:ver35-Cursor,
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3518 o:hor50-Cursor,
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3519 i-ci:ver25-Cursor/lCursor,
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3520 r-cr:hor20-Cursor/lCursor,
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3521 sm:block-Cursor
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3522 -blinkwait175-blinkoff150-blinkon175",
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3523 for MS-DOS and Win32 console:
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3524 "n-v-c:block,o:hor50,i-ci:hor15,
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3525 r-cr:hor30,sm:block")
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3526 global
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3527 {only available when compiled with GUI enabled, and
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3528 for MS-DOS and Win32 console}
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3529 This option tells Vim what the cursor should look like in different
10
4e2284e71352 updated for version 7.0002
vimboss
parents: 8
diff changeset
3530 modes. It fully works in the GUI. In an MSDOS or Win32 console, only
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3531 the height of the cursor can be changed. This can be done by
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3532 specifying a block cursor, or a percentage for a vertical or
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3533 horizontal cursor.
6727
7c5a0c69e1ac updated for version 7.4.687
Bram Moolenaar <bram@vim.org>
parents: 6647
diff changeset
3534 For a console the 't_SI', 't_SR', and 't_EI' escape sequences are
7c5a0c69e1ac updated for version 7.4.687
Bram Moolenaar <bram@vim.org>
parents: 6647
diff changeset
3535 used.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3536
10
4e2284e71352 updated for version 7.0002
vimboss
parents: 8
diff changeset
3537 The option is a comma separated list of parts. Each part consist of a
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3538 mode-list and an argument-list:
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3539 mode-list:argument-list,mode-list:argument-list,..
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3540 The mode-list is a dash separated list of these modes:
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3541 n Normal mode
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3542 v Visual mode
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3543 ve Visual mode with 'selection' "exclusive" (same as 'v',
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3544 if not specified)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3545 o Operator-pending mode
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3546 i Insert mode
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3547 r Replace mode
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3548 c Command-line Normal (append) mode
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3549 ci Command-line Insert mode
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3550 cr Command-line Replace mode
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3551 sm showmatch in Insert mode
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3552 a all modes
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3553 The argument-list is a dash separated list of these arguments:
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3554 hor{N} horizontal bar, {N} percent of the character height
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3555 ver{N} vertical bar, {N} percent of the character width
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3556 block block cursor, fills the whole character
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3557 [only one of the above three should be present]
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3558 blinkwait{N} *cursor-blinking*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3559 blinkon{N}
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3560 blinkoff{N}
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3561 blink times for cursor: blinkwait is the delay before
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3562 the cursor starts blinking, blinkon is the time that
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3563 the cursor is shown and blinkoff is the time that the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3564 cursor is not shown. The times are in msec. When one
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3565 of the numbers is zero, there is no blinking. The
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3566 default is: "blinkwait700-blinkon400-blinkoff250".
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3567 These numbers are used for a missing entry. This
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3568 means that blinking is enabled by default. To switch
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3569 blinking off you can use "blinkon0". The cursor only
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3570 blinks when Vim is waiting for input, not while
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3571 executing a command.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3572 To make the cursor blink in an xterm, see
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3573 |xterm-blink|.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3574 {group-name}
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3575 a highlight group name, that sets the color and font
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3576 for the cursor
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3577 {group-name}/{group-name}
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3578 Two highlight group names, the first is used when
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3579 no language mappings are used, the other when they
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3580 are. |language-mapping|
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3581
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3582 Examples of parts:
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3583 n-c-v:block-nCursor in Normal, Command-line and Visual mode, use a
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3584 block cursor with colors from the "nCursor"
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3585 highlight group
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3586 i-ci:ver30-iCursor-blinkwait300-blinkon200-blinkoff150
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3587 In Insert and Command-line Insert mode, use a
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3588 30% vertical bar cursor with colors from the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3589 "iCursor" highlight group. Blink a bit
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3590 faster.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3591
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3592 The 'a' mode is different. It will set the given argument-list for
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3593 all modes. It does not reset anything to defaults. This can be used
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3594 to do a common setting for all modes. For example, to switch off
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3595 blinking: "a:blinkon0"
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3596
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3597 Examples of cursor highlighting: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3598 :highlight Cursor gui=reverse guifg=NONE guibg=NONE
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3599 :highlight Cursor gui=NONE guifg=bg guibg=fg
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3600 <
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3601 *'guifont'* *'gfn'*
2908
fd09a9c8468e Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 2873
diff changeset
3602 *E235* *E596*
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3603 'guifont' 'gfn' string (default "")
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3604 global
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3605 {only available when compiled with GUI enabled}
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3606 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
3607 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
3608 See |gui-font| for the details.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3609
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3610 *'guifontset'* *'gfs'*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3611 *E250* *E252* *E234* *E597* *E598*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3612 'guifontset' 'gfs' string (default "")
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3613 global
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3614 {only available when compiled with GUI enabled and
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3615 with the |+xfontset| feature}
10895
c391bfbdb452 Updated runtime files.
Christian Brabandt <cb@256bit.org>
parents: 10734
diff changeset
3616 {not available in the GTK+ GUI}
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3617 When not empty, specifies two (or more) fonts to be used. The first
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3618 one for normal English, the second one for your special language. See
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3619 |xfontset|.
16439
9d20e26dc13c patch 8.1.1224: MS-Windows: cannot specify font weight
Bram Moolenaar <Bram@vim.org>
parents: 16427
diff changeset
3620
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3621 *'guifontwide'* *'gfw'* *E231* *E533* *E534*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3622 'guifontwide' 'gfw' string (default "")
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3623 global
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3624 {only available when compiled with GUI enabled}
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3625 When not empty, specifies a comma-separated list of fonts to be used
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3626 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
3627 used. See |gui-fontwide|.
4055
0de969850c06 updated for version 7.3.782
Bram Moolenaar <bram@vim.org>
parents: 3920
diff changeset
3628
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3629 *'guiheadroom'* *'ghr'*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3630 'guiheadroom' 'ghr' number (default 50)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3631 global
16728
e55c26aaf484 patch 8.1.1366: using expressions in a modeline is unsafe
Bram Moolenaar <Bram@vim.org>
parents: 16610
diff changeset
3632 {only for GTK and X11 GUI}
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3633 The number of pixels subtracted from the screen height when fitting
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3634 the GUI window on the screen. Set this before the GUI is started,
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3635 e.g., in your |gvimrc| file. When zero, the whole screen height will
10
4e2284e71352 updated for version 7.0002
vimboss
parents: 8
diff changeset
3636 be used by the window. When positive, the specified number of pixel
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3637 lines will be left for window decorations and other items on the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3638 screen. Set it to a negative value to allow windows taller than the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3639 screen.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3640
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3641 *'guioptions'* *'go'*
14945
4ee65b4150fd Update runtime files
Bram Moolenaar <Bram@vim.org>
parents: 14864
diff changeset
3642 'guioptions' 'go' string (default "egmrLtT" (MS-Windows,
4ee65b4150fd Update runtime files
Bram Moolenaar <Bram@vim.org>
parents: 14864
diff changeset
3643 "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
3644 "aegimrLtT" (GTK, Motif and Athena),
284b4eb307fc commit https://github.com/vim/vim/commit/8c08b5b569e2a9e9f63dea514591ecfa2d3bb392
Christian Brabandt <cb@256bit.org>
parents: 9665
diff changeset
3645 )
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3646 global
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3647 {only available when compiled with GUI enabled}
8
7edf9b6e4c36 Various changes
vimboss
parents: 7
diff changeset
3648 This option only has an effect in the GUI version of Vim. It is a
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3649 sequence of letters which describes what components and options of the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3650 GUI should be used.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3651 To avoid problems with flags that are added in the future, use the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3652 "+=" and "-=" feature of ":set" |add-option-flags|.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3653
13470
6faef782f50b patch 8.0.1609: shell commands in the GUI use a dumb terminal
Christian Brabandt <cb@256bit.org>
parents: 13437
diff changeset
3654 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
3655 *'go-!'*
6faef782f50b patch 8.0.1609: shell commands in the GUI use a dumb terminal
Christian Brabandt <cb@256bit.org>
parents: 13437
diff changeset
3656 '!' 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
3657 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
3658 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
3659 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
3660 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
3661 upwards as needed.
14999
2b30a2b4bde2 Update runtime files
Bram Moolenaar <Bram@vim.org>
parents: 14945
diff changeset
3662 *'go-a'*
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3663 'a' Autoselect: If present, then whenever VISUAL mode is started,
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3664 or the Visual area extended, Vim tries to become the owner of
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3665 the windowing system's global selection. This means that the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3666 Visually highlighted text is available for pasting into other
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3667 applications as well as into Vim itself. When the Visual mode
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3668 ends, possibly due to an operation on the text, or when an
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3669 application wants to paste the selection, the highlighted text
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3670 is automatically yanked into the "* selection register.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3671 Thus the selection is still available for pasting into other
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3672 applications after the VISUAL mode has ended.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3673 If not present, then Vim won't become the owner of the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3674 windowing system's global selection unless explicitly told to
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3675 by a yank or delete operation for the "* register.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3676 The same applies to the modeless selection.
3674
b9aa7fb4a928 updated for version 7.3.597
Bram Moolenaar <bram@vim.org>
parents: 3557
diff changeset
3677 *'go-P'*
b9aa7fb4a928 updated for version 7.3.597
Bram Moolenaar <bram@vim.org>
parents: 3557
diff changeset
3678 '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
3679 register.
1152
e1787f5b90da updated for version 7.1a
vimboss
parents: 1111
diff changeset
3680 *'go-A'*
10
4e2284e71352 updated for version 7.0002
vimboss
parents: 8
diff changeset
3681 'A' Autoselect for the modeless selection. Like 'a', but only
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3682 applies to the modeless selection.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3683
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3684 'guioptions' autoselect Visual autoselect modeless ~
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3685 "" - -
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3686 "a" yes yes
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3687 "A" - yes
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3688 "aA" yes yes
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3689
1152
e1787f5b90da updated for version 7.1a
vimboss
parents: 1111
diff changeset
3690 *'go-c'*
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3691 'c' Use console dialogs instead of popup dialogs for simple
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3692 choices.
1152
e1787f5b90da updated for version 7.1a
vimboss
parents: 1111
diff changeset
3693 *'go-e'*
697
f08390485cd3 updated for version 7.0210
vimboss
parents: 694
diff changeset
3694 'e' Add tab pages when indicated with 'showtabline'.
688
bcd2edc4539e updated for version 7.0207
vimboss
parents: 685
diff changeset
3695 'guitablabel' can be used to change the text in the labels.
bcd2edc4539e updated for version 7.0207
vimboss
parents: 685
diff changeset
3696 When 'e' is missing a non-GUI tab pages line may be used.
857
b933657f7c9d updated for version 7.0g01
vimboss
parents: 856
diff changeset
3697 The GUI tabs are only supported on some systems, currently
1621
82b5078be2dd updated for version 7.2a
vimboss
parents: 1564
diff changeset
3698 GTK, Motif, Mac OS/X and MS-Windows.
1152
e1787f5b90da updated for version 7.1a
vimboss
parents: 1111
diff changeset
3699 *'go-f'*
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3700 'f' Foreground: Don't use fork() to detach the GUI from the shell
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3701 where it was started. Use this for programs that wait for the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3702 editor to finish (e.g., an e-mail program). Alternatively you
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3703 can use "gvim -f" or ":gui -f" to start the GUI in the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3704 foreground. |gui-fork|
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3705 Note: Set this option in the vimrc file. The forking may have
819
23f82b5d2814 updated for version 7.0c10
vimboss
parents: 818
diff changeset
3706 happened already when the |gvimrc| file is read.
1152
e1787f5b90da updated for version 7.1a
vimboss
parents: 1111
diff changeset
3707 *'go-i'*
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3708 'i' Use a Vim icon. For GTK with KDE it is used in the left-upper
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3709 corner of the window. It's black&white on non-GTK, because of
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3710 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
3711 *'go-m'*
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3712 'm' Menu bar is present.
2290
22529abcd646 Fixed ":s" message. Docs updates.
Bram Moolenaar <bram@vim.org>
parents: 2283
diff changeset
3713 *'go-M'*
10
4e2284e71352 updated for version 7.0002
vimboss
parents: 8
diff changeset
3714 'M' The system menu "$VIMRUNTIME/menu.vim" is not sourced. Note
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3715 that this flag must be added in the .vimrc file, before
819
23f82b5d2814 updated for version 7.0c10
vimboss
parents: 818
diff changeset
3716 switching on syntax or filetype recognition (when the |gvimrc|
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3717 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
3718 `: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
3719 *'go-g'*
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3720 'g' Grey menu items: Make menu items that are not active grey. If
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3721 'g' is not included inactive menu items are not shown at all.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3722 Exception: Athena will always use grey menu items.
1152
e1787f5b90da updated for version 7.1a
vimboss
parents: 1111
diff changeset
3723 *'go-t'*
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3724 't' Include tearoff menu items. Currently only works for Win32,
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3725 GTK+, and Motif 1.2 GUI.
1152
e1787f5b90da updated for version 7.1a
vimboss
parents: 1111
diff changeset
3726 *'go-T'*
236
4707450c2b33 updated for version 7.0066
vimboss
parents: 233
diff changeset
3727 'T' Include Toolbar. Currently only in Win32, GTK+, Motif, Photon
856
8cd729851562 updated for version 7.0g
vimboss
parents: 853
diff changeset
3728 and Athena GUIs.
1152
e1787f5b90da updated for version 7.1a
vimboss
parents: 1111
diff changeset
3729 *'go-r'*
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3730 'r' Right-hand scrollbar is always present.
2290
22529abcd646 Fixed ":s" message. Docs updates.
Bram Moolenaar <bram@vim.org>
parents: 2283
diff changeset
3731 *'go-R'*
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3732 'R' Right-hand scrollbar is present when there is a vertically
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3733 split window.
2290
22529abcd646 Fixed ":s" message. Docs updates.
Bram Moolenaar <bram@vim.org>
parents: 2283
diff changeset
3734 *'go-l'*
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3735 'l' Left-hand scrollbar is always present.
2290
22529abcd646 Fixed ":s" message. Docs updates.
Bram Moolenaar <bram@vim.org>
parents: 2283
diff changeset
3736 *'go-L'*
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3737 'L' Left-hand scrollbar is present when there is a vertically
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3738 split window.
1152
e1787f5b90da updated for version 7.1a
vimboss
parents: 1111
diff changeset
3739 *'go-b'*
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3740 'b' Bottom (horizontal) scrollbar is present. Its size depends on
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3741 the longest visible line, or on the cursor line if the 'h'
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3742 flag is included. |gui-horiz-scroll|
2290
22529abcd646 Fixed ":s" message. Docs updates.
Bram Moolenaar <bram@vim.org>
parents: 2283
diff changeset
3743 *'go-h'*
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3744 'h' Limit horizontal scrollbar size to the length of the cursor
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3745 line. Reduces computations. |gui-horiz-scroll|
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3746
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3747 And yes, you may even have scrollbars on the left AND the right if
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3748 you really want to :-). See |gui-scrollbars| for more information.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3749
2290
22529abcd646 Fixed ":s" message. Docs updates.
Bram Moolenaar <bram@vim.org>
parents: 2283
diff changeset
3750 *'go-v'*
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3751 'v' Use a vertical button layout for dialogs. When not included,
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3752 a horizontal layout is preferred, but when it doesn't fit a
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3753 vertical layout is used anyway.
2290
22529abcd646 Fixed ":s" message. Docs updates.
Bram Moolenaar <bram@vim.org>
parents: 2283
diff changeset
3754 *'go-p'*
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3755 'p' Use Pointer callbacks for X11 GUI. This is required for some
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3756 window managers. If the cursor is not blinking or hollow at
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3757 the right moment, try adding this flag. This must be done
819
23f82b5d2814 updated for version 7.0c10
vimboss
parents: 818
diff changeset
3758 before starting the GUI. Set it in your |gvimrc|. Adding or
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3759 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
3760 *'go-F'*
10
4e2284e71352 updated for version 7.0002
vimboss
parents: 8
diff changeset
3761 '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
3762 *'go-k'*
29a728529f92 patch 8.0.1278: GUI window always resizes when adding scrollbar
Christian Brabandt <cb@256bit.org>
parents: 12785
diff changeset
3763 '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
3764 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
3765 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
3766 '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
3767 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
3768 removing GUI components.
1152
e1787f5b90da updated for version 7.1a
vimboss
parents: 1111
diff changeset
3769
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3770 *'guipty'* *'noguipty'*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3771 'guipty' boolean (default on)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3772 global
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3773 {only available when compiled with GUI enabled}
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3774 Only in the GUI: If on, an attempt is made to open a pseudo-tty for
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3775 I/O to/from shell commands. See |gui-pty|.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3776
688
bcd2edc4539e updated for version 7.0207
vimboss
parents: 685
diff changeset
3777 *'guitablabel'* *'gtl'*
bcd2edc4539e updated for version 7.0207
vimboss
parents: 685
diff changeset
3778 'guitablabel' 'gtl' string (default empty)
bcd2edc4539e updated for version 7.0207
vimboss
parents: 685
diff changeset
3779 global
692
a28f83d37113 updated for version 7.0208
vimboss
parents: 688
diff changeset
3780 {only available when compiled with GUI enabled and
2570
71b56b4e7785 Make the references to features in the help more consistent. (Sylvain Hitier)
Bram Moolenaar <bram@vim.org>
parents: 2561
diff changeset
3781 with the |+windows| feature}
688
bcd2edc4539e updated for version 7.0207
vimboss
parents: 685
diff changeset
3782 When nonempty describes the text to use in a label of the GUI tab
857
b933657f7c9d updated for version 7.0g01
vimboss
parents: 856
diff changeset
3783 pages line. When empty and when the result is empty Vim will use a
b933657f7c9d updated for version 7.0g01
vimboss
parents: 856
diff changeset
3784 default label. See |setting-guitablabel| for more info.
688
bcd2edc4539e updated for version 7.0207
vimboss
parents: 685
diff changeset
3785
692
a28f83d37113 updated for version 7.0208
vimboss
parents: 688
diff changeset
3786 The format of this option is like that of 'statusline'.
839
1f3b1021f002 updated for version 7.0e05
vimboss
parents: 838
diff changeset
3787 '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
3788 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
3789 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
3790 This option cannot be set in a modeline when 'modelineexpr' is off.
692
a28f83d37113 updated for version 7.0208
vimboss
parents: 688
diff changeset
3791
688
bcd2edc4539e updated for version 7.0207
vimboss
parents: 685
diff changeset
3792 Only used when the GUI tab pages line is displayed. 'e' must be
bcd2edc4539e updated for version 7.0207
vimboss
parents: 685
diff changeset
3793 present in 'guioptions'. For the non-GUI tab pages line 'tabline' is
bcd2edc4539e updated for version 7.0207
vimboss
parents: 685
diff changeset
3794 used.
bcd2edc4539e updated for version 7.0207
vimboss
parents: 685
diff changeset
3795
839
1f3b1021f002 updated for version 7.0e05
vimboss
parents: 838
diff changeset
3796 *'guitabtooltip'* *'gtt'*
1f3b1021f002 updated for version 7.0e05
vimboss
parents: 838
diff changeset
3797 'guitabtooltip' 'gtt' string (default empty)
1f3b1021f002 updated for version 7.0e05
vimboss
parents: 838
diff changeset
3798 global
1f3b1021f002 updated for version 7.0e05
vimboss
parents: 838
diff changeset
3799 {only available when compiled with GUI enabled and
2570
71b56b4e7785 Make the references to features in the help more consistent. (Sylvain Hitier)
Bram Moolenaar <bram@vim.org>
parents: 2561
diff changeset
3800 with the |+windows| feature}
839
1f3b1021f002 updated for version 7.0e05
vimboss
parents: 838
diff changeset
3801 When nonempty describes the text to use in a tooltip for the GUI tab
1f3b1021f002 updated for version 7.0e05
vimboss
parents: 838
diff changeset
3802 pages line. When empty Vim will use a default tooltip.
1f3b1021f002 updated for version 7.0e05
vimboss
parents: 838
diff changeset
3803 This option is otherwise just like 'guitablabel' above.
2033
de5a43c5eedc Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents: 1904
diff changeset
3804 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
3805 :let &guitabtooltip = "line one\nline two"
de5a43c5eedc Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents: 1904
diff changeset
3806 <
839
1f3b1021f002 updated for version 7.0e05
vimboss
parents: 838
diff changeset
3807
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3808 *'helpfile'* *'hf'*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3809 'helpfile' 'hf' string (default (MSDOS) "$VIMRUNTIME\doc\help.txt"
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3810 (others) "$VIMRUNTIME/doc/help.txt")
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3811 global
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3812 Name of the main help file. All distributed help files should be
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3813 placed together in one directory. Additionally, all "doc" directories
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3814 in 'runtimepath' will be used.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3815 Environment variables are expanded |:set_env|. For example:
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3816 "$VIMRUNTIME/doc/help.txt". If $VIMRUNTIME is not set, $VIM is also
10
4e2284e71352 updated for version 7.0002
vimboss
parents: 8
diff changeset
3817 tried. Also see |$VIMRUNTIME| and |option-backslash| about including
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3818 spaces and backslashes.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3819 This option cannot be set from a |modeline| or in the |sandbox|, for
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3820 security reasons.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3821
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3822 *'helpheight'* *'hh'*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3823 'helpheight' 'hh' number (default 20)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3824 global
2570
71b56b4e7785 Make the references to features in the help more consistent. (Sylvain Hitier)
Bram Moolenaar <bram@vim.org>
parents: 2561
diff changeset
3825 {not available when compiled without the |+windows|
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3826 feature}
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3827 Minimal initial height of the help window when it is opened with the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3828 ":help" command. The initial height of the help window is half of the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3829 current window, or (when the 'ea' option is on) the same as other
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3830 windows. When the height is less than 'helpheight', the height is
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3831 set to 'helpheight'. Set to zero to disable.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3832
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3833 *'helplang'* *'hlg'*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3834 'helplang' 'hlg' string (default: messages language or empty)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3835 global
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3836 {only available when compiled with the |+multi_lang|
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3837 feature}
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3838 Comma separated list of languages. Vim will use the first language
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3839 for which the desired help can be found. The English help will always
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3840 be used as a last resort. You can add "en" to prefer English over
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3841 another language, but that will only find tags that exist in that
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3842 language and not in the English help.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3843 Example: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3844 :set helplang=de,it
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3845 < This will first search German, then Italian and finally English help
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3846 files.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3847 When using |CTRL-]| and ":help!" in a non-English help file Vim will
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3848 try to find the tag in the current language before using this option.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3849 See |help-translated|.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3850
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3851 *'hidden'* *'hid'* *'nohidden'* *'nohid'*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3852 'hidden' 'hid' boolean (default off)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3853 global
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3854 When off a buffer is unloaded when it is |abandon|ed. When on a
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3855 buffer becomes hidden when it is |abandon|ed. If the buffer is still
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3856 displayed in another window, it does not become hidden, of course.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3857 The commands that move through the buffer list sometimes make a buffer
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3858 hidden although the 'hidden' option is off: When the buffer is
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3859 modified, 'autowrite' is off or writing is not possible, and the '!'
10
4e2284e71352 updated for version 7.0002
vimboss
parents: 8
diff changeset
3860 flag was used. See also |windows.txt|.
12
bdeee1504ac1 updated for version 7.0004
vimboss
parents: 11
diff changeset
3861 To only make one buffer hidden use the 'bufhidden' option.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3862 This option is set for one command with ":hide {command}" |:hide|.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3863 WARNING: It's easy to forget that you have changes in hidden buffers.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3864 Think twice when using ":q!" or ":qa!".
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3865
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3866 *'highlight'* *'hl'*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3867 '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
3868 "8:SpecialKey,~:EndOfBuffer,@:NonText,
7da89d9c744b commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents: 9860
diff changeset
3869 d:Directory,e:ErrorMsg,i:IncSearch,
7da89d9c744b commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents: 9860
diff changeset
3870 l:Search,m:MoreMsg,M:ModeMsg,n:LineNr,
7da89d9c744b commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents: 9860
diff changeset
3871 N:CursorLineNr,r:Question,s:StatusLine,
7da89d9c744b commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents: 9860
diff changeset
3872 S:StatusLineNC,c:VertSplit,t:Title,
15194
8b334e4cb97f Update runtime files.
Bram Moolenaar <Bram@vim.org>
parents: 15192
diff changeset
3873 v:Visual,V:VisualNOS,w:WarningMsg,
8b334e4cb97f Update runtime files.
Bram Moolenaar <Bram@vim.org>
parents: 15192
diff changeset
3874 W:WildMenu,f:Folded,F:FoldColumn,
8b334e4cb97f Update runtime files.
Bram Moolenaar <Bram@vim.org>
parents: 15192
diff changeset
3875 A:DiffAdd,C:DiffChange,D:DiffDelete,
8b334e4cb97f Update runtime files.
Bram Moolenaar <Bram@vim.org>
parents: 15192
diff changeset
3876 T:DiffText,>:SignColumn,-:Conceal,
15281
97b40b4c6911 Update runtime files.
Bram Moolenaar <Bram@vim.org>
parents: 15194
diff changeset
3877 B:SpellBad,P:SpellCap,R:SpellRare,
15194
8b334e4cb97f Update runtime files.
Bram Moolenaar <Bram@vim.org>
parents: 15192
diff changeset
3878 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
3879 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
3880 #:TabLineSel,_:TabLineFill,!:CursorColumn,
11914
4f7081eb1e26 Updated runtime files
Christian Brabandt <cb@256bit.org>
parents: 11757
diff changeset
3881 .:CursorLine,o:ColorColumn,q:QuickFixLine,
12254
8d76a56861ec Update runtime files
Christian Brabandt <cb@256bit.org>
parents: 12138
diff changeset
3882 z:StatusLineTerm,Z:StatusLineTermNC")
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3883 global
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3884 This option can be used to set highlighting mode for various
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3885 occasions. It is a comma separated list of character pairs. The
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3886 first character in a pair gives the occasion, the second the mode to
10
4e2284e71352 updated for version 7.0002
vimboss
parents: 8
diff changeset
3887 use for that occasion. The occasions are:
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3888 |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
3889 |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
3890 |hl-NonText| @ '@' at the end of the window and
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3891 characters from 'showbreak'
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3892 |hl-Directory| d directories in CTRL-D listing and other special
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3893 things in listings
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3894 |hl-ErrorMsg| e error messages
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3895 h (obsolete, ignored)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3896 |hl-IncSearch| i 'incsearch' highlighting
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3897 |hl-Search| l last search pattern highlighting (see 'hlsearch')
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3898 |hl-MoreMsg| m |more-prompt|
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3899 |hl-ModeMsg| M Mode (e.g., "-- INSERT --")
2178
c6f1aa1e9f32 Add 'relativenumber' patch from Markus Heidelberg.
Bram Moolenaar <bram@vim.org>
parents: 2154
diff changeset
3900 |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
3901 when 'number' or 'relativenumber' option is set.
4073
e362db8b2d7b Update runtime files.
Bram Moolenaar <bram@vim.org>
parents: 4055
diff changeset
3902 |hl-CursorLineNr| N like n for when 'cursorline' or 'relativenumber' is
e362db8b2d7b Update runtime files.
Bram Moolenaar <bram@vim.org>
parents: 4055
diff changeset
3903 set.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3904 |hl-Question| r |hit-enter| prompt and yes/no questions
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3905 |hl-StatusLine| s status line of current window |status-line|
12785
65d7fd8381a3 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 12756
diff changeset
3906 |hl-StatusLineNC| S status lines of not-current windows
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3907 |hl-Title| t Titles for output from ":set all", ":autocmd" etc.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3908 |hl-VertSplit| c column used to separate vertically split windows
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3909 |hl-Visual| v Visual mode
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3910 |hl-VisualNOS| V Visual mode when Vim does is "Not Owning the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3911 Selection" Only X11 Gui's |gui-x11| and
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3912 |xterm-clipboard|.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3913 |hl-WarningMsg| w warning messages
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3914 |hl-WildMenu| W wildcard matches displayed for 'wildmenu'
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3915 |hl-Folded| f line used for closed folds
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3916 |hl-FoldColumn| F 'foldcolumn'
386
607d3cd9364f updated for version 7.0100
vimboss
parents: 378
diff changeset
3917 |hl-DiffAdd| A added line in diff mode
607d3cd9364f updated for version 7.0100
vimboss
parents: 378
diff changeset
3918 |hl-DiffChange| C changed line in diff mode
607d3cd9364f updated for version 7.0100
vimboss
parents: 378
diff changeset
3919 |hl-DiffDelete| D deleted line in diff mode
607d3cd9364f updated for version 7.0100
vimboss
parents: 378
diff changeset
3920 |hl-DiffText| T inserted text in diff mode
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3921 |hl-SignColumn| > column used for |signs|
15194
8b334e4cb97f Update runtime files.
Bram Moolenaar <Bram@vim.org>
parents: 15192
diff changeset
3922 |hl-Conceal| - the placeholders used for concealed characters
8b334e4cb97f Update runtime files.
Bram Moolenaar <Bram@vim.org>
parents: 15192
diff changeset
3923 (see 'conceallevel')
221
7fd4b5df33be updated for version 7.0062
vimboss
parents: 205
diff changeset
3924 |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
3925 |hl-SpellCap| P word that should start with capital |spell|
221
7fd4b5df33be updated for version 7.0062
vimboss
parents: 205
diff changeset
3926 |hl-SpellRare| R rare word |spell|
7fd4b5df33be updated for version 7.0062
vimboss
parents: 205
diff changeset
3927 |hl-SpellLocal| L word from other region |spell|
15194
8b334e4cb97f Update runtime files.
Bram Moolenaar <Bram@vim.org>
parents: 15192
diff changeset
3928 |hl-Pmenu| + popup menu normal line
8b334e4cb97f Update runtime files.
Bram Moolenaar <Bram@vim.org>
parents: 15192
diff changeset
3929 |hl-PmenuSel| = popup menu selected line
8b334e4cb97f Update runtime files.
Bram Moolenaar <Bram@vim.org>
parents: 15192
diff changeset
3930 |hl-PmenuSbar| x popup menu scrollbar
8b334e4cb97f Update runtime files.
Bram Moolenaar <Bram@vim.org>
parents: 15192
diff changeset
3931 |hl-PmenuThumb| X popup menu scrollbar thumb
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3932
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3933 The display modes are:
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3934 r reverse (termcap entry "mr" and "me")
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3935 i italic (termcap entry "ZH" and "ZR")
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3936 b bold (termcap entry "md" and "me")
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3937 s standout (termcap entry "so" and "se")
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3938 u underline (termcap entry "us" and "ue")
205
d292c40ca788 updated for version 7.0060
vimboss
parents: 199
diff changeset
3939 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
3940 t strikethrough (termcap entry "Ts" and "Te")
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3941 n no highlighting
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3942 - no highlighting
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3943 : use a highlight group
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3944 The default is used for occasions that are not included.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3945 If you want to change what the display modes do, see |dos-colors|
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3946 for an example.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3947 When using the ':' display mode, this must be followed by the name of
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3948 a highlight group. A highlight group can be used to define any type
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3949 of highlighting, including using color. See |:highlight| on how to
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3950 define one. The default uses a different group for each occasion.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3951 See |highlight-default| for the default highlight groups.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3952
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3953 *'history'* *'hi'*
9669
284b4eb307fc commit https://github.com/vim/vim/commit/8c08b5b569e2a9e9f63dea514591ecfa2d3bb392
Christian Brabandt <cb@256bit.org>
parents: 9665
diff changeset
3954 '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
3955 set to 200 in |defaults.vim|)
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3956 global
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3957 A history of ":" commands, and a history of previous search patterns
5991
a42ba1e50992 updated for version 7.4.336
Bram Moolenaar <bram@vim.org>
parents: 5968
diff changeset
3958 is remembered. This option decides how many entries may be stored in
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3959 each of these histories (see |cmdline-editing|).
5991
a42ba1e50992 updated for version 7.4.336
Bram Moolenaar <bram@vim.org>
parents: 5968
diff changeset
3960 The maximum value is 10000.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3961 NOTE: This option is set to the Vi default value when 'compatible' is
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3962 set and to the Vim default value when 'compatible' is reset.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3963
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3964 *'hkmap'* *'hk'* *'nohkmap'* *'nohk'*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3965 'hkmap' 'hk' boolean (default off)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3966 global
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3967 {only available when compiled with the |+rightleft|
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3968 feature}
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3969 When on, the keyboard is mapped for the Hebrew character set.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3970 Normally you would set 'allowrevins' and use CTRL-_ in insert mode to
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3971 toggle this option. See |rileft.txt|.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3972 NOTE: This option is reset when 'compatible' is set.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3973
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3974 *'hkmapp'* *'hkp'* *'nohkmapp'* *'nohkp'*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3975 'hkmapp' 'hkp' boolean (default off)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3976 global
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3977 {only available when compiled with the |+rightleft|
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3978 feature}
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3979 When on, phonetic keyboard mapping is used. 'hkmap' must also be on.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3980 This is useful if you have a non-Hebrew keyboard.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3981 See |rileft.txt|.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3982 NOTE: This option is reset when 'compatible' is set.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3983
11160
d0a20101ecb2 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 11063
diff changeset
3984 *'hlsearch'* *'hls'* *'nohlsearch'* *'nohls'*
d0a20101ecb2 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 11063
diff changeset
3985 'hlsearch' 'hls' boolean (default off)
d0a20101ecb2 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 11063
diff changeset
3986 global
d0a20101ecb2 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 11063
diff changeset
3987 {not available when compiled without the
d0a20101ecb2 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 11063
diff changeset
3988 |+extra_search| feature}
d0a20101ecb2 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 11063
diff changeset
3989 When there is a previous search pattern, highlight all its matches.
d0a20101ecb2 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 11063
diff changeset
3990 The type of highlighting used can be set with the 'l' occasion in the
d0a20101ecb2 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 11063
diff changeset
3991 'highlight' option. This uses the "Search" highlight group by
d0a20101ecb2 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 11063
diff changeset
3992 default. Note that only the matching text is highlighted, any offsets
d0a20101ecb2 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 11063
diff changeset
3993 are not applied.
d0a20101ecb2 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 11063
diff changeset
3994 See also: 'incsearch' and |:match|.
d0a20101ecb2 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 11063
diff changeset
3995 When you get bored looking at the highlighted matches, you can turn it
d0a20101ecb2 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 11063
diff changeset
3996 off with |:nohlsearch|. This does not change the option value, as
d0a20101ecb2 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 11063
diff changeset
3997 soon as you use a search command, the highlighting comes back.
d0a20101ecb2 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 11063
diff changeset
3998 'redrawtime' specifies the maximum time spent on finding matches.
d0a20101ecb2 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 11063
diff changeset
3999 When the search pattern can match an end-of-line, Vim will try to
d0a20101ecb2 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 11063
diff changeset
4000 highlight all of the matched text. However, this depends on where the
d0a20101ecb2 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 11063
diff changeset
4001 search starts. This will be the first line in the window or the first
d0a20101ecb2 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 11063
diff changeset
4002 line below a closed fold. A match in a previous line which is not
d0a20101ecb2 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 11063
diff changeset
4003 drawn may not continue in a newly drawn line.
d0a20101ecb2 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 11063
diff changeset
4004 You can specify whether the highlight status is restored on startup
d0a20101ecb2 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 11063
diff changeset
4005 with the 'h' flag in 'viminfo' |viminfo-h|.
d0a20101ecb2 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 11063
diff changeset
4006 NOTE: This option is reset when 'compatible' is set.
d0a20101ecb2 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 11063
diff changeset
4007
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4008 *'icon'* *'noicon'*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4009 'icon' boolean (default off, on when title can be restored)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4010 global
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4011 {not available when compiled without the |+title|
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4012 feature}
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4013 When on, the icon text of the window will be set to the value of
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4014 'iconstring' (if it is not empty), or to the name of the file
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4015 currently being edited. Only the last part of the name is used.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4016 Overridden by the 'iconstring' option.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4017 Only works if the terminal supports setting window icons (currently
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4018 only X11 GUI and terminals with a non-empty 't_IS' option - these are
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4019 Unix xterm and iris-ansi by default, where 't_IS' is taken from the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4020 builtin termcap).
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4021 When Vim was compiled with HAVE_X11 defined, the original icon will be
233
fca8a9b65afa updated for version 7.0065
vimboss
parents: 227
diff changeset
4022 restored if possible |X11|. See |X11-icon| for changing the icon on
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4023 X11.
6259
bd18da914be9 Update runtime files.
Bram Moolenaar <bram@vim.org>
parents: 6243
diff changeset
4024 For MS-Windows the icon can be changed, see |windows-icon|.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4025
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4026 *'iconstring'*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4027 'iconstring' string (default "")
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4028 global
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4029 {not available when compiled without the |+title|
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4030 feature}
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4031 When this option is not empty, it will be used for the icon text of
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4032 the window. This happens only when the 'icon' option is on.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4033 Only works if the terminal supports setting window icon text
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4034 (currently only X11 GUI and terminals with a non-empty 't_IS' option).
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4035 Does not work for MS Windows.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4036 When Vim was compiled with HAVE_X11 defined, the original icon will be
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4037 restored if possible |X11|.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4038 When this option contains printf-style '%' items, they will be
10
4e2284e71352 updated for version 7.0002
vimboss
parents: 8
diff changeset
4039 expanded according to the rules used for 'statusline'. See
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4040 '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
4041 This option cannot be set in a modeline when 'modelineexpr' is off.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4042 {not available when compiled without the |+statusline| feature}
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4043
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4044 *'ignorecase'* *'ic'* *'noignorecase'* *'noic'*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4045 'ignorecase' 'ic' boolean (default off)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4046 global
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4047 Ignore case in search patterns. Also used when searching in the tags
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4048 file.
7266
6ba7182fb7bd commit https://github.com/vim/vim/commit/0f6562e9036f889185dff49a75c7fc5ffb28b307
Christian Brabandt <cb@256bit.org>
parents: 7245
diff changeset
4049 Also see 'smartcase' and 'tagcase'.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4050 Can be overruled by using "\c" or "\C" in the pattern, see
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4051 |/ignorecase|.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4052
5008
3717d569027d updated for version 7.3.1248
Bram Moolenaar <bram@vim.org>
parents: 4869
diff changeset
4053 *'imactivatefunc'* *'imaf'*
3717d569027d updated for version 7.3.1248
Bram Moolenaar <bram@vim.org>
parents: 4869
diff changeset
4054 'imactivatefunc' 'imaf' string (default "")
3717d569027d updated for version 7.3.1248
Bram Moolenaar <bram@vim.org>
parents: 4869
diff changeset
4055 global
3717d569027d updated for version 7.3.1248
Bram Moolenaar <bram@vim.org>
parents: 4869
diff changeset
4056 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
4057 activate or deactivate the Input Method.
c53a80f39a52 patch 8.0.1344: using 'imactivatefunc' in the GUI does not work
Christian Brabandt <cb@256bit.org>
parents: 12934
diff changeset
4058 It is not used in the GUI.
16728
e55c26aaf484 patch 8.1.1366: using expressions in a modeline is unsafe
Bram Moolenaar <Bram@vim.org>
parents: 16610
diff changeset
4059 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
4060 modeline, see |sandbox-option|.
5008
3717d569027d updated for version 7.3.1248
Bram Moolenaar <bram@vim.org>
parents: 4869
diff changeset
4061
3717d569027d updated for version 7.3.1248
Bram Moolenaar <bram@vim.org>
parents: 4869
diff changeset
4062 Example: >
3717d569027d updated for version 7.3.1248
Bram Moolenaar <bram@vim.org>
parents: 4869
diff changeset
4063 function ImActivateFunc(active)
3717d569027d updated for version 7.3.1248
Bram Moolenaar <bram@vim.org>
parents: 4869
diff changeset
4064 if a:active
3717d569027d updated for version 7.3.1248
Bram Moolenaar <bram@vim.org>
parents: 4869
diff changeset
4065 ... do something
3717d569027d updated for version 7.3.1248
Bram Moolenaar <bram@vim.org>
parents: 4869
diff changeset
4066 else
3717d569027d updated for version 7.3.1248
Bram Moolenaar <bram@vim.org>
parents: 4869
diff changeset
4067 ... do something
3717d569027d updated for version 7.3.1248
Bram Moolenaar <bram@vim.org>
parents: 4869
diff changeset
4068 endif
3717d569027d updated for version 7.3.1248
Bram Moolenaar <bram@vim.org>
parents: 4869
diff changeset
4069 " return value is not used
3717d569027d updated for version 7.3.1248
Bram Moolenaar <bram@vim.org>
parents: 4869
diff changeset
4070 endfunction
3717d569027d updated for version 7.3.1248
Bram Moolenaar <bram@vim.org>
parents: 4869
diff changeset
4071 set imactivatefunc=ImActivateFunc
3717d569027d updated for version 7.3.1248
Bram Moolenaar <bram@vim.org>
parents: 4869
diff changeset
4072 <
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4073 *'imactivatekey'* *'imak'*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4074 'imactivatekey' 'imak' string (default "")
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4075 global
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4076 {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
4077 |+GUI_GTK|} *E599*
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4078 Specifies the key that your Input Method in X-Windows uses for
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4079 activation. When this is specified correctly, vim can fully control
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4080 IM with 'imcmdline', 'iminsert' and 'imsearch'.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4081 You can't use this option to change the activation key, the option
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4082 tells Vim what the key is.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4083 Format:
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4084 [MODIFIER_FLAG-]KEY_STRING
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4085
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4086 These characters can be used for MODIFIER_FLAG (case is ignored):
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4087 S Shift key
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4088 L Lock key
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4089 C Control key
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4090 1 Mod1 key
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4091 2 Mod2 key
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4092 3 Mod3 key
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4093 4 Mod4 key
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4094 5 Mod5 key
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4095 Combinations are allowed, for example "S-C-space" or "SC-space" are
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4096 both shift+ctrl+space.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4097 See <X11/keysymdef.h> and XStringToKeysym for KEY_STRING.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4098
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4099 Example: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4100 :set imactivatekey=S-space
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4101 < "S-space" means shift+space. This is the activation key for kinput2 +
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4102 canna (Japanese), and ami (Korean).
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4103
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4104 *'imcmdline'* *'imc'* *'noimcmdline'* *'noimc'*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4105 'imcmdline' 'imc' boolean (default off)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4106 global
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4107 When set the Input Method is always on when starting to edit a command
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4108 line, unless entering a search pattern (see 'imsearch' for that).
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4109 Setting this option is useful when your input method allows entering
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4110 English characters directly, e.g., when it's used to type accented
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4111 characters with dead keys.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4112
2033
de5a43c5eedc Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents: 1904
diff changeset
4113 *'imdisable'* *'imd'* *'noimdisable'* *'noimd'*
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4114 'imdisable' 'imd' boolean (default off, on for some systems (SGI))
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4115 global
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4116 When set the Input Method is never used. This is useful to disable
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4117 the IM when it doesn't work properly.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4118 Currently this option is on by default for SGI/IRIX machines. This
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4119 may change in later releases.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4120
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4121 *'iminsert'* *'imi'*
12469
61d910f0999d patch 8.0.1114: default for 'iminsert' is annoying
Christian Brabandt <cb@256bit.org>
parents: 12317
diff changeset
4122 'iminsert' 'imi' number (default 0)
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4123 local to buffer
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4124 Specifies whether :lmap or an Input Method (IM) is to be used in
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4125 Insert mode. Valid values:
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4126 0 :lmap is off and IM is off
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4127 1 :lmap is ON and IM is off
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4128 2 :lmap is off and IM is ON
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4129 To always reset the option to zero when leaving Insert mode with <Esc>
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4130 this can be used: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4131 :inoremap <ESC> <ESC>:set iminsert=0<CR>
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4132 < This makes :lmap and IM turn off automatically when leaving Insert
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4133 mode.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4134 Note that this option changes when using CTRL-^ in Insert mode
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4135 |i_CTRL-^|.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4136 The value is set to 1 when setting 'keymap' to a valid keymap name.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4137 It is also used for the argument of commands like "r" and "f".
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4138 The value 0 may not work correctly with Athena and Motif with some XIM
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4139 methods. Use 'imdisable' to disable XIM then.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4140
12920
327e1264b9bf patch 8.0.1336: cannot use imactivatefunc() unless compiled with +xim
Christian Brabandt <cb@256bit.org>
parents: 12865
diff changeset
4141 You can set 'imactivatefunc' and 'imstatusfunc' to handle IME/XIM
14519
5c5908e81e93 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 14475
diff changeset
4142 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
4143 |+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
4144
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4145 *'imsearch'* *'ims'*
12469
61d910f0999d patch 8.0.1114: default for 'iminsert' is annoying
Christian Brabandt <cb@256bit.org>
parents: 12317
diff changeset
4146 'imsearch' 'ims' number (default -1)
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4147 local to buffer
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4148 Specifies whether :lmap or an Input Method (IM) is to be used when
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4149 entering a search pattern. Valid values:
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4150 -1 the value of 'iminsert' is used, makes it look like
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4151 'iminsert' is also used when typing a search pattern
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4152 0 :lmap is off and IM is off
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4153 1 :lmap is ON and IM is off
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4154 2 :lmap is off and IM is ON
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4155 Note that this option changes when using CTRL-^ in Command-line mode
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4156 |c_CTRL-^|.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4157 The value is set to 1 when it is not -1 and setting the 'keymap'
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4158 option to a valid keymap name.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4159 The value 0 may not work correctly with Athena and Motif with some XIM
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4160 methods. Use 'imdisable' to disable XIM then.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4161
5008
3717d569027d updated for version 7.3.1248
Bram Moolenaar <bram@vim.org>
parents: 4869
diff changeset
4162 *'imstatusfunc'* *'imsf'*
3717d569027d updated for version 7.3.1248
Bram Moolenaar <bram@vim.org>
parents: 4869
diff changeset
4163 'imstatusfunc' 'imsf' string (default "")
3717d569027d updated for version 7.3.1248
Bram Moolenaar <bram@vim.org>
parents: 4869
diff changeset
4164 global
3717d569027d updated for version 7.3.1248
Bram Moolenaar <bram@vim.org>
parents: 4869
diff changeset
4165 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
4166 of Input Method. It must return a positive number when IME is active.
12936
c53a80f39a52 patch 8.0.1344: using 'imactivatefunc' in the GUI does not work
Christian Brabandt <cb@256bit.org>
parents: 12934
diff changeset
4167 It is not used in the GUI.
5008
3717d569027d updated for version 7.3.1248
Bram Moolenaar <bram@vim.org>
parents: 4869
diff changeset
4168
3717d569027d updated for version 7.3.1248
Bram Moolenaar <bram@vim.org>
parents: 4869
diff changeset
4169 Example: >
3717d569027d updated for version 7.3.1248
Bram Moolenaar <bram@vim.org>
parents: 4869
diff changeset
4170 function ImStatusFunc()
3717d569027d updated for version 7.3.1248
Bram Moolenaar <bram@vim.org>
parents: 4869
diff changeset
4171 let is_active = ...do something
3717d569027d updated for version 7.3.1248
Bram Moolenaar <bram@vim.org>
parents: 4869
diff changeset
4172 return is_active ? 1 : 0
3717d569027d updated for version 7.3.1248
Bram Moolenaar <bram@vim.org>
parents: 4869
diff changeset
4173 endfunction
3717d569027d updated for version 7.3.1248
Bram Moolenaar <bram@vim.org>
parents: 4869
diff changeset
4174 set imstatusfunc=ImStatusFunc
3717d569027d updated for version 7.3.1248
Bram Moolenaar <bram@vim.org>
parents: 4869
diff changeset
4175 <
3717d569027d updated for version 7.3.1248
Bram Moolenaar <bram@vim.org>
parents: 4869
diff changeset
4176 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
4177 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
4178 modeline, see |sandbox-option|.
5008
3717d569027d updated for version 7.3.1248
Bram Moolenaar <bram@vim.org>
parents: 4869
diff changeset
4179
12293
1ff5e5dfa9b0 patch 8.0.1026: GTK on-the-spot input has problems
Christian Brabandt <cb@256bit.org>
parents: 12254
diff changeset
4180 *'imstyle'* *'imst'*
1ff5e5dfa9b0 patch 8.0.1026: GTK on-the-spot input has problems
Christian Brabandt <cb@256bit.org>
parents: 12254
diff changeset
4181 '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
4182 global
1ff5e5dfa9b0 patch 8.0.1026: GTK on-the-spot input has problems
Christian Brabandt <cb@256bit.org>
parents: 12254
diff changeset
4183 {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
4184 |+GUI_GTK|}
12499
d91cf2e26ef0 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 12469
diff changeset
4185 This option specifies the input style of Input Method:
d91cf2e26ef0 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 12469
diff changeset
4186 0 use on-the-spot style
d91cf2e26ef0 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 12469
diff changeset
4187 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
4188 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
4189
12559
34c8ec888122 Update runtime files
Christian Brabandt <cb@256bit.org>
parents: 12499
diff changeset
4190 For a long time on-the-spot style had been used in the GTK version of
34c8ec888122 Update runtime files
Christian Brabandt <cb@256bit.org>
parents: 12499
diff changeset
4191 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
4192 |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
4193 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
4194 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
4195 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
4196 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
4197
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4198 *'include'* *'inc'*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4199 'include' 'inc' string (default "^\s*#\s*include")
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4200 global or local to buffer |global-local|
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4201 {not available when compiled without the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4202 |+find_in_path| feature}
10
4e2284e71352 updated for version 7.0002
vimboss
parents: 8
diff changeset
4203 Pattern to be used to find an include command. It is a search
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4204 pattern, just like for the "/" command (See |pattern|). The default
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4205 value is for C programs. This option is used for the commands "[i",
532
7052f11a3dc9 updated for version 7.0150
vimboss
parents: 523
diff changeset
4206 "]I", "[d", etc.
7052f11a3dc9 updated for version 7.0150
vimboss
parents: 523
diff changeset
4207 Normally the 'isfname' option is used to recognize the file name that
534
c6296b0ad9ea updated for version 7.0151
vimboss
parents: 532
diff changeset
4208 comes after the matched pattern. But if "\zs" appears in the pattern
c6296b0ad9ea updated for version 7.0151
vimboss
parents: 532
diff changeset
4209 then the text matched from "\zs" to the end, or until "\ze" if it
c6296b0ad9ea updated for version 7.0151
vimboss
parents: 532
diff changeset
4210 appears, is used as the file name. Use this to include characters
c6296b0ad9ea updated for version 7.0151
vimboss
parents: 532
diff changeset
4211 that are not in 'isfname', such as a space. You can then use
c6296b0ad9ea updated for version 7.0151
vimboss
parents: 532
diff changeset
4212 'includeexpr' to process the matched text.
532
7052f11a3dc9 updated for version 7.0150
vimboss
parents: 523
diff changeset
4213 See |option-backslash| about including spaces and backslashes.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4214
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4215 *'includeexpr'* *'inex'*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4216 'includeexpr' 'inex' string (default "")
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4217 local to buffer
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4218 {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
4219 |+find_in_path| or |+eval| features}
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4220 Expression to be used to transform the string found with the 'include'
10
4e2284e71352 updated for version 7.0002
vimboss
parents: 8
diff changeset
4221 option to a file name. Mostly useful to change "." to "/" for Java: >
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4222 :set includeexpr=substitute(v:fname,'\\.','/','g')
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4223 < The "v:fname" variable will be set to the file name that was detected.
634
1c586ee8dd45 updated for version 7.0183
vimboss
parents: 632
diff changeset
4224
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4225 Also used for the |gf| command if an unmodified file name can't be
10
4e2284e71352 updated for version 7.0002
vimboss
parents: 8
diff changeset
4226 found. Allows doing "gf" on the name after an 'include' statement.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4227 Also used for |<cfile>|.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4228
3682
11d40fc82f11 Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 3674
diff changeset
4229 The expression will be evaluated in the |sandbox| when set from a
11d40fc82f11 Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 3674
diff changeset
4230 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
4231 This option cannot be set in a modeline when 'modelineexpr' is off.
634
1c586ee8dd45 updated for version 7.0183
vimboss
parents: 632
diff changeset
4232
1c586ee8dd45 updated for version 7.0183
vimboss
parents: 632
diff changeset
4233 It is not allowed to change text or jump to another window while
1c586ee8dd45 updated for version 7.0183
vimboss
parents: 632
diff changeset
4234 evaluating 'includeexpr' |textlock|.
1c586ee8dd45 updated for version 7.0183
vimboss
parents: 632
diff changeset
4235
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4236 *'incsearch'* *'is'* *'noincsearch'* *'nois'*
9669
284b4eb307fc commit https://github.com/vim/vim/commit/8c08b5b569e2a9e9f63dea514591ecfa2d3bb392
Christian Brabandt <cb@256bit.org>
parents: 9665
diff changeset
4237 '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
4238 +reltime feature is supported)
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4239 global
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4240 {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
4241 |+extra_search| features}
17
9be87deaeb52 updated for version 7.0009
vimboss
parents: 15
diff changeset
4242 While typing a search command, show where the pattern, as it was typed
9be87deaeb52 updated for version 7.0009
vimboss
parents: 15
diff changeset
4243 so far, matches. The matched string is highlighted. If the pattern
9be87deaeb52 updated for version 7.0009
vimboss
parents: 15
diff changeset
4244 is invalid or not found, nothing is shown. The screen will be updated
9be87deaeb52 updated for version 7.0009
vimboss
parents: 15
diff changeset
4245 often, this is only useful on fast terminals.
14637
0ecb909e3249 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 14519
diff changeset
4246 Also applies to the pattern in commands: >
0ecb909e3249 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 14519
diff changeset
4247 :global
0ecb909e3249 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 14519
diff changeset
4248 :lvimgrep
0ecb909e3249 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 14519
diff changeset
4249 :lvimgrepadd
0ecb909e3249 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 14519
diff changeset
4250 :smagic
0ecb909e3249 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 14519
diff changeset
4251 :snomagic
0ecb909e3249 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 14519
diff changeset
4252 :sort
0ecb909e3249 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 14519
diff changeset
4253 :substitute
0ecb909e3249 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 14519
diff changeset
4254 :vglobal
0ecb909e3249 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 14519
diff changeset
4255 :vimgrep
0ecb909e3249 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 14519
diff changeset
4256 :vimgrepadd
0ecb909e3249 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 14519
diff changeset
4257 < Note that the match will be shown, but the cursor will return to its
17
9be87deaeb52 updated for version 7.0009
vimboss
parents: 15
diff changeset
4258 original position when no match is found and when pressing <Esc>. You
9be87deaeb52 updated for version 7.0009
vimboss
parents: 15
diff changeset
4259 still need to finish the search command with <Enter> to move the
9be87deaeb52 updated for version 7.0009
vimboss
parents: 15
diff changeset
4260 cursor to the match.
10261
bdd7fc1a38c0 commit https://github.com/vim/vim/commit/dc08328821a2c11e33dfb1980332e4923ec64fca
Christian Brabandt <cb@256bit.org>
parents: 10244
diff changeset
4261 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
4262 previous match. |c_CTRL-G| |c_CTRL-T|
1521
cc4fe241baa3 updated for version 7.1-236
vimboss
parents: 1354
diff changeset
4263 When compiled with the |+reltime| feature Vim only searches for about
cc4fe241baa3 updated for version 7.1-236
vimboss
parents: 1354
diff changeset
4264 half a second. With a complicated pattern and/or a lot of text the
cc4fe241baa3 updated for version 7.1-236
vimboss
parents: 1354
diff changeset
4265 match may not be found. This is to avoid that Vim hangs while you
cc4fe241baa3 updated for version 7.1-236
vimboss
parents: 1354
diff changeset
4266 are typing the pattern.
17
9be87deaeb52 updated for version 7.0009
vimboss
parents: 15
diff changeset
4267 The highlighting can be set with the 'i' flag in 'highlight'.
12968
45987b1b77dc Update runtime files
Christian Brabandt <cb@256bit.org>
parents: 12936
diff changeset
4268 When 'hlsearch' is on, all matched strings are highlighted too while
45987b1b77dc Update runtime files
Christian Brabandt <cb@256bit.org>
parents: 12936
diff changeset
4269 typing a search command. See also: 'hlsearch'.
14519
5c5908e81e93 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 14475
diff changeset
4270 If you don't want to turn 'hlsearch' on, but want to highlight all
5c5908e81e93 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 14475
diff changeset
4271 matches while searching, you can turn on and off 'hlsearch' with
5c5908e81e93 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 14475
diff changeset
4272 autocmd. Example: >
12720
37c384802df4 patch 8.0.1238: incremental search only shows one match
Christian Brabandt <cb@256bit.org>
parents: 12608
diff changeset
4273 augroup vimrc-incsearch-highlight
37c384802df4 patch 8.0.1238: incremental search only shows one match
Christian Brabandt <cb@256bit.org>
parents: 12608
diff changeset
4274 autocmd!
12744
0c704288ced4 patch 8.0.1250: 'hlsearch' highlighting not removed after incsearch
Christian Brabandt <cb@256bit.org>
parents: 12720
diff changeset
4275 autocmd CmdlineEnter /,\? :set hlsearch
0c704288ced4 patch 8.0.1250: 'hlsearch' highlighting not removed after incsearch
Christian Brabandt <cb@256bit.org>
parents: 12720
diff changeset
4276 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
4277 augroup END
37c384802df4 patch 8.0.1238: incremental search only shows one match
Christian Brabandt <cb@256bit.org>
parents: 12608
diff changeset
4278 <
772
aaaca5077255 updated for version 7.0226
vimboss
parents: 766
diff changeset
4279 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
4280 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
4281 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
4282 converted to lowercase.
772
aaaca5077255 updated for version 7.0226
vimboss
parents: 766
diff changeset
4283 CTRL-R CTRL-W can be used to add the word at the end of the current
aaaca5077255 updated for version 7.0226
vimboss
parents: 766
diff changeset
4284 match, excluding the characters that were already typed.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4285 NOTE: This option is reset when 'compatible' is set.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4286
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4287 *'indentexpr'* *'inde'*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4288 'indentexpr' 'inde' string (default "")
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4289 local to buffer
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4290 {not available when compiled without the |+cindent|
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4291 or |+eval| features}
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4292 Expression which is evaluated to obtain the proper indent for a line.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4293 It is used when a new line is created, for the |=| operator and
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4294 in Insert mode as specified with the 'indentkeys' option.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4295 When this option is not empty, it overrules the 'cindent' and
2833
c869ff170ddc Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 2826
diff changeset
4296 'smartindent' indenting. When 'lisp' is set, this option is
c869ff170ddc Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 2826
diff changeset
4297 overridden by the Lisp indentation algorithm.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4298 When 'paste' is set this option is not used for indenting.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4299 The expression is evaluated with |v:lnum| set to the line number for
534
c6296b0ad9ea updated for version 7.0151
vimboss
parents: 532
diff changeset
4300 which the indent is to be computed. The cursor is also in this line
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4301 when the expression is evaluated (but it may be moved around).
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4302 The expression must return the number of spaces worth of indent. It
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4303 can return "-1" to keep the current indent (this means 'autoindent' is
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4304 used for the indent).
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4305 Functions useful for computing the indent are |indent()|, |cindent()|
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4306 and |lispindent()|.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4307 The evaluation of the expression must not have side effects! It must
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4308 not change the text, jump to another window, etc. Afterwards the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4309 cursor position is always restored, thus the cursor may be moved.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4310 Normally this option would be set to call a function: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4311 :set indentexpr=GetMyIndent()
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4312 < Error messages will be suppressed, unless the 'debug' option contains
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4313 "msg".
634
1c586ee8dd45 updated for version 7.0183
vimboss
parents: 632
diff changeset
4314 See |indent-expression|.
11160
d0a20101ecb2 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 11063
diff changeset
4315 NOTE: This option is set to "" when 'compatible' is set.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4316
3682
11d40fc82f11 Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 3674
diff changeset
4317 The expression will be evaluated in the |sandbox| when set from a
11d40fc82f11 Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 3674
diff changeset
4318 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
4319 This option cannot be set in a modeline when 'modelineexpr' is off.
634
1c586ee8dd45 updated for version 7.0183
vimboss
parents: 632
diff changeset
4320
1c586ee8dd45 updated for version 7.0183
vimboss
parents: 632
diff changeset
4321 It is not allowed to change text or jump to another window while
1c586ee8dd45 updated for version 7.0183
vimboss
parents: 632
diff changeset
4322 evaluating 'indentexpr' |textlock|.
1c586ee8dd45 updated for version 7.0183
vimboss
parents: 632
diff changeset
4323
1c586ee8dd45 updated for version 7.0183
vimboss
parents: 632
diff changeset
4324
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4325 *'indentkeys'* *'indk'*
15701
9cd11f6beb70 patch 8.1.0858: 'indentkeys' and 'cinkeys' defaults are different
Bram Moolenaar <Bram@vim.org>
parents: 15512
diff changeset
4326 'indentkeys' 'indk' string (default "0{,0},0),0],:,0#,!^F,o,O,e")
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4327 local to buffer
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4328 {not available when compiled without the |+cindent|
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4329 feature}
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4330 A list of keys that, when typed in Insert mode, cause reindenting of
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4331 the current line. Only happens if 'indentexpr' isn't empty.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4332 The format is identical to 'cinkeys', see |indentkeys-format|.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4333 See |C-indenting| and |indent-expression|.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4334
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4335 *'infercase'* *'inf'* *'noinfercase'* *'noinf'*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4336 'infercase' 'inf' boolean (default off)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4337 local to buffer
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4338 When doing keyword completion in insert mode |ins-completion|, and
1621
82b5078be2dd updated for version 7.2a
vimboss
parents: 1564
diff changeset
4339 'ignorecase' is also on, the case of the match is adjusted depending
82b5078be2dd updated for version 7.2a
vimboss
parents: 1564
diff changeset
4340 on the typed text. If the typed text contains a lowercase letter
82b5078be2dd updated for version 7.2a
vimboss
parents: 1564
diff changeset
4341 where the match has an upper case letter, the completed part is made
82b5078be2dd updated for version 7.2a
vimboss
parents: 1564
diff changeset
4342 lowercase. If the typed text has no lowercase letters and the match
82b5078be2dd updated for version 7.2a
vimboss
parents: 1564
diff changeset
4343 has a lowercase letter where the typed text has an uppercase letter,
82b5078be2dd updated for version 7.2a
vimboss
parents: 1564
diff changeset
4344 and there is a letter before it, the completed part is made uppercase.
82b5078be2dd updated for version 7.2a
vimboss
parents: 1564
diff changeset
4345 With 'noinfercase' the match is used as-is.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4346
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4347 *'insertmode'* *'im'* *'noinsertmode'* *'noim'*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4348 'insertmode' 'im' boolean (default off)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4349 global
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4350 Makes Vim work in a way that Insert mode is the default mode. Useful
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4351 if you want to use Vim as a modeless editor. Used for |evim|.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4352 These Insert mode commands will be useful:
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4353 - 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
4354 - Use CTRL-O to execute one Normal mode command |i_CTRL-O|. When
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4355 this is a mapping, it is executed as if 'insertmode' was off.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4356 Normal mode remains active until the mapping is finished.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4357 - Use CTRL-L to execute a number of Normal mode commands, then use
477
f8b75b8f1988 updated for version 7.0128
vimboss
parents: 464
diff changeset
4358 <Esc> to get back to Insert mode. Note that CTRL-L moves the cursor
f8b75b8f1988 updated for version 7.0128
vimboss
parents: 464
diff changeset
4359 left, like <Esc> does when 'insertmode' isn't set. |i_CTRL-L|
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4360
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4361 These items change when 'insertmode' is set:
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4362 - when starting to edit of a file, Vim goes to Insert mode.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4363 - <Esc> in Insert mode is a no-op and beeps.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4364 - <Esc> in Normal mode makes Vim go to Insert mode.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4365 - CTRL-L in Insert mode is a command, it is not inserted.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4366 - CTRL-Z in Insert mode suspends Vim, see |CTRL-Z|. *i_CTRL-Z*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4367 However, when <Esc> is used inside a mapping, it behaves like
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4368 'insertmode' was not set. This was done to be able to use the same
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4369 mappings with 'insertmode' set or not set.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4370 When executing commands with |:normal| 'insertmode' is not used.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4371
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4372 NOTE: This option is reset when 'compatible' is set.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4373
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4374 *'isfname'* *'isf'*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4375 'isfname' 'isf' string (default for MS-DOS, Win32 and OS/2:
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4376 "@,48-57,/,\,.,-,_,+,,,#,$,%,{,},[,],:,@-@,!,~,="
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4377 for AMIGA: "@,48-57,/,.,-,_,+,,,$,:"
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4378 for VMS: "@,48-57,/,.,-,_,+,,,#,$,%,<,>,[,],:,;,~"
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4379 for OS/390: "@,240-249,/,.,-,_,+,,,#,$,%,~,="
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4380 otherwise: "@,48-57,/,.,-,_,+,,,#,$,%,~,=")
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4381 global
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4382 The characters specified by this option are included in file names and
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4383 path names. Filenames are used for commands like "gf", "[i" and in
10
4e2284e71352 updated for version 7.0002
vimboss
parents: 8
diff changeset
4384 the tags file. It is also used for "\f" in a |pattern|.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4385 Multi-byte characters 256 and above are always included, only the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4386 characters up to 255 are specified with this option.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4387 For UTF-8 the characters 0xa0 to 0xff are included as well.
1621
82b5078be2dd updated for version 7.2a
vimboss
parents: 1564
diff changeset
4388 Think twice before adding white space to this option. Although a
82b5078be2dd updated for version 7.2a
vimboss
parents: 1564
diff changeset
4389 space may appear inside a file name, the effect will be that Vim
82b5078be2dd updated for version 7.2a
vimboss
parents: 1564
diff changeset
4390 doesn't know where a file name starts or ends when doing completion.
82b5078be2dd updated for version 7.2a
vimboss
parents: 1564
diff changeset
4391 It most likely works better without a space in 'isfname'.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4392
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4393 Note that on systems using a backslash as path separator, Vim tries to
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4394 do its best to make it work as you would expect. That is a bit
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4395 tricky, since Vi originally used the backslash to escape special
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4396 characters. Vim will not remove a backslash in front of a normal file
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4397 name character on these systems, but it will on Unix and alikes. The
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4398 '&' and '^' are not included by default, because these are special for
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4399 cmd.exe.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4400
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4401 The format of this option is a list of parts, separated with commas.
10
4e2284e71352 updated for version 7.0002
vimboss
parents: 8
diff changeset
4402 Each part can be a single character number or a range. A range is two
4e2284e71352 updated for version 7.0002
vimboss
parents: 8
diff changeset
4403 character numbers with '-' in between. A character number can be a
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4404 decimal number between 0 and 255 or the ASCII character itself (does
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4405 not work for digits). Example:
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4406 "_,-,128-140,#-43" (include '_' and '-' and the range
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4407 128 to 140 and '#' to 43)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4408 If a part starts with '^', the following character number or range
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4409 will be excluded from the option. The option is interpreted from left
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4410 to right. Put the excluded character after the range where it is
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4411 included. To include '^' itself use it as the last character of the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4412 option or the end of a range. Example:
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4413 "^a-z,#,^" (exclude 'a' to 'z', include '#' and '^')
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4414 If the character is '@', all characters where isalpha() returns TRUE
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4415 are included. Normally these are the characters a to z and A to Z,
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4416 plus accented characters. To include '@' itself use "@-@". Examples:
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4417 "@,^a-z" All alphabetic characters, excluding lower
1621
82b5078be2dd updated for version 7.2a
vimboss
parents: 1564
diff changeset
4418 case ASCII letters.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4419 "a-z,A-Z,@-@" All letters plus the '@' character.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4420 A comma can be included by using it where a character number is
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4421 expected. Example:
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4422 "48-57,,,_" Digits, comma and underscore.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4423 A comma can be excluded by prepending a '^'. Example:
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4424 " -~,^,,9" All characters from space to '~', excluding
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4425 comma, plus <Tab>.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4426 See |option-backslash| about including spaces and backslashes.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4427
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4428 *'isident'* *'isi'*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4429 'isident' 'isi' string (default for MS-DOS, Win32 and OS/2:
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4430 "@,48-57,_,128-167,224-235"
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4431 otherwise: "@,48-57,_,192-255")
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4432 global
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4433 The characters given by this option are included in identifiers.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4434 Identifiers are used in recognizing environment variables and after a
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4435 match of the 'define' option. It is also used for "\i" in a
233
fca8a9b65afa updated for version 7.0065
vimboss
parents: 227
diff changeset
4436 |pattern|. See 'isfname' for a description of the format of this
14864
40ef13331e02 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 14702
diff changeset
4437 option. For '@' only characters up to 255 are used.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4438 Careful: If you change this option, it might break expanding
10
4e2284e71352 updated for version 7.0002
vimboss
parents: 8
diff changeset
4439 environment variables. E.g., when '/' is included and Vim tries to
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4440 expand "$HOME/.viminfo". Maybe you should change 'iskeyword' instead.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4441
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4442 *'iskeyword'* *'isk'*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4443 'iskeyword' 'isk' string (Vim default for MS-DOS and Win32:
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4444 "@,48-57,_,128-167,224-235"
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4445 otherwise: "@,48-57,_,192-255"
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4446 Vi default: "@,48-57,_")
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4447 local to buffer
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4448 Keywords are used in searching and recognizing with many commands:
10
4e2284e71352 updated for version 7.0002
vimboss
parents: 8
diff changeset
4449 "w", "*", "[i", etc. It is also used for "\k" in a |pattern|. See
14864
40ef13331e02 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 14702
diff changeset
4450 'isfname' for a description of the format of this option. For '@'
40ef13331e02 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 14702
diff changeset
4451 characters above 255 check the "word" character class.
40ef13331e02 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 14702
diff changeset
4452 For C programs you could use "a-z,A-Z,48-57,_,.,-,>".
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4453 For a help file it is set to all non-blank printable characters except
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4454 '*', '"' and '|' (so that CTRL-] on a command finds the help for that
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4455 command).
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4456 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
4457 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
4458 uses |:syn-iskeyword|.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4459 NOTE: This option is set to the Vi default value when 'compatible' is
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4460 set and to the Vim default value when 'compatible' is reset.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4461
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4462 *'isprint'* *'isp'*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4463 'isprint' 'isp' string (default for MS-DOS, Win32, OS/2 and Macintosh:
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4464 "@,~-255"; otherwise: "@,161-255")
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4465 global
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4466 The characters given by this option are displayed directly on the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4467 screen. It is also used for "\p" in a |pattern|. The characters from
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4468 space (ASCII 32) to '~' (ASCII 126) are always displayed directly,
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4469 even when they are not included in 'isprint' or excluded. See
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4470 'isfname' for a description of the format of this option.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4471
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4472 Non-printable characters are displayed with two characters:
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4473 0 - 31 "^@" - "^_"
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4474 32 - 126 always single characters
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4475 127 "^?"
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4476 128 - 159 "~@" - "~_"
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4477 160 - 254 "| " - "|~"
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4478 255 "~?"
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4479 When 'encoding' is a Unicode one, illegal bytes from 128 to 255 are
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4480 displayed as <xx>, with the hexadecimal value of the byte.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4481 When 'display' contains "uhex" all unprintable characters are
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4482 displayed as <xx>.
2033
de5a43c5eedc Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents: 1904
diff changeset
4483 The SpecialKey highlighting will be used for unprintable characters.
de5a43c5eedc Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents: 1904
diff changeset
4484 |hl-SpecialKey|
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4485
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4486 Multi-byte characters 256 and above are always included, only the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4487 characters up to 255 are specified with this option. When a character
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4488 is printable but it is not available in the current font, a
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4489 replacement character will be shown.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4490 Unprintable and zero-width Unicode characters are displayed as <xxxx>.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4491 There is no option to specify these characters.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4492
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4493 *'joinspaces'* *'js'* *'nojoinspaces'* *'nojs'*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4494 'joinspaces' 'js' boolean (default on)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4495 global
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4496 Insert two spaces after a '.', '?' and '!' with a join command.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4497 When 'cpoptions' includes the 'j' flag, only do this after a '.'.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4498 Otherwise only one space is inserted.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4499 NOTE: This option is set when 'compatible' is set.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4500
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4501 *'key'*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4502 'key' string (default "")
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4503 local to buffer
2283
7e1bd501306d Mainly documentation updates.
Bram Moolenaar <bram@vim.org>
parents: 2265
diff changeset
4504 {only available when compiled with the |+cryptv|
7e1bd501306d Mainly documentation updates.
Bram Moolenaar <bram@vim.org>
parents: 2265
diff changeset
4505 feature}
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4506 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
4507 See |encryption| and 'cryptmethod'.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4508 Careful: Do not set the key value by hand, someone might see the typed
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4509 key. Use the |:X| command. But you can make 'key' empty: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4510 :set key=
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4511 < It is not possible to get the value of this option with ":set key" or
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4512 "echo &key". This is to avoid showing it to someone who shouldn't
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4513 know. It also means you cannot see it yourself once you have set it,
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4514 be careful not to make a typing error!
2698
b6471224d2af Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents: 2681
diff changeset
4515 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
4516 enabled. When 'key' is set it returns "*****" (five stars).
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4517
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4518 *'keymap'* *'kmp'* *E544*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4519 'keymap' 'kmp' string (default "")
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4520 local to buffer
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4521 {only available when compiled with the |+keymap|
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4522 feature}
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4523 Name of a keyboard mapping. See |mbyte-keymap|.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4524 Setting this option to a valid keymap name has the side effect of
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4525 setting 'iminsert' to one, so that the keymap becomes effective.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4526 'imsearch' is also set to one, unless it was -1
36
125e80798a85 updated for version 7.0021
vimboss
parents: 33
diff changeset
4527 Only normal file name characters can be used, "/\*?[|<>" are illegal.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4528
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4529 *'keymodel'* *'km'*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4530 'keymodel' 'km' string (default "")
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4531 global
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4532 List of comma separated words, which enable special things that keys
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4533 can do. These values can be used:
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4534 startsel Using a shifted special key starts selection (either
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4535 Select mode or Visual mode, depending on "key" being
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4536 present in 'selectmode').
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4537 stopsel Using a not-shifted special key stops selection.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4538 Special keys in this context are the cursor keys, <End>, <Home>,
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4539 <PageUp> and <PageDown>.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4540 The 'keymodel' option is set by the |:behave| command.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4541
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4542 *'keywordprg'* *'kp'*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4543 '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
4544 VMS: "help")
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4545 global or local to buffer |global-local|
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4546 Program to use for the |K| command. Environment variables are
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4547 expanded |:set_env|. ":help" may be used to access the Vim internal
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4548 help. (Note that previously setting the global option to the empty
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4549 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
4550 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
4551 Ex command prefixed with [count].
0d52ddff8db4 commit https://github.com/vim/vim/commit/2ff8b64679242e73248774a388d54931c9ce49bd
Christian Brabandt <cb@256bit.org>
parents: 9097
diff changeset
4552 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
4553 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
4554 argument. For "man -s" the "-s" is removed when there is no count.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4555 See |option-backslash| about including spaces and backslashes.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4556 Example: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4557 :set keywordprg=man\ -s
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4558 < This option cannot be set from a |modeline| or in the |sandbox|, for
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4559 security reasons.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4560
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4561 *'langmap'* *'lmap'* *E357* *E358*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4562 'langmap' 'lmap' string (default "")
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4563 global
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4564 {only available when compiled with the |+langmap|
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4565 feature}
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4566 This option allows switching your keyboard into a special language
10
4e2284e71352 updated for version 7.0002
vimboss
parents: 8
diff changeset
4567 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
4568 inserted directly. When in Normal mode the 'langmap' option takes
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4569 care of translating these special characters to the original meaning
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4570 of the key. This means you don't have to change the keyboard mode to
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4571 be able to execute Normal mode commands.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4572 This is the opposite of the 'keymap' option, where characters are
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4573 mapped in Insert mode.
9975
03fa8a51e9dc commit https://github.com/vim/vim/commit/e4a3bcf28d92d0bde9ca227ccb40d401038185e5
Christian Brabandt <cb@256bit.org>
parents: 9913
diff changeset
4574 Also consider resetting 'langremap' to avoid 'langmap' applies to
6369
c5d53d4c3e2e Update runtime files.
Bram Moolenaar <bram@vim.org>
parents: 6339
diff changeset
4575 characters resulting from a mapping.
5908
32de51778c27 Update runtime files.
Bram Moolenaar <bram@vim.org>
parents: 5862
diff changeset
4576 This option cannot be set from a |modeline| or in the |sandbox|, for
32de51778c27 Update runtime files.
Bram Moolenaar <bram@vim.org>
parents: 5862
diff changeset
4577 security reasons.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4578
699
2af8de31a3a8 updated for version 7.0211
vimboss
parents: 697
diff changeset
4579 Example (for Greek, in UTF-8): *greek* >
2af8de31a3a8 updated for version 7.0211
vimboss
parents: 697
diff changeset
4580 :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
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4581 < Example (exchanges meaning of z and y for commands): >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4582 :set langmap=zy,yz,ZY,YZ
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4583 <
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4584 The 'langmap' option is a list of parts, separated with commas. Each
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4585 part can be in one of two forms:
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4586 1. A list of pairs. Each pair is a "from" character immediately
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4587 followed by the "to" character. Examples: "aA", "aAbBcC".
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4588 2. A list of "from" characters, a semi-colon and a list of "to"
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4589 characters. Example: "abc;ABC"
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4590 Example: "aA,fgh;FGH,cCdDeE"
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4591 Special characters need to be preceded with a backslash. These are
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4592 ";", ',' and backslash itself.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4593
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4594 This will allow you to activate vim actions without having to switch
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4595 back and forth between the languages. Your language characters will
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4596 be understood as normal vim English characters (according to the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4597 langmap mappings) in the following cases:
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4598 o Normal/Visual mode (commands, buffer/register names, user mappings)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4599 o Insert/Replace Mode: Register names after CTRL-R
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4600 o Insert/Replace Mode: Mappings
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4601 Characters entered in Command-line mode will NOT be affected by
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4602 this option. Note that this option can be changed at any time
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4603 allowing to switch between mappings for different languages/encodings.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4604 Use a mapping to avoid having to type it each time!
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4605
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4606 *'langmenu'* *'lm'*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4607 'langmenu' 'lm' string (default "")
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4608 global
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4609 {only available when compiled with the |+menu| and
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4610 |+multi_lang| features}
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4611 Language to use for menu translation. Tells which file is loaded
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4612 from the "lang" directory in 'runtimepath': >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4613 "lang/menu_" . &langmenu . ".vim"
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4614 < (without the spaces). For example, to always use the Dutch menus, no
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4615 matter what $LANG is set to: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4616 :set langmenu=nl_NL.ISO_8859-1
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4617 < When 'langmenu' is empty, |v:lang| is used.
36
125e80798a85 updated for version 7.0021
vimboss
parents: 33
diff changeset
4618 Only normal file name characters can be used, "/\*?[|<>" are illegal.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4619 If your $LANG is set to a non-English language but you do want to use
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4620 the English menus: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4621 :set langmenu=none
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4622 < This option must be set before loading menus, switching on filetype
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4623 detection or syntax highlighting. Once the menus are defined setting
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4624 this option has no effect. But you could do this: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4625 :source $VIMRUNTIME/delmenu.vim
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4626 :set langmenu=de_DE.ISO_8859-1
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4627 :source $VIMRUNTIME/menu.vim
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4628 < Warning: This deletes all menus that you defined yourself!
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4629
7196
42717d048817 commit https://github.com/vim/vim/commit/d94464ee294a351ce7b6ba18e8bd3f24f1bef920
Christian Brabandt <cb@256bit.org>
parents: 7147
diff changeset
4630 *'langnoremap'* *'lnr'* *'nolangnoremap'* *'nolnr'*
9669
284b4eb307fc commit https://github.com/vim/vim/commit/8c08b5b569e2a9e9f63dea514591ecfa2d3bb392
Christian Brabandt <cb@256bit.org>
parents: 9665
diff changeset
4631 'langnoremap' 'lnr' boolean (default off, set in |defaults.vim|)
6339
7b28dc1d756e updated for version 7.4.502
Bram Moolenaar <bram@vim.org>
parents: 6336
diff changeset
4632 global
7b28dc1d756e updated for version 7.4.502
Bram Moolenaar <bram@vim.org>
parents: 6336
diff changeset
4633 {only available when compiled with the |+langmap|
7b28dc1d756e updated for version 7.4.502
Bram Moolenaar <bram@vim.org>
parents: 6336
diff changeset
4634 feature}
9975
03fa8a51e9dc commit https://github.com/vim/vim/commit/e4a3bcf28d92d0bde9ca227ccb40d401038185e5
Christian Brabandt <cb@256bit.org>
parents: 9913
diff changeset
4635 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
4636 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
4637 '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
4638
03fa8a51e9dc commit https://github.com/vim/vim/commit/e4a3bcf28d92d0bde9ca227ccb40d401038185e5
Christian Brabandt <cb@256bit.org>
parents: 9913
diff changeset
4639 *'langremap'* *'lrm'* *'nolangremap'* *'nolrm'*
03fa8a51e9dc commit https://github.com/vim/vim/commit/e4a3bcf28d92d0bde9ca227ccb40d401038185e5
Christian Brabandt <cb@256bit.org>
parents: 9913
diff changeset
4640 'langremap' 'lrm' boolean (default on, reset in |defaults.vim|)
03fa8a51e9dc commit https://github.com/vim/vim/commit/e4a3bcf28d92d0bde9ca227ccb40d401038185e5
Christian Brabandt <cb@256bit.org>
parents: 9913
diff changeset
4641 global
03fa8a51e9dc commit https://github.com/vim/vim/commit/e4a3bcf28d92d0bde9ca227ccb40d401038185e5
Christian Brabandt <cb@256bit.org>
parents: 9913
diff changeset
4642 {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
4643 feature}
03fa8a51e9dc commit https://github.com/vim/vim/commit/e4a3bcf28d92d0bde9ca227ccb40d401038185e5
Christian Brabandt <cb@256bit.org>
parents: 9913
diff changeset
4644 When off, setting 'langmap' does not apply to characters resulting from
6339
7b28dc1d756e updated for version 7.4.502
Bram Moolenaar <bram@vim.org>
parents: 6336
diff changeset
4645 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
4646 '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
4647 This option defaults to on for backwards compatibility. Set it off if
6339
7b28dc1d756e updated for version 7.4.502
Bram Moolenaar <bram@vim.org>
parents: 6336
diff changeset
4648 that works for you to avoid mappings to break.
7b28dc1d756e updated for version 7.4.502
Bram Moolenaar <bram@vim.org>
parents: 6336
diff changeset
4649
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4650 *'laststatus'* *'ls'*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4651 'laststatus' 'ls' number (default 1)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4652 global
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4653 The value of this option influences when the last window will have a
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4654 status line:
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4655 0: never
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4656 1: only if there are at least two windows
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4657 2: always
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4658 The screen looks nicer with a status line if you have several
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4659 windows, but it takes another screen line. |status-line|
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4660
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4661 *'lazyredraw'* *'lz'* *'nolazyredraw'* *'nolz'*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4662 'lazyredraw' 'lz' boolean (default off)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4663 global
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4664 When this option is set, the screen will not be redrawn while
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4665 executing macros, registers and other commands that have not been
10
4e2284e71352 updated for version 7.0002
vimboss
parents: 8
diff changeset
4666 typed. Also, updating the window title is postponed. To force an
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4667 update use |:redraw|.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4668
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4669 *'linebreak'* *'lbr'* *'nolinebreak'* *'nolbr'*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4670 'linebreak' 'lbr' boolean (default off)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4671 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
4672 {not available when compiled without the |+linebreak|
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4673 feature}
6009
7b83c190d370 Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 5991
diff changeset
4674 If on, Vim will wrap long lines at a character in 'breakat' rather
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4675 than at the last character that fits on the screen. Unlike
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4676 'wrapmargin' and 'textwidth', this does not insert <EOL>s in the file,
6009
7b83c190d370 Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 5991
diff changeset
4677 it only affects the way the file is displayed, not its contents.
7b83c190d370 Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 5991
diff changeset
4678 If 'breakindent' is set, line is visually indented. Then, the value
7b83c190d370 Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 5991
diff changeset
4679 of 'showbreak' is used to put in front of wrapped lines. This option
6026
d42a1d3b74d4 updated for version 7.4.353
Bram Moolenaar <bram@vim.org>
parents: 6009
diff changeset
4680 is not used when the 'wrap' option is off.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4681 Note that <Tab> characters after an <EOL> are mostly not displayed
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4682 with the right amount of white space.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4683
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4684 *'lines'* *E593*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4685 'lines' number (default 24 or terminal height)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4686 global
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4687 Number of lines of the Vim window.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4688 Normally you don't need to set this. It is done automatically by the
161
6df0106fc595 updated for version 7.0049
vimboss
parents: 148
diff changeset
4689 terminal initialization code. Also see |posix-screen-size|.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4690 When Vim is running in the GUI or in a resizable window, setting this
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4691 option will cause the window size to be changed. When you only want
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4692 to use the size for the GUI, put the command in your |gvimrc| file.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4693 Vim limits the number of lines to what fits on the screen. You can
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4694 use this command to get the tallest window possible: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4695 :set lines=999
571
0ae54f30d5bc updated for version 7.0162
vimboss
parents: 557
diff changeset
4696 < 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
4697 If you get fewer lines than expected, check the 'guiheadroom' option.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4698 When you set this option and Vim is unable to change the physical
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4699 number of lines of the display, the display may be messed up.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4700
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4701 *'linespace'* *'lsp'*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4702 'linespace' 'lsp' number (default 0, 1 for Win32 GUI)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4703 global
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4704 {only in the GUI}
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4705 Number of pixel lines inserted between characters. Useful if the font
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4706 uses the full character cell height, making lines touch each other.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4707 When non-zero there is room for underlining.
180
7e70fc748752 updated for version 7.0056
vimboss
parents: 179
diff changeset
4708 With some fonts there can be too much room between lines (to have
7e70fc748752 updated for version 7.0056
vimboss
parents: 179
diff changeset
4709 space for ascents and descents). Then it makes sense to set
7e70fc748752 updated for version 7.0056
vimboss
parents: 179
diff changeset
4710 'linespace' to a negative value. This may cause display problems
7e70fc748752 updated for version 7.0056
vimboss
parents: 179
diff changeset
4711 though!
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4712
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4713 *'lisp'* *'nolisp'*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4714 'lisp' boolean (default off)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4715 local to buffer
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4716 {not available when compiled without the |+lispindent|
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4717 feature}
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4718 Lisp mode: When <Enter> is typed in insert mode set the indent for
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4719 the next line to Lisp standards (well, sort of). Also happens with
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4720 "cc" or "S". 'autoindent' must also be on for this to work. The 'p'
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4721 flag in 'cpoptions' changes the method of indenting: Vi compatible or
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4722 better. Also see 'lispwords'.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4723 The '-' character is included in keyword characters. Redefines the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4724 "=" operator to use this same indentation algorithm rather than
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4725 calling an external program if 'equalprg' is empty.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4726 This option is not used when 'paste' is set.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4727
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4728 *'lispwords'* *'lw'*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4729 'lispwords' 'lw' string (default is very long)
5712
06e5f65c34d8 updated for version 7.4.201
Bram Moolenaar <bram@vim.org>
parents: 5690
diff changeset
4730 global or local to buffer |global-local|
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4731 {not available when compiled without the |+lispindent|
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4732 feature}
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4733 Comma separated list of words that influence the Lisp indenting.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4734 |'lisp'|
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4735
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4736 *'list'* *'nolist'*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4737 'list' boolean (default off)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4738 local to window
2033
de5a43c5eedc Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents: 1904
diff changeset
4739 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
4740 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
4741 trailing blanks. Further changed by the 'listchars' option.
de5a43c5eedc Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents: 1904
diff changeset
4742
de5a43c5eedc Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents: 1904
diff changeset
4743 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
4744 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
4745 position while displaying Tabs with spaces, use: >
5161
f7add3891e95 Updated runtime files. Fix NL translations.
Bram Moolenaar <bram@vim.org>
parents: 5146
diff changeset
4746 :set list lcs=tab:\ \
2033
de5a43c5eedc Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents: 1904
diff changeset
4747 <
de5a43c5eedc Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents: 1904
diff changeset
4748 Note that list mode will also affect formatting (set with 'textwidth'
de5a43c5eedc Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents: 1904
diff changeset
4749 or 'wrapmargin') when 'cpoptions' includes 'L'. See 'listchars' for
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4750 changing the way tabs are displayed.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4751
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4752 *'listchars'* *'lcs'*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4753 'listchars' 'lcs' string (default "eol:$")
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4754 global
2458
22a6f99e6477 Runtime file updates.
Bram Moolenaar <bram@vim.org>
parents: 2426
diff changeset
4755 Strings to use in 'list' mode and for the |:list| command. It is a
22a6f99e6477 Runtime file updates.
Bram Moolenaar <bram@vim.org>
parents: 2426
diff changeset
4756 comma separated list of string settings.
6777
a8962f0e0d34 patch 7.4.710
Bram Moolenaar <bram@vim.org>
parents: 6727
diff changeset
4757 *lcs-eol*
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4758 eol:c Character to show at the end of each line. When
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4759 omitted, there is no extra character at the end of the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4760 line.
6777
a8962f0e0d34 patch 7.4.710
Bram Moolenaar <bram@vim.org>
parents: 6727
diff changeset
4761 *lcs-tab*
15502
bc17a9d37810 patch 8.1.0759: showing two characters for tab is limited
Bram Moolenaar <Bram@vim.org>
parents: 15396
diff changeset
4762 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
4763 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
4764
bc17a9d37810 patch 8.1.0759: showing two characters for tab is limited
Bram Moolenaar <Bram@vim.org>
parents: 15396
diff changeset
4765 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
4766 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
4767 >
bc17a9d37810 patch 8.1.0759: showing two characters for tab is limited
Bram Moolenaar <Bram@vim.org>
parents: 15396
diff changeset
4768 >-
bc17a9d37810 patch 8.1.0759: showing two characters for tab is limited
Bram Moolenaar <Bram@vim.org>
parents: 15396
diff changeset
4769 >--
bc17a9d37810 patch 8.1.0759: showing two characters for tab is limited
Bram Moolenaar <Bram@vim.org>
parents: 15396
diff changeset
4770 etc.
bc17a9d37810 patch 8.1.0759: showing two characters for tab is limited
Bram Moolenaar <Bram@vim.org>
parents: 15396
diff changeset
4771
bc17a9d37810 patch 8.1.0759: showing two characters for tab is limited
Bram Moolenaar <Bram@vim.org>
parents: 15396
diff changeset
4772 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
4773 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
4774 "tab:<->" displays:
bc17a9d37810 patch 8.1.0759: showing two characters for tab is limited
Bram Moolenaar <Bram@vim.org>
parents: 15396
diff changeset
4775 >
bc17a9d37810 patch 8.1.0759: showing two characters for tab is limited
Bram Moolenaar <Bram@vim.org>
parents: 15396
diff changeset
4776 <>
bc17a9d37810 patch 8.1.0759: showing two characters for tab is limited
Bram Moolenaar <Bram@vim.org>
parents: 15396
diff changeset
4777 <->
bc17a9d37810 patch 8.1.0759: showing two characters for tab is limited
Bram Moolenaar <Bram@vim.org>
parents: 15396
diff changeset
4778 <-->
bc17a9d37810 patch 8.1.0759: showing two characters for tab is limited
Bram Moolenaar <Bram@vim.org>
parents: 15396
diff changeset
4779 etc.
bc17a9d37810 patch 8.1.0759: showing two characters for tab is limited
Bram Moolenaar <Bram@vim.org>
parents: 15396
diff changeset
4780
bc17a9d37810 patch 8.1.0759: showing two characters for tab is limited
Bram Moolenaar <Bram@vim.org>
parents: 15396
diff changeset
4781 When "tab:" is omitted, a tab is shown as ^I.
6777
a8962f0e0d34 patch 7.4.710
Bram Moolenaar <bram@vim.org>
parents: 6727
diff changeset
4782 *lcs-space*
a8962f0e0d34 patch 7.4.710
Bram Moolenaar <bram@vim.org>
parents: 6727
diff changeset
4783 space:c Character to show for a space. When omitted, spaces
a8962f0e0d34 patch 7.4.710
Bram Moolenaar <bram@vim.org>
parents: 6727
diff changeset
4784 are left blank.
a8962f0e0d34 patch 7.4.710
Bram Moolenaar <bram@vim.org>
parents: 6727
diff changeset
4785 *lcs-trail*
10
4e2284e71352 updated for version 7.0002
vimboss
parents: 8
diff changeset
4786 trail:c Character to show for trailing spaces. When omitted,
6777
a8962f0e0d34 patch 7.4.710
Bram Moolenaar <bram@vim.org>
parents: 6727
diff changeset
4787 trailing spaces are blank. Overrides the "space"
a8962f0e0d34 patch 7.4.710
Bram Moolenaar <bram@vim.org>
parents: 6727
diff changeset
4788 setting for trailing spaces.
a8962f0e0d34 patch 7.4.710
Bram Moolenaar <bram@vim.org>
parents: 6727
diff changeset
4789 *lcs-extends*
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4790 extends:c Character to show in the last column, when 'wrap' is
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4791 off and the line continues beyond the right of the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4792 screen.
6777
a8962f0e0d34 patch 7.4.710
Bram Moolenaar <bram@vim.org>
parents: 6727
diff changeset
4793 *lcs-precedes*
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4794 precedes:c Character to show in the first column, when 'wrap'
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4795 is off and there is text preceding the character
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4796 visible in the first column.
6777
a8962f0e0d34 patch 7.4.710
Bram Moolenaar <bram@vim.org>
parents: 6727
diff changeset
4797 *lcs-conceal*
2250
1bac28a53fae Add the conceal patch from Vince Negri.
Bram Moolenaar <bram@vim.org>
parents: 2249
diff changeset
4798 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
4799 'conceallevel' is set to 1.
6777
a8962f0e0d34 patch 7.4.710
Bram Moolenaar <bram@vim.org>
parents: 6727
diff changeset
4800 *lcs-nbsp*
6801
47ebd4065059 patch 7.4.722
Bram Moolenaar <bram@vim.org>
parents: 6777
diff changeset
4801 nbsp:c Character to show for a non-breakable space character
47ebd4065059 patch 7.4.722
Bram Moolenaar <bram@vim.org>
parents: 6777
diff changeset
4802 (0xA0 (160 decimal) and U+202F). Left blank when
47ebd4065059 patch 7.4.722
Bram Moolenaar <bram@vim.org>
parents: 6777
diff changeset
4803 omitted.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4804
10
4e2284e71352 updated for version 7.0002
vimboss
parents: 8
diff changeset
4805 The characters ':' and ',' should not be used. UTF-8 characters can
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4806 be used when 'encoding' is "utf-8", otherwise only printable
819
23f82b5d2814 updated for version 7.0c10
vimboss
parents: 818
diff changeset
4807 characters are allowed. All characters must be single width.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4808
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4809 Examples: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4810 :set lcs=tab:>-,trail:-
12
bdeee1504ac1 updated for version 7.0004
vimboss
parents: 11
diff changeset
4811 :set lcs=tab:>-,eol:<,nbsp:%
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4812 :set lcs=extends:>,precedes:<
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4813 < The "NonText" highlighting will be used for "eol", "extends" and
6777
a8962f0e0d34 patch 7.4.710
Bram Moolenaar <bram@vim.org>
parents: 6727
diff changeset
4814 "precedes". "SpecialKey" for "nbsp", "space", "tab" and "trail".
1152
e1787f5b90da updated for version 7.1a
vimboss
parents: 1111
diff changeset
4815 |hl-NonText| |hl-SpecialKey|
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4816
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4817 *'lpl'* *'nolpl'* *'loadplugins'* *'noloadplugins'*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4818 'loadplugins' 'lpl' boolean (default on)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4819 global
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4820 When on the plugin scripts are loaded when starting up |load-plugins|.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4821 This option can be reset in your |vimrc| file to disable the loading
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4822 of plugins.
11666
5cd9ba96561d patch 8.0.0716: not easy to start Vim cleanly
Christian Brabandt <cb@256bit.org>
parents: 11659
diff changeset
4823 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
4824 line arguments reset this option. See |-u| and |--noplugin|.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4825
7196
42717d048817 commit https://github.com/vim/vim/commit/d94464ee294a351ce7b6ba18e8bd3f24f1bef920
Christian Brabandt <cb@256bit.org>
parents: 7147
diff changeset
4826 *'luadll'*
8629
54ac275e3fc4 commit https://github.com/vim/vim/commit/3848e00e0177abdb31bc600234967863ec487233
Christian Brabandt <cb@256bit.org>
parents: 8560
diff changeset
4827 '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
4828 global
7196
42717d048817 commit https://github.com/vim/vim/commit/d94464ee294a351ce7b6ba18e8bd3f24f1bef920
Christian Brabandt <cb@256bit.org>
parents: 7147
diff changeset
4829 {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
4830 feature}
7528
53163e4d9e4f commit https://github.com/vim/vim/commit/25e4fcde767084d1a79e0926bc301c92987c0cce
Christian Brabandt <cb@256bit.org>
parents: 7477
diff changeset
4831 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
4832 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
4833 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
4834 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
4835 security reasons.
42717d048817 commit https://github.com/vim/vim/commit/d94464ee294a351ce7b6ba18e8bd3f24f1bef920
Christian Brabandt <cb@256bit.org>
parents: 7147
diff changeset
4836
842
a209672376fd updated for version 7.0f
vimboss
parents: 839
diff changeset
4837 *'macatsui'* *'nomacatsui'*
a209672376fd updated for version 7.0f
vimboss
parents: 839
diff changeset
4838 'macatsui' boolean (default on)
a209672376fd updated for version 7.0f
vimboss
parents: 839
diff changeset
4839 global
a209672376fd updated for version 7.0f
vimboss
parents: 839
diff changeset
4840 {only available in Mac GUI version}
a209672376fd updated for version 7.0f
vimboss
parents: 839
diff changeset
4841 This is a workaround for when drawing doesn't work properly. When set
a209672376fd updated for version 7.0f
vimboss
parents: 839
diff changeset
4842 and compiled with multi-byte support ATSUI text drawing is used. When
a209672376fd updated for version 7.0f
vimboss
parents: 839
diff changeset
4843 not set ATSUI text drawing is not used. Switch this option off when
a209672376fd updated for version 7.0f
vimboss
parents: 839
diff changeset
4844 you experience drawing problems. In a future version the problems may
a209672376fd updated for version 7.0f
vimboss
parents: 839
diff changeset
4845 be solved and this option becomes obsolete. Therefore use this method
a209672376fd updated for version 7.0f
vimboss
parents: 839
diff changeset
4846 to unset it: >
a209672376fd updated for version 7.0f
vimboss
parents: 839
diff changeset
4847 if exists('&macatsui')
a209672376fd updated for version 7.0f
vimboss
parents: 839
diff changeset
4848 set nomacatsui
a209672376fd updated for version 7.0f
vimboss
parents: 839
diff changeset
4849 endif
1152
e1787f5b90da updated for version 7.1a
vimboss
parents: 1111
diff changeset
4850 < Another option to check if you have drawing problems is
e1787f5b90da updated for version 7.1a
vimboss
parents: 1111
diff changeset
4851 'termencoding'.
e1787f5b90da updated for version 7.1a
vimboss
parents: 1111
diff changeset
4852
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4853 *'magic'* *'nomagic'*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4854 'magic' boolean (default on)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4855 global
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4856 Changes the special characters that can be used in search patterns.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4857 See |pattern|.
10140
b11ceef7116e commit https://github.com/vim/vim/commit/64d8e25bf6efe5f18b032563521c3ce278c316ab
Christian Brabandt <cb@256bit.org>
parents: 10027
diff changeset
4858 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
4859 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
4860 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
4861 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
4862 when you want to |/\M|.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4863
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4864 *'makeef'* *'mef'*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4865 'makeef' 'mef' string (default: "")
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4866 global
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4867 {not available when compiled without the |+quickfix|
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4868 feature}
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4869 Name of the errorfile for the |:make| command (see |:make_makeprg|)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4870 and the |:grep| command.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4871 When it is empty, an internally generated temp file will be used.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4872 When "##" is included, it is replaced by a number to make the name
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4873 unique. This makes sure that the ":make" command doesn't overwrite an
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4874 existing file.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4875 NOT used for the ":cf" command. See 'errorfile' for that.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4876 Environment variables are expanded |:set_env|.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4877 See |option-backslash| about including spaces and backslashes.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4878 This option cannot be set from a |modeline| or in the |sandbox|, for
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4879 security reasons.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4880
11063
e71d3bdf3bc3 patch 8.0.0420: text garbled when the system encoding differs from 'encoding'
Christian Brabandt <cb@256bit.org>
parents: 11062
diff changeset
4881 *'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
4882 '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
4883 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
4884 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
4885 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
4886 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
4887 `: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
4888 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
4889
e71d3bdf3bc3 patch 8.0.0420: text garbled when the system encoding differs from 'encoding'
Christian Brabandt <cb@256bit.org>
parents: 11062
diff changeset
4890 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
4891 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
4892 '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
4893 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
4894 :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
4895 :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
4896 <
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4897 *'makeprg'* *'mp'*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4898 'makeprg' 'mp' string (default "make", VMS: "MMS")
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4899 global or local to buffer |global-local|
1152
e1787f5b90da updated for version 7.1a
vimboss
parents: 1111
diff changeset
4900 Program to use for the ":make" command. See |:make_makeprg|.
13341
acd7eaa13d2b Updated runtime files.
Christian Brabandt <cb@256bit.org>
parents: 13314
diff changeset
4901 This option may contain '%' and '#' characters (see |:_%| and |:_#|),
acd7eaa13d2b Updated runtime files.
Christian Brabandt <cb@256bit.org>
parents: 13314
diff changeset
4902 which are expanded to the current and alternate file name. Use |::S|
5690
40f18a1c1592 updated for version 7.4.191
Bram Moolenaar <bram@vim.org>
parents: 5555
diff changeset
4903 to escape file names in case they contain special characters.
1152
e1787f5b90da updated for version 7.1a
vimboss
parents: 1111
diff changeset
4904 Environment variables are expanded |:set_env|. See |option-backslash|
e1787f5b90da updated for version 7.1a
vimboss
parents: 1111
diff changeset
4905 about including spaces and backslashes.
e1787f5b90da updated for version 7.1a
vimboss
parents: 1111
diff changeset
4906 Note that a '|' must be escaped twice: once for ":set" and once for
e1787f5b90da updated for version 7.1a
vimboss
parents: 1111
diff changeset
4907 the interpretation of a command. When you use a filter called
e1787f5b90da updated for version 7.1a
vimboss
parents: 1111
diff changeset
4908 "myfilter" do it like this: >
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4909 :set makeprg=gmake\ \\\|\ myfilter
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4910 < The placeholder "$*" can be given (even multiple times) to specify
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4911 where the arguments will be included, for example: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4912 :set makeprg=latex\ \\\\nonstopmode\ \\\\input\\{$*}
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4913 < This option cannot be set from a |modeline| or in the |sandbox|, for
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4914 security reasons.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4915
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4916 *'matchpairs'* *'mps'*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4917 'matchpairs' 'mps' string (default "(:),{:},[:]")
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4918 local to buffer
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4919 Characters that form pairs. The |%| command jumps from one to the
4073
e362db8b2d7b Update runtime files.
Bram Moolenaar <bram@vim.org>
parents: 4055
diff changeset
4920 other.
e362db8b2d7b Update runtime files.
Bram Moolenaar <bram@vim.org>
parents: 4055
diff changeset
4921 Only character pairs are allowed that are different, thus you cannot
e362db8b2d7b Update runtime files.
Bram Moolenaar <bram@vim.org>
parents: 4055
diff changeset
4922 jump between two double quotes.
e362db8b2d7b Update runtime files.
Bram Moolenaar <bram@vim.org>
parents: 4055
diff changeset
4923 The characters must be separated by a colon.
1152
e1787f5b90da updated for version 7.1a
vimboss
parents: 1111
diff changeset
4924 The pairs must be separated by a comma. Example for including '<' and
e1787f5b90da updated for version 7.1a
vimboss
parents: 1111
diff changeset
4925 '>' (HTML): >
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4926 :set mps+=<:>
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4927
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4928 < A more exotic example, to jump between the '=' and ';' in an
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4929 assignment, useful for languages like C and Java: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4930 :au FileType c,cpp,java set mps+==:;
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4931
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4932 < 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
4933 the $VIMRUNTIME/pack/dist/opt/matchit directory. |add-local-help|
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4934
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4935 *'matchtime'* *'mat'*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4936 'matchtime' 'mat' number (default 5)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4937 global
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4938 Tenths of a second to show the matching paren, when 'showmatch' is
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4939 set. Note that this is not in milliseconds, like other options that
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4940 set a time. This is to be compatible with Nvi.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4941
714
0f9f4761ad9c updated for version 7.0216
vimboss
parents: 712
diff changeset
4942 *'maxcombine'* *'mco'*
0f9f4761ad9c updated for version 7.0216
vimboss
parents: 712
diff changeset
4943 'maxcombine' 'mco' number (default 2)
0f9f4761ad9c updated for version 7.0216
vimboss
parents: 712
diff changeset
4944 global
0f9f4761ad9c updated for version 7.0216
vimboss
parents: 712
diff changeset
4945 The maximum number of combining characters supported for displaying.
0f9f4761ad9c updated for version 7.0216
vimboss
parents: 712
diff changeset
4946 Only used when 'encoding' is "utf-8".
0f9f4761ad9c updated for version 7.0216
vimboss
parents: 712
diff changeset
4947 The default is OK for most languages. Hebrew may require 4.
0f9f4761ad9c updated for version 7.0216
vimboss
parents: 712
diff changeset
4948 Maximum value is 6.
0f9f4761ad9c updated for version 7.0216
vimboss
parents: 712
diff changeset
4949 Even when this option is set to 2 you can still edit text with more
0f9f4761ad9c updated for version 7.0216
vimboss
parents: 712
diff changeset
4950 combining characters, you just can't see them. Use |g8| or |ga|.
0f9f4761ad9c updated for version 7.0216
vimboss
parents: 712
diff changeset
4951 See |mbyte-combining|.
0f9f4761ad9c updated for version 7.0216
vimboss
parents: 712
diff changeset
4952
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4953 *'maxfuncdepth'* *'mfd'*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4954 'maxfuncdepth' 'mfd' number (default 100)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4955 global
2570
71b56b4e7785 Make the references to features in the help more consistent. (Sylvain Hitier)
Bram Moolenaar <bram@vim.org>
parents: 2561
diff changeset
4956 {not available when compiled without the |+eval|
1152
e1787f5b90da updated for version 7.1a
vimboss
parents: 1111
diff changeset
4957 feature}
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4958 Maximum depth of function calls for user functions. This normally
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4959 catches endless recursion. When using a recursive function with
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4960 more depth, set 'maxfuncdepth' to a bigger number. But this will use
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4961 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
4962 Increasing this limit above 200 also changes the maximum for Ex
14006
665fe1f419b0 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 13963
diff changeset
4963 command recursion, see |E169|.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4964 See also |:function|.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4965
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4966 *'maxmapdepth'* *'mmd'* *E223*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4967 'maxmapdepth' 'mmd' number (default 1000)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4968 global
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4969 Maximum number of times a mapping is done without resulting in a
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4970 character to be used. This normally catches endless mappings, like
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4971 ":map x y" with ":map y x". It still does not catch ":map g wg",
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4972 because the 'w' is used before the next mapping is done. See also
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4973 |key-mapping|.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4974
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4975 *'maxmem'* *'mm'*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4976 'maxmem' 'mm' number (default between 256 to 5120 (system
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4977 dependent) or half the amount of memory
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4978 available)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4979 global
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4980 Maximum amount of memory (in Kbyte) to use for one buffer. When this
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4981 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
4982 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
4983 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
4984 limit.
65c3e8259124 patch 8.0.1531: cannot use 24 bit colors in MS-Windows console
Christian Brabandt <cb@256bit.org>
parents: 13234
diff changeset
4985 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
4986 Also see 'maxmemtot'.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4987
189
504c627f7474 updated for version 7.0057
vimboss
parents: 180
diff changeset
4988 *'maxmempattern'* *'mmp'*
504c627f7474 updated for version 7.0057
vimboss
parents: 180
diff changeset
4989 'maxmempattern' 'mmp' number (default 1000)
504c627f7474 updated for version 7.0057
vimboss
parents: 180
diff changeset
4990 global
504c627f7474 updated for version 7.0057
vimboss
parents: 180
diff changeset
4991 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
4992 The maximum value is about 2000000. Use this to work without a limit.
189
504c627f7474 updated for version 7.0057
vimboss
parents: 180
diff changeset
4993 *E363*
1152
e1787f5b90da updated for version 7.1a
vimboss
parents: 1111
diff changeset
4994 When Vim runs into the limit it gives an error message and mostly
e1787f5b90da updated for version 7.1a
vimboss
parents: 1111
diff changeset
4995 behaves like CTRL-C was typed.
189
504c627f7474 updated for version 7.0057
vimboss
parents: 180
diff changeset
4996 Running into the limit often means that the pattern is very
504c627f7474 updated for version 7.0057
vimboss
parents: 180
diff changeset
4997 inefficient or too complex. This may already happen with the pattern
504c627f7474 updated for version 7.0057
vimboss
parents: 180
diff changeset
4998 "\(.\)*" 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
4999 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
5000 text structure.
4a588e3afd4a Update runtime files, add Danish translations.
Christian Brabandt <cb@256bit.org>
parents: 14249
diff changeset
5001 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
5002 which case you get an "Out of memory" error instead.
189
504c627f7474 updated for version 7.0057
vimboss
parents: 180
diff changeset
5003
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5004 *'maxmemtot'* *'mmt'*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5005 'maxmemtot' 'mmt' number (default between 2048 and 10240 (system
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5006 dependent) or half the amount of memory
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5007 available)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5008 global
2033
de5a43c5eedc Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents: 1904
diff changeset
5009 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
5010 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
5011 without a limit.
05cf4cc72a9f commit https://github.com/vim/vim/commit/fa7353428f705f7a13465a1943dddeede4083023
Christian Brabandt <cb@256bit.org>
parents: 7272
diff changeset
5012 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
5013 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
5014 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
5015 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
5016 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
5017 used.
2033
de5a43c5eedc Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents: 1904
diff changeset
5018 Also see 'maxmem'.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5019
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5020 *'menuitems'* *'mis'*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5021 'menuitems' 'mis' number (default 25)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5022 global
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5023 {not available when compiled without the |+menu|
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5024 feature}
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5025 Maximum number of items to use in a menu. Used for menus that are
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5026 generated from a list of items, e.g., the Buffers menu. Changing this
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5027 option has no direct effect, the menu must be refreshed first.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5028
484
f012c4ed8c38 updated for version 7.0132
vimboss
parents: 480
diff changeset
5029 *'mkspellmem'* *'msm'*
f012c4ed8c38 updated for version 7.0132
vimboss
parents: 480
diff changeset
5030 'mkspellmem' 'msm' string (default "460000,2000,500")
f012c4ed8c38 updated for version 7.0132
vimboss
parents: 480
diff changeset
5031 global
f012c4ed8c38 updated for version 7.0132
vimboss
parents: 480
diff changeset
5032 {not available when compiled without the |+syntax|
f012c4ed8c38 updated for version 7.0132
vimboss
parents: 480
diff changeset
5033 feature}
f012c4ed8c38 updated for version 7.0132
vimboss
parents: 480
diff changeset
5034 Parameters for |:mkspell|. This tunes when to start compressing the
f012c4ed8c38 updated for version 7.0132
vimboss
parents: 480
diff changeset
5035 word tree. Compression can be slow when there are many words, but
f012c4ed8c38 updated for version 7.0132
vimboss
parents: 480
diff changeset
5036 it's needed to avoid running out of memory. The amount of memory used
f012c4ed8c38 updated for version 7.0132
vimboss
parents: 480
diff changeset
5037 per word depends very much on how similar the words are, that's why
f012c4ed8c38 updated for version 7.0132
vimboss
parents: 480
diff changeset
5038 this tuning is complicated.
f012c4ed8c38 updated for version 7.0132
vimboss
parents: 480
diff changeset
5039
f012c4ed8c38 updated for version 7.0132
vimboss
parents: 480
diff changeset
5040 There are three numbers, separated by commas:
f012c4ed8c38 updated for version 7.0132
vimboss
parents: 480
diff changeset
5041 {start},{inc},{added}
f012c4ed8c38 updated for version 7.0132
vimboss
parents: 480
diff changeset
5042
f012c4ed8c38 updated for version 7.0132
vimboss
parents: 480
diff changeset
5043 For most languages the uncompressed word tree fits in memory. {start}
f012c4ed8c38 updated for version 7.0132
vimboss
parents: 480
diff changeset
5044 gives the amount of memory in Kbyte that can be used before any
f012c4ed8c38 updated for version 7.0132
vimboss
parents: 480
diff changeset
5045 compression is done. It should be a bit smaller than the amount of
f012c4ed8c38 updated for version 7.0132
vimboss
parents: 480
diff changeset
5046 memory that is available to Vim.
f012c4ed8c38 updated for version 7.0132
vimboss
parents: 480
diff changeset
5047
f012c4ed8c38 updated for version 7.0132
vimboss
parents: 480
diff changeset
5048 When going over the {start} limit the {inc} number specifies the
f012c4ed8c38 updated for version 7.0132
vimboss
parents: 480
diff changeset
5049 amount of memory in Kbyte that can be allocated before another
f012c4ed8c38 updated for version 7.0132
vimboss
parents: 480
diff changeset
5050 compression is done. A low number means compression is done after
f012c4ed8c38 updated for version 7.0132
vimboss
parents: 480
diff changeset
5051 less words are added, which is slow. A high number means more memory
f012c4ed8c38 updated for version 7.0132
vimboss
parents: 480
diff changeset
5052 will be allocated.
f012c4ed8c38 updated for version 7.0132
vimboss
parents: 480
diff changeset
5053
f012c4ed8c38 updated for version 7.0132
vimboss
parents: 480
diff changeset
5054 After doing compression, {added} times 1024 words can be added before
f012c4ed8c38 updated for version 7.0132
vimboss
parents: 480
diff changeset
5055 the {inc} limit is ignored and compression is done when any extra
f012c4ed8c38 updated for version 7.0132
vimboss
parents: 480
diff changeset
5056 amount of memory is needed. A low number means there is a smaller
f012c4ed8c38 updated for version 7.0132
vimboss
parents: 480
diff changeset
5057 chance of hitting the {inc} limit, less memory is used but it's
f012c4ed8c38 updated for version 7.0132
vimboss
parents: 480
diff changeset
5058 slower.
f012c4ed8c38 updated for version 7.0132
vimboss
parents: 480
diff changeset
5059
f012c4ed8c38 updated for version 7.0132
vimboss
parents: 480
diff changeset
5060 The languages for which these numbers are important are Italian and
f012c4ed8c38 updated for version 7.0132
vimboss
parents: 480
diff changeset
5061 Hungarian. The default works for when you have about 512 Mbyte. If
f012c4ed8c38 updated for version 7.0132
vimboss
parents: 480
diff changeset
5062 you have 1 Gbyte you could use: >
f012c4ed8c38 updated for version 7.0132
vimboss
parents: 480
diff changeset
5063 :set mkspellmem=900000,3000,800
f012c4ed8c38 updated for version 7.0132
vimboss
parents: 480
diff changeset
5064 < If you have less than 512 Mbyte |:mkspell| may fail for some
f012c4ed8c38 updated for version 7.0132
vimboss
parents: 480
diff changeset
5065 languages, no matter what you set 'mkspellmem' to.
f012c4ed8c38 updated for version 7.0132
vimboss
parents: 480
diff changeset
5066
16798
63ac51f16ea1 patch 8.1.1401: misspelled mkspellmem as makespellmem
Bram Moolenaar <Bram@vim.org>
parents: 16778
diff changeset
5067 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
5068
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5069 *'modeline'* *'ml'* *'nomodeline'* *'noml'*
1111
53fd0a213cff updated for version 7.0-237
vimboss
parents: 1004
diff changeset
5070 'modeline' 'ml' boolean (Vim default: on (off for root),
53fd0a213cff updated for version 7.0-237
vimboss
parents: 1004
diff changeset
5071 Vi default: off)
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5072 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
5073 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
5074 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
5075 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
5076
e55c26aaf484 patch 8.1.1366: using expressions in a modeline is unsafe
Bram Moolenaar <Bram@vim.org>
parents: 16610
diff changeset
5077 *'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
5078 '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
5079 global
e55c26aaf484 patch 8.1.1366: using expressions in a modeline is unsafe
Bram Moolenaar <Bram@vim.org>
parents: 16610
diff changeset
5080 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
5081 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
5082 '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
5083 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
5084 security reasons.
16728
e55c26aaf484 patch 8.1.1366: using expressions in a modeline is unsafe
Bram Moolenaar <Bram@vim.org>
parents: 16610
diff changeset
5085
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5086 *'modelines'* *'mls'*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5087 'modelines' 'mls' number (default 5)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5088 global
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5089 If 'modeline' is on 'modelines' gives the number of lines that is
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5090 checked for set commands. If 'modeline' is off or 'modelines' is zero
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5091 no lines are checked. See |modeline|.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5092 NOTE: 'modeline' is set to the Vi default value when 'compatible' is
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5093 set and to the Vim default value when 'compatible' is reset.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5094
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5095 *'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
5096 *E21*
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5097 'modifiable' 'ma' boolean (default on)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5098 local to buffer
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5099 When off the buffer contents cannot be changed. The 'fileformat' and
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5100 'fileencoding' options also can't be changed.
10617
9a75c8a1b8b1 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 10579
diff changeset
5101 Can be reset on startup with the |-M| command line argument.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5102
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5103 *'modified'* *'mod'* *'nomodified'* *'nomod'*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5104 'modified' 'mod' boolean (default off)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5105 local to buffer
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5106 When on, the buffer is considered to be modified. This option is set
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5107 when:
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5108 1. A change was made to the text since it was last written. Using the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5109 |undo| command to go back to the original text will reset the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5110 option. But undoing changes that were made before writing the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5111 buffer will set the option again, since the text is different from
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5112 when it was written.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5113 2. 'fileformat' or 'fileencoding' is different from its original
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5114 value. The original value is set when the buffer is read or
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5115 written. A ":set nomodified" command also resets the original
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5116 values to the current values and the 'modified' option will be
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5117 reset.
8748
b1a19a2f73f0 commit https://github.com/vim/vim/commit/4f3f668c8486444e53163c29d2fc79bf47eb3c82
Christian Brabandt <cb@256bit.org>
parents: 8629
diff changeset
5118 Similarly for 'eol' and 'bomb'.
3082
3502a7f991fc Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 2965
diff changeset
5119 This option is not set when a change is made to the buffer as the
3502a7f991fc Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 2965
diff changeset
5120 result of a BufNewFile, BufRead/BufReadPost, BufWritePost,
3502a7f991fc Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 2965
diff changeset
5121 FileAppendPost or VimLeave autocommand event. See |gzip-example| for
3502a7f991fc Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 2965
diff changeset
5122 an explanation.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5123 When 'buftype' is "nowrite" or "nofile" this option may be set, but
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5124 will be ignored.
13437
02b3f719eacb Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 13341
diff changeset
5125 Note that the text may actually be the same, e.g. 'modified' is set
02b3f719eacb Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 13341
diff changeset
5126 when using "rA" on an "A".
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5127
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5128 *'more'* *'nomore'*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5129 'more' boolean (Vim default: on, Vi default: off)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5130 global
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5131 When on, listings pause when the whole screen is filled. You will get
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5132 the |more-prompt|. When this option is off there are no pauses, the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5133 listing continues until finished.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5134 NOTE: This option is set to the Vi default value when 'compatible' is
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5135 set and to the Vim default value when 'compatible' is reset.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5136
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5137 *'mouse'* *E538*
9669
284b4eb307fc commit https://github.com/vim/vim/commit/8c08b5b569e2a9e9f63dea514591ecfa2d3bb392
Christian Brabandt <cb@256bit.org>
parents: 9665
diff changeset
5138 'mouse' string (default "", "a" for GUI, MS-DOS and Win32,
284b4eb307fc commit https://github.com/vim/vim/commit/8c08b5b569e2a9e9f63dea514591ecfa2d3bb392
Christian Brabandt <cb@256bit.org>
parents: 9665
diff changeset
5139 set to "a" in |defaults.vim|)
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5140 global
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5141 Enable the use of the mouse. Only works for certain terminals
1621
82b5078be2dd updated for version 7.2a
vimboss
parents: 1564
diff changeset
5142 (xterm, MS-DOS, Win32 |win32-mouse|, QNX pterm, *BSD console with
82b5078be2dd updated for version 7.2a
vimboss
parents: 1564
diff changeset
5143 sysmouse and Linux console with gpm). For using the mouse in the
82b5078be2dd updated for version 7.2a
vimboss
parents: 1564
diff changeset
5144 GUI, see |gui-mouse|.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5145 The mouse can be enabled for different modes:
12826
f690da1b3c04 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 12824
diff changeset
5146 n Normal mode and Terminal modes
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5147 v Visual mode
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5148 i Insert mode
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5149 c Command-line mode
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5150 h all previous modes when editing a help file
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5151 a all previous modes
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5152 r for |hit-enter| and |more-prompt| prompt
14864
40ef13331e02 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 14702
diff changeset
5153 Normally you would enable the mouse in all five modes with: >
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5154 :set mouse=a
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5155 < When the mouse is not enabled, the GUI will still use the mouse for
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5156 modeless selection. This doesn't move the text cursor.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5157
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5158 See |mouse-using|. Also see |'clipboard'|.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5159
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5160 Note: When enabling the mouse in a terminal, copy/paste will use the
10
4e2284e71352 updated for version 7.0002
vimboss
parents: 8
diff changeset
5161 "* register if there is access to an X-server. The xterm handling of
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5162 the mouse buttons can still be used by keeping the shift key pressed.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5163 Also see the 'clipboard' option.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5164
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5165 *'mousefocus'* *'mousef'* *'nomousefocus'* *'nomousef'*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5166 'mousefocus' 'mousef' boolean (default off)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5167 global
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5168 {only works in the GUI}
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5169 The window that the mouse pointer is on is automatically activated.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5170 When changing the window layout or window focus in another way, the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5171 mouse pointer is moved to the window with keyboard focus. Off is the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5172 default because it makes using the pull down menus a little goofy, as
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5173 a pointer transit may activate a window unintentionally.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5174
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5175 *'mousehide'* *'mh'* *'nomousehide'* *'nomh'*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5176 'mousehide' 'mh' boolean (default on)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5177 global
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5178 {only works in the GUI}
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5179 When on, the mouse pointer is hidden when characters are typed.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5180 The mouse pointer is restored when the mouse is moved.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5181
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5182 *'mousemodel'* *'mousem'*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5183 'mousemodel' 'mousem' string (default "extend", "popup" for MS-DOS and Win32)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5184 global
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5185 Sets the model to use for the mouse. The name mostly specifies what
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5186 the right mouse button is used for:
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5187 extend Right mouse button extends a selection. This works
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5188 like in an xterm.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5189 popup Right mouse button pops up a menu. The shifted left
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5190 mouse button extends a selection. This works like
233
fca8a9b65afa updated for version 7.0065
vimboss
parents: 227
diff changeset
5191 with Microsoft Windows.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5192 popup_setpos Like "popup", but the cursor will be moved to the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5193 position where the mouse was clicked, and thus the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5194 selected operation will act upon the clicked object.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5195 If clicking inside a selection, that selection will
233
fca8a9b65afa updated for version 7.0065
vimboss
parents: 227
diff changeset
5196 be acted upon, i.e. no cursor move. This implies of
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5197 course, that right clicking outside a selection will
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5198 end Visual mode.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5199 Overview of what button does what for each model:
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5200 mouse extend popup(_setpos) ~
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5201 left click place cursor place cursor
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5202 left drag start selection start selection
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5203 shift-left search word extend selection
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5204 right click extend selection popup menu (place cursor)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5205 right drag extend selection -
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5206 middle click paste paste
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5207
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5208 In the "popup" model the right mouse button produces a pop-up menu.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5209 You need to define this first, see |popup-menu|.
13437
02b3f719eacb Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 13341
diff changeset
5210 In a terminal the popup menu works if Vim is compiled with the
02b3f719eacb Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 13341
diff changeset
5211 |+insert_expand| option.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5212
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5213 Note that you can further refine the meaning of buttons with mappings.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5214 See |gui-mouse-mapping|. But mappings are NOT used for modeless
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5215 selection (because that's handled in the GUI code directly).
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5216
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5217 The 'mousemodel' option is set by the |:behave| command.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5218
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5219 *'mouseshape'* *'mouses'* *E547*
15932
c3c1abe7aff2 Update runtime files
Bram Moolenaar <Bram@vim.org>
parents: 15878
diff changeset
5220 'mouseshape' 'mouses' string (default "i-r:beam,s:updown,sd:udsizing,
c3c1abe7aff2 Update runtime files
Bram Moolenaar <Bram@vim.org>
parents: 15878
diff changeset
5221 vs:leftright,vd:lrsizing,m:no,
c3c1abe7aff2 Update runtime files
Bram Moolenaar <Bram@vim.org>
parents: 15878
diff changeset
5222 ml:up-arrow,v:rightup-arrow")
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5223 global
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5224 {only available when compiled with the |+mouseshape|
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5225 feature}
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5226 This option tells Vim what the mouse pointer should look like in
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5227 different modes. The option is a comma separated list of parts, much
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5228 like used for 'guicursor'. Each part consist of a mode/location-list
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5229 and an argument-list:
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5230 mode-list:shape,mode-list:shape,..
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5231 The mode-list is a dash separated list of these modes/locations:
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5232 In a normal window: ~
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5233 n Normal mode
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5234 v Visual mode
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5235 ve Visual mode with 'selection' "exclusive" (same as 'v',
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5236 if not specified)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5237 o Operator-pending mode
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5238 i Insert mode
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5239 r Replace mode
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5240
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5241 Others: ~
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5242 c appending to the command-line
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5243 ci inserting in the command-line
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5244 cr replacing in the command-line
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5245 m at the 'Hit ENTER' or 'More' prompts
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5246 ml idem, but cursor in the last line
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5247 e any mode, pointer below last window
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5248 s any mode, pointer on a status line
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5249 sd any mode, while dragging a status line
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5250 vs any mode, pointer on a vertical separator line
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5251 vd any mode, while dragging a vertical separator line
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5252 a everywhere
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5253
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5254 The shape is one of the following:
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5255 avail name looks like ~
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5256 w x arrow Normal mouse pointer
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5257 w x blank no pointer at all (use with care!)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5258 w x beam I-beam
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5259 w x updown up-down sizing arrows
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5260 w x leftright left-right sizing arrows
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5261 w x busy The system's usual busy pointer
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5262 w x no The system's usual 'no input' pointer
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5263 x udsizing indicates up-down resizing
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5264 x lrsizing indicates left-right resizing
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5265 x crosshair like a big thin +
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5266 x hand1 black hand
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5267 x hand2 white hand
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5268 x pencil what you write with
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5269 x question big ?
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5270 x rightup-arrow arrow pointing right-up
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5271 w x up-arrow arrow pointing up
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5272 x <number> any X11 pointer number (see X11/cursorfont.h)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5273
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5274 The "avail" column contains a 'w' if the shape is available for Win32,
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5275 x for X11.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5276 Any modes not specified or shapes not available use the normal mouse
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5277 pointer.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5278
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5279 Example: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5280 :set mouseshape=s:udsizing,m:no
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5281 < will make the mouse turn to a sizing arrow over the status lines and
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5282 indicate no input when the hit-enter prompt is displayed (since
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5283 clicking the mouse has no effect in this state.)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5284
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5285 *'mousetime'* *'mouset'*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5286 'mousetime' 'mouset' number (default 500)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5287 global
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5288 Only for GUI, MS-DOS, Win32 and Unix with xterm. Defines the maximum
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5289 time in msec between two mouse clicks for the second click to be
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5290 recognized as a multi click.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5291
12608
b390f5003e2f patch 8.0.1182: cannot see or change mzscheme dll name
Christian Brabandt <cb@256bit.org>
parents: 12559
diff changeset
5292 *'mzschemedll'*
b390f5003e2f patch 8.0.1182: cannot see or change mzscheme dll name
Christian Brabandt <cb@256bit.org>
parents: 12559
diff changeset
5293 '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
5294 global
b390f5003e2f patch 8.0.1182: cannot see or change mzscheme dll name
Christian Brabandt <cb@256bit.org>
parents: 12559
diff changeset
5295 {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
5296 feature}
b390f5003e2f patch 8.0.1182: cannot see or change mzscheme dll name
Christian Brabandt <cb@256bit.org>
parents: 12559
diff changeset
5297 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
5298 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
5299 Environment variables are expanded |:set_env|.
12785
65d7fd8381a3 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 12756
diff changeset
5300 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
5301 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
5302 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
5303 security reasons.
b390f5003e2f patch 8.0.1182: cannot see or change mzscheme dll name
Christian Brabandt <cb@256bit.org>
parents: 12559
diff changeset
5304
b390f5003e2f patch 8.0.1182: cannot see or change mzscheme dll name
Christian Brabandt <cb@256bit.org>
parents: 12559
diff changeset
5305 *'mzschemegcdll'*
b390f5003e2f patch 8.0.1182: cannot see or change mzscheme dll name
Christian Brabandt <cb@256bit.org>
parents: 12559
diff changeset
5306 '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
5307 global
b390f5003e2f patch 8.0.1182: cannot see or change mzscheme dll name
Christian Brabandt <cb@256bit.org>
parents: 12559
diff changeset
5308 {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
5309 feature}
b390f5003e2f patch 8.0.1182: cannot see or change mzscheme dll name
Christian Brabandt <cb@256bit.org>
parents: 12559
diff changeset
5310 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
5311 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
5312 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
5313 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
5314 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
5315 security reasons.
b390f5003e2f patch 8.0.1182: cannot see or change mzscheme dll name
Christian Brabandt <cb@256bit.org>
parents: 12559
diff changeset
5316
14
946da5994c01 updated for version 7.0006
vimboss
parents: 13
diff changeset
5317 *'mzquantum'* *'mzq'*
946da5994c01 updated for version 7.0006
vimboss
parents: 13
diff changeset
5318 'mzquantum' 'mzq' number (default 100)
946da5994c01 updated for version 7.0006
vimboss
parents: 13
diff changeset
5319 global
946da5994c01 updated for version 7.0006
vimboss
parents: 13
diff changeset
5320 {not available when compiled without the |+mzscheme|
946da5994c01 updated for version 7.0006
vimboss
parents: 13
diff changeset
5321 feature}
946da5994c01 updated for version 7.0006
vimboss
parents: 13
diff changeset
5322 The number of milliseconds between polls for MzScheme threads.
946da5994c01 updated for version 7.0006
vimboss
parents: 13
diff changeset
5323 Negative or zero value means no thread scheduling.
11160
d0a20101ecb2 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 11063
diff changeset
5324 NOTE: This option is set to the Vim default value when 'compatible'
d0a20101ecb2 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 11063
diff changeset
5325 is reset.
14
946da5994c01 updated for version 7.0006
vimboss
parents: 13
diff changeset
5326
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5327 *'nrformats'* *'nf'*
9669
284b4eb307fc commit https://github.com/vim/vim/commit/8c08b5b569e2a9e9f63dea514591ecfa2d3bb392
Christian Brabandt <cb@256bit.org>
parents: 9665
diff changeset
5328 '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
5329 set to "bin,hex" in |defaults.vim|)
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5330 local to buffer
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5331 This defines what bases Vim will consider for numbers when using the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5332 CTRL-A and CTRL-X commands for adding to and subtracting from a number
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5333 respectively; see |CTRL-A| for more info on these commands.
625
81fe2ccc1207 updated for version 7.0179
vimboss
parents: 623
diff changeset
5334 alpha If included, single alphabetical characters will be
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5335 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
5336 letter index a), b), etc. *octal-nrformats*
625
81fe2ccc1207 updated for version 7.0179
vimboss
parents: 623
diff changeset
5337 octal If included, numbers that start with a zero will be considered
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5338 to be octal. Example: Using CTRL-A on "007" results in "010".
625
81fe2ccc1207 updated for version 7.0179
vimboss
parents: 623
diff changeset
5339 hex If included, numbers starting with "0x" or "0X" will be
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5340 considered to be hexadecimal. Example: Using CTRL-X on
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5341 "0x100" results in "0x0ff".
7528
53163e4d9e4f commit https://github.com/vim/vim/commit/25e4fcde767084d1a79e0926bc301c92987c0cce
Christian Brabandt <cb@256bit.org>
parents: 7477
diff changeset
5342 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
5343 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
5344 "0b1000" subtracts one, resulting in "0b0111".
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5345 Numbers which simply begin with a digit in the range 1-9 are always
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5346 considered decimal. This also happens for numbers that are not
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5347 recognized as octal or hex.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5348
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5349 *'number'* *'nu'* *'nonumber'* *'nonu'*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5350 'number' 'nu' boolean (default off)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5351 local to window
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5352 Print the line number in front of each line. When the 'n' option is
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5353 excluded from 'cpoptions' a wrapped line will not use the column of
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5354 line numbers (this is the default when 'compatible' isn't set).
13
24d5189d3956 updated for version 7.0005
vimboss
parents: 12
diff changeset
5355 The 'numberwidth' option can be used to set the room used for the line
24d5189d3956 updated for version 7.0005
vimboss
parents: 12
diff changeset
5356 number.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5357 When a long, wrapped line doesn't start with the first character, '-'
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5358 characters are put before the number.
3445
2cfb68fa26cd Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 3371
diff changeset
5359 See |hl-LineNr| and |hl-CursorLineNr| for the highlighting used for
2cfb68fa26cd Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 3371
diff changeset
5360 the number.
4780
2b11ac90d9e9 Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 4681
diff changeset
5361 *number_relativenumber*
2b11ac90d9e9 Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 4681
diff changeset
5362 The 'relativenumber' option changes the displayed number to be
2b11ac90d9e9 Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 4681
diff changeset
5363 relative to the cursor. Together with 'number' there are these
2b11ac90d9e9 Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 4681
diff changeset
5364 four combinations (cursor in line 3):
2b11ac90d9e9 Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 4681
diff changeset
5365
8629
54ac275e3fc4 commit https://github.com/vim/vim/commit/3848e00e0177abdb31bc600234967863ec487233
Christian Brabandt <cb@256bit.org>
parents: 8560
diff changeset
5366 'nonu' 'nu' 'nonu' 'nu'
4780
2b11ac90d9e9 Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 4681
diff changeset
5367 'nornu' 'nornu' 'rnu' 'rnu'
2b11ac90d9e9 Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 4681
diff changeset
5368
2b11ac90d9e9 Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 4681
diff changeset
5369 |apple | 1 apple | 2 apple | 2 apple
2b11ac90d9e9 Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 4681
diff changeset
5370 |pear | 2 pear | 1 pear | 1 pear
2b11ac90d9e9 Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 4681
diff changeset
5371 |nobody | 3 nobody | 0 nobody |3 nobody
2b11ac90d9e9 Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 4681
diff changeset
5372 |there | 4 there | 1 there | 1 there
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5373
13
24d5189d3956 updated for version 7.0005
vimboss
parents: 12
diff changeset
5374 *'numberwidth'* *'nuw'*
24d5189d3956 updated for version 7.0005
vimboss
parents: 12
diff changeset
5375 'numberwidth' 'nuw' number (Vim default: 4 Vi default: 8)
24d5189d3956 updated for version 7.0005
vimboss
parents: 12
diff changeset
5376 local to window
14
946da5994c01 updated for version 7.0006
vimboss
parents: 13
diff changeset
5377 {only available when compiled with the |+linebreak|
946da5994c01 updated for version 7.0006
vimboss
parents: 13
diff changeset
5378 feature}
13
24d5189d3956 updated for version 7.0005
vimboss
parents: 12
diff changeset
5379 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
5380 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
5381 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
5382 the text, there is one less character for the number itself.
13
24d5189d3956 updated for version 7.0005
vimboss
parents: 12
diff changeset
5383 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
5384 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
5385 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
5386 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
5387 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
5388 The minimum value is 1, the maximum value is 20.
11160
d0a20101ecb2 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 11063
diff changeset
5389 NOTE: This option is set to the Vi default value when 'compatible' is
d0a20101ecb2 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 11063
diff changeset
5390 set and to the Vim default value when 'compatible' is reset.
13
24d5189d3956 updated for version 7.0005
vimboss
parents: 12
diff changeset
5391
523
a7ae7e043e43 updated for version 7.0146
vimboss
parents: 519
diff changeset
5392 *'omnifunc'* *'ofu'*
a7ae7e043e43 updated for version 7.0146
vimboss
parents: 519
diff changeset
5393 'omnifunc' 'ofu' string (default: empty)
502
52e76e2b5b65 updated for version 7.0140
vimboss
parents: 500
diff changeset
5394 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
5395 {not available when compiled without the |+eval|
71b56b4e7785 Make the references to features in the help more consistent. (Sylvain Hitier)
Bram Moolenaar <bram@vim.org>
parents: 2561
diff changeset
5396 or |+insert_expand| features}
623
bd2fe62c9d77 updated for version 7.0178
vimboss
parents: 596
diff changeset
5397 This option specifies a function to be used for Insert mode omni
bd2fe62c9d77 updated for version 7.0178
vimboss
parents: 596
diff changeset
5398 completion with CTRL-X CTRL-O. |i_CTRL-X_CTRL-O|
648
9032e4668296 updated for version 7.0189
vimboss
parents: 642
diff changeset
5399 See |complete-functions| for an explanation of how the function is
9032e4668296 updated for version 7.0189
vimboss
parents: 642
diff changeset
5400 invoked and what it should return.
1004
09d0e83c29b8 updated for version 7.0-130
vimboss
parents: 874
diff changeset
5401 This option is usually set by a filetype plugin:
859
99305c4c42d4 updated for version 7.0g02
vimboss
parents: 857
diff changeset
5402 |:filetype-plugin-on|
3682
11d40fc82f11 Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 3674
diff changeset
5403 This option cannot be set from a |modeline| or in the |sandbox|, for
11d40fc82f11 Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 3674
diff changeset
5404 security reasons.
502
52e76e2b5b65 updated for version 7.0140
vimboss
parents: 500
diff changeset
5405
52e76e2b5b65 updated for version 7.0140
vimboss
parents: 500
diff changeset
5406
1152
e1787f5b90da updated for version 7.1a
vimboss
parents: 1111
diff changeset
5407 *'opendevice'* *'odev'* *'noopendevice'* *'noodev'*
1004
09d0e83c29b8 updated for version 7.0-130
vimboss
parents: 874
diff changeset
5408 'opendevice' 'odev' boolean (default off)
09d0e83c29b8 updated for version 7.0-130
vimboss
parents: 874
diff changeset
5409 global
09d0e83c29b8 updated for version 7.0-130
vimboss
parents: 874
diff changeset
5410 {only for MS-DOS, MS-Windows and OS/2}
09d0e83c29b8 updated for version 7.0-130
vimboss
parents: 874
diff changeset
5411 Enable reading and writing from devices. This may get Vim stuck on a
09d0e83c29b8 updated for version 7.0-130
vimboss
parents: 874
diff changeset
5412 device that can be opened but doesn't actually do the I/O. Therefore
09d0e83c29b8 updated for version 7.0-130
vimboss
parents: 874
diff changeset
5413 it is off by default.
09d0e83c29b8 updated for version 7.0-130
vimboss
parents: 874
diff changeset
5414 Note that on MS-Windows editing "aux.h", "lpt1.txt" and the like also
09d0e83c29b8 updated for version 7.0-130
vimboss
parents: 874
diff changeset
5415 result in editing a device.
09d0e83c29b8 updated for version 7.0-130
vimboss
parents: 874
diff changeset
5416
09d0e83c29b8 updated for version 7.0-130
vimboss
parents: 874
diff changeset
5417
593
d220eb88e4e4 updated for version 7.0168
vimboss
parents: 590
diff changeset
5418 *'operatorfunc'* *'opfunc'*
d220eb88e4e4 updated for version 7.0168
vimboss
parents: 590
diff changeset
5419 'operatorfunc' 'opfunc' string (default: empty)
d220eb88e4e4 updated for version 7.0168
vimboss
parents: 590
diff changeset
5420 global
d220eb88e4e4 updated for version 7.0168
vimboss
parents: 590
diff changeset
5421 This option specifies a function to be called by the |g@| operator.
d220eb88e4e4 updated for version 7.0168
vimboss
parents: 590
diff changeset
5422 See |:map-operator| for more info and an example.
d220eb88e4e4 updated for version 7.0168
vimboss
parents: 590
diff changeset
5423
d220eb88e4e4 updated for version 7.0168
vimboss
parents: 590
diff changeset
5424 This option cannot be set from a |modeline| or in the |sandbox|, for
d220eb88e4e4 updated for version 7.0168
vimboss
parents: 590
diff changeset
5425 security reasons.
d220eb88e4e4 updated for version 7.0168
vimboss
parents: 590
diff changeset
5426
d220eb88e4e4 updated for version 7.0168
vimboss
parents: 590
diff changeset
5427
2908
fd09a9c8468e Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 2873
diff changeset
5428 *'osfiletype'* *'oft'*
fd09a9c8468e Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 2873
diff changeset
5429 'osfiletype' 'oft' string (default: "")
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5430 local to buffer
2908
fd09a9c8468e Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 2873
diff changeset
5431 This option was supported on RISC OS, which has been removed.
fd09a9c8468e Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 2873
diff changeset
5432
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5433
8182
95d59081580f commit https://github.com/vim/vim/commit/f6fee0e2d4341c0c2f5339c1268e5877fafd07cf
Christian Brabandt <cb@256bit.org>
parents: 8148
diff changeset
5434 *'packpath'* *'pp'*
95d59081580f commit https://github.com/vim/vim/commit/f6fee0e2d4341c0c2f5339c1268e5877fafd07cf
Christian Brabandt <cb@256bit.org>
parents: 8148
diff changeset
5435 'packpath' 'pp' string (default: see 'runtimepath')
95d59081580f commit https://github.com/vim/vim/commit/f6fee0e2d4341c0c2f5339c1268e5877fafd07cf
Christian Brabandt <cb@256bit.org>
parents: 8148
diff changeset
5436 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
5437
95d59081580f commit https://github.com/vim/vim/commit/f6fee0e2d4341c0c2f5339c1268e5877fafd07cf
Christian Brabandt <cb@256bit.org>
parents: 8148
diff changeset
5438
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5439 *'paragraphs'* *'para'*
1564
8c9396275bfa updated for version 7.1-277
vimboss
parents: 1521
diff changeset
5440 'paragraphs' 'para' string (default "IPLPPPQPP TPHPLIPpLpItpplpipbp")
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5441 global
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5442 Specifies the nroff macros that separate paragraphs. These are pairs
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5443 of two letters (see |object-motions|).
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5444
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5445 *'paste'* *'nopaste'*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5446 'paste' boolean (default off)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5447 global
10
4e2284e71352 updated for version 7.0002
vimboss
parents: 8
diff changeset
5448 Put Vim in Paste mode. This is useful if you want to cut or copy
4e2284e71352 updated for version 7.0002
vimboss
parents: 8
diff changeset
5449 some text from one window and paste it in Vim. This will avoid
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5450 unexpected effects.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5451 Setting this option is useful when using Vim in a terminal, where Vim
10
4e2284e71352 updated for version 7.0002
vimboss
parents: 8
diff changeset
5452 cannot distinguish between typed text and pasted text. In the GUI, Vim
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5453 knows about pasting and will mostly do the right thing without 'paste'
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5454 being set. The same is true for a terminal where Vim handles the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5455 mouse clicks itself.
148
72aefd4c1e0d updated for version 7.0046
vimboss
parents: 140
diff changeset
5456 This option is reset when starting the GUI. Thus if you set it in
72aefd4c1e0d updated for version 7.0046
vimboss
parents: 140
diff changeset
5457 your .vimrc it will work in a terminal, but not in the GUI. Setting
72aefd4c1e0d updated for version 7.0046
vimboss
parents: 140
diff changeset
5458 'paste' in the GUI has side effects: e.g., the Paste toolbar button
72aefd4c1e0d updated for version 7.0046
vimboss
parents: 140
diff changeset
5459 will no longer work in Insert mode, because it uses a mapping.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5460 When the 'paste' option is switched on (also when it was already on):
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5461 - mapping in Insert mode and Command-line mode is disabled
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5462 - abbreviations are disabled
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5463 - 'autoindent' is reset
7147
c590de398af9 commit https://github.com/vim/vim/commit/ca63501fbcd1cf9c8aa9ff12c093c95b62a89ed7
Christian Brabandt <cb@256bit.org>
parents: 7080
diff changeset
5464 - 'expandtab' is reset
c590de398af9 commit https://github.com/vim/vim/commit/ca63501fbcd1cf9c8aa9ff12c093c95b62a89ed7
Christian Brabandt <cb@256bit.org>
parents: 7080
diff changeset
5465 - 'formatoptions' is used like it is empty
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5466 - 'revins' is reset
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5467 - 'ruler' is reset
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5468 - 'showmatch' is reset
7147
c590de398af9 commit https://github.com/vim/vim/commit/ca63501fbcd1cf9c8aa9ff12c093c95b62a89ed7
Christian Brabandt <cb@256bit.org>
parents: 7080
diff changeset
5469 - 'smartindent' is reset
c590de398af9 commit https://github.com/vim/vim/commit/ca63501fbcd1cf9c8aa9ff12c093c95b62a89ed7
Christian Brabandt <cb@256bit.org>
parents: 7080
diff changeset
5470 - 'smarttab' is reset
c590de398af9 commit https://github.com/vim/vim/commit/ca63501fbcd1cf9c8aa9ff12c093c95b62a89ed7
Christian Brabandt <cb@256bit.org>
parents: 7080
diff changeset
5471 - 'softtabstop' is set to 0
c590de398af9 commit https://github.com/vim/vim/commit/ca63501fbcd1cf9c8aa9ff12c093c95b62a89ed7
Christian Brabandt <cb@256bit.org>
parents: 7080
diff changeset
5472 - 'textwidth' is set to 0
c590de398af9 commit https://github.com/vim/vim/commit/ca63501fbcd1cf9c8aa9ff12c093c95b62a89ed7
Christian Brabandt <cb@256bit.org>
parents: 7080
diff changeset
5473 - 'wrapmargin' is set to 0
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5474 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
5475 - 'cindent'
c590de398af9 commit https://github.com/vim/vim/commit/ca63501fbcd1cf9c8aa9ff12c093c95b62a89ed7
Christian Brabandt <cb@256bit.org>
parents: 7080
diff changeset
5476 - 'indentexpr'
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5477 - 'lisp'
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5478 NOTE: When you start editing another file while the 'paste' option is
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5479 on, settings from the modelines or autocommands may change the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5480 settings again, causing trouble when pasting text. You might want to
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5481 set the 'paste' option again.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5482 When the 'paste' option is reset the mentioned options are restored to
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5483 the value before the moment 'paste' was switched from off to on.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5484 Resetting 'paste' before ever setting it does not have any effect.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5485 Since mapping doesn't work while 'paste' is active, you need to use
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5486 the 'pastetoggle' option to toggle the 'paste' option with some key.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5487
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5488 *'pastetoggle'* *'pt'*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5489 'pastetoggle' 'pt' string (default "")
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5490 global
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5491 When non-empty, specifies the key sequence that toggles the 'paste'
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5492 option. This is like specifying a mapping: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5493 :map {keys} :set invpaste<CR>
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5494 < Where {keys} is the value of 'pastetoggle'.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5495 The difference is that it will work even when 'paste' is set.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5496 'pastetoggle' works in Insert mode and Normal mode, but not in
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5497 Command-line mode.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5498 Mappings are checked first, thus overrule 'pastetoggle'. However,
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5499 when 'paste' is on mappings are ignored in Insert mode, thus you can do
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5500 this: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5501 :map <F10> :set paste<CR>
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5502 :map <F11> :set nopaste<CR>
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5503 :imap <F10> <C-O>:set paste<CR>
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5504 :imap <F11> <nop>
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5505 :set pastetoggle=<F11>
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5506 < This will make <F10> start paste mode and <F11> stop paste mode.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5507 Note that typing <F10> in paste mode inserts "<F10>", since in paste
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5508 mode everything is inserted literally, except the 'pastetoggle' key
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5509 sequence.
1621
82b5078be2dd updated for version 7.2a
vimboss
parents: 1564
diff changeset
5510 When the value has several bytes 'ttimeoutlen' applies.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5511
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5512 *'pex'* *'patchexpr'*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5513 'patchexpr' 'pex' string (default "")
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5514 global
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5515 {not available when compiled without the |+diff|
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5516 feature}
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5517 Expression which is evaluated to apply a patch to a file and generate
10
4e2284e71352 updated for version 7.0002
vimboss
parents: 8
diff changeset
5518 the resulting new version of the file. See |diff-patchexpr|.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5519
6091
7090d7f160f7 Update runtime files. Add vroom file support.
Bram Moolenaar <bram@vim.org>
parents: 6032
diff changeset
5520 *'patchmode'* *'pm'* *E205* *E206*
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5521 'patchmode' 'pm' string (default "")
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5522 global
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5523 When non-empty the oldest version of a file is kept. This can be used
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5524 to keep the original version of a file if you are changing files in a
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5525 source distribution. Only the first time that a file is written a
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5526 copy of the original file will be kept. The name of the copy is the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5527 name of the original file with the string in the 'patchmode' option
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5528 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
5529 ".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
5530 (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
5531 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
5532 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
5533 empty file is created.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5534 When the 'backupskip' pattern matches, a patchmode file is not made.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5535 Using 'patchmode' for compressed files appends the extension at the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5536 end (e.g., "file.gz.orig"), thus the resulting name isn't always
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5537 recognized as a compressed file.
36
125e80798a85 updated for version 7.0021
vimboss
parents: 33
diff changeset
5538 Only normal file name characters can be used, "/\*?[|<>" are illegal.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5539
3224
8b8ef1fed009 Update runtime files.
Bram Moolenaar <bram@vim.org>
parents: 3153
diff changeset
5540 *'path'* *'pa'* *E343* *E345* *E347* *E854*
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5541 'path' 'pa' string (default on Unix: ".,/usr/include,,"
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5542 on OS/2: ".,/emx/include,,"
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5543 other systems: ".,,")
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5544 global or local to buffer |global-local|
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5545 This is a list of directories which will be searched when using the
1668
0b796e045c42 updated for version 7.2b-000
vimboss
parents: 1621
diff changeset
5546 |gf|, [f, ]f, ^Wf, |:find|, |:sfind|, |:tabfind| and other commands,
0b796e045c42 updated for version 7.2b-000
vimboss
parents: 1621
diff changeset
5547 provided that the file being searched for has a relative path (not
0b796e045c42 updated for version 7.2b-000
vimboss
parents: 1621
diff changeset
5548 starting with "/", "./" or "../"). The directories in the 'path'
0b796e045c42 updated for version 7.2b-000
vimboss
parents: 1621
diff changeset
5549 option may be relative or absolute.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5550 - Use commas to separate directory names: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5551 :set path=.,/usr/local/include,/usr/include
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5552 < - Spaces can also be used to separate directory names (for backwards
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5553 compatibility with version 3.0). To have a space in a directory
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5554 name, precede it with an extra backslash, and escape the space: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5555 :set path=.,/dir/with\\\ space
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5556 < - To include a comma in a directory name precede it with an extra
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5557 backslash: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5558 :set path=.,/dir/with\\,comma
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5559 < - To search relative to the directory of the current file, use: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5560 :set path=.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5561 < - To search in the current directory use an empty string between two
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5562 commas: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5563 :set path=,,
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5564 < - A directory name may end in a ':' or '/'.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5565 - Environment variables are expanded |:set_env|.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5566 - When using |netrw.vim| URLs can be used. For example, adding
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5567 "http://www.vim.org" will make ":find index.html" work.
1668
0b796e045c42 updated for version 7.2b-000
vimboss
parents: 1621
diff changeset
5568 - Search upwards and downwards in a directory tree using "*", "**" and
0b796e045c42 updated for version 7.2b-000
vimboss
parents: 1621
diff changeset
5569 ";". See |file-searching| for info and syntax.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5570 {not available when compiled without the |+path_extra| feature}
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5571 - Careful with '\' characters, type two to get one in the option: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5572 :set path=.,c:\\include
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5573 < Or just use '/' instead: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5574 :set path=.,c:/include
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5575 < Don't forget "." or files won't even be found in the same directory as
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5576 the file!
10
4e2284e71352 updated for version 7.0002
vimboss
parents: 8
diff changeset
5577 The maximum length is limited. How much depends on the system, mostly
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5578 it is something like 256 or 1024 characters.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5579 You can check if all the include files are found, using the value of
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5580 'path', see |:checkpath|.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5581 The use of |:set+=| and |:set-=| is preferred when adding or removing
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5582 directories from the list. This avoids problems when a future version
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5583 uses another default. To remove the current directory use: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5584 :set path-=
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5585 < To add the current directory use: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5586 :set path+=
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5587 < To use an environment variable, you probably need to replace the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5588 separator. Here is an example to append $INCL, in which directory
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5589 names are separated with a semi-colon: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5590 :let &path = &path . "," . substitute($INCL, ';', ',', 'g')
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5591 < Replace the ';' with a ':' or whatever separator is used. Note that
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5592 this doesn't work when $INCL contains a comma or white space.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5593
12499
d91cf2e26ef0 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 12469
diff changeset
5594 *'perldll'*
d91cf2e26ef0 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 12469
diff changeset
5595 'perldll' string (default depends on the build)
d91cf2e26ef0 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 12469
diff changeset
5596 global
d91cf2e26ef0 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 12469
diff changeset
5597 {only available when compiled with the |+perl/dyn|
d91cf2e26ef0 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 12469
diff changeset
5598 feature}
d91cf2e26ef0 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 12469
diff changeset
5599 Specifies the name of the Perl shared library. The default is
d91cf2e26ef0 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 12469
diff changeset
5600 DYNAMIC_PERL_DLL, which was specified at compile time.
d91cf2e26ef0 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 12469
diff changeset
5601 Environment variables are expanded |:set_env|.
d91cf2e26ef0 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 12469
diff changeset
5602 This option cannot be set from a |modeline| or in the |sandbox|, for
d91cf2e26ef0 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 12469
diff changeset
5603 security reasons.
d91cf2e26ef0 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 12469
diff changeset
5604
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5605 *'preserveindent'* *'pi'* *'nopreserveindent'* *'nopi'*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5606 'preserveindent' 'pi' boolean (default off)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5607 local to buffer
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5608 When changing the indent of the current line, preserve as much of the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5609 indent structure as possible. Normally the indent is replaced by a
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5610 series of tabs followed by spaces as required (unless |'expandtab'| is
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5611 enabled, in which case only spaces are used). Enabling this option
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5612 means the indent will preserve as many existing characters as possible
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5613 for indenting, and only add additional tabs or spaces as required.
1621
82b5078be2dd updated for version 7.2a
vimboss
parents: 1564
diff changeset
5614 'expandtab' does not apply to the preserved white space, a Tab remains
82b5078be2dd updated for version 7.2a
vimboss
parents: 1564
diff changeset
5615 a Tab.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5616 NOTE: When using ">>" multiple times the resulting indent is a mix of
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5617 tabs and spaces. You might not like this.
11160
d0a20101ecb2 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 11063
diff changeset
5618 NOTE: This option is reset when 'compatible' is set.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5619 Also see 'copyindent'.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5620 Use |:retab| to clean up white space.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5621
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5622 *'previewheight'* *'pvh'*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5623 'previewheight' 'pvh' number (default 12)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5624 global
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5625 {not available when compiled without the |+windows| or
2570
71b56b4e7785 Make the references to features in the help more consistent. (Sylvain Hitier)
Bram Moolenaar <bram@vim.org>
parents: 2561
diff changeset
5626 |+quickfix| features}
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5627 Default height for a preview window. Used for |:ptag| and associated
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5628 commands. Used for |CTRL-W_}| when no count is given.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5629
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5630 *'previewwindow'* *'nopreviewwindow'*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5631 *'pvw'* *'nopvw'* *E590*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5632 'previewwindow' 'pvw' boolean (default off)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5633 local to window
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5634 {not available when compiled without the |+windows| or
2570
71b56b4e7785 Make the references to features in the help more consistent. (Sylvain Hitier)
Bram Moolenaar <bram@vim.org>
parents: 2561
diff changeset
5635 |+quickfix| features}
10
4e2284e71352 updated for version 7.0002
vimboss
parents: 8
diff changeset
5636 Identifies the preview window. Only one window can have this option
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5637 set. It's normally not set directly, but by using one of the commands
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5638 |:ptag|, |:pedit|, etc.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5639
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5640 *'printdevice'* *'pdev'*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5641 'printdevice' 'pdev' string (default empty)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5642 global
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5643 {only available when compiled with the |+printer|
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5644 feature}
15
631143ac4a01 updated for version 7.0007
vimboss
parents: 14
diff changeset
5645 The name of the printer to be used for |:hardcopy|.
631143ac4a01 updated for version 7.0007
vimboss
parents: 14
diff changeset
5646 See |pdev-option|.
36
125e80798a85 updated for version 7.0021
vimboss
parents: 33
diff changeset
5647 This option cannot be set from a |modeline| or in the |sandbox|, for
125e80798a85 updated for version 7.0021
vimboss
parents: 33
diff changeset
5648 security reasons.
15
631143ac4a01 updated for version 7.0007
vimboss
parents: 14
diff changeset
5649
631143ac4a01 updated for version 7.0007
vimboss
parents: 14
diff changeset
5650 *'printencoding'* *'penc'*
14864
40ef13331e02 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 14702
diff changeset
5651 'printencoding' 'penc' string (default empty, except for some systems)
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5652 global
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5653 {only available when compiled with the |+printer|
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5654 and |+postscript| features}
15
631143ac4a01 updated for version 7.0007
vimboss
parents: 14
diff changeset
5655 Sets the character encoding used when printing.
631143ac4a01 updated for version 7.0007
vimboss
parents: 14
diff changeset
5656 See |penc-option|.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5657
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5658 *'printexpr'* *'pexpr'*
14864
40ef13331e02 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 14702
diff changeset
5659 'printexpr' 'pexpr' string (default: see below)
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5660 global
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5661 {only available when compiled with the |+printer|
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5662 and |+postscript| features}
15
631143ac4a01 updated for version 7.0007
vimboss
parents: 14
diff changeset
5663 Expression used to print the PostScript produced with |:hardcopy|.
631143ac4a01 updated for version 7.0007
vimboss
parents: 14
diff changeset
5664 See |pexpr-option|.
10449
222b1432814e commit https://github.com/vim/vim/commit/5162822914372fc916a93f85848c0c82209e7cec
Christian Brabandt <cb@256bit.org>
parents: 10272
diff changeset
5665 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
5666 security reasons.
15
631143ac4a01 updated for version 7.0007
vimboss
parents: 14
diff changeset
5667
631143ac4a01 updated for version 7.0007
vimboss
parents: 14
diff changeset
5668 *'printfont'* *'pfn'*
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5669 'printfont' 'pfn' string (default "courier")
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5670 global
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5671 {only available when compiled with the |+printer|
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5672 feature}
15
631143ac4a01 updated for version 7.0007
vimboss
parents: 14
diff changeset
5673 The name of the font that will be used for |:hardcopy|.
631143ac4a01 updated for version 7.0007
vimboss
parents: 14
diff changeset
5674 See |pfn-option|.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5675
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5676 *'printheader'* *'pheader'*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5677 'printheader' 'pheader' string (default "%<%f%h%m%=Page %N")
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5678 global
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5679 {only available when compiled with the |+printer|
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5680 feature}
15
631143ac4a01 updated for version 7.0007
vimboss
parents: 14
diff changeset
5681 The format of the header produced in |:hardcopy| output.
631143ac4a01 updated for version 7.0007
vimboss
parents: 14
diff changeset
5682 See |pheader-option|.
631143ac4a01 updated for version 7.0007
vimboss
parents: 14
diff changeset
5683
631143ac4a01 updated for version 7.0007
vimboss
parents: 14
diff changeset
5684 *'printmbcharset'* *'pmbcs'*
631143ac4a01 updated for version 7.0007
vimboss
parents: 14
diff changeset
5685 'printmbcharset' 'pmbcs' string (default "")
631143ac4a01 updated for version 7.0007
vimboss
parents: 14
diff changeset
5686 global
15878
314694a2e74a Update runtime files.
Bram Moolenaar <Bram@vim.org>
parents: 15850
diff changeset
5687 {only available when compiled with the |+printer|
314694a2e74a Update runtime files.
Bram Moolenaar <Bram@vim.org>
parents: 15850
diff changeset
5688 and |+postscript| features}
15
631143ac4a01 updated for version 7.0007
vimboss
parents: 14
diff changeset
5689 The CJK character set to be used for CJK output from |:hardcopy|.
631143ac4a01 updated for version 7.0007
vimboss
parents: 14
diff changeset
5690 See |pmbcs-option|.
631143ac4a01 updated for version 7.0007
vimboss
parents: 14
diff changeset
5691
631143ac4a01 updated for version 7.0007
vimboss
parents: 14
diff changeset
5692 *'printmbfont'* *'pmbfn'*
631143ac4a01 updated for version 7.0007
vimboss
parents: 14
diff changeset
5693 'printmbfont' 'pmbfn' string (default "")
631143ac4a01 updated for version 7.0007
vimboss
parents: 14
diff changeset
5694 global
15878
314694a2e74a Update runtime files.
Bram Moolenaar <Bram@vim.org>
parents: 15850
diff changeset
5695 {only available when compiled with the |+printer|
314694a2e74a Update runtime files.
Bram Moolenaar <Bram@vim.org>
parents: 15850
diff changeset
5696 and |+postscript| features}
15
631143ac4a01 updated for version 7.0007
vimboss
parents: 14
diff changeset
5697 List of font names to be used for CJK output from |:hardcopy|.
631143ac4a01 updated for version 7.0007
vimboss
parents: 14
diff changeset
5698 See |pmbfn-option|.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5699
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5700 *'printoptions'* *'popt'*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5701 'printoptions' 'popt' string (default "")
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5702 global
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5703 {only available when compiled with |+printer| feature}
15
631143ac4a01 updated for version 7.0007
vimboss
parents: 14
diff changeset
5704 List of items that control the format of the output of |:hardcopy|.
631143ac4a01 updated for version 7.0007
vimboss
parents: 14
diff changeset
5705 See |popt-option|.
631143ac4a01 updated for version 7.0007
vimboss
parents: 14
diff changeset
5706
168
4d9eabb1396e updated for version 7.0051
vimboss
parents: 164
diff changeset
5707 *'prompt'* *'noprompt'*
4d9eabb1396e updated for version 7.0051
vimboss
parents: 164
diff changeset
5708 'prompt' boolean (default on)
4d9eabb1396e updated for version 7.0051
vimboss
parents: 164
diff changeset
5709 global
4d9eabb1396e updated for version 7.0051
vimboss
parents: 164
diff changeset
5710 When on a ":" prompt is used in Ex mode.
4d9eabb1396e updated for version 7.0051
vimboss
parents: 164
diff changeset
5711
766
f0d0d3d3a1e2 updated for version 7.0225
vimboss
parents: 743
diff changeset
5712 *'pumheight'* *'ph'*
f0d0d3d3a1e2 updated for version 7.0225
vimboss
parents: 743
diff changeset
5713 'pumheight' 'ph' number (default 0)
f0d0d3d3a1e2 updated for version 7.0225
vimboss
parents: 743
diff changeset
5714 global
f0d0d3d3a1e2 updated for version 7.0225
vimboss
parents: 743
diff changeset
5715 {not available when compiled without the
f0d0d3d3a1e2 updated for version 7.0225
vimboss
parents: 743
diff changeset
5716 |+insert_expand| feature}
853
d10fbefd3bc1 updated for version 7.0f05
vimboss
parents: 844
diff changeset
5717 Determines the maximum number of items to show in the popup menu for
d10fbefd3bc1 updated for version 7.0f05
vimboss
parents: 844
diff changeset
5718 Insert mode completion. When zero as much space as available is used.
766
f0d0d3d3a1e2 updated for version 7.0225
vimboss
parents: 743
diff changeset
5719 |ins-completion-menu|.
f0d0d3d3a1e2 updated for version 7.0225
vimboss
parents: 743
diff changeset
5720
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
5721 *'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
5722 '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
5723 global
6e972d830e13 patch 8.0.1491: the minimum width of the popup menu is hard coded
Christian Brabandt <cb@256bit.org>
parents: 13231
diff changeset
5724 {not available when compiled without the
6e972d830e13 patch 8.0.1491: the minimum width of the popup menu is hard coded
Christian Brabandt <cb@256bit.org>
parents: 13231
diff changeset
5725 |+insert_expand| feature}
13341
acd7eaa13d2b Updated runtime files.
Christian Brabandt <cb@256bit.org>
parents: 13314
diff changeset
5726 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
5727 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
5728
7228
873eae260c97 commit https://github.com/vim/vim/commit/b4ff518d95aa57c2f8c0568c915035bef849581b
Christian Brabandt <cb@256bit.org>
parents: 7218
diff changeset
5729 *'pythondll'*
8629
54ac275e3fc4 commit https://github.com/vim/vim/commit/3848e00e0177abdb31bc600234967863ec487233
Christian Brabandt <cb@256bit.org>
parents: 8560
diff changeset
5730 '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
5731 global
7228
873eae260c97 commit https://github.com/vim/vim/commit/b4ff518d95aa57c2f8c0568c915035bef849581b
Christian Brabandt <cb@256bit.org>
parents: 7218
diff changeset
5732 {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
5733 feature}
7528
53163e4d9e4f commit https://github.com/vim/vim/commit/25e4fcde767084d1a79e0926bc301c92987c0cce
Christian Brabandt <cb@256bit.org>
parents: 7477
diff changeset
5734 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
5735 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
5736 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
5737 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
5738 security reasons.
873eae260c97 commit https://github.com/vim/vim/commit/b4ff518d95aa57c2f8c0568c915035bef849581b
Christian Brabandt <cb@256bit.org>
parents: 7218
diff changeset
5739
13154
53cc7ea77c54 patch 8.0.1451: difficult to set the python home directories properly
Christian Brabandt <cb@256bit.org>
parents: 13150
diff changeset
5740 *'pythonhome'*
53cc7ea77c54 patch 8.0.1451: difficult to set the python home directories properly
Christian Brabandt <cb@256bit.org>
parents: 13150
diff changeset
5741 '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
5742 global
53cc7ea77c54 patch 8.0.1451: difficult to set the python home directories properly
Christian Brabandt <cb@256bit.org>
parents: 13150
diff changeset
5743 {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
5744 feature}
53cc7ea77c54 patch 8.0.1451: difficult to set the python home directories properly
Christian Brabandt <cb@256bit.org>
parents: 13150
diff changeset
5745 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
5746 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
5747 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
5748 home directory.
53cc7ea77c54 patch 8.0.1451: difficult to set the python home directories properly
Christian Brabandt <cb@256bit.org>
parents: 13150
diff changeset
5749 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
5750 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
5751 security reasons.
53cc7ea77c54 patch 8.0.1451: difficult to set the python home directories properly
Christian Brabandt <cb@256bit.org>
parents: 13150
diff changeset
5752
7218
36dc8df8560f commit https://github.com/vim/vim/commit/0796c0625fa4b9eb2f47fe8c976b78523924e1fb
Christian Brabandt <cb@256bit.org>
parents: 7196
diff changeset
5753 *'pythonthreedll'*
7528
53163e4d9e4f commit https://github.com/vim/vim/commit/25e4fcde767084d1a79e0926bc301c92987c0cce
Christian Brabandt <cb@256bit.org>
parents: 7477
diff changeset
5754 '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
5755 global
7196
42717d048817 commit https://github.com/vim/vim/commit/d94464ee294a351ce7b6ba18e8bd3f24f1bef920
Christian Brabandt <cb@256bit.org>
parents: 7147
diff changeset
5756 {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
5757 feature}
7528
53163e4d9e4f commit https://github.com/vim/vim/commit/25e4fcde767084d1a79e0926bc301c92987c0cce
Christian Brabandt <cb@256bit.org>
parents: 7477
diff changeset
5758 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
5759 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
5760 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
5761 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
5762 security reasons.
42717d048817 commit https://github.com/vim/vim/commit/d94464ee294a351ce7b6ba18e8bd3f24f1bef920
Christian Brabandt <cb@256bit.org>
parents: 7147
diff changeset
5763
13154
53cc7ea77c54 patch 8.0.1451: difficult to set the python home directories properly
Christian Brabandt <cb@256bit.org>
parents: 13150
diff changeset
5764 *'pythonthreehome'*
53cc7ea77c54 patch 8.0.1451: difficult to set the python home directories properly
Christian Brabandt <cb@256bit.org>
parents: 13150
diff changeset
5765 '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
5766 global
53cc7ea77c54 patch 8.0.1451: difficult to set the python home directories properly
Christian Brabandt <cb@256bit.org>
parents: 13150
diff changeset
5767 {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
5768 feature}
53cc7ea77c54 patch 8.0.1451: difficult to set the python home directories properly
Christian Brabandt <cb@256bit.org>
parents: 13150
diff changeset
5769 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
5770 '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
5771 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
5772 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
5773 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
5774 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
5775 security reasons.
53cc7ea77c54 patch 8.0.1451: difficult to set the python home directories properly
Christian Brabandt <cb@256bit.org>
parents: 13150
diff changeset
5776
10722
7598ce51bf2a patch 8.0.0251: not easy to select Python 2 or 3
Christian Brabandt <cb@256bit.org>
parents: 10617
diff changeset
5777 *'pyxversion'* *'pyx'*
7598ce51bf2a patch 8.0.0251: not easy to select Python 2 or 3
Christian Brabandt <cb@256bit.org>
parents: 10617
diff changeset
5778 '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
5779 global
7598ce51bf2a patch 8.0.0251: not easy to select Python 2 or 3
Christian Brabandt <cb@256bit.org>
parents: 10617
diff changeset
5780 {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
5781 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
5782 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
5783 |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
5784
7598ce51bf2a patch 8.0.0251: not easy to select Python 2 or 3
Christian Brabandt <cb@256bit.org>
parents: 10617
diff changeset
5785 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
5786 |+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
5787 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
5788 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
5789
7598ce51bf2a patch 8.0.0251: not easy to select Python 2 or 3
Christian Brabandt <cb@256bit.org>
parents: 10617
diff changeset
5790 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
5791 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
5792 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
5793 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
5794 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
5795 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
5796
7598ce51bf2a patch 8.0.0251: not easy to select Python 2 or 3
Christian Brabandt <cb@256bit.org>
parents: 10617
diff changeset
5797 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
5798 '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
5799 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
5800
7598ce51bf2a patch 8.0.0251: not easy to select Python 2 or 3
Christian Brabandt <cb@256bit.org>
parents: 10617
diff changeset
5801 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
5802 security reasons.
7598ce51bf2a patch 8.0.0251: not easy to select Python 2 or 3
Christian Brabandt <cb@256bit.org>
parents: 10617
diff changeset
5803
140
8ecb0db93e9a updated for version 7.0045
vimboss
parents: 99
diff changeset
5804 *'quoteescape'* *'qe'*
12
bdeee1504ac1 updated for version 7.0004
vimboss
parents: 11
diff changeset
5805 'quoteescape' 'qe' string (default "\")
bdeee1504ac1 updated for version 7.0004
vimboss
parents: 11
diff changeset
5806 local to buffer
bdeee1504ac1 updated for version 7.0004
vimboss
parents: 11
diff changeset
5807 The characters that are used to escape quotes in a string. Used for
bdeee1504ac1 updated for version 7.0004
vimboss
parents: 11
diff changeset
5808 objects like a', a" and a` |a'|.
bdeee1504ac1 updated for version 7.0004
vimboss
parents: 11
diff changeset
5809 When one of the characters in this option is found inside a string,
bdeee1504ac1 updated for version 7.0004
vimboss
parents: 11
diff changeset
5810 the following character will be skipped. The default value makes the
bdeee1504ac1 updated for version 7.0004
vimboss
parents: 11
diff changeset
5811 text "foo\"bar\\" considered to be one string.
bdeee1504ac1 updated for version 7.0004
vimboss
parents: 11
diff changeset
5812
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5813 *'readonly'* *'ro'* *'noreadonly'* *'noro'*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5814 'readonly' 'ro' boolean (default off)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5815 local to buffer
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5816 If on, writes fail unless you use a '!'. Protects you from
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5817 accidentally overwriting a file. Default on when Vim is started
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5818 in read-only mode ("vim -R") or when the executable is called "view".
164
8b0ee9d57d7f updated for version 7.0050
vimboss
parents: 161
diff changeset
5819 When using ":w!" the 'readonly' option is reset for the current
8b0ee9d57d7f updated for version 7.0050
vimboss
parents: 161
diff changeset
5820 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
5821 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
5822 newly edited buffer.
10617
9a75c8a1b8b1 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 10579
diff changeset
5823 See 'modifiable' for disallowing changes to the buffer.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5824
1521
cc4fe241baa3 updated for version 7.1-236
vimboss
parents: 1354
diff changeset
5825 *'redrawtime'* *'rdt'*
cc4fe241baa3 updated for version 7.1-236
vimboss
parents: 1354
diff changeset
5826 'redrawtime' 'rdt' number (default 2000)
cc4fe241baa3 updated for version 7.1-236
vimboss
parents: 1354
diff changeset
5827 global
cc4fe241baa3 updated for version 7.1-236
vimboss
parents: 1354
diff changeset
5828 {only available when compiled with the |+reltime|
cc4fe241baa3 updated for version 7.1-236
vimboss
parents: 1354
diff changeset
5829 feature}
cc4fe241baa3 updated for version 7.1-236
vimboss
parents: 1354
diff changeset
5830 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
5831 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
5832 highlighting.
1521
cc4fe241baa3 updated for version 7.1-236
vimboss
parents: 1354
diff changeset
5833 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
5834 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
5835 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
5836 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
5837 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
5838 pattern.
1521
cc4fe241baa3 updated for version 7.1-236
vimboss
parents: 1354
diff changeset
5839
4681
2eb30f341e8d Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents: 4502
diff changeset
5840 *'regexpengine'* *'re'*
4502
605c9ce57ec3 Updated runtime files, language files and translations.
Bram Moolenaar <bram@vim.org>
parents: 4358
diff changeset
5841 'regexpengine' 're' number (default 0)
605c9ce57ec3 Updated runtime files, language files and translations.
Bram Moolenaar <bram@vim.org>
parents: 4358
diff changeset
5842 global
605c9ce57ec3 Updated runtime files, language files and translations.
Bram Moolenaar <bram@vim.org>
parents: 4358
diff changeset
5843 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
5844 The possible values are:
605c9ce57ec3 Updated runtime files, language files and translations.
Bram Moolenaar <bram@vim.org>
parents: 4358
diff changeset
5845 0 automatic selection
605c9ce57ec3 Updated runtime files, language files and translations.
Bram Moolenaar <bram@vim.org>
parents: 4358
diff changeset
5846 1 old engine
605c9ce57ec3 Updated runtime files, language files and translations.
Bram Moolenaar <bram@vim.org>
parents: 4358
diff changeset
5847 2 NFA engine
605c9ce57ec3 Updated runtime files, language files and translations.
Bram Moolenaar <bram@vim.org>
parents: 4358
diff changeset
5848 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
5849 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
5850 for debugging the regexp engine.
6328
adfbffe1e642 updated for version 7.4.497
Bram Moolenaar <bram@vim.org>
parents: 6259
diff changeset
5851 Using automatic selection enables Vim to switch the engine, if the
adfbffe1e642 updated for version 7.4.497
Bram Moolenaar <bram@vim.org>
parents: 6259
diff changeset
5852 default engine becomes too costly. E.g., when the NFA engine uses too
adfbffe1e642 updated for version 7.4.497
Bram Moolenaar <bram@vim.org>
parents: 6259
diff changeset
5853 many states. This should prevent Vim from hanging on a combination of
adfbffe1e642 updated for version 7.4.497
Bram Moolenaar <bram@vim.org>
parents: 6259
diff changeset
5854 a complex pattern with long text.
4502
605c9ce57ec3 Updated runtime files, language files and translations.
Bram Moolenaar <bram@vim.org>
parents: 4358
diff changeset
5855
2178
c6f1aa1e9f32 Add 'relativenumber' patch from Markus Heidelberg.
Bram Moolenaar <bram@vim.org>
parents: 2154
diff changeset
5856 *'relativenumber'* *'rnu'* *'norelativenumber'* *'nornu'*
c6f1aa1e9f32 Add 'relativenumber' patch from Markus Heidelberg.
Bram Moolenaar <bram@vim.org>
parents: 2154
diff changeset
5857 'relativenumber' 'rnu' boolean (default off)
c6f1aa1e9f32 Add 'relativenumber' patch from Markus Heidelberg.
Bram Moolenaar <bram@vim.org>
parents: 2154
diff changeset
5858 local to window
c6f1aa1e9f32 Add 'relativenumber' patch from Markus Heidelberg.
Bram Moolenaar <bram@vim.org>
parents: 2154
diff changeset
5859 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
5860 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
5861 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
5862 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
5863 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
5864 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
5865 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
5866 'compatible' isn't set).
c6f1aa1e9f32 Add 'relativenumber' patch from Markus Heidelberg.
Bram Moolenaar <bram@vim.org>
parents: 2154
diff changeset
5867 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
5868 number.
c6f1aa1e9f32 Add 'relativenumber' patch from Markus Heidelberg.
Bram Moolenaar <bram@vim.org>
parents: 2154
diff changeset
5869 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
5870 characters are put before the number.
3445
2cfb68fa26cd Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 3371
diff changeset
5871 See |hl-LineNr| and |hl-CursorLineNr| for the highlighting used for
2cfb68fa26cd Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 3371
diff changeset
5872 the number.
13341
acd7eaa13d2b Updated runtime files.
Christian Brabandt <cb@256bit.org>
parents: 13314
diff changeset
5873
4780
2b11ac90d9e9 Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 4681
diff changeset
5874 The number in front of the cursor line also depends on the value of
2b11ac90d9e9 Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 4681
diff changeset
5875 'number', see |number_relativenumber| for all combinations of the two
2b11ac90d9e9 Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 4681
diff changeset
5876 options.
2178
c6f1aa1e9f32 Add 'relativenumber' patch from Markus Heidelberg.
Bram Moolenaar <bram@vim.org>
parents: 2154
diff changeset
5877
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5878 *'remap'* *'noremap'*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5879 'remap' boolean (default on)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5880 global
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5881 Allows for mappings to work recursively. If you do not want this for
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5882 a single entry, use the :noremap[!] command.
717
2fa8cb05b861 updated for version 7.0218
vimboss
parents: 714
diff changeset
5883 NOTE: To avoid portability problems with Vim scripts, always keep
2fa8cb05b861 updated for version 7.0218
vimboss
parents: 714
diff changeset
5884 this option at the default "on". Only switch it off when working with
2fa8cb05b861 updated for version 7.0218
vimboss
parents: 714
diff changeset
5885 old Vi scripts.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5886
6110
1bff71d20262 updated for version 7.4.393
Bram Moolenaar <bram@vim.org>
parents: 6091
diff changeset
5887 *'renderoptions'* *'rop'*
1bff71d20262 updated for version 7.4.393
Bram Moolenaar <bram@vim.org>
parents: 6091
diff changeset
5888 'renderoptions' 'rop' string (default: empty)
1bff71d20262 updated for version 7.4.393
Bram Moolenaar <bram@vim.org>
parents: 6091
diff changeset
5889 global
1bff71d20262 updated for version 7.4.393
Bram Moolenaar <bram@vim.org>
parents: 6091
diff changeset
5890 {only available when compiled with GUI and DIRECTX on
1bff71d20262 updated for version 7.4.393
Bram Moolenaar <bram@vim.org>
parents: 6091
diff changeset
5891 MS-Windows}
1bff71d20262 updated for version 7.4.393
Bram Moolenaar <bram@vim.org>
parents: 6091
diff changeset
5892 Select a text renderer and set its options. The options depend on the
1bff71d20262 updated for version 7.4.393
Bram Moolenaar <bram@vim.org>
parents: 6091
diff changeset
5893 renderer.
1bff71d20262 updated for version 7.4.393
Bram Moolenaar <bram@vim.org>
parents: 6091
diff changeset
5894
1bff71d20262 updated for version 7.4.393
Bram Moolenaar <bram@vim.org>
parents: 6091
diff changeset
5895 Syntax: >
1bff71d20262 updated for version 7.4.393
Bram Moolenaar <bram@vim.org>
parents: 6091
diff changeset
5896 set rop=type:{renderer}(,{name}:{value})*
1bff71d20262 updated for version 7.4.393
Bram Moolenaar <bram@vim.org>
parents: 6091
diff changeset
5897 <
1bff71d20262 updated for version 7.4.393
Bram Moolenaar <bram@vim.org>
parents: 6091
diff changeset
5898 Currently, only one optional renderer is available.
1bff71d20262 updated for version 7.4.393
Bram Moolenaar <bram@vim.org>
parents: 6091
diff changeset
5899
1bff71d20262 updated for version 7.4.393
Bram Moolenaar <bram@vim.org>
parents: 6091
diff changeset
5900 render behavior ~
1bff71d20262 updated for version 7.4.393
Bram Moolenaar <bram@vim.org>
parents: 6091
diff changeset
5901 directx Vim will draw text using DirectX (DirectWrite). It makes
1bff71d20262 updated for version 7.4.393
Bram Moolenaar <bram@vim.org>
parents: 6091
diff changeset
5902 drawn glyphs more beautiful than default GDI.
1bff71d20262 updated for version 7.4.393
Bram Moolenaar <bram@vim.org>
parents: 6091
diff changeset
5903 It requires 'encoding' is "utf-8", and only works on
1bff71d20262 updated for version 7.4.393
Bram Moolenaar <bram@vim.org>
parents: 6091
diff changeset
5904 MS-Windows Vista or newer version.
1bff71d20262 updated for version 7.4.393
Bram Moolenaar <bram@vim.org>
parents: 6091
diff changeset
5905
1bff71d20262 updated for version 7.4.393
Bram Moolenaar <bram@vim.org>
parents: 6091
diff changeset
5906 Options:
1bff71d20262 updated for version 7.4.393
Bram Moolenaar <bram@vim.org>
parents: 6091
diff changeset
5907 name meaning type value ~
1bff71d20262 updated for version 7.4.393
Bram Moolenaar <bram@vim.org>
parents: 6091
diff changeset
5908 gamma gamma float 1.0 - 2.2 (maybe)
1bff71d20262 updated for version 7.4.393
Bram Moolenaar <bram@vim.org>
parents: 6091
diff changeset
5909 contrast enhancedContrast float (unknown)
1bff71d20262 updated for version 7.4.393
Bram Moolenaar <bram@vim.org>
parents: 6091
diff changeset
5910 level clearTypeLevel float (unknown)
1bff71d20262 updated for version 7.4.393
Bram Moolenaar <bram@vim.org>
parents: 6091
diff changeset
5911 geom pixelGeometry int 0 - 2 (see below)
1bff71d20262 updated for version 7.4.393
Bram Moolenaar <bram@vim.org>
parents: 6091
diff changeset
5912 renmode renderingMode int 0 - 6 (see below)
1bff71d20262 updated for version 7.4.393
Bram Moolenaar <bram@vim.org>
parents: 6091
diff changeset
5913 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
5914 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
5915
18e6f4addce9 patch 8.0.1369: MS-Windows: drawing underline slow, mFallbackDC not updated
Christian Brabandt <cb@256bit.org>
parents: 12971
diff changeset
5916 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
5917 https://msdn.microsoft.com/en-us/library/dd368190.aspx
6110
1bff71d20262 updated for version 7.4.393
Bram Moolenaar <bram@vim.org>
parents: 6091
diff changeset
5918
1bff71d20262 updated for version 7.4.393
Bram Moolenaar <bram@vim.org>
parents: 6091
diff changeset
5919 For geom: structure of a device pixel.
1bff71d20262 updated for version 7.4.393
Bram Moolenaar <bram@vim.org>
parents: 6091
diff changeset
5920 0 - DWRITE_PIXEL_GEOMETRY_FLAT
1bff71d20262 updated for version 7.4.393
Bram Moolenaar <bram@vim.org>
parents: 6091
diff changeset
5921 1 - DWRITE_PIXEL_GEOMETRY_RGB
1bff71d20262 updated for version 7.4.393
Bram Moolenaar <bram@vim.org>
parents: 6091
diff changeset
5922 2 - DWRITE_PIXEL_GEOMETRY_BGR
1bff71d20262 updated for version 7.4.393
Bram Moolenaar <bram@vim.org>
parents: 6091
diff changeset
5923
1bff71d20262 updated for version 7.4.393
Bram Moolenaar <bram@vim.org>
parents: 6091
diff changeset
5924 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
5925 https://msdn.microsoft.com/en-us/library/dd368114.aspx
6110
1bff71d20262 updated for version 7.4.393
Bram Moolenaar <bram@vim.org>
parents: 6091
diff changeset
5926
1bff71d20262 updated for version 7.4.393
Bram Moolenaar <bram@vim.org>
parents: 6091
diff changeset
5927 For renmode: method of rendering glyphs.
1bff71d20262 updated for version 7.4.393
Bram Moolenaar <bram@vim.org>
parents: 6091
diff changeset
5928 0 - DWRITE_RENDERING_MODE_DEFAULT
1bff71d20262 updated for version 7.4.393
Bram Moolenaar <bram@vim.org>
parents: 6091
diff changeset
5929 1 - DWRITE_RENDERING_MODE_ALIASED
1bff71d20262 updated for version 7.4.393
Bram Moolenaar <bram@vim.org>
parents: 6091
diff changeset
5930 2 - DWRITE_RENDERING_MODE_GDI_CLASSIC
1bff71d20262 updated for version 7.4.393
Bram Moolenaar <bram@vim.org>
parents: 6091
diff changeset
5931 3 - DWRITE_RENDERING_MODE_GDI_NATURAL
1bff71d20262 updated for version 7.4.393
Bram Moolenaar <bram@vim.org>
parents: 6091
diff changeset
5932 4 - DWRITE_RENDERING_MODE_NATURAL
1bff71d20262 updated for version 7.4.393
Bram Moolenaar <bram@vim.org>
parents: 6091
diff changeset
5933 5 - DWRITE_RENDERING_MODE_NATURAL_SYMMETRIC
1bff71d20262 updated for version 7.4.393
Bram Moolenaar <bram@vim.org>
parents: 6091
diff changeset
5934 6 - DWRITE_RENDERING_MODE_OUTLINE
1bff71d20262 updated for version 7.4.393
Bram Moolenaar <bram@vim.org>
parents: 6091
diff changeset
5935
1bff71d20262 updated for version 7.4.393
Bram Moolenaar <bram@vim.org>
parents: 6091
diff changeset
5936 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
5937 https://msdn.microsoft.com/en-us/library/dd368118.aspx
6110
1bff71d20262 updated for version 7.4.393
Bram Moolenaar <bram@vim.org>
parents: 6091
diff changeset
5938
1bff71d20262 updated for version 7.4.393
Bram Moolenaar <bram@vim.org>
parents: 6091
diff changeset
5939 For taamode: antialiasing mode used for drawing text.
1bff71d20262 updated for version 7.4.393
Bram Moolenaar <bram@vim.org>
parents: 6091
diff changeset
5940 0 - D2D1_TEXT_ANTIALIAS_MODE_DEFAULT
1bff71d20262 updated for version 7.4.393
Bram Moolenaar <bram@vim.org>
parents: 6091
diff changeset
5941 1 - D2D1_TEXT_ANTIALIAS_MODE_CLEARTYPE
1bff71d20262 updated for version 7.4.393
Bram Moolenaar <bram@vim.org>
parents: 6091
diff changeset
5942 2 - D2D1_TEXT_ANTIALIAS_MODE_GRAYSCALE
1bff71d20262 updated for version 7.4.393
Bram Moolenaar <bram@vim.org>
parents: 6091
diff changeset
5943 3 - D2D1_TEXT_ANTIALIAS_MODE_ALIASED
1bff71d20262 updated for version 7.4.393
Bram Moolenaar <bram@vim.org>
parents: 6091
diff changeset
5944
1bff71d20262 updated for version 7.4.393
Bram Moolenaar <bram@vim.org>
parents: 6091
diff changeset
5945 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
5946 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
5947
13150
808625d4b71b patch 8.0.1449: slow redrawing with DirectX
Christian Brabandt <cb@256bit.org>
parents: 13100
diff changeset
5948 For scrlines:
808625d4b71b patch 8.0.1449: slow redrawing with DirectX
Christian Brabandt <cb@256bit.org>
parents: 13100
diff changeset
5949 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
5950 is now deprecated. If specified, it is simply ignored.
6110
1bff71d20262 updated for version 7.4.393
Bram Moolenaar <bram@vim.org>
parents: 6091
diff changeset
5951
1bff71d20262 updated for version 7.4.393
Bram Moolenaar <bram@vim.org>
parents: 6091
diff changeset
5952 Example: >
1bff71d20262 updated for version 7.4.393
Bram Moolenaar <bram@vim.org>
parents: 6091
diff changeset
5953 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
5954 set gfn=Ricty_Diminished:h12
6110
1bff71d20262 updated for version 7.4.393
Bram Moolenaar <bram@vim.org>
parents: 6091
diff changeset
5955 set rop=type:directx
1bff71d20262 updated for version 7.4.393
Bram Moolenaar <bram@vim.org>
parents: 6091
diff changeset
5956 <
12934
2ebc3df65ca2 patch 8.0.1343: MS-Windows: does not show colored emojis
Christian Brabandt <cb@256bit.org>
parents: 12930
diff changeset
5957 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
5958 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
5959 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
5960
2ebc3df65ca2 patch 8.0.1343: MS-Windows: does not show colored emojis
Christian Brabandt <cb@256bit.org>
parents: 12930
diff changeset
5961 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
5962 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
5963
12986
18e6f4addce9 patch 8.0.1369: MS-Windows: drawing underline slow, mFallbackDC not updated
Christian Brabandt <cb@256bit.org>
parents: 12971
diff changeset
5964 - '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
5965 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
5966 bitmap glyphs).
2ebc3df65ca2 patch 8.0.1343: MS-Windows: does not show colored emojis
Christian Brabandt <cb@256bit.org>
parents: 12930
diff changeset
5967 - '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
5968
2ebc3df65ca2 patch 8.0.1343: MS-Windows: does not show colored emojis
Christian Brabandt <cb@256bit.org>
parents: 12930
diff changeset
5969 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
5970 (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
5971 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
5972
2ebc3df65ca2 patch 8.0.1343: MS-Windows: does not show colored emojis
Christian Brabandt <cb@256bit.org>
parents: 12930
diff changeset
5973 - 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
5974 be used.
2ebc3df65ca2 patch 8.0.1343: MS-Windows: does not show colored emojis
Christian Brabandt <cb@256bit.org>
parents: 12930
diff changeset
5975 - 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
5976 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
5977 will be used.
2ebc3df65ca2 patch 8.0.1343: MS-Windows: does not show colored emojis
Christian Brabandt <cb@256bit.org>
parents: 12930
diff changeset
5978 - 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
5979 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
5980 cell.
6110
1bff71d20262 updated for version 7.4.393
Bram Moolenaar <bram@vim.org>
parents: 6091
diff changeset
5981
1bff71d20262 updated for version 7.4.393
Bram Moolenaar <bram@vim.org>
parents: 6091
diff changeset
5982 Other render types are currently not supported.
1bff71d20262 updated for version 7.4.393
Bram Moolenaar <bram@vim.org>
parents: 6091
diff changeset
5983
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5984 *'report'*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5985 'report' number (default 2)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5986 global
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5987 Threshold for reporting number of lines changed. When the number of
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5988 changed lines is more than 'report' a message will be given for most
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5989 ":" commands. If you want it always, set 'report' to 0.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5990 For the ":substitute" command the number of substitutions is used
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5991 instead of the number of lines.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5992
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5993 *'restorescreen'* *'rs'* *'norestorescreen'* *'nors'*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5994 'restorescreen' 'rs' boolean (default on)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5995 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
5996 {only in Windows 95/NT console version}
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5997 When set, the screen contents is restored when exiting Vim. This also
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5998 happens when executing external commands.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5999
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6000 For non-Windows Vim: You can set or reset the 't_ti' and 't_te'
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6001 options in your .vimrc. To disable restoring:
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6002 set t_ti= t_te=
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6003 To enable restoring (for an xterm):
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6004 set t_ti=^[7^[[r^[[?47h t_te=^[[?47l^[8
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6005 (Where ^[ is an <Esc>, type CTRL-V <Esc> to insert it)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6006
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6007 *'revins'* *'ri'* *'norevins'* *'nori'*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6008 'revins' 'ri' boolean (default off)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6009 global
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6010 {only available when compiled with the |+rightleft|
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6011 feature}
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6012 Inserting characters in Insert mode will work backwards. See "typing
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6013 backwards" |ins-reverse|. This option can be toggled with the CTRL-_
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6014 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
6015 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
6016 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
6017 reset.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6018
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6019 *'rightleft'* *'rl'* *'norightleft'* *'norl'*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6020 'rightleft' 'rl' boolean (default off)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6021 local to window
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6022 {only available when compiled with the |+rightleft|
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6023 feature}
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6024 When on, display orientation becomes right-to-left, i.e., characters
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6025 that are stored in the file appear from the right to the left.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6026 Using this option, it is possible to edit files for languages that
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6027 are written from the right to the left such as Hebrew and Arabic.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6028 This option is per window, so it is possible to edit mixed files
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6029 simultaneously, or to view the same file in both ways (this is
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6030 useful whenever you have a mixed text file with both right-to-left
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6031 and left-to-right strings so that both sets are displayed properly
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6032 in different windows). Also see |rileft.txt|.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6033
2341
9272cc83214f Minor runtime file updates.
Bram Moolenaar <bram@vim.org>
parents: 2340
diff changeset
6034 *'rightleftcmd'* *'rlc'*
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6035 'rightleftcmd' 'rlc' string (default "search")
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6036 local to window
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6037 {only available when compiled with the |+rightleft|
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6038 feature}
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6039 Each word in this option enables the command line editing to work in
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6040 right-to-left mode for a group of commands:
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6041
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6042 search "/" and "?" commands
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6043
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6044 This is useful for languages such as Hebrew, Arabic and Farsi.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6045 The 'rightleft' option must be set for 'rightleftcmd' to take effect.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6046
7196
42717d048817 commit https://github.com/vim/vim/commit/d94464ee294a351ce7b6ba18e8bd3f24f1bef920
Christian Brabandt <cb@256bit.org>
parents: 7147
diff changeset
6047 *'rubydll'*
8629
54ac275e3fc4 commit https://github.com/vim/vim/commit/3848e00e0177abdb31bc600234967863ec487233
Christian Brabandt <cb@256bit.org>
parents: 8560
diff changeset
6048 '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
6049 global
7196
42717d048817 commit https://github.com/vim/vim/commit/d94464ee294a351ce7b6ba18e8bd3f24f1bef920
Christian Brabandt <cb@256bit.org>
parents: 7147
diff changeset
6050 {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
6051 feature}
7528
53163e4d9e4f commit https://github.com/vim/vim/commit/25e4fcde767084d1a79e0926bc301c92987c0cce
Christian Brabandt <cb@256bit.org>
parents: 7477
diff changeset
6052 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
6053 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
6054 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
6055 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
6056 security reasons.
42717d048817 commit https://github.com/vim/vim/commit/d94464ee294a351ce7b6ba18e8bd3f24f1bef920
Christian Brabandt <cb@256bit.org>
parents: 7147
diff changeset
6057
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6058 *'ruler'* *'ru'* *'noruler'* *'noru'*
9669
284b4eb307fc commit https://github.com/vim/vim/commit/8c08b5b569e2a9e9f63dea514591ecfa2d3bb392
Christian Brabandt <cb@256bit.org>
parents: 9665
diff changeset
6059 'ruler' 'ru' boolean (default off, set in |defaults.vim|)
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6060 global
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6061 {not available when compiled without the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6062 |+cmdline_info| feature}
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6063 Show the line and column number of the cursor position, separated by a
10
4e2284e71352 updated for version 7.0002
vimboss
parents: 8
diff changeset
6064 comma. When there is room, the relative position of the displayed
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6065 text in the file is shown on the far right:
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6066 Top first line is visible
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6067 Bot last line is visible
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6068 All first and last line are visible
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6069 45% relative position in the file
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6070 If 'rulerformat' is set, it will determine the contents of the ruler.
10
4e2284e71352 updated for version 7.0002
vimboss
parents: 8
diff changeset
6071 Each window has its own ruler. If a window has a status line, the
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6072 ruler is shown there. Otherwise it is shown in the last line of the
233
fca8a9b65afa updated for version 7.0065
vimboss
parents: 227
diff changeset
6073 screen. If the statusline is given by 'statusline' (i.e. not empty),
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6074 this option takes precedence over 'ruler' and 'rulerformat'
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6075 If the number of characters displayed is different from the number of
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6076 bytes in the text (e.g., for a TAB or a multi-byte character), both
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6077 the text column (byte number) and the screen column are shown,
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6078 separated with a dash.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6079 For an empty line "0-1" is shown.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6080 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
6081 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
6082 reset.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6083 If you don't want to see the ruler all the time but want to know where
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6084 you are, use "g CTRL-G" |g_CTRL-G|.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6085 NOTE: This option is reset when 'compatible' is set.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6086
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6087 *'rulerformat'* *'ruf'*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6088 'rulerformat' 'ruf' string (default empty)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6089 global
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6090 {not available when compiled without the |+statusline|
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6091 feature}
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6092 When this option is not empty, it determines the content of the ruler
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6093 string, as displayed for the 'ruler' option.
692
a28f83d37113 updated for version 7.0208
vimboss
parents: 688
diff changeset
6094 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
6095 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
6096
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6097 The default ruler width is 17 characters. To make the ruler 15
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6098 characters wide, put "%15(" at the start and "%)" at the end.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6099 Example: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6100 :set rulerformat=%15(%c%V\ %p%%%)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6101 <
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6102 *'runtimepath'* *'rtp'* *vimfiles*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6103 'runtimepath' 'rtp' string (default:
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6104 Unix: "$HOME/.vim,
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6105 $VIM/vimfiles,
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6106 $VIMRUNTIME,
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6107 $VIM/vimfiles/after,
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6108 $HOME/.vim/after"
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6109 Amiga: "home:vimfiles,
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6110 $VIM/vimfiles,
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6111 $VIMRUNTIME,
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6112 $VIM/vimfiles/after,
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6113 home:vimfiles/after"
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6114 PC, OS/2: "$HOME/vimfiles,
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6115 $VIM/vimfiles,
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6116 $VIMRUNTIME,
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6117 $VIM/vimfiles/after,
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6118 $HOME/vimfiles/after"
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6119 Macintosh: "$VIM:vimfiles,
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6120 $VIMRUNTIME,
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6121 $VIM:vimfiles:after"
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6122 RISC-OS: "Choices:vimfiles,
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6123 $VIMRUNTIME,
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6124 Choices:vimfiles/after"
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6125 VMS: "sys$login:vimfiles,
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6126 $VIM/vimfiles,
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6127 $VIMRUNTIME,
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6128 $VIM/vimfiles/after,
233
fca8a9b65afa updated for version 7.0065
vimboss
parents: 227
diff changeset
6129 sys$login:vimfiles/after")
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6130 global
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6131 This is a list of directories which will be searched for runtime
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6132 files:
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6133 filetype.vim filetypes by file name |new-filetype|
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6134 scripts.vim filetypes by file contents |new-filetype-scripts|
164
8b0ee9d57d7f updated for version 7.0050
vimboss
parents: 161
diff changeset
6135 autoload/ automatically loaded scripts |autoload-functions|
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6136 colors/ color scheme files |:colorscheme|
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6137 compiler/ compiler files |:compiler|
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6138 doc/ documentation |write-local-help|
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6139 ftplugin/ filetype plugins |write-filetype-plugin|
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6140 indent/ indent scripts |indent-expression|
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6141 keymap/ key mapping files |mbyte-keymap|
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6142 lang/ menu translations |:menutrans|
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6143 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
6144 pack/ packages |:packadd|
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6145 plugin/ plugin scripts |write-plugin|
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6146 print/ files for printing |postscript-print-encoding|
650
662e40bd2be1 updated for version 7.0191
vimboss
parents: 648
diff changeset
6147 spell/ spell checking files |spell|
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6148 syntax/ syntax files |mysyntaxfile|
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6149 tutor/ files for vimtutor |tutor|
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6150
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6151 And any other file searched for with the |:runtime| command.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6152
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6153 The defaults for most systems are setup to search five locations:
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6154 1. In your home directory, for your personal preferences.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6155 2. In a system-wide Vim directory, for preferences from the system
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6156 administrator.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6157 3. In $VIMRUNTIME, for files distributed with Vim.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6158 *after-directory*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6159 4. In the "after" directory in the system-wide Vim directory. This is
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6160 for the system administrator to overrule or add to the distributed
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6161 defaults (rarely needed)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6162 5. In the "after" directory in your home directory. This is for
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6163 personal preferences to overrule or add to the distributed defaults
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6164 or system-wide settings (rarely needed).
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6165
10211
b7da8d4c594c commit https://github.com/vim/vim/commit/d07969093a9b3051511c478d71c36de6fc33c0d6
Christian Brabandt <cb@256bit.org>
parents: 10198
diff changeset
6166 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
6167 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
6168 string.
9116
bc38030aec7d commit https://github.com/vim/vim/commit/26852128a2b713ef49341a0c18daba928444e7eb
Christian Brabandt <cb@256bit.org>
parents: 9098
diff changeset
6169
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6170 Note that, unlike 'path', no wildcards like "**" are allowed. Normal
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6171 wildcards are allowed, but can significantly slow down searching for
10
4e2284e71352 updated for version 7.0002
vimboss
parents: 8
diff changeset
6172 runtime files. For speed, use as few items as possible and avoid
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6173 wildcards.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6174 See |:runtime|.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6175 Example: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6176 :set runtimepath=~/vimruntime,/mygroup/vim,$VIMRUNTIME
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6177 < This will use the directory "~/vimruntime" first (containing your
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6178 personal Vim runtime files), then "/mygroup/vim" (shared between a
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6179 group of people) and finally "$VIMRUNTIME" (the distributed runtime
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6180 files).
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6181 You probably should always include $VIMRUNTIME somewhere, to use the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6182 distributed runtime files. You can put a directory before $VIMRUNTIME
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6183 to find files which replace a distributed runtime files. You can put
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6184 a directory after $VIMRUNTIME to find files which add to distributed
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6185 runtime files.
13437
02b3f719eacb Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 13341
diff changeset
6186 When Vim is started with |--clean| the home directory entries are not
02b3f719eacb Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 13341
diff changeset
6187 included.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6188 This option cannot be set from a |modeline| or in the |sandbox|, for
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6189 security reasons.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6190
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6191 *'scroll'* *'scr'*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6192 'scroll' 'scr' number (default: half the window height)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6193 local to window
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6194 Number of lines to scroll with CTRL-U and CTRL-D commands. Will be
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6195 set to half the number of lines in the window when the window size
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6196 changes. If you give a count to the CTRL-U or CTRL-D command it will
10
4e2284e71352 updated for version 7.0002
vimboss
parents: 8
diff changeset
6197 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
6198 height with ":set scroll=0".
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6199
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6200 *'scrollbind'* *'scb'* *'noscrollbind'* *'noscb'*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6201 'scrollbind' 'scb' boolean (default off)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6202 local to window
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6203 See also |scroll-binding|. When this option is set, the current
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6204 window scrolls as other scrollbind windows (windows that also have
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6205 this option set) scroll. This option is useful for viewing the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6206 differences between two versions of a file, see 'diff'.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6207 See |'scrollopt'| for options that determine how this option should be
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6208 interpreted.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6209 This option is mostly reset when splitting a window to edit another
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6210 file. This means that ":split | edit file" results in two windows
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6211 with scroll-binding, but ":split file" does not.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6212
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6213 *'scrolljump'* *'sj'*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6214 'scrolljump' 'sj' number (default 1)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6215 global
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6216 Minimal number of lines to scroll when the cursor gets off the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6217 screen (e.g., with "j"). Not used for scroll commands (e.g., CTRL-E,
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6218 CTRL-D). Useful if your terminal scrolls very slowly.
532
7052f11a3dc9 updated for version 7.0150
vimboss
parents: 523
diff changeset
6219 When set to a negative number from -1 to -100 this is used as the
7052f11a3dc9 updated for version 7.0150
vimboss
parents: 523
diff changeset
6220 percentage of the window height. Thus -50 scrolls half the window
7052f11a3dc9 updated for version 7.0150
vimboss
parents: 523
diff changeset
6221 height.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6222 NOTE: This option is set to 1 when 'compatible' is set.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6223
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6224 *'scrolloff'* *'so'*
10218
584c835a2de1 commit https://github.com/vim/vim/commit/50ba526fbf3e9e5e0e6b0b3086a4d5df581ebc7e
Christian Brabandt <cb@256bit.org>
parents: 10211
diff changeset
6225 '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
6226 global or local to window |global-local|
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6227 Minimal number of screen lines to keep above and below the cursor.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6228 This will make some context visible around where you are working. If
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6229 you set it to a very large value (999) the cursor line will always be
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6230 in the middle of the window (except at the start or end of the file or
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6231 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
6232 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
6233 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
6234 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
6235 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
6236 < For scrolling horizontally see 'sidescrolloff'.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6237 NOTE: This option is set to 0 when 'compatible' is set.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6238
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6239 *'scrollopt'* *'sbo'*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6240 'scrollopt' 'sbo' string (default "ver,jump")
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6241 global
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6242 This is a comma-separated list of words that specifies how
236
4707450c2b33 updated for version 7.0066
vimboss
parents: 233
diff changeset
6243 'scrollbind' windows should behave. 'sbo' stands for ScrollBind
4707450c2b33 updated for version 7.0066
vimboss
parents: 233
diff changeset
6244 Options.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6245 The following words are available:
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6246 ver Bind vertical scrolling for 'scrollbind' windows
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6247 hor Bind horizontal scrolling for 'scrollbind' windows
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6248 jump Applies to the offset between two windows for vertical
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6249 scrolling. This offset is the difference in the first
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6250 displayed line of the bound windows. When moving
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6251 around in a window, another 'scrollbind' window may
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6252 reach a position before the start or after the end of
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6253 the buffer. The offset is not changed though, when
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6254 moving back the 'scrollbind' window will try to scroll
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6255 to the desired position when possible.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6256 When now making that window the current one, two
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6257 things can be done with the relative offset:
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6258 1. When "jump" is not included, the relative offset is
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6259 adjusted for the scroll position in the new current
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6260 window. When going back to the other window, the
1152
e1787f5b90da updated for version 7.1a
vimboss
parents: 1111
diff changeset
6261 new relative offset will be used.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6262 2. When "jump" is included, the other windows are
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6263 scrolled to keep the same relative offset. When
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6264 going back to the other window, it still uses the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6265 same relative offset.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6266 Also see |scroll-binding|.
819
23f82b5d2814 updated for version 7.0c10
vimboss
parents: 818
diff changeset
6267 When 'diff' mode is active there always is vertical scroll binding,
23f82b5d2814 updated for version 7.0c10
vimboss
parents: 818
diff changeset
6268 even when "ver" isn't there.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6269
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6270 *'sections'* *'sect'*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6271 'sections' 'sect' string (default "SHNHH HUnhsh")
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6272 global
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6273 Specifies the nroff macros that separate sections. These are pairs of
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6274 two letters (See |object-motions|). The default makes a section start
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6275 at the nroff macros ".SH", ".NH", ".H", ".HU", ".nh" and ".sh".
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6276
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6277 *'secure'* *'nosecure'* *E523*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6278 'secure' boolean (default off)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6279 global
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6280 When on, ":autocmd", shell and write commands are not allowed in
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6281 ".vimrc" and ".exrc" in the current directory and map commands are
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6282 displayed. Switch it off only if you know that you will not run into
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6283 problems, or when the 'exrc' option is off. On Unix this option is
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6284 only used if the ".vimrc" or ".exrc" is not owned by you. This can be
10
4e2284e71352 updated for version 7.0002
vimboss
parents: 8
diff changeset
6285 dangerous if the systems allows users to do a "chown". You better set
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6286 'secure' at the end of your ~/.vimrc then.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6287 This option cannot be set from a |modeline| or in the |sandbox|, for
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6288 security reasons.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6289
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6290 *'selection'* *'sel'*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6291 'selection' 'sel' string (default "inclusive")
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6292 global
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6293 This option defines the behavior of the selection. It is only used
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6294 in Visual and Select mode.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6295 Possible values:
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6296 value past line inclusive ~
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6297 old no yes
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6298 inclusive yes yes
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6299 exclusive yes no
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6300 "past line" means that the cursor is allowed to be positioned one
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6301 character past the line.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6302 "inclusive" means that the last character of the selection is included
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6303 in an operation. For example, when "x" is used to delete the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6304 selection.
9975
03fa8a51e9dc commit https://github.com/vim/vim/commit/e4a3bcf28d92d0bde9ca227ccb40d401038185e5
Christian Brabandt <cb@256bit.org>
parents: 9913
diff changeset
6305 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
6306 the end of line the line break still isn't included.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6307 Note that when "exclusive" is used and selecting from the end
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6308 backwards, you cannot include the last character of a line, when
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6309 starting in Normal mode and 'virtualedit' empty.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6310
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6311 The 'selection' option is set by the |:behave| command.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6312
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6313 *'selectmode'* *'slm'*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6314 'selectmode' 'slm' string (default "")
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6315 global
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6316 This is a comma separated list of words, which specifies when to start
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6317 Select mode instead of Visual mode, when a selection is started.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6318 Possible values:
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6319 mouse when using the mouse
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6320 key when using shifted special keys
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6321 cmd when using "v", "V" or CTRL-V
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6322 See |Select-mode|.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6323 The 'selectmode' option is set by the |:behave| command.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6324
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6325 *'sessionoptions'* *'ssop'*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6326 'sessionoptions' 'ssop' string (default: "blank,buffers,curdir,folds,
13437
02b3f719eacb Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 13341
diff changeset
6327 help,options,tabpages,winsize,terminal")
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6328 global
2570
71b56b4e7785 Make the references to features in the help more consistent. (Sylvain Hitier)
Bram Moolenaar <bram@vim.org>
parents: 2561
diff changeset
6329 {not available when compiled without the |+mksession|
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6330 feature}
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6331 Changes the effect of the |:mksession| command. It is a comma
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6332 separated list of words. Each word enables saving and restoring
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6333 something:
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6334 word save and restore ~
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6335 blank empty windows
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6336 buffers hidden and unloaded buffers, not just those in windows
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6337 curdir the current directory
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6338 folds manually created folds, opened/closed folds and local
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6339 fold options
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6340 globals global variables that start with an uppercase letter
75
388f285bda1b updated for version 7.0031
vimboss
parents: 41
diff changeset
6341 and contain at least one lowercase letter. Only
388f285bda1b updated for version 7.0031
vimboss
parents: 41
diff changeset
6342 String and Number types are stored.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6343 help the help window
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6344 localoptions options and mappings local to a window or buffer (not
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6345 global values for local options)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6346 options all options and mappings (also global values for local
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6347 options)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6348 resize size of the Vim window: 'lines' and 'columns'
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6349 sesdir the directory in which the session file is located
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6350 will become the current directory (useful with
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6351 projects accessed over a network from different
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6352 systems)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6353 slash backslashes in file names replaced with forward
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6354 slashes
827
fd1b3406fd1c updated for version 7.0d02
vimboss
parents: 826
diff changeset
6355 tabpages all tab pages; without this only the current tab page
fd1b3406fd1c updated for version 7.0d02
vimboss
parents: 826
diff changeset
6356 is restored, so that you can make a session for each
fd1b3406fd1c updated for version 7.0d02
vimboss
parents: 826
diff changeset
6357 tab page separately
14519
5c5908e81e93 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 14475
diff changeset
6358 terminal include terminal windows where the command can be
5c5908e81e93 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 14475
diff changeset
6359 restored
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6360 unix with Unix end-of-line format (single <NL>), even when
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6361 on Windows or DOS
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6362 winpos position of the whole Vim window
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6363 winsize window sizes
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6364
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6365 Don't include both "curdir" and "sesdir".
2033
de5a43c5eedc Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents: 1904
diff changeset
6366 When neither "curdir" nor "sesdir" is included, file names are stored
de5a43c5eedc Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents: 1904
diff changeset
6367 with absolute paths.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6368 "slash" and "unix" are useful on Windows when sharing session files
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6369 with Unix. The Unix version of Vim cannot source dos format scripts,
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6370 but the Windows version of Vim can source unix format scripts.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6371
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6372 *'shell'* *'sh'* *E91*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6373 'shell' 'sh' string (default $SHELL or "sh",
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6374 MS-DOS and Win32: "command.com" or
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6375 "cmd.exe", OS/2: "cmd")
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6376 global
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6377 Name of the shell to use for ! and :! commands. When changing the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6378 value also check these options: 'shelltype', 'shellpipe', 'shellslash'
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6379 'shellredir', 'shellquote', 'shellxquote' and 'shellcmdflag'.
10
4e2284e71352 updated for version 7.0002
vimboss
parents: 8
diff changeset
6380 It is allowed to give an argument to the command, e.g. "csh -f".
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6381 See |option-backslash| about including spaces and backslashes.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6382 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
6383
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6384 If the name of the shell contains a space, you might need to enclose
13162
51521b8a370c patch 8.0.1455: if $SHELL contains a space then 'shell' is incorrect
Christian Brabandt <cb@256bit.org>
parents: 13154
diff changeset
6385 it in quotes or escape the space. Example with quotes: >
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6386 :set shell=\"c:\program\ files\unix\sh.exe\"\ -f
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6387 < Note the backslash before each quote (to avoid starting a comment) and
10
4e2284e71352 updated for version 7.0002
vimboss
parents: 8
diff changeset
6388 each space (to avoid ending the option value). Also note that the
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6389 "-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
6390 name. Vim automagically recognizes the backslashes that are path
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6391 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
6392 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
6393 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
6394 :set shell=/bin/with\\\ space/sh
14519
5c5908e81e93 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 14475
diff changeset
6395 < 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
6396 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
6397
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6398 Under MS-Windows, when the executable ends in ".com" it must be
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6399 included. Thus setting the shell to "command.com" or "4dos.com"
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6400 works, but "command" and "4dos" do not work for all commands (e.g.,
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6401 filtering).
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6402 For unknown reasons, when using "4dos.com" the current directory is
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6403 changed to "C:\". To avoid this set 'shell' like this: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6404 :set shell=command.com\ /c\ 4dos
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6405 < This option cannot be set from a |modeline| or in the |sandbox|, for
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6406 security reasons.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6407
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6408 *'shellcmdflag'* *'shcf'*
3356
b37888de599c Update runtime files.
Bram Moolenaar <bram@vim.org>
parents: 3352
diff changeset
6409 'shellcmdflag' 'shcf' string (default: "-c";
3371
8dcf3ea92b63 Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 3359
diff changeset
6410 MS-DOS and Win32, when 'shell' does not
8dcf3ea92b63 Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 3359
diff changeset
6411 contain "sh" somewhere: "/c")
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6412 global
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6413 Flag passed to the shell to execute "!" and ":!" commands; e.g.,
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6414 "bash.exe -c ls" or "command.com /c dir". For the MS-DOS-like
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6415 systems, the default is set according to the value of 'shell', to
11262
214f228718cf Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 11160
diff changeset
6416 reduce the need to set this option by the user.
3082
3502a7f991fc Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 2965
diff changeset
6417 On Unix it can have more than one flag. Each white space separated
3502a7f991fc Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 2965
diff changeset
6418 part is passed as an argument to the shell command.
3502a7f991fc Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 2965
diff changeset
6419 See |option-backslash| about including spaces and backslashes.
3502a7f991fc Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 2965
diff changeset
6420 Also see |dos-shell| for MS-DOS and MS-Windows.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6421 This option cannot be set from a |modeline| or in the |sandbox|, for
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6422 security reasons.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6423
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6424 *'shellpipe'* *'sp'*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6425 'shellpipe' 'sp' string (default ">", "| tee", "|& tee" or "2>&1| tee")
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6426 global
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6427 {not available when compiled without the |+quickfix|
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6428 feature}
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6429 String to be used to put the output of the ":make" command in the
10
4e2284e71352 updated for version 7.0002
vimboss
parents: 8
diff changeset
6430 error file. See also |:make_makeprg|. See |option-backslash| about
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6431 including spaces and backslashes.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6432 The name of the temporary file can be represented by "%s" if necessary
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6433 (the file name is appended automatically if no %s appears in the value
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6434 of this option).
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6435 For the Amiga and MS-DOS the default is ">". The output is directly
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6436 saved in a file and not echoed to the screen.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6437 For Unix the default it "| tee". The stdout of the compiler is saved
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6438 in a file and echoed to the screen. If the 'shell' option is "csh" or
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6439 "tcsh" after initializations, the default becomes "|& tee". If the
2788
0877b8d6370e Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 2729
diff changeset
6440 'shell' option is "sh", "ksh", "mksh", "pdksh", "zsh" or "bash" the
0877b8d6370e Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 2729
diff changeset
6441 default becomes "2>&1| tee". This means that stderr is also included.
0877b8d6370e Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 2729
diff changeset
6442 Before using the 'shell' option a path is removed, thus "/bin/sh" uses
0877b8d6370e Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 2729
diff changeset
6443 "sh".
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6444 The initialization of this option is done after reading the ".vimrc"
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6445 and the other initializations, so that when the 'shell' option is set
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6446 there, the 'shellpipe' option changes automatically, unless it was
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6447 explicitly set before.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6448 When 'shellpipe' is set to an empty string, no redirection of the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6449 ":make" output will be done. This is useful if you use a 'makeprg'
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6450 that writes to 'makeef' by itself. If you want no piping, but do
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6451 want to include the 'makeef', set 'shellpipe' to a single space.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6452 Don't forget to precede the space with a backslash: ":set sp=\ ".
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6453 In the future pipes may be used for filtering and this option will
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6454 become obsolete (at least for Unix).
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6455 This option cannot be set from a |modeline| or in the |sandbox|, for
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6456 security reasons.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6457
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6458 *'shellquote'* *'shq'*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6459 'shellquote' 'shq' string (default: ""; MS-DOS and Win32, when 'shell'
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6460 contains "sh" somewhere: "\"")
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6461 global
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6462 Quoting character(s), put around the command passed to the shell, for
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6463 the "!" and ":!" commands. The redirection is kept outside of the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6464 quoting. See 'shellxquote' to include the redirection. It's
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6465 probably not useful to set both options.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6466 This is an empty string by default. Only known to be useful for
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6467 third-party shells on MS-DOS-like systems, such as the MKS Korn Shell
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6468 or bash, where it should be "\"". The default is adjusted according
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6469 the value of 'shell', to reduce the need to set this option by the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6470 user. See |dos-shell|.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6471 This option cannot be set from a |modeline| or in the |sandbox|, for
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6472 security reasons.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6473
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6474 *'shellredir'* *'srr'*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6475 'shellredir' 'srr' string (default ">", ">&" or ">%s 2>&1")
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6476 global
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6477 String to be used to put the output of a filter command in a temporary
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6478 file. See also |:!|. See |option-backslash| about including spaces
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6479 and backslashes.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6480 The name of the temporary file can be represented by "%s" if necessary
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6481 (the file name is appended automatically if no %s appears in the value
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6482 of this option).
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6483 The default is ">". For Unix, if the 'shell' option is "csh", "tcsh"
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6484 or "zsh" during initializations, the default becomes ">&". If the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6485 'shell' option is "sh", "ksh" or "bash" the default becomes
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6486 ">%s 2>&1". This means that stderr is also included.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6487 For Win32, the Unix checks are done and additionally "cmd" is checked
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6488 for, which makes the default ">%s 2>&1". Also, the same names with
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6489 ".exe" appended are checked for.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6490 The initialization of this option is done after reading the ".vimrc"
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6491 and the other initializations, so that when the 'shell' option is set
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6492 there, the 'shellredir' option changes automatically unless it was
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6493 explicitly set before.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6494 In the future pipes may be used for filtering and this option will
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6495 become obsolete (at least for Unix).
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6496 This option cannot be set from a |modeline| or in the |sandbox|, for
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6497 security reasons.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6498
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6499 *'shellslash'* *'ssl'* *'noshellslash'* *'nossl'*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6500 'shellslash' 'ssl' boolean (default off)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6501 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
6502 {only for MSDOS, MS-Windows and OS/2}
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6503 When set, a forward slash is used when expanding file names. This is
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6504 useful when a Unix-like shell is used instead of command.com or
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6505 cmd.exe. Backward slashes can still be typed, but they are changed to
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6506 forward slashes by Vim.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6507 Note that setting or resetting this option has no effect for some
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6508 existing file names, thus this option needs to be set before opening
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6509 any file for best results. This might change in the future.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6510 'shellslash' only works when a backslash can be used as a path
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6511 separator. To test if this is so use: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6512 if exists('+shellslash')
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6513 <
168
4d9eabb1396e updated for version 7.0051
vimboss
parents: 164
diff changeset
6514 *'shelltemp'* *'stmp'* *'noshelltemp'* *'nostmp'*
4d9eabb1396e updated for version 7.0051
vimboss
parents: 164
diff changeset
6515 'shelltemp' 'stmp' boolean (Vi default off, Vim default on)
4d9eabb1396e updated for version 7.0051
vimboss
parents: 164
diff changeset
6516 global
4d9eabb1396e updated for version 7.0051
vimboss
parents: 164
diff changeset
6517 When on, use temp files for shell commands. When off use a pipe.
4d9eabb1396e updated for version 7.0051
vimboss
parents: 164
diff changeset
6518 When using a pipe is not possible temp files are used anyway.
2965
f2de38a019a2 Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 2925
diff changeset
6519 Currently a pipe is only supported on Unix and MS-Windows 2K and
f2de38a019a2 Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 2925
diff changeset
6520 later. You can check it with: >
168
4d9eabb1396e updated for version 7.0051
vimboss
parents: 164
diff changeset
6521 :if has("filterpipe")
4d9eabb1396e updated for version 7.0051
vimboss
parents: 164
diff changeset
6522 < The advantage of using a pipe is that nobody can read the temp file
4d9eabb1396e updated for version 7.0051
vimboss
parents: 164
diff changeset
6523 and the 'shell' command does not need to support redirection.
4d9eabb1396e updated for version 7.0051
vimboss
parents: 164
diff changeset
6524 The advantage of using a temp file is that the file type and encoding
4d9eabb1396e updated for version 7.0051
vimboss
parents: 164
diff changeset
6525 can be detected.
4d9eabb1396e updated for version 7.0051
vimboss
parents: 164
diff changeset
6526 The |FilterReadPre|, |FilterReadPost| and |FilterWritePre|,
4d9eabb1396e updated for version 7.0051
vimboss
parents: 164
diff changeset
6527 |FilterWritePost| autocommands event are not triggered when
4d9eabb1396e updated for version 7.0051
vimboss
parents: 164
diff changeset
6528 'shelltemp' is off.
9533
9f921133ee90 commit https://github.com/vim/vim/commit/269f595f9eef584937e7eae70fde68cdd7da5bcf
Christian Brabandt <cb@256bit.org>
parents: 9464
diff changeset
6529 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
6530 temp files.
11160
d0a20101ecb2 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 11063
diff changeset
6531 NOTE: This option is set to the Vim default value when 'compatible'
d0a20101ecb2 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 11063
diff changeset
6532 is reset.
168
4d9eabb1396e updated for version 7.0051
vimboss
parents: 164
diff changeset
6533
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6534 *'shelltype'* *'st'*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6535 'shelltype' 'st' number (default 0)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6536 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
6537 {only for the Amiga}
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6538 On the Amiga this option influences the way how the commands work
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6539 which use a shell.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6540 0 and 1: always use the shell
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6541 2 and 3: use the shell only to filter lines
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6542 4 and 5: use shell only for ':sh' command
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6543 When not using the shell, the command is executed directly.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6544
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6545 0 and 2: use "shell 'shellcmdflag' cmd" to start external commands
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6546 1 and 3: use "shell cmd" to start external commands
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6547
3371
8dcf3ea92b63 Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 3359
diff changeset
6548 *'shellxescape'* *'sxe'*
8dcf3ea92b63 Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 3359
diff changeset
6549 'shellxescape' 'sxe' string (default: "";
8dcf3ea92b63 Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 3359
diff changeset
6550 for MS-DOS and MS-Windows: "\"&|<>()@^")
8dcf3ea92b63 Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 3359
diff changeset
6551 global
8dcf3ea92b63 Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 3359
diff changeset
6552 When 'shellxquote' is set to "(" then the characters listed in this
8dcf3ea92b63 Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 3359
diff changeset
6553 option will be escaped with a '^' character. This makes it possible
8dcf3ea92b63 Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 3359
diff changeset
6554 to execute most external commands with cmd.exe.
8dcf3ea92b63 Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 3359
diff changeset
6555
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6556 *'shellxquote'* *'sxq'*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6557 'shellxquote' 'sxq' string (default: "";
3359
20ca2e05ae20 updated for version 7.3.446
Bram Moolenaar <bram@vim.org>
parents: 3356
diff changeset
6558 for Win32, when 'shell' is cmd.exe: "("
20ca2e05ae20 updated for version 7.3.446
Bram Moolenaar <bram@vim.org>
parents: 3356
diff changeset
6559 for Win32, when 'shell' contains "sh"
20ca2e05ae20 updated for version 7.3.446
Bram Moolenaar <bram@vim.org>
parents: 3356
diff changeset
6560 somewhere: "\""
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6561 for Unix, when using system(): "\"")
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6562 global
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6563 Quoting character(s), put around the command passed to the shell, for
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6564 the "!" and ":!" commands. Includes the redirection. See
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6565 'shellquote' to exclude the redirection. It's probably not useful
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6566 to set both options.
3359
20ca2e05ae20 updated for version 7.3.446
Bram Moolenaar <bram@vim.org>
parents: 3356
diff changeset
6567 When the value is '(' then ')' is appended. When the value is '"('
20ca2e05ae20 updated for version 7.3.446
Bram Moolenaar <bram@vim.org>
parents: 3356
diff changeset
6568 then ')"' is appended.
20ca2e05ae20 updated for version 7.3.446
Bram Moolenaar <bram@vim.org>
parents: 3356
diff changeset
6569 When the value is '(' then also see 'shellxescape'.
3352
de050fcc24cf updated for version 7.3.443
Bram Moolenaar <bram@vim.org>
parents: 3281
diff changeset
6570 This is an empty string by default on most systems, but is known to be
de050fcc24cf updated for version 7.3.443
Bram Moolenaar <bram@vim.org>
parents: 3281
diff changeset
6571 useful for on Win32 version, either for cmd.exe which automatically
de050fcc24cf updated for version 7.3.443
Bram Moolenaar <bram@vim.org>
parents: 3281
diff changeset
6572 strips off the first and last quote on a command, or 3rd-party shells
de050fcc24cf updated for version 7.3.443
Bram Moolenaar <bram@vim.org>
parents: 3281
diff changeset
6573 such as the MKS Korn Shell or bash, where it should be "\"". The
de050fcc24cf updated for version 7.3.443
Bram Moolenaar <bram@vim.org>
parents: 3281
diff changeset
6574 default is adjusted according the value of 'shell', to reduce the need
de050fcc24cf updated for version 7.3.443
Bram Moolenaar <bram@vim.org>
parents: 3281
diff changeset
6575 to set this option by the user. See |dos-shell|.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6576 This option cannot be set from a |modeline| or in the |sandbox|, for
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6577 security reasons.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6578
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6579 *'shiftround'* *'sr'* *'noshiftround'* *'nosr'*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6580 'shiftround' 'sr' boolean (default off)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6581 global
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6582 Round indent to multiple of 'shiftwidth'. Applies to > and <
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6583 commands. CTRL-T and CTRL-D in Insert mode always round the indent to
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6584 a multiple of 'shiftwidth' (this is Vi compatible).
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6585 NOTE: This option is reset when 'compatible' is set.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6586
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6587 *'shiftwidth'* *'sw'*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6588 'shiftwidth' 'sw' number (default 8)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6589 local to buffer
10
4e2284e71352 updated for version 7.0002
vimboss
parents: 8
diff changeset
6590 Number of spaces to use for each step of (auto)indent. Used for
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6591 |'cindent'|, |>>|, |<<|, etc.
3893
c3036f1dca68 Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 3750
diff changeset
6592 When zero the 'ts' value will be used. Use the |shiftwidth()|
c3036f1dca68 Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 3750
diff changeset
6593 function to get the effective shiftwidth value.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6594
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6595 *'shortmess'* *'shm'*
16533
5e25171e0e75 patch 8.1.1270: cannot see current match position
Bram Moolenaar <Bram@vim.org>
parents: 16447
diff changeset
6596 '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
6597 POSIX default: "AS")
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6598 global
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6599 This option helps to avoid all the |hit-enter| prompts caused by file
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6600 messages, for example with CTRL-G, and to avoid some other messages.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6601 It is a list of flags:
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6602 flag meaning when present ~
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6603 f use "(3 of 5)" instead of "(file 3 of 5)"
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6604 i use "[noeol]" instead of "[Incomplete last line]"
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6605 l use "999L, 888C" instead of "999 lines, 888 characters"
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6606 m use "[+]" instead of "[Modified]"
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6607 n use "[New]" instead of "[New File]"
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6608 r use "[RO]" instead of "[readonly]"
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6609 w use "[w]" instead of "written" for file write message
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6610 and "[a]" instead of "appended" for ':w >> file' command
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6611 x use "[dos]" instead of "[dos format]", "[unix]" instead of
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6612 "[unix format]" and "[mac]" instead of "[mac format]".
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6613 a all of the above abbreviations
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6614
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6615 o overwrite message for writing a file with subsequent message
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6616 for reading a file (useful for ":wn" or when 'autowrite' on)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6617 O message for reading a file overwrites any previous message.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6618 Also for quickfix message (e.g., ":cn").
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6619 s don't give "search hit BOTTOM, continuing at TOP" or "search
16610
1eaf34420bb3 Update runtime files
Bram Moolenaar <Bram@vim.org>
parents: 16553
diff changeset
6620 hit TOP, continuing at BOTTOM" messages; when using the search
1eaf34420bb3 Update runtime files
Bram Moolenaar <Bram@vim.org>
parents: 16553
diff changeset
6621 count do not show "W" after the count message (see S below)
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6622 t truncate file message at the start if it is too long to fit
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6623 on the command-line, "<" will appear in the left most column.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6624 Ignored in Ex mode.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6625 T truncate other messages in the middle if they are too long to
233
fca8a9b65afa updated for version 7.0065
vimboss
parents: 227
diff changeset
6626 fit on the command line. "..." will appear in the middle.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6627 Ignored in Ex mode.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6628 W don't give "written" or "[w]" when writing a file
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6629 A don't give the "ATTENTION" message when an existing swap file
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6630 is found.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6631 I don't give the intro message when starting Vim |:intro|.
5946
4d7af1962d6c updated for version 7.4.314
Bram Moolenaar <bram@vim.org>
parents: 5908
diff changeset
6632 c don't give |ins-completion-menu| messages. For example,
4d7af1962d6c updated for version 7.4.314
Bram Moolenaar <bram@vim.org>
parents: 5908
diff changeset
6633 "-- XXX completion (YYY)", "match 1 of 2", "The only match",
4d7af1962d6c updated for version 7.4.314
Bram Moolenaar <bram@vim.org>
parents: 5908
diff changeset
6634 "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
6635 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
6636 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
6637 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
6638 from autocommands
16533
5e25171e0e75 patch 8.1.1270: cannot see current match position
Bram Moolenaar <Bram@vim.org>
parents: 16447
diff changeset
6639 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
6640 "[1/5]"
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6641
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6642 This gives you the opportunity to avoid that a change between buffers
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6643 requires you to hit <Enter>, but still gives as useful a message as
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6644 possible for the space available. To get the whole message that you
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6645 would have got with 'shm' empty, use ":file!"
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6646 Useful values:
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6647 shm= No abbreviation of message.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6648 shm=a Abbreviation, but no loss of information.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6649 shm=at Abbreviation, and truncate message when necessary.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6650
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6651 NOTE: This option is set to the Vi default value when 'compatible' is
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6652 set and to the Vim default value when 'compatible' is reset.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6653
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6654 *'shortname'* *'sn'* *'noshortname'* *'nosn'*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6655 'shortname' 'sn' boolean (default off)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6656 local to buffer
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6657 Filenames are assumed to be 8 characters plus one extension of 3
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6658 characters. Multiple dots in file names are not allowed. When this
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6659 option is on, dots in file names are replaced with underscores when
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6660 adding an extension (".~" or ".swp"). This option is not available
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6661 for MS-DOS, because then it would always be on. This option is useful
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6662 when editing files on an MS-DOS compatible filesystem, e.g., messydos
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6663 or crossdos. When running the Win32 GUI version under Win32s, this
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6664 option is always on by default.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6665
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6666 *'showbreak'* *'sbr'* *E595*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6667 'showbreak' 'sbr' string (default "")
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6668 global
2570
71b56b4e7785 Make the references to features in the help more consistent. (Sylvain Hitier)
Bram Moolenaar <bram@vim.org>
parents: 2561
diff changeset
6669 {not available when compiled without the |+linebreak|
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6670 feature}
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6671 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
6672 values are "> " or "+++ ": >
de5a43c5eedc Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents: 1904
diff changeset
6673 :set showbreak=>\
de5a43c5eedc Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents: 1904
diff changeset
6674 < 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
6675 this: >
2314
233eb4412f5d Added 'colorcolumn' option. Partly by Gregor Uhlenheuer.
Bram Moolenaar <bram@vim.org>
parents: 2302
diff changeset
6676 :let &showbreak = '+++ '
2033
de5a43c5eedc Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents: 1904
diff changeset
6677 < Only printable single-cell characters are allowed, excluding <Tab> and
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6678 comma (in a future version the comma might be used to separate the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6679 part that is shown at the end and at the start of a line).
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6680 The characters are highlighted according to the '@' flag in
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6681 'highlight'.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6682 Note that tabs after the showbreak will be displayed differently.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6683 If you want the 'showbreak' to appear in between line numbers, add the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6684 "n" flag to 'cpoptions'.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6685
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6686 *'showcmd'* *'sc'* *'noshowcmd'* *'nosc'*
9669
284b4eb307fc commit https://github.com/vim/vim/commit/8c08b5b569e2a9e9f63dea514591ecfa2d3bb392
Christian Brabandt <cb@256bit.org>
parents: 9665
diff changeset
6687 '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
6688 Vi default: off, set in |defaults.vim|)
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6689 global
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6690 {not available when compiled without the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6691 |+cmdline_info| feature}
1152
e1787f5b90da updated for version 7.1a
vimboss
parents: 1111
diff changeset
6692 Show (partial) command in the last line of the screen. Set this
e1787f5b90da updated for version 7.1a
vimboss
parents: 1111
diff changeset
6693 option off if your terminal is slow.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6694 In Visual mode the size of the selected area is shown:
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6695 - 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
6696 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
6697 means two characters and six bytes.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6698 - When selecting more than one line, the number of lines.
2033
de5a43c5eedc Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents: 1904
diff changeset
6699 - When selecting a block, the size in screen characters:
de5a43c5eedc Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents: 1904
diff changeset
6700 {lines}x{columns}.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6701 NOTE: This option is set to the Vi default value when 'compatible' is
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6702 set and to the Vim default value when 'compatible' is reset.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6703
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6704 *'showfulltag'* *'sft'* *'noshowfulltag'* *'nosft'*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6705 'showfulltag' 'sft' boolean (default off)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6706 global
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6707 When completing a word in insert mode (see |ins-completion|) from the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6708 tags file, show both the tag name and a tidied-up form of the search
10
4e2284e71352 updated for version 7.0002
vimboss
parents: 8
diff changeset
6709 pattern (if there is one) as possible matches. Thus, if you have
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6710 matched a C function, you can see a template for what arguments are
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6711 required (coding style permitting).
1621
82b5078be2dd updated for version 7.2a
vimboss
parents: 1564
diff changeset
6712 Note that this doesn't work well together with having "longest" in
82b5078be2dd updated for version 7.2a
vimboss
parents: 1564
diff changeset
6713 'completeopt', because the completion from the search pattern may not
82b5078be2dd updated for version 7.2a
vimboss
parents: 1564
diff changeset
6714 match the typed text.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6715
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6716 *'showmatch'* *'sm'* *'noshowmatch'* *'nosm'*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6717 'showmatch' 'sm' boolean (default off)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6718 global
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6719 When a bracket is inserted, briefly jump to the matching one. The
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6720 jump is only done if the match can be seen on the screen. The time to
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6721 show the match can be set with 'matchtime'.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6722 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
6723 seen or not).
c590de398af9 commit https://github.com/vim/vim/commit/ca63501fbcd1cf9c8aa9ff12c093c95b62a89ed7
Christian Brabandt <cb@256bit.org>
parents: 7080
diff changeset
6724 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
6725 reset.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6726 When the 'm' flag is not included in 'cpoptions', typing a character
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6727 will immediately move the cursor back to where it belongs.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6728 See the "sm" field in 'guicursor' for setting the cursor shape and
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6729 blinking when showing the match.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6730 The 'matchpairs' option can be used to specify the characters to show
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6731 matches for. 'rightleft' and 'revins' are used to look for opposite
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6732 matches.
699
2af8de31a3a8 updated for version 7.0211
vimboss
parents: 697
diff changeset
6733 Also see the matchparen plugin for highlighting the match when moving
2af8de31a3a8 updated for version 7.0211
vimboss
parents: 697
diff changeset
6734 around |pi_paren.txt|.
2af8de31a3a8 updated for version 7.0211
vimboss
parents: 697
diff changeset
6735 Note: Use of the short form is rated PG.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6736
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6737 *'showmode'* *'smd'* *'noshowmode'* *'nosmd'*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6738 'showmode' 'smd' boolean (Vim default: on, Vi default: off)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6739 global
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6740 If in Insert, Replace or Visual mode put a message on the last line.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6741 Use the 'M' flag in 'highlight' to set the type of highlighting for
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6742 this message.
10
4e2284e71352 updated for version 7.0002
vimboss
parents: 8
diff changeset
6743 When |XIM| may be used the message will include "XIM". But this
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6744 doesn't mean XIM is really active, especially when 'imactivatekey' is
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6745 not set.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6746 NOTE: This option is set to the Vi default value when 'compatible' is
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6747 set and to the Vim default value when 'compatible' is reset.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6748
677
e649c78407e6 updated for version 7.0202
vimboss
parents: 674
diff changeset
6749 *'showtabline'* *'stal'*
e649c78407e6 updated for version 7.0202
vimboss
parents: 674
diff changeset
6750 'showtabline' 'stal' number (default 1)
e649c78407e6 updated for version 7.0202
vimboss
parents: 674
diff changeset
6751 global
2570
71b56b4e7785 Make the references to features in the help more consistent. (Sylvain Hitier)
Bram Moolenaar <bram@vim.org>
parents: 2561
diff changeset
6752 {not available when compiled without the |+windows|
677
e649c78407e6 updated for version 7.0202
vimboss
parents: 674
diff changeset
6753 feature}
e649c78407e6 updated for version 7.0202
vimboss
parents: 674
diff changeset
6754 The value of this option specifies when the line with tab page labels
e649c78407e6 updated for version 7.0202
vimboss
parents: 674
diff changeset
6755 will be displayed:
e649c78407e6 updated for version 7.0202
vimboss
parents: 674
diff changeset
6756 0: never
e649c78407e6 updated for version 7.0202
vimboss
parents: 674
diff changeset
6757 1: only if there are at least two tab pages
e649c78407e6 updated for version 7.0202
vimboss
parents: 674
diff changeset
6758 2: always
e649c78407e6 updated for version 7.0202
vimboss
parents: 674
diff changeset
6759 This is both for the GUI and non-GUI implementation of the tab pages
e649c78407e6 updated for version 7.0202
vimboss
parents: 674
diff changeset
6760 line.
e649c78407e6 updated for version 7.0202
vimboss
parents: 674
diff changeset
6761 See |tab-page| for more information about tab pages.
e649c78407e6 updated for version 7.0202
vimboss
parents: 674
diff changeset
6762
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6763 *'sidescroll'* *'ss'*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6764 'sidescroll' 'ss' number (default 0)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6765 global
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6766 The minimal number of columns to scroll horizontally. Used only when
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6767 the 'wrap' option is off and the cursor is moved off of the screen.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6768 When it is zero the cursor will be put in the middle of the screen.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6769 When using a slow terminal set it to a large number or 0. When using
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6770 a fast terminal use a small number or 1. Not used for "zh" and "zl"
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6771 commands.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6772
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6773 *'sidescrolloff'* *'siso'*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6774 '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
6775 global or local to window |global-local|
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6776 The minimal number of screen columns to keep to the left and to the
534
c6296b0ad9ea updated for version 7.0151
vimboss
parents: 532
diff changeset
6777 right of the cursor if 'nowrap' is set. Setting this option to a
c6296b0ad9ea updated for version 7.0151
vimboss
parents: 532
diff changeset
6778 value greater than 0 while having |'sidescroll'| also at a non-zero
c6296b0ad9ea updated for version 7.0151
vimboss
parents: 532
diff changeset
6779 value makes some context visible in the line you are scrolling in
c6296b0ad9ea updated for version 7.0151
vimboss
parents: 532
diff changeset
6780 horizontally (except at beginning of the line). Setting this option
c6296b0ad9ea updated for version 7.0151
vimboss
parents: 532
diff changeset
6781 to a large value (like 999) has the effect of keeping the cursor
c6296b0ad9ea updated for version 7.0151
vimboss
parents: 532
diff changeset
6782 horizontally centered in the window, as long as one does not come too
c6296b0ad9ea updated for version 7.0151
vimboss
parents: 532
diff changeset
6783 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
6784 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
6785 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
6786 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
6787 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
6788 < NOTE: This option is set to 0 when 'compatible' is set.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6789
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6790 Example: Try this together with 'sidescroll' and 'listchars' as
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6791 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
6792 onto the "extends" character: >
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6793
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6794 :set nowrap sidescroll=1 listchars=extends:>,precedes:<
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6795 :set sidescrolloff=1
9852
4eea48b76d03 commit https://github.com/vim/vim/commit/95ec9d6a6ab3117d60ff638670a803d43974ba51
Christian Brabandt <cb@256bit.org>
parents: 9737
diff changeset
6796 <
4eea48b76d03 commit https://github.com/vim/vim/commit/95ec9d6a6ab3117d60ff638670a803d43974ba51
Christian Brabandt <cb@256bit.org>
parents: 9737
diff changeset
6797 *'signcolumn'* *'scl'*
4eea48b76d03 commit https://github.com/vim/vim/commit/95ec9d6a6ab3117d60ff638670a803d43974ba51
Christian Brabandt <cb@256bit.org>
parents: 9737
diff changeset
6798 'signcolumn' 'scl' string (default "auto")
4eea48b76d03 commit https://github.com/vim/vim/commit/95ec9d6a6ab3117d60ff638670a803d43974ba51
Christian Brabandt <cb@256bit.org>
parents: 9737
diff changeset
6799 local to window
4eea48b76d03 commit https://github.com/vim/vim/commit/95ec9d6a6ab3117d60ff638670a803d43974ba51
Christian Brabandt <cb@256bit.org>
parents: 9737
diff changeset
6800 {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
6801 feature}
9860
9eaf8ef656e9 commit https://github.com/vim/vim/commit/0952131376a517fc12dc5ae908a97018b4ee23f0
Christian Brabandt <cb@256bit.org>
parents: 9852
diff changeset
6802 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
6803 "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
6804 "no" never
9eaf8ef656e9 commit https://github.com/vim/vim/commit/0952131376a517fc12dc5ae908a97018b4ee23f0
Christian Brabandt <cb@256bit.org>
parents: 9852
diff changeset
6805 "yes" always
17129
4fb68abc770f patch 8.1.1564: sign column takes up space
Bram Moolenaar <Bram@vim.org>
parents: 16808
diff changeset
6806 "number" display signs in the 'number' column. If the number
17161
9ccb1ea9b2fc Update runtime files
Bram Moolenaar <Bram@vim.org>
parents: 17129
diff changeset
6807 column is not present, then behaves like "auto".
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6808
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6809
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6810 *'smartcase'* *'scs'* *'nosmartcase'* *'noscs'*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6811 'smartcase' 'scs' boolean (default off)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6812 global
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6813 Override the 'ignorecase' option if the search pattern contains upper
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6814 case characters. Only used when the search pattern is typed and
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6815 'ignorecase' option is on. Used for the commands "/", "?", "n", "N",
3557
9cb3a75a20b9 Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 3513
diff changeset
6816 ":g" and ":s". Not used for "*", "#", "gd", tag search, etc. After
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6817 "*" and "#" you can make 'smartcase' used by doing a "/" command,
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6818 recalling the search pattern from history and hitting <Enter>.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6819 NOTE: This option is reset when 'compatible' is set.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6820
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6821 *'smartindent'* *'si'* *'nosmartindent'* *'nosi'*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6822 'smartindent' 'si' boolean (default off)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6823 local to buffer
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6824 {not available when compiled without the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6825 |+smartindent| feature}
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6826 Do smart autoindenting when starting a new line. Works for C-like
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6827 programs, but can also be used for other languages. 'cindent' does
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6828 something like this, works better in most cases, but is more strict,
2662
916c90b37ea9 Update runtime files.
Bram Moolenaar <bram@vim.org>
parents: 2654
diff changeset
6829 see |C-indenting|. When 'cindent' is on or 'indentexpr' is set,
2642
840c3cadb842 Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 2625
diff changeset
6830 setting 'si' has no effect. 'indentexpr' is a more advanced
840c3cadb842 Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 2625
diff changeset
6831 alternative.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6832 Normally 'autoindent' should also be on when using 'smartindent'.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6833 An indent is automatically inserted:
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6834 - After a line ending in '{'.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6835 - After a line starting with a keyword from 'cinwords'.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6836 - Before a line starting with '}' (only with the "O" command).
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6837 When typing '}' as the first character in a new line, that line is
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6838 given the same indent as the matching '{'.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6839 When typing '#' as the first character in a new line, the indent for
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6840 that line is removed, the '#' is put in the first column. The indent
10
4e2284e71352 updated for version 7.0002
vimboss
parents: 8
diff changeset
6841 is restored for the next line. If you don't want this, use this
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6842 mapping: ":inoremap # X^H#", where ^H is entered with CTRL-V CTRL-H.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6843 When using the ">>" command, lines starting with '#' are not shifted
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6844 right.
11160
d0a20101ecb2 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 11063
diff changeset
6845 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
6846 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
6847 reset.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6848
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6849 *'smarttab'* *'sta'* *'nosmarttab'* *'nosta'*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6850 'smarttab' 'sta' boolean (default off)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6851 global
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6852 When on, a <Tab> in front of a line inserts blanks according to
648
9032e4668296 updated for version 7.0189
vimboss
parents: 642
diff changeset
6853 'shiftwidth'. 'tabstop' or 'softtabstop' is used in other places. A
9032e4668296 updated for version 7.0189
vimboss
parents: 642
diff changeset
6854 <BS> will delete a 'shiftwidth' worth of space at the start of the
9032e4668296 updated for version 7.0189
vimboss
parents: 642
diff changeset
6855 line.
650
662e40bd2be1 updated for version 7.0191
vimboss
parents: 648
diff changeset
6856 When off, a <Tab> always inserts blanks according to 'tabstop' or
648
9032e4668296 updated for version 7.0189
vimboss
parents: 642
diff changeset
6857 'softtabstop'. 'shiftwidth' is only used for shifting text left or
9032e4668296 updated for version 7.0189
vimboss
parents: 642
diff changeset
6858 right |shift-left-right|.
1263
57361514f73a updated for version 7.1
vimboss
parents: 1213
diff changeset
6859 What gets inserted (a <Tab> or spaces) depends on the 'expandtab'
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6860 option. Also see |ins-expandtab|. When 'expandtab' is not set, the
11
4424b47a0797 updated for version 7.0003
vimboss
parents: 10
diff changeset
6861 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
6862 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
6863 reset.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6864 NOTE: This option is reset when 'compatible' is set.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6865
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6866 *'softtabstop'* *'sts'*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6867 'softtabstop' 'sts' number (default 0)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6868 local to buffer
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6869 Number of spaces that a <Tab> counts for while performing editing
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6870 operations, like inserting a <Tab> or using <BS>. It "feels" like
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6871 <Tab>s are being inserted, while in fact a mix of spaces and <Tab>s is
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6872 used. This is useful to keep the 'ts' setting at its standard value
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6873 of 8, while being able to edit like it is set to 'sts'. However,
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6874 commands like "x" still work on the actual characters.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6875 When 'sts' is zero, this feature is off.
3893
c3036f1dca68 Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 3750
diff changeset
6876 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
6877 '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
6878 when 'paste' is reset.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6879 See also |ins-expandtab|. When 'expandtab' is not set, the number of
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6880 spaces is minimized by using <Tab>s.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6881 The 'L' flag in 'cpoptions' changes how tabs are used when 'list' is
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6882 set.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6883 NOTE: This option is set to 0 when 'compatible' is set.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6884
14175
2ad722003b36 patch 8.1.0105: all tab stops are the same
Christian Brabandt <cb@256bit.org>
parents: 14019
diff changeset
6885 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
6886 '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
6887 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
6888
221
7fd4b5df33be updated for version 7.0062
vimboss
parents: 205
diff changeset
6889 *'spell'* *'nospell'*
7fd4b5df33be updated for version 7.0062
vimboss
parents: 205
diff changeset
6890 'spell' boolean (default off)
7fd4b5df33be updated for version 7.0062
vimboss
parents: 205
diff changeset
6891 local to window
7fd4b5df33be updated for version 7.0062
vimboss
parents: 205
diff changeset
6892 {not available when compiled without the |+syntax|
7fd4b5df33be updated for version 7.0062
vimboss
parents: 205
diff changeset
6893 feature}
7fd4b5df33be updated for version 7.0062
vimboss
parents: 205
diff changeset
6894 When on spell checking will be done. See |spell|.
236
4707450c2b33 updated for version 7.0066
vimboss
parents: 233
diff changeset
6895 The languages are specified with 'spelllang'.
221
7fd4b5df33be updated for version 7.0062
vimboss
parents: 205
diff changeset
6896
386
607d3cd9364f updated for version 7.0100
vimboss
parents: 378
diff changeset
6897 *'spellcapcheck'* *'spc'*
389
4fe8e1a7758e updated for version 7.0102
vimboss
parents: 386
diff changeset
6898 'spellcapcheck' 'spc' string (default "[.?!]\_[\])'" \t]\+")
386
607d3cd9364f updated for version 7.0100
vimboss
parents: 378
diff changeset
6899 local to buffer
607d3cd9364f updated for version 7.0100
vimboss
parents: 378
diff changeset
6900 {not available when compiled without the |+syntax|
607d3cd9364f updated for version 7.0100
vimboss
parents: 378
diff changeset
6901 feature}
607d3cd9364f updated for version 7.0100
vimboss
parents: 378
diff changeset
6902 Pattern to locate the end of a sentence. The following word will be
607d3cd9364f updated for version 7.0100
vimboss
parents: 378
diff changeset
6903 checked to start with a capital letter. If not then it is highlighted
484
f012c4ed8c38 updated for version 7.0132
vimboss
parents: 480
diff changeset
6904 with SpellCap |hl-SpellCap| (unless the word is also badly spelled).
386
607d3cd9364f updated for version 7.0100
vimboss
parents: 378
diff changeset
6905 When this check is not wanted make this option empty.
607d3cd9364f updated for version 7.0100
vimboss
parents: 378
diff changeset
6906 Only used when 'spell' is set.
389
4fe8e1a7758e updated for version 7.0102
vimboss
parents: 386
diff changeset
6907 Be careful with special characters, see |option-backslash| about
4fe8e1a7758e updated for version 7.0102
vimboss
parents: 386
diff changeset
6908 including spaces and backslashes.
480
bf5ba8a0cdee updated for version 7.0129
vimboss
parents: 477
diff changeset
6909 To set this option automatically depending on the language, see
bf5ba8a0cdee updated for version 7.0129
vimboss
parents: 477
diff changeset
6910 |set-spc-auto|.
386
607d3cd9364f updated for version 7.0100
vimboss
parents: 378
diff changeset
6911
314
529f887b5cb7 updated for version 7.0082
vimboss
parents: 308
diff changeset
6912 *'spellfile'* *'spf'*
529f887b5cb7 updated for version 7.0082
vimboss
parents: 308
diff changeset
6913 'spellfile' 'spf' string (default empty)
529f887b5cb7 updated for version 7.0082
vimboss
parents: 308
diff changeset
6914 local to buffer
529f887b5cb7 updated for version 7.0082
vimboss
parents: 308
diff changeset
6915 {not available when compiled without the |+syntax|
529f887b5cb7 updated for version 7.0082
vimboss
parents: 308
diff changeset
6916 feature}
529f887b5cb7 updated for version 7.0082
vimboss
parents: 308
diff changeset
6917 Name of the word list file where words are added for the |zg| and |zw|
401
4a1ead01d30b updated for version 7.0105
vimboss
parents: 389
diff changeset
6918 commands. It must end in ".{encoding}.add". You need to include the
4a1ead01d30b updated for version 7.0105
vimboss
parents: 389
diff changeset
6919 path, otherwise the file is placed in the current directory.
386
607d3cd9364f updated for version 7.0100
vimboss
parents: 378
diff changeset
6920 *E765*
607d3cd9364f updated for version 7.0100
vimboss
parents: 378
diff changeset
6921 It may also be a comma separated list of names. A count before the
607d3cd9364f updated for version 7.0100
vimboss
parents: 378
diff changeset
6922 |zg| and |zw| commands can be used to access each. This allows using
607d3cd9364f updated for version 7.0100
vimboss
parents: 378
diff changeset
6923 a personal word list file and a project word list file.
314
529f887b5cb7 updated for version 7.0082
vimboss
parents: 308
diff changeset
6924 When a word is added while this option is empty Vim will set it for
819
23f82b5d2814 updated for version 7.0c10
vimboss
parents: 818
diff changeset
6925 you: Using the first directory in 'runtimepath' that is writable. If
23f82b5d2814 updated for version 7.0c10
vimboss
parents: 818
diff changeset
6926 there is no "spell" directory yet it will be created. For the file
23f82b5d2814 updated for version 7.0c10
vimboss
parents: 818
diff changeset
6927 name the first language name that appears in 'spelllang' is used,
353
3161473d6462 updated for version 7.0091
vimboss
parents: 344
diff changeset
6928 ignoring the region.
3161473d6462 updated for version 7.0091
vimboss
parents: 344
diff changeset
6929 The resulting ".spl" file will be used for spell checking, it does not
3161473d6462 updated for version 7.0091
vimboss
parents: 344
diff changeset
6930 have to appear in 'spelllang'.
3161473d6462 updated for version 7.0091
vimboss
parents: 344
diff changeset
6931 Normally one file is used for all regions, but you can add the region
3161473d6462 updated for version 7.0091
vimboss
parents: 344
diff changeset
6932 name if you want to. However, it will then only be used when
3161473d6462 updated for version 7.0091
vimboss
parents: 344
diff changeset
6933 'spellfile' is set to it, for entries in 'spelllang' only files
3161473d6462 updated for version 7.0091
vimboss
parents: 344
diff changeset
6934 without region name will be found.
336
2d8c2622e1fa updated for version 7.0087
vimboss
parents: 314
diff changeset
6935 This option cannot be set from a |modeline| or in the |sandbox|, for
2d8c2622e1fa updated for version 7.0087
vimboss
parents: 314
diff changeset
6936 security reasons.
314
529f887b5cb7 updated for version 7.0082
vimboss
parents: 308
diff changeset
6937
221
7fd4b5df33be updated for version 7.0062
vimboss
parents: 205
diff changeset
6938 *'spelllang'* *'spl'*
314
529f887b5cb7 updated for version 7.0082
vimboss
parents: 308
diff changeset
6939 'spelllang' 'spl' string (default "en")
221
7fd4b5df33be updated for version 7.0062
vimboss
parents: 205
diff changeset
6940 local to buffer
7fd4b5df33be updated for version 7.0062
vimboss
parents: 205
diff changeset
6941 {not available when compiled without the |+syntax|
7fd4b5df33be updated for version 7.0062
vimboss
parents: 205
diff changeset
6942 feature}
353
3161473d6462 updated for version 7.0091
vimboss
parents: 344
diff changeset
6943 A comma separated list of word list names. When the 'spell' option is
3161473d6462 updated for version 7.0091
vimboss
parents: 344
diff changeset
6944 on spellchecking will be done for these languages. Example: >
3161473d6462 updated for version 7.0091
vimboss
parents: 344
diff changeset
6945 set spelllang=en_us,nl,medical
3161473d6462 updated for version 7.0091
vimboss
parents: 344
diff changeset
6946 < This means US English, Dutch and medical words are recognized. Words
3161473d6462 updated for version 7.0091
vimboss
parents: 344
diff changeset
6947 that are not recognized will be highlighted.
16380
5ad204d8a2f2 Update runtime files
Bram Moolenaar <Bram@vim.org>
parents: 16086
diff changeset
6948 The word list name must consist of alphanumeric characters, a dash or
5ad204d8a2f2 Update runtime files
Bram Moolenaar <Bram@vim.org>
parents: 16086
diff changeset
6949 an underscore. It should not include a comma or dot. Using a dash is
353
3161473d6462 updated for version 7.0091
vimboss
parents: 344
diff changeset
6950 recommended to separate the two letter language name from a
3161473d6462 updated for version 7.0091
vimboss
parents: 344
diff changeset
6951 specification. Thus "en-rare" is used for rare English words.
3161473d6462 updated for version 7.0091
vimboss
parents: 344
diff changeset
6952 A region name must come last and have the form "_xx", where "xx" is
3161473d6462 updated for version 7.0091
vimboss
parents: 344
diff changeset
6953 the two-letter, lower case region name. You can use more than one
3161473d6462 updated for version 7.0091
vimboss
parents: 344
diff changeset
6954 region by listing them: "en_us,en_ca" supports both US and Canadian
3161473d6462 updated for version 7.0091
vimboss
parents: 344
diff changeset
6955 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
6956 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
6957 en_ca, en_gb and en_us).
5477
853a76c7fded updated for version 7.4.088
Bram Moolenaar <bram@vim.org>
parents: 5466
diff changeset
6958 If the name "cjk" is included East Asian characters are excluded from
853a76c7fded updated for version 7.4.088
Bram Moolenaar <bram@vim.org>
parents: 5466
diff changeset
6959 spell checking. This is useful when editing text that also has Asian
853a76c7fded updated for version 7.4.088
Bram Moolenaar <bram@vim.org>
parents: 5466
diff changeset
6960 words.
484
f012c4ed8c38 updated for version 7.0132
vimboss
parents: 480
diff changeset
6961 *E757*
419
f713fc55bf7b updated for version 7.0109
vimboss
parents: 410
diff changeset
6962 As a special case the name of a .spl file can be given as-is. The
f713fc55bf7b updated for version 7.0109
vimboss
parents: 410
diff changeset
6963 first "_xx" in the name is removed and used as the region name
f713fc55bf7b updated for version 7.0109
vimboss
parents: 410
diff changeset
6964 (_xx is an underscore, two letters and followed by a non-letter).
f713fc55bf7b updated for version 7.0109
vimboss
parents: 410
diff changeset
6965 This is mainly for testing purposes. You must make sure the correct
f713fc55bf7b updated for version 7.0109
vimboss
parents: 410
diff changeset
6966 encoding is used, Vim doesn't check it.
236
4707450c2b33 updated for version 7.0066
vimboss
parents: 233
diff changeset
6967 When 'encoding' is set the word lists are reloaded. Thus it's a good
419
f713fc55bf7b updated for version 7.0109
vimboss
parents: 410
diff changeset
6968 idea to set 'spelllang' after setting 'encoding' to avoid loading the
f713fc55bf7b updated for version 7.0109
vimboss
parents: 410
diff changeset
6969 files twice.
353
3161473d6462 updated for version 7.0091
vimboss
parents: 344
diff changeset
6970 How the related spell files are found is explained here: |spell-load|.
221
7fd4b5df33be updated for version 7.0062
vimboss
parents: 205
diff changeset
6971
653
5acda076fb0c updated for version 7.0192
vimboss
parents: 650
diff changeset
6972 If the |spellfile.vim| plugin is active and you use a language name
5acda076fb0c updated for version 7.0192
vimboss
parents: 650
diff changeset
6973 for which Vim cannot find the .spl file in 'runtimepath' the plugin
5acda076fb0c updated for version 7.0192
vimboss
parents: 650
diff changeset
6974 will ask you if you want to download the file.
5acda076fb0c updated for version 7.0192
vimboss
parents: 650
diff changeset
6975
480
bf5ba8a0cdee updated for version 7.0129
vimboss
parents: 477
diff changeset
6976 After this option has been set successfully, Vim will source the files
bf5ba8a0cdee updated for version 7.0129
vimboss
parents: 477
diff changeset
6977 "spell/LANG.vim" in 'runtimepath'. "LANG" is the value of 'spelllang'
15068
d9d97b8afe0d Update runtime files
Bram Moolenaar <Bram@vim.org>
parents: 15056
diff changeset
6978 up to the first character that is not an ASCII letter or number and
d9d97b8afe0d Update runtime files
Bram Moolenaar <Bram@vim.org>
parents: 15056
diff changeset
6979 not a dash. Also see |set-spc-auto|.
480
bf5ba8a0cdee updated for version 7.0129
vimboss
parents: 477
diff changeset
6980
bf5ba8a0cdee updated for version 7.0129
vimboss
parents: 477
diff changeset
6981
344
7033303ea0c0 updated for version 7.0089
vimboss
parents: 336
diff changeset
6982 *'spellsuggest'* *'sps'*
7033303ea0c0 updated for version 7.0089
vimboss
parents: 336
diff changeset
6983 'spellsuggest' 'sps' string (default "best")
7033303ea0c0 updated for version 7.0089
vimboss
parents: 336
diff changeset
6984 global
7033303ea0c0 updated for version 7.0089
vimboss
parents: 336
diff changeset
6985 {not available when compiled without the |+syntax|
7033303ea0c0 updated for version 7.0089
vimboss
parents: 336
diff changeset
6986 feature}
593
d220eb88e4e4 updated for version 7.0168
vimboss
parents: 590
diff changeset
6987 Methods used for spelling suggestions. Both for the |z=| command and
374
575dacb554d8 updated for version 7.0096
vimboss
parents: 356
diff changeset
6988 the |spellsuggest()| function. This is a comma-separated list of
575dacb554d8 updated for version 7.0096
vimboss
parents: 356
diff changeset
6989 items:
575dacb554d8 updated for version 7.0096
vimboss
parents: 356
diff changeset
6990
575dacb554d8 updated for version 7.0096
vimboss
parents: 356
diff changeset
6991 best Internal method that works best for English. Finds
575dacb554d8 updated for version 7.0096
vimboss
parents: 356
diff changeset
6992 changes like "fast" and uses a bit of sound-a-like
575dacb554d8 updated for version 7.0096
vimboss
parents: 356
diff changeset
6993 scoring to improve the ordering.
575dacb554d8 updated for version 7.0096
vimboss
parents: 356
diff changeset
6994
575dacb554d8 updated for version 7.0096
vimboss
parents: 356
diff changeset
6995 double Internal method that uses two methods and mixes the
575dacb554d8 updated for version 7.0096
vimboss
parents: 356
diff changeset
6996 results. The first method is "fast", the other method
344
7033303ea0c0 updated for version 7.0089
vimboss
parents: 336
diff changeset
6997 computes how much the suggestion sounds like the bad
374
575dacb554d8 updated for version 7.0096
vimboss
parents: 356
diff changeset
6998 word. That only works when the language specifies
575dacb554d8 updated for version 7.0096
vimboss
parents: 356
diff changeset
6999 sound folding. Can be slow and doesn't always give
575dacb554d8 updated for version 7.0096
vimboss
parents: 356
diff changeset
7000 better results.
575dacb554d8 updated for version 7.0096
vimboss
parents: 356
diff changeset
7001
575dacb554d8 updated for version 7.0096
vimboss
parents: 356
diff changeset
7002 fast Internal method that only checks for simple changes:
575dacb554d8 updated for version 7.0096
vimboss
parents: 356
diff changeset
7003 character inserts/deletes/swaps. Works well for
575dacb554d8 updated for version 7.0096
vimboss
parents: 356
diff changeset
7004 simple typing mistakes.
575dacb554d8 updated for version 7.0096
vimboss
parents: 356
diff changeset
7005
593
d220eb88e4e4 updated for version 7.0168
vimboss
parents: 590
diff changeset
7006 {number} The maximum number of suggestions listed for |z=|.
484
f012c4ed8c38 updated for version 7.0132
vimboss
parents: 480
diff changeset
7007 Not used for |spellsuggest()|. The number of
f012c4ed8c38 updated for version 7.0132
vimboss
parents: 480
diff changeset
7008 suggestions is never more than the value of 'lines'
f012c4ed8c38 updated for version 7.0132
vimboss
parents: 480
diff changeset
7009 minus two.
f012c4ed8c38 updated for version 7.0132
vimboss
parents: 480
diff changeset
7010
374
575dacb554d8 updated for version 7.0096
vimboss
parents: 356
diff changeset
7011 file:{filename} Read file {filename}, which must have two columns,
575dacb554d8 updated for version 7.0096
vimboss
parents: 356
diff changeset
7012 separated by a slash. The first column contains the
575dacb554d8 updated for version 7.0096
vimboss
parents: 356
diff changeset
7013 bad word, the second column the suggested good word.
575dacb554d8 updated for version 7.0096
vimboss
parents: 356
diff changeset
7014 Example:
575dacb554d8 updated for version 7.0096
vimboss
parents: 356
diff changeset
7015 theribal/terrible ~
575dacb554d8 updated for version 7.0096
vimboss
parents: 356
diff changeset
7016 Use this for common mistakes that do not appear at the
575dacb554d8 updated for version 7.0096
vimboss
parents: 356
diff changeset
7017 top of the suggestion list with the internal methods.
575dacb554d8 updated for version 7.0096
vimboss
parents: 356
diff changeset
7018 Lines without a slash are ignored, use this for
575dacb554d8 updated for version 7.0096
vimboss
parents: 356
diff changeset
7019 comments.
5862
306caa30d83b Runtime file updates.
Bram Moolenaar <bram@vim.org>
parents: 5763
diff changeset
7020 The word in the second column must be correct,
306caa30d83b Runtime file updates.
Bram Moolenaar <bram@vim.org>
parents: 5763
diff changeset
7021 otherwise it will not be used. Add the word to an
306caa30d83b Runtime file updates.
Bram Moolenaar <bram@vim.org>
parents: 5763
diff changeset
7022 ".add" file if it is currently flagged as a spelling
306caa30d83b Runtime file updates.
Bram Moolenaar <bram@vim.org>
parents: 5763
diff changeset
7023 mistake.
374
575dacb554d8 updated for version 7.0096
vimboss
parents: 356
diff changeset
7024 The file is used for all languages.
575dacb554d8 updated for version 7.0096
vimboss
parents: 356
diff changeset
7025
575dacb554d8 updated for version 7.0096
vimboss
parents: 356
diff changeset
7026 expr:{expr} Evaluate expression {expr}. Use a function to avoid
575dacb554d8 updated for version 7.0096
vimboss
parents: 356
diff changeset
7027 trouble with spaces. |v:val| holds the badly spelled
575dacb554d8 updated for version 7.0096
vimboss
parents: 356
diff changeset
7028 word. The expression must evaluate to a List of
575dacb554d8 updated for version 7.0096
vimboss
parents: 356
diff changeset
7029 Lists, each with a suggestion and a score.
575dacb554d8 updated for version 7.0096
vimboss
parents: 356
diff changeset
7030 Example:
11062
1218c5353e2b Runtime file updates.
Christian Brabandt <cb@256bit.org>
parents: 10895
diff changeset
7031 [['the', 33], ['that', 44]] ~
593
d220eb88e4e4 updated for version 7.0168
vimboss
parents: 590
diff changeset
7032 Set 'verbose' and use |z=| to see the scores that the
374
575dacb554d8 updated for version 7.0096
vimboss
parents: 356
diff changeset
7033 internal methods use. A lower score is better.
575dacb554d8 updated for version 7.0096
vimboss
parents: 356
diff changeset
7034 This may invoke |spellsuggest()| if you temporarily
575dacb554d8 updated for version 7.0096
vimboss
parents: 356
diff changeset
7035 set 'spellsuggest' to exclude the "expr:" part.
575dacb554d8 updated for version 7.0096
vimboss
parents: 356
diff changeset
7036 Errors are silently ignored, unless you set the
575dacb554d8 updated for version 7.0096
vimboss
parents: 356
diff changeset
7037 'verbose' option to a non-zero value.
575dacb554d8 updated for version 7.0096
vimboss
parents: 356
diff changeset
7038
575dacb554d8 updated for version 7.0096
vimboss
parents: 356
diff changeset
7039 Only one of "best", "double" or "fast" may be used. The others may
575dacb554d8 updated for version 7.0096
vimboss
parents: 356
diff changeset
7040 appear several times in any order. Example: >
575dacb554d8 updated for version 7.0096
vimboss
parents: 356
diff changeset
7041 :set sps=file:~/.vim/sugg,best,expr:MySuggest()
575dacb554d8 updated for version 7.0096
vimboss
parents: 356
diff changeset
7042 <
575dacb554d8 updated for version 7.0096
vimboss
parents: 356
diff changeset
7043 This option cannot be set from a |modeline| or in the |sandbox|, for
575dacb554d8 updated for version 7.0096
vimboss
parents: 356
diff changeset
7044 security reasons.
344
7033303ea0c0 updated for version 7.0089
vimboss
parents: 336
diff changeset
7045
7033303ea0c0 updated for version 7.0089
vimboss
parents: 336
diff changeset
7046
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7047 *'splitbelow'* *'sb'* *'nosplitbelow'* *'nosb'*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7048 'splitbelow' 'sb' boolean (default off)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7049 global
2570
71b56b4e7785 Make the references to features in the help more consistent. (Sylvain Hitier)
Bram Moolenaar <bram@vim.org>
parents: 2561
diff changeset
7050 {not available when compiled without the |+windows|
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7051 feature}
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7052 When on, splitting a window will put the new window below the current
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7053 one. |:split|
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7054
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7055 *'splitright'* *'spr'* *'nosplitright'* *'nospr'*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7056 'splitright' 'spr' boolean (default off)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7057 global
2570
71b56b4e7785 Make the references to features in the help more consistent. (Sylvain Hitier)
Bram Moolenaar <bram@vim.org>
parents: 2561
diff changeset
7058 {not available when compiled without the |+vertsplit|
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7059 feature}
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7060 When on, splitting a window will put the new window right of the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7061 current one. |:vsplit|
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7062
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7063 *'startofline'* *'sol'* *'nostartofline'* *'nosol'*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7064 'startofline' 'sol' boolean (default on)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7065 global
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7066 When "on" the commands listed below move the cursor to the first
11
4424b47a0797 updated for version 7.0003
vimboss
parents: 10
diff changeset
7067 non-blank of the line. When off the cursor is kept in the same column
10
4e2284e71352 updated for version 7.0002
vimboss
parents: 8
diff changeset
7068 (if possible). This applies to the commands: CTRL-D, CTRL-U, CTRL-B,
11
4424b47a0797 updated for version 7.0003
vimboss
parents: 10
diff changeset
7069 CTRL-F, "G", "H", "M", "L", gg, and to the commands "d", "<<" and ">>"
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7070 with a linewise operator, with "%" with a count and to buffer changing
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7071 commands (CTRL-^, :bnext, :bNext, etc.). Also for an Ex command that
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7072 only has a line number, e.g., ":25" or ":+".
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7073 In case of buffer changing commands the cursor is placed at the column
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7074 where it was the last time the buffer was edited.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7075 NOTE: This option is set when 'compatible' is set.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7076
2709
b01a37ab556b Runtime file updates.
Bram Moolenaar <bram@vim.org>
parents: 2698
diff changeset
7077 *'statusline'* *'stl'* *E540* *E542*
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7078 'statusline' 'stl' string (default empty)
40
f1d2a58883b9 updated for version 7.0024
vimboss
parents: 39
diff changeset
7079 global or local to window |global-local|
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7080 {not available when compiled without the |+statusline|
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7081 feature}
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7082 When nonempty, this option determines the content of the status line.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7083 Also see |status-line|.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7084
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7085 The option consists of printf style '%' items interspersed with
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7086 normal text. Each status line item is of the form:
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7087 %-0{minwid}.{maxwid}{item}
7876
93f747af7b58 commit https://github.com/vim/vim/commit/5e9b2fa9bb0e6061cf18457c173cd141a5dc9c92
Christian Brabandt <cb@256bit.org>
parents: 7687
diff changeset
7088 All fields except the {item} are optional. A single percent sign can
2709
b01a37ab556b Runtime file updates.
Bram Moolenaar <bram@vim.org>
parents: 2698
diff changeset
7089 be given as "%%". Up to 80 items can be specified. *E541*
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7090
680
5b101ff9d4c4 updated for version 7.0203
vimboss
parents: 677
diff changeset
7091 When the option starts with "%!" then it is used as an expression,
5b101ff9d4c4 updated for version 7.0203
vimboss
parents: 677
diff changeset
7092 evaluated and the result is used as the option value. Example: >
5b101ff9d4c4 updated for version 7.0203
vimboss
parents: 677
diff changeset
7093 :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
7094 < 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
7095 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
7096 The result can contain %{} items that will be evaluated too.
3445
2cfb68fa26cd Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 3371
diff changeset
7097 Note that the "%!" expression is evaluated in the context of the
2cfb68fa26cd Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 3371
diff changeset
7098 current window and buffer, while %{} items are evaluated in the
2cfb68fa26cd Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 3371
diff changeset
7099 context of the window that the statusline belongs to.
680
5b101ff9d4c4 updated for version 7.0203
vimboss
parents: 677
diff changeset
7100
5b101ff9d4c4 updated for version 7.0203
vimboss
parents: 677
diff changeset
7101 When there is error while evaluating the option then it will be made
5b101ff9d4c4 updated for version 7.0203
vimboss
parents: 677
diff changeset
7102 empty to avoid further errors. Otherwise screen updating would loop.
5b101ff9d4c4 updated for version 7.0203
vimboss
parents: 677
diff changeset
7103
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7104 Note that the only effect of 'ruler' when this option is set (and
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7105 'laststatus' is 2) is controlling the output of |CTRL-G|.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7106
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7107 field meaning ~
233
fca8a9b65afa updated for version 7.0065
vimboss
parents: 227
diff changeset
7108 - Left justify the item. The default is right justified
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7109 when minwid is larger than the length of the item.
233
fca8a9b65afa updated for version 7.0065
vimboss
parents: 227
diff changeset
7110 0 Leading zeroes in numeric items. Overridden by '-'.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7111 minwid Minimum width of the item, padding as set by '-' & '0'.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7112 Value must be 50 or less.
10
4e2284e71352 updated for version 7.0002
vimboss
parents: 8
diff changeset
7113 maxwid Maximum width of the item. Truncation occurs with a '<'
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7114 on the left for text items. Numeric items will be
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7115 shifted down to maxwid-2 digits followed by '>'number
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7116 where number is the amount of missing digits, much like
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7117 an exponential notation.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7118 item A one letter code as described below.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7119
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7120 Following is a description of the possible statusline items. The
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7121 second character in "item" is the type:
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7122 N for number
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7123 S for string
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7124 F for flags as described below
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7125 - not applicable
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7126
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7127 item meaning ~
1152
e1787f5b90da updated for version 7.1a
vimboss
parents: 1111
diff changeset
7128 f S Path to the file in the buffer, as typed or relative to current
e1787f5b90da updated for version 7.1a
vimboss
parents: 1111
diff changeset
7129 directory.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7130 F S Full path to the file in the buffer.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7131 t S File name (tail) of file in the buffer.
1698
f4f8014d516e updated for version 7.2c-000
vimboss
parents: 1668
diff changeset
7132 m F Modified flag, text is "[+]"; "[-]" if 'modifiable' is off.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7133 M F Modified flag, text is ",+" or ",-".
1698
f4f8014d516e updated for version 7.2c-000
vimboss
parents: 1668
diff changeset
7134 r F Readonly flag, text is "[RO]".
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7135 R F Readonly flag, text is ",RO".
1698
f4f8014d516e updated for version 7.2c-000
vimboss
parents: 1668
diff changeset
7136 h F Help buffer flag, text is "[help]".
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7137 H F Help buffer flag, text is ",HLP".
1698
f4f8014d516e updated for version 7.2c-000
vimboss
parents: 1668
diff changeset
7138 w F Preview window flag, text is "[Preview]".
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7139 W F Preview window flag, text is ",PRV".
1698
f4f8014d516e updated for version 7.2c-000
vimboss
parents: 1668
diff changeset
7140 y F Type of file in the buffer, e.g., "[vim]". See 'filetype'.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7141 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
7142 q S "[Quickfix List]", "[Location List]" or empty.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7143 k S Value of "b:keymap_name" or 'keymap' when |:lmap| mappings are
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7144 being used: "<keymap>"
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7145 n N Buffer number.
2709
b01a37ab556b Runtime file updates.
Bram Moolenaar <bram@vim.org>
parents: 2698
diff changeset
7146 b N Value of character under cursor.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7147 B N As above, in hexadecimal.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7148 o N Byte number in file of byte under cursor, first byte is 1.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7149 Mnemonic: Offset from start of file (with one added)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7150 {not available when compiled without |+byte_offset| feature}
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7151 O N As above, in hexadecimal.
233
fca8a9b65afa updated for version 7.0065
vimboss
parents: 227
diff changeset
7152 N N Printer page number. (Only works in the 'printheader' option.)
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7153 l N Line number.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7154 L N Number of lines in buffer.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7155 c N Column number.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7156 v N Virtual column number.
10
4e2284e71352 updated for version 7.0002
vimboss
parents: 8
diff changeset
7157 V N Virtual column number as -{num}. Not displayed if equal to 'c'.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7158 p N Percentage through file in lines as in |CTRL-G|.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7159 P S Percentage through file of displayed window. This is like the
5055
c458ff35497e Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 5024
diff changeset
7160 percentage described for 'ruler'. Always 3 in length, unless
c458ff35497e Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 5024
diff changeset
7161 translated.
233
fca8a9b65afa updated for version 7.0065
vimboss
parents: 227
diff changeset
7162 a S Argument list status as in default title. ({current} of {max})
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7163 Empty if the argument file count is zero or one.
680
5b101ff9d4c4 updated for version 7.0203
vimboss
parents: 677
diff changeset
7164 { 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
7165 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
7166 expression cannot contain a '}' character, call a function to
a34b1323286c patch 8.0.1743: terminal window options are named inconsistently
Christian Brabandt <cb@256bit.org>
parents: 13735
diff changeset
7167 work around that.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7168 ( - Start of item group. Can be used for setting the width and
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7169 alignment of a section. Must be followed by %) somewhere.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7170 ) - End of item group. No width fields allowed.
681
9364d114ed8d updated for version 7.0204
vimboss
parents: 680
diff changeset
7171 T N For 'tabline': start of tab page N label. Use %T after the last
9364d114ed8d updated for version 7.0204
vimboss
parents: 680
diff changeset
7172 label. This information is used for mouse clicks.
9364d114ed8d updated for version 7.0204
vimboss
parents: 680
diff changeset
7173 X N For 'tabline': start of close tab N label. Use %X after the
9364d114ed8d updated for version 7.0204
vimboss
parents: 680
diff changeset
7174 label, e.g.: %3Xclose%X. Use %999X for a "close current tab"
9364d114ed8d updated for version 7.0204
vimboss
parents: 680
diff changeset
7175 mark. This information is used for mouse clicks.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7176 < - Where to truncate line if too long. Default is at the start.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7177 No width fields allowed.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7178 = - Separation point between left and right aligned items.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7179 No width fields allowed.
680
5b101ff9d4c4 updated for version 7.0203
vimboss
parents: 677
diff changeset
7180 # - Set highlight group. The name must follow and then a # again.
5b101ff9d4c4 updated for version 7.0203
vimboss
parents: 677
diff changeset
7181 Thus use %#HLname# for highlight group HLname. The same
5b101ff9d4c4 updated for version 7.0203
vimboss
parents: 677
diff changeset
7182 highlighting is used, also for the statusline of non-current
5b101ff9d4c4 updated for version 7.0203
vimboss
parents: 677
diff changeset
7183 windows.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7184 * - Set highlight group to User{N}, where {N} is taken from the
233
fca8a9b65afa updated for version 7.0065
vimboss
parents: 227
diff changeset
7185 minwid field, e.g. %1*. Restore normal highlight with %* or %0*.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7186 The difference between User{N} and StatusLine will be applied
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7187 to StatusLineNC for the statusline of non-current windows.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7188 The number N must be between 1 and 9. See |hl-User1..9|
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7189
1698
f4f8014d516e updated for version 7.2c-000
vimboss
parents: 1668
diff changeset
7190 When displaying a flag, Vim removes the leading comma, if any, when
f4f8014d516e updated for version 7.2c-000
vimboss
parents: 1668
diff changeset
7191 that flag comes right after plaintext. This will make a nice display
f4f8014d516e updated for version 7.2c-000
vimboss
parents: 1668
diff changeset
7192 when flags are used like in the examples below.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7193
233
fca8a9b65afa updated for version 7.0065
vimboss
parents: 227
diff changeset
7194 When all items in a group becomes an empty string (i.e. flags that are
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7195 not set) and a minwid is not set for the group, the whole group will
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7196 become empty. This will make a group like the following disappear
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7197 completely from the statusline when none of the flags are set. >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7198 :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
7199 < 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
7200 line is displayed.
dc85d49349f7 patch 8.1.1372: when evaluating 'statusline' the current window is unknown
Bram Moolenaar <Bram@vim.org>
parents: 16728
diff changeset
7201 *g:actual_curbuf* *g:actual_curwin*
dc85d49349f7 patch 8.1.1372: when evaluating 'statusline' the current window is unknown
Bram Moolenaar <Bram@vim.org>
parents: 16728
diff changeset
7202 The current buffer and current window will be set temporarily to that
dc85d49349f7 patch 8.1.1372: when evaluating 'statusline' the current window is unknown
Bram Moolenaar <Bram@vim.org>
parents: 16728
diff changeset
7203 of the window (and buffer) whose statusline is currently being drawn.
dc85d49349f7 patch 8.1.1372: when evaluating 'statusline' the current window is unknown
Bram Moolenaar <Bram@vim.org>
parents: 16728
diff changeset
7204 The expression will evaluate in this context. The variable
dc85d49349f7 patch 8.1.1372: when evaluating 'statusline' the current window is unknown
Bram Moolenaar <Bram@vim.org>
parents: 16728
diff changeset
7205 "g:actual_curbuf" is set to the `bufnr()` number of the real current
dc85d49349f7 patch 8.1.1372: when evaluating 'statusline' the current window is unknown
Bram Moolenaar <Bram@vim.org>
parents: 16728
diff changeset
7206 buffer and "g:actual_curwin" to the |window-ID| of the real current
dc85d49349f7 patch 8.1.1372: when evaluating 'statusline' the current window is unknown
Bram Moolenaar <Bram@vim.org>
parents: 16728
diff changeset
7207 window. These values are strings.
634
1c586ee8dd45 updated for version 7.0183
vimboss
parents: 632
diff changeset
7208
3682
11d40fc82f11 Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 3674
diff changeset
7209 The 'statusline' option will be evaluated in the |sandbox| if set from
11d40fc82f11 Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 3674
diff changeset
7210 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
7211 This option cannot be set in a modeline when 'modelineexpr' is off.
634
1c586ee8dd45 updated for version 7.0183
vimboss
parents: 632
diff changeset
7212
1c586ee8dd45 updated for version 7.0183
vimboss
parents: 632
diff changeset
7213 It is not allowed to change text or jump to another window while
1c586ee8dd45 updated for version 7.0183
vimboss
parents: 632
diff changeset
7214 evaluating 'statusline' |textlock|.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7215
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7216 If the statusline is not updated when you want it (e.g., after setting
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7217 a variable that's used in an expression), you can force an update by
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7218 setting an option without changing its value. Example: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7219 :let &ro = &ro
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7220
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7221 < A result of all digits is regarded a number for display purposes.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7222 Otherwise the result is taken as flag text and applied to the rules
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7223 described above.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7224
199
3b32f6b507fa updated for version 7.0059
vimboss
parents: 189
diff changeset
7225 Watch out for errors in expressions. They may render Vim unusable!
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7226 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
7227 edit your .vimrc or whatever with "vim --clean" to get it right.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7228
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7229 Examples:
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7230 Emulate standard status line with 'ruler' set >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7231 :set statusline=%<%f\ %h%m%r%=%-14.(%l,%c%V%)\ %P
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7232 < Similar, but add ASCII value of char under the cursor (like "ga") >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7233 :set statusline=%<%f%h%m%r%=%b\ 0x%B\ \ %l,%c%V\ %P
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7234 < Display byte count and byte value, modified flag in red. >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7235 :set statusline=%<%f%=\ [%1*%M%*%n%R%H]\ %-19(%3l,%02c%03V%)%O'%02b'
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7236 :hi User1 term=inverse,bold cterm=inverse,bold ctermfg=red
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7237 < Display a ,GZ flag if a compressed file is loaded >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7238 :set statusline=...%r%{VarExists('b:gzflag','\ [GZ]')}%h...
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7239 < In the |:autocmd|'s: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7240 :let b:gzflag = 1
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7241 < And: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7242 :unlet b:gzflag
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7243 < And define this function: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7244 :function VarExists(var, val)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7245 : if exists(a:var) | return a:val | else | return '' | endif
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7246 :endfunction
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7247 <
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7248 *'suffixes'* *'su'*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7249 'suffixes' 'su' string (default ".bak,~,.o,.h,.info,.swp,.obj")
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7250 global
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7251 Files with these suffixes get a lower priority when multiple files
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7252 match a wildcard. See |suffixes|. Commas can be used to separate the
10
4e2284e71352 updated for version 7.0002
vimboss
parents: 8
diff changeset
7253 suffixes. Spaces after the comma are ignored. A dot is also seen as
4e2284e71352 updated for version 7.0002
vimboss
parents: 8
diff changeset
7254 the start of a suffix. To avoid a dot or comma being recognized as a
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7255 separator, precede it with a backslash (see |option-backslash| about
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7256 including spaces and backslashes).
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7257 See 'wildignore' for completely ignoring files.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7258 The use of |:set+=| and |:set-=| is preferred when adding or removing
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7259 suffixes from the list. This avoids problems when a future version
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7260 uses another default.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7261
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7262 *'suffixesadd'* *'sua'*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7263 'suffixesadd' 'sua' string (default "")
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7264 local to buffer
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7265 {not available when compiled without the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7266 |+file_in_path| feature}
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7267 Comma separated list of suffixes, which are used when searching for a
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7268 file for the "gf", "[I", etc. commands. Example: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7269 :set suffixesadd=.java
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7270 <
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7271 *'swapfile'* *'swf'* *'noswapfile'* *'noswf'*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7272 'swapfile' 'swf' boolean (default on)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7273 local to buffer
10
4e2284e71352 updated for version 7.0002
vimboss
parents: 8
diff changeset
7274 Use a swapfile for the buffer. This option can be reset when a
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7275 swapfile is not wanted for a specific buffer. For example, with
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7276 confidential information that even root must not be able to access.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7277 Careful: All text will be in memory:
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7278 - Don't use this for big files.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7279 - Recovery will be impossible!
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7280 A swapfile will only be present when |'updatecount'| is non-zero and
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7281 'swapfile' is set.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7282 When 'swapfile' is reset, the swap file for the current buffer is
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7283 immediately deleted. When 'swapfile' is set, and 'updatecount' is
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7284 non-zero, a swap file is immediately created.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7285 Also see |swap-file| and |'swapsync'|.
5763
c52a655d927d Update runtime files.
Bram Moolenaar <bram@vim.org>
parents: 5712
diff changeset
7286 If you want to open a new buffer without creating a swap file for it,
c52a655d927d Update runtime files.
Bram Moolenaar <bram@vim.org>
parents: 5712
diff changeset
7287 use the |:noswapfile| modifier.
13341
acd7eaa13d2b Updated runtime files.
Christian Brabandt <cb@256bit.org>
parents: 13314
diff changeset
7288 See 'directory' for where the swap file is created.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7289
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7290 This option is used together with 'bufhidden' and 'buftype' to
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7291 specify special kinds of buffers. See |special-buffers|.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7292
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7293 *'swapsync'* *'sws'*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7294 'swapsync' 'sws' string (default "fsync")
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7295 global
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7296 When this option is not empty a swap file is synced to disk after
10
4e2284e71352 updated for version 7.0002
vimboss
parents: 8
diff changeset
7297 writing to it. This takes some time, especially on busy unix systems.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7298 When this option is empty parts of the swap file may be in memory and
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7299 not written to disk. When the system crashes you may lose more work.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7300 On Unix the system does a sync now and then without Vim asking for it,
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7301 so the disadvantage of setting this option off is small. On some
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7302 systems the swap file will not be written at all. For a unix system
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7303 setting it to "sync" will use the sync() call instead of the default
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7304 fsync(), which may work better on some systems.
36
125e80798a85 updated for version 7.0021
vimboss
parents: 33
diff changeset
7305 The 'fsync' option is used for the actual file.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7306
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7307 *'switchbuf'* *'swb'*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7308 'switchbuf' 'swb' string (default "")
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7309 global
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7310 This option controls the behavior when switching between buffers.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7311 Possible values (comma separated list):
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7312 useopen If included, jump to the first open window that
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7313 contains the specified buffer (if there is one).
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7314 Otherwise: Do not examine other windows.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7315 This setting is checked with |quickfix| commands, when
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7316 jumping to errors (":cc", ":cn", "cp", etc.). It is
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7317 also used in all buffer related split commands, for
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7318 example ":sbuffer", ":sbnext", or ":sbrewind".
825
6675076019ae updated for version 7.0d
vimboss
parents: 824
diff changeset
7319 usetab Like "useopen", but also consider windows in other tab
856
8cd729851562 updated for version 7.0g
vimboss
parents: 853
diff changeset
7320 pages.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7321 split If included, split the current window before loading
3153
37ecb8ff4560 Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 3082
diff changeset
7322 a buffer for a |quickfix| command that display errors.
16086
bd7461db24b3 Update runtime files.
Bram Moolenaar <Bram@vim.org>
parents: 16023
diff changeset
7323 Otherwise: do not split, use current window (when used
bd7461db24b3 Update runtime files.
Bram Moolenaar <Bram@vim.org>
parents: 16023
diff changeset
7324 in the quickfix window: the previously used window or
bd7461db24b3 Update runtime files.
Bram Moolenaar <Bram@vim.org>
parents: 16023
diff changeset
7325 split if there is no other window).
6843
50cdebea094f patch 7.4.742
Bram Moolenaar <bram@vim.org>
parents: 6823
diff changeset
7326 vsplit Just like "split" but split vertically.
1621
82b5078be2dd updated for version 7.2a
vimboss
parents: 1564
diff changeset
7327 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
7328 "split" when both are present.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7329
410
c60ba877860b updated for version 7.0107
vimboss
parents: 401
diff changeset
7330 *'synmaxcol'* *'smc'*
c60ba877860b updated for version 7.0107
vimboss
parents: 401
diff changeset
7331 'synmaxcol' 'smc' number (default 3000)
c60ba877860b updated for version 7.0107
vimboss
parents: 401
diff changeset
7332 local to buffer
c60ba877860b updated for version 7.0107
vimboss
parents: 401
diff changeset
7333 {not available when compiled without the |+syntax|
c60ba877860b updated for version 7.0107
vimboss
parents: 401
diff changeset
7334 feature}
419
f713fc55bf7b updated for version 7.0109
vimboss
parents: 410
diff changeset
7335 Maximum column in which to search for syntax items. In long lines the
f713fc55bf7b updated for version 7.0109
vimboss
parents: 410
diff changeset
7336 text after this column is not highlighted and following lines may not
f713fc55bf7b updated for version 7.0109
vimboss
parents: 410
diff changeset
7337 be highlighted correctly, because the syntax state is cleared.
410
c60ba877860b updated for version 7.0107
vimboss
parents: 401
diff changeset
7338 This helps to avoid very slow redrawing for an XML file that is one
c60ba877860b updated for version 7.0107
vimboss
parents: 401
diff changeset
7339 long line.
c60ba877860b updated for version 7.0107
vimboss
parents: 401
diff changeset
7340 Set to zero to remove the limit.
c60ba877860b updated for version 7.0107
vimboss
parents: 401
diff changeset
7341
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7342 *'syntax'* *'syn'*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7343 'syntax' 'syn' string (default empty)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7344 local to buffer
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7345 {not available when compiled without the |+syntax|
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7346 feature}
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7347 When this option is set, the syntax with this name is loaded, unless
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7348 syntax highlighting has been switched off with ":syntax off".
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7349 Otherwise this option does not always reflect the current syntax (the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7350 b:current_syntax variable does).
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7351 This option is most useful in a modeline, for a file which syntax is
782
d20041a02ee5 updated for version 7.0228
vimboss
parents: 777
diff changeset
7352 not automatically recognized. Example, in an IDL file:
d20041a02ee5 updated for version 7.0228
vimboss
parents: 777
diff changeset
7353 /* vim: set syntax=idl : */ ~
d20041a02ee5 updated for version 7.0228
vimboss
parents: 777
diff changeset
7354 When a dot appears in the value then this separates two filetype
d20041a02ee5 updated for version 7.0228
vimboss
parents: 777
diff changeset
7355 names. Example:
d20041a02ee5 updated for version 7.0228
vimboss
parents: 777
diff changeset
7356 /* vim: set syntax=c.doxygen : */ ~
d20041a02ee5 updated for version 7.0228
vimboss
parents: 777
diff changeset
7357 This will use the "c" syntax first, then the "doxygen" syntax.
d20041a02ee5 updated for version 7.0228
vimboss
parents: 777
diff changeset
7358 Note that the second one must be prepared to be loaded as an addition,
d20041a02ee5 updated for version 7.0228
vimboss
parents: 777
diff changeset
7359 otherwise it will be skipped. More than one dot may appear.
d20041a02ee5 updated for version 7.0228
vimboss
parents: 777
diff changeset
7360 To switch off syntax highlighting for the current file, use: >
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7361 :set syntax=OFF
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7362 < To switch syntax highlighting on according to the current value of the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7363 'filetype' option: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7364 :set syntax=ON
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7365 < What actually happens when setting the 'syntax' option is that the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7366 Syntax autocommand event is triggered with the value as argument.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7367 This option is not copied to another buffer, independent of the 's' or
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7368 'S' flag in 'cpoptions'.
36
125e80798a85 updated for version 7.0021
vimboss
parents: 33
diff changeset
7369 Only normal file name characters can be used, "/\*?[|<>" are illegal.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7370
699
2af8de31a3a8 updated for version 7.0211
vimboss
parents: 697
diff changeset
7371 *'tabline'* *'tal'*
677
e649c78407e6 updated for version 7.0202
vimboss
parents: 674
diff changeset
7372 'tabline' 'tal' string (default empty)
674
4b8583e82cb8 updated for version 7.0201
vimboss
parents: 667
diff changeset
7373 global
2570
71b56b4e7785 Make the references to features in the help more consistent. (Sylvain Hitier)
Bram Moolenaar <bram@vim.org>
parents: 2561
diff changeset
7374 {not available when compiled without the |+windows|
674
4b8583e82cb8 updated for version 7.0201
vimboss
parents: 667
diff changeset
7375 feature}
677
e649c78407e6 updated for version 7.0202
vimboss
parents: 674
diff changeset
7376 When nonempty, this option determines the content of the tab pages
e649c78407e6 updated for version 7.0202
vimboss
parents: 674
diff changeset
7377 line at the top of the Vim window. When empty Vim will use a default
681
9364d114ed8d updated for version 7.0204
vimboss
parents: 680
diff changeset
7378 tab pages line. See |setting-tabline| for more info.
677
e649c78407e6 updated for version 7.0202
vimboss
parents: 674
diff changeset
7379
e649c78407e6 updated for version 7.0202
vimboss
parents: 674
diff changeset
7380 The tab pages line only appears as specified with the 'showtabline'
688
bcd2edc4539e updated for version 7.0207
vimboss
parents: 685
diff changeset
7381 option and only when there is no GUI tab line. When 'e' is in
bcd2edc4539e updated for version 7.0207
vimboss
parents: 685
diff changeset
7382 '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
7383 instead. Note that the two tab pages lines are very different.
677
e649c78407e6 updated for version 7.0202
vimboss
parents: 674
diff changeset
7384
e649c78407e6 updated for version 7.0202
vimboss
parents: 674
diff changeset
7385 The value is evaluated like with 'statusline'. You can use
e649c78407e6 updated for version 7.0202
vimboss
parents: 674
diff changeset
7386 |tabpagenr()|, |tabpagewinnr()| and |tabpagebuflist()| to figure out
681
9364d114ed8d updated for version 7.0204
vimboss
parents: 680
diff changeset
7387 the text to be displayed. Use "%1T" for the first label, "%2T" for
9364d114ed8d updated for version 7.0204
vimboss
parents: 680
diff changeset
7388 the second one, etc. Use "%X" items for closing labels.
677
e649c78407e6 updated for version 7.0202
vimboss
parents: 674
diff changeset
7389
15396
325e4a8ba1b6 patch 8.1.0706: tabline is not always redrawn
Bram Moolenaar <Bram@vim.org>
parents: 15281
diff changeset
7390 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
7391 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
7392 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
7393
677
e649c78407e6 updated for version 7.0202
vimboss
parents: 674
diff changeset
7394 Keep in mind that only one of the tab pages is the current one, others
e649c78407e6 updated for version 7.0202
vimboss
parents: 674
diff changeset
7395 are invisible and you can't jump to their windows.
e649c78407e6 updated for version 7.0202
vimboss
parents: 674
diff changeset
7396
674
4b8583e82cb8 updated for version 7.0201
vimboss
parents: 667
diff changeset
7397
699
2af8de31a3a8 updated for version 7.0211
vimboss
parents: 697
diff changeset
7398 *'tabpagemax'* *'tpm'*
2af8de31a3a8 updated for version 7.0211
vimboss
parents: 697
diff changeset
7399 'tabpagemax' 'tpm' number (default 10)
2af8de31a3a8 updated for version 7.0211
vimboss
parents: 697
diff changeset
7400 global
2570
71b56b4e7785 Make the references to features in the help more consistent. (Sylvain Hitier)
Bram Moolenaar <bram@vim.org>
parents: 2561
diff changeset
7401 {not available when compiled without the |+windows|
699
2af8de31a3a8 updated for version 7.0211
vimboss
parents: 697
diff changeset
7402 feature}
2af8de31a3a8 updated for version 7.0211
vimboss
parents: 697
diff changeset
7403 Maximum number of tab pages to be opened by the |-p| command line
2af8de31a3a8 updated for version 7.0211
vimboss
parents: 697
diff changeset
7404 argument or the ":tab all" command. |tabpage|
2af8de31a3a8 updated for version 7.0211
vimboss
parents: 697
diff changeset
7405
2af8de31a3a8 updated for version 7.0211
vimboss
parents: 697
diff changeset
7406
2af8de31a3a8 updated for version 7.0211
vimboss
parents: 697
diff changeset
7407 *'tabstop'* *'ts'*
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7408 'tabstop' 'ts' number (default 8)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7409 local to buffer
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7410 Number of spaces that a <Tab> in the file counts for. Also see
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7411 |:retab| command, and 'softtabstop' option.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7412
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7413 Note: Setting 'tabstop' to any other value than 8 can make your file
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7414 appear wrong in many places (e.g., when printing it).
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7415
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7416 There are four main ways to use tabs in Vim:
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7417 1. Always keep 'tabstop' at 8, set 'softtabstop' and 'shiftwidth' to 4
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7418 (or 3 or whatever you prefer) and use 'noexpandtab'. Then Vim
1263
57361514f73a updated for version 7.1
vimboss
parents: 1213
diff changeset
7419 will use a mix of tabs and spaces, but typing <Tab> and <BS> will
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7420 behave like a tab appears every 4 (or 3) characters.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7421 2. Set 'tabstop' and 'shiftwidth' to whatever you prefer and use
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7422 'expandtab'. This way you will always insert spaces. The
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7423 formatting will never be messed up when 'tabstop' is changed.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7424 3. Set 'tabstop' and 'shiftwidth' to whatever you prefer and use a
10
4e2284e71352 updated for version 7.0002
vimboss
parents: 8
diff changeset
7425 |modeline| to set these values when editing the file again. Only
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7426 works when using Vim to edit the file.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7427 4. Always set 'tabstop' and 'shiftwidth' to the same value, and
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7428 'noexpandtab'. This should then work (for initial indents only)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7429 for any tabstop setting that people use. It might be nice to have
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7430 tabs after the first non-blank inserted as spaces if you do this
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7431 though. Otherwise aligned comments will be wrong when 'tabstop' is
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7432 changed.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7433
14175
2ad722003b36 patch 8.1.0105: all tab stops are the same
Christian Brabandt <cb@256bit.org>
parents: 14019
diff changeset
7434 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
7435 '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
7436 than an empty string.
2ad722003b36 patch 8.1.0105: all tab stops are the same
Christian Brabandt <cb@256bit.org>
parents: 14019
diff changeset
7437
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7438 *'tagbsearch'* *'tbs'* *'notagbsearch'* *'notbs'*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7439 'tagbsearch' 'tbs' boolean (default on)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7440 global
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7441 When searching for a tag (e.g., for the |:ta| command), Vim can either
10
4e2284e71352 updated for version 7.0002
vimboss
parents: 8
diff changeset
7442 use a binary search or a linear search in a tags file. Binary
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7443 searching makes searching for a tag a LOT faster, but a linear search
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7444 will find more tags if the tags file wasn't properly sorted.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7445 Vim normally assumes that your tags files are sorted, or indicate that
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7446 they are not sorted. Only when this is not the case does the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7447 'tagbsearch' option need to be switched off.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7448
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7449 When 'tagbsearch' is on, binary searching is first used in the tags
10
4e2284e71352 updated for version 7.0002
vimboss
parents: 8
diff changeset
7450 files. In certain situations, Vim will do a linear search instead for
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7451 certain files, or retry all files with a linear search. When
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7452 'tagbsearch' is off, only a linear search is done.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7453
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7454 Linear searching is done anyway, for one file, when Vim finds a line
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7455 at the start of the file indicating that it's not sorted: >
1621
82b5078be2dd updated for version 7.2a
vimboss
parents: 1564
diff changeset
7456 !_TAG_FILE_SORTED 0 /some comment/
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7457 < [The whitespace before and after the '0' must be a single <Tab>]
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7458
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7459 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
7460 files listed in 'tags', and case is ignored or a pattern is used
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7461 instead of a normal tag name, a retry is done with a linear search.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7462 Tags in unsorted tags files, and matches with different case will only
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7463 be found in the retry.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7464
22
cc049b00ee70 updated for version 7.0014
vimboss
parents: 20
diff changeset
7465 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
7466 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
7467 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
7468 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
7469 "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
7470 (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
7471 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
7472
6ba7182fb7bd commit https://github.com/vim/vim/commit/0f6562e9036f889185dff49a75c7fc5ffb28b307
Christian Brabandt <cb@256bit.org>
parents: 7245
diff changeset
7473 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
7474 '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
7475 "ignore".
9913
bb00c661b3a4 commit https://github.com/vim/vim/commit/66e29d7112e437b2b50efe1f82c7e892736d23e4
Christian Brabandt <cb@256bit.org>
parents: 9887
diff changeset
7476 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
7477 '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
7478 characters.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7479
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7480 When 'tagbsearch' is off, tags searching is slower when a full match
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7481 exists, but faster when no full match exists. Tags in unsorted tags
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7482 files may only be found with 'tagbsearch' off.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7483 When the tags file is not sorted, or sorted in a wrong way (not on
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7484 ASCII byte value), 'tagbsearch' should be off, or the line given above
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7485 must be included in the tags file.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7486 This option doesn't affect commands that find all matching tags (e.g.,
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7487 command-line completion and ":help").
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7488
7266
6ba7182fb7bd commit https://github.com/vim/vim/commit/0f6562e9036f889185dff49a75c7fc5ffb28b307
Christian Brabandt <cb@256bit.org>
parents: 7245
diff changeset
7489 *'tagcase'* *'tc'*
6ba7182fb7bd commit https://github.com/vim/vim/commit/0f6562e9036f889185dff49a75c7fc5ffb28b307
Christian Brabandt <cb@256bit.org>
parents: 7245
diff changeset
7490 'tagcase' 'tc' string (default "followic")
6ba7182fb7bd commit https://github.com/vim/vim/commit/0f6562e9036f889185dff49a75c7fc5ffb28b307
Christian Brabandt <cb@256bit.org>
parents: 7245
diff changeset
7491 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
7492 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
7493 file:
6ba7182fb7bd commit https://github.com/vim/vim/commit/0f6562e9036f889185dff49a75c7fc5ffb28b307
Christian Brabandt <cb@256bit.org>
parents: 7245
diff changeset
7494 followic Follow the 'ignorecase' option
9913
bb00c661b3a4 commit https://github.com/vim/vim/commit/66e29d7112e437b2b50efe1f82c7e892736d23e4
Christian Brabandt <cb@256bit.org>
parents: 9887
diff changeset
7495 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
7496 ignore Ignore case
6ba7182fb7bd commit https://github.com/vim/vim/commit/0f6562e9036f889185dff49a75c7fc5ffb28b307
Christian Brabandt <cb@256bit.org>
parents: 7245
diff changeset
7497 match Match case
9913
bb00c661b3a4 commit https://github.com/vim/vim/commit/66e29d7112e437b2b50efe1f82c7e892736d23e4
Christian Brabandt <cb@256bit.org>
parents: 9887
diff changeset
7498 smart Ignore case unless an upper case letter is used
11160
d0a20101ecb2 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 11063
diff changeset
7499 NOTE: This option is set to the Vi default value when 'compatible' is
d0a20101ecb2 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 11063
diff changeset
7500 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
7501
16447
54ffc82f38a8 patch 8.1.1228: not possible to process tags with a function
Bram Moolenaar <Bram@vim.org>
parents: 16443
diff changeset
7502 *'tagfunc'* *'tfu'*
54ffc82f38a8 patch 8.1.1228: not possible to process tags with a function
Bram Moolenaar <Bram@vim.org>
parents: 16443
diff changeset
7503 '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
7504 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
7505 {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
7506 feature}
54ffc82f38a8 patch 8.1.1228: not possible to process tags with a function
Bram Moolenaar <Bram@vim.org>
parents: 16443
diff changeset
7507 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
7508 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
7509 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
7510 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
7511
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7512 *'taglength'* *'tl'*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7513 'taglength' 'tl' number (default 0)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7514 global
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7515 If non-zero, tags are significant up to this number of characters.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7516
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7517 *'tagrelative'* *'tr'* *'notagrelative'* *'notr'*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7518 'tagrelative' 'tr' boolean (Vim default: on, Vi default: off)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7519 global
824
8dd456c1e283 updated for version 7.0c13
vimboss
parents: 819
diff changeset
7520 If on and using a tags file in another directory, file names in that
8dd456c1e283 updated for version 7.0c13
vimboss
parents: 819
diff changeset
7521 tags file are relative to the directory where the tags file is.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7522 NOTE: This option is set to the Vi default value when 'compatible' is
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7523 set and to the Vim default value when 'compatible' is reset.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7524
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7525 *'tags'* *'tag'* *E433*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7526 'tags' 'tag' string (default "./tags,tags", when compiled with
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7527 |+emacs_tags|: "./tags,./TAGS,tags,TAGS")
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7528 global or local to buffer |global-local|
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7529 Filenames for the tag command, separated by spaces or commas. To
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7530 include a space or comma in a file name, precede it with a backslash
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7531 (see |option-backslash| about including spaces and backslashes).
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7532 When a file name starts with "./", the '.' is replaced with the path
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7533 of the current file. But only when the 'd' flag is not included in
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7534 'cpoptions'. Environment variables are expanded |:set_env|. Also see
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7535 |tags-option|.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7536 "*", "**" 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
7537 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
7538 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
7539 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
7540 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
7541 |+path_extra| feature}
515
04dcb5a1f2f9 updated for version 7.0144
vimboss
parents: 502
diff changeset
7542 The |tagfiles()| function can be used to get a list of the file names
04dcb5a1f2f9 updated for version 7.0144
vimboss
parents: 502
diff changeset
7543 actually used.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7544 If Vim was compiled with the |+emacs_tags| feature, Emacs-style tag
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7545 files are also supported. They are automatically recognized. The
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7546 default value becomes "./tags,./TAGS,tags,TAGS", unless case
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7547 differences are ignored (MS-Windows). |emacs-tags|
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7548 The use of |:set+=| and |:set-=| is preferred when adding or removing
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7549 file names from the list. This avoids problems when a future version
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7550 uses another default.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7551
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7552 *'tagstack'* *'tgst'* *'notagstack'* *'notgst'*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7553 'tagstack' 'tgst' boolean (default on)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7554 global
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7555 When on, the |tagstack| is used normally. When off, a ":tag" or
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7556 ":tselect" command with an argument will not push the tag onto the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7557 tagstack. A following ":tag" without an argument, a ":pop" command or
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7558 any other command that uses the tagstack will use the unmodified
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7559 tagstack, but does change the pointer to the active entry.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7560 Resetting this option is useful when using a ":tag" command in a
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7561 mapping which should not change the tagstack.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7562
7538
c9fc24b76293 commit https://github.com/vim/vim/commit/8a5115cf18751022387af2085f374d38c60dde83
Christian Brabandt <cb@256bit.org>
parents: 7528
diff changeset
7563 *'tcldll'*
8629
54ac275e3fc4 commit https://github.com/vim/vim/commit/3848e00e0177abdb31bc600234967863ec487233
Christian Brabandt <cb@256bit.org>
parents: 8560
diff changeset
7564 '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
7565 global
c9fc24b76293 commit https://github.com/vim/vim/commit/8a5115cf18751022387af2085f374d38c60dde83
Christian Brabandt <cb@256bit.org>
parents: 7528
diff changeset
7566 {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
7567 feature}
c9fc24b76293 commit https://github.com/vim/vim/commit/8a5115cf18751022387af2085f374d38c60dde83
Christian Brabandt <cb@256bit.org>
parents: 7528
diff changeset
7568 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
7569 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
7570 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
7571 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
7572 security reasons.
c9fc24b76293 commit https://github.com/vim/vim/commit/8a5115cf18751022387af2085f374d38c60dde83
Christian Brabandt <cb@256bit.org>
parents: 7528
diff changeset
7573
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7574 *'term'* *E529* *E530* *E531*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7575 'term' string (default is $TERM, if that fails:
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7576 in the GUI: "builtin_gui"
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7577 on Amiga: "amiga"
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7578 on BeOS: "beos-ansi"
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7579 on Mac: "mac-ansi"
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7580 on MiNT: "vt52"
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7581 on MS-DOS: "pcterm"
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7582 on OS/2: "os2ansi"
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7583 on Unix: "ansi"
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7584 on VMS: "ansi"
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7585 on Win 32: "win32")
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7586 global
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7587 Name of the terminal. Used for choosing the terminal control
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7588 characters. Environment variables are expanded |:set_env|.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7589 For example: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7590 :set term=$TERM
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7591 < See |termcap|.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7592
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7593 *'termbidi'* *'tbidi'*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7594 *'notermbidi'* *'notbidi'*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7595 'termbidi' 'tbidi' boolean (default off, on for "mlterm")
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7596 global
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7597 {only available when compiled with the |+arabic|
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7598 feature}
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7599 The terminal is in charge of Bi-directionality of text (as specified
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7600 by Unicode). The terminal is also expected to do the required shaping
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7601 that some languages (such as Arabic) require.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7602 Setting this option implies that 'rightleft' will not be set when
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7603 'arabic' is set and the value of 'arabicshape' will be ignored.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7604 Note that setting 'termbidi' has the immediate effect that
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7605 'arabicshape' is ignored, but 'rightleft' isn't changed automatically.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7606 This option is reset when the GUI is started.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7607 For further details see |arabic.txt|.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7608
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7609 *'termencoding'* *'tenc'*
10895
c391bfbdb452 Updated runtime files.
Christian Brabandt <cb@256bit.org>
parents: 10734
diff changeset
7610 'termencoding' 'tenc' string (default ""; with GTK+ GUI: "utf-8"; with
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7611 Macintosh GUI: "macroman")
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7612 global
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7613 Encoding used for the terminal. This specifies what character
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7614 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
7615 the GUI it only applies to the keyboard ('encoding' is used for the
1152
e1787f5b90da updated for version 7.1a
vimboss
parents: 1111
diff changeset
7616 display). Except for the Mac when 'macatsui' is off, then
e1787f5b90da updated for version 7.1a
vimboss
parents: 1111
diff changeset
7617 'termencoding' should be "macroman".
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7618 *E617*
10895
c391bfbdb452 Updated runtime files.
Christian Brabandt <cb@256bit.org>
parents: 10734
diff changeset
7619 Note: This does not apply to the GTK+ GUI. After the GUI has been
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7620 successfully initialized, 'termencoding' is forcibly set to "utf-8".
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7621 Any attempts to set a different value will be rejected, and an error
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7622 message is shown.
7080
1a34f5272977 commit https://github.com/vim/vim/commit/ac360bf2ca293735fc7c6654dc2b3066f4c62488
Christian Brabandt <cb@256bit.org>
parents: 7051
diff changeset
7623 For the Win32 GUI and console versions 'termencoding' is not used,
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7624 because the Win32 system always passes Unicode characters.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7625 When empty, the same encoding is used as for the 'encoding' option.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7626 This is the normal value.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7627 Not all combinations for 'termencoding' and 'encoding' are valid. See
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7628 |encoding-table|.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7629 The value for this option must be supported by internal conversions or
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7630 iconv(). When this is not possible no conversion will be done and you
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7631 will probably experience problems with non-ASCII characters.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7632 Example: You are working with the locale set to euc-jp (Japanese) and
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7633 want to edit a UTF-8 file: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7634 :let &termencoding = &encoding
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7635 :set encoding=utf-8
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7636 < You need to do this when your system has no locale support for UTF-8.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7637
13314
65c3e8259124 patch 8.0.1531: cannot use 24 bit colors in MS-Windows console
Christian Brabandt <cb@256bit.org>
parents: 13234
diff changeset
7638 *'termguicolors'* *'tgc'* *E954*
9027
773d627cac0b commit https://github.com/vim/vim/commit/61be73bb0f965a895bfb064ea3e55476ac175162
Christian Brabandt <cb@256bit.org>
parents: 8969
diff changeset
7639 'termguicolors' 'tgc' boolean (default off)
773d627cac0b commit https://github.com/vim/vim/commit/61be73bb0f965a895bfb064ea3e55476ac175162
Christian Brabandt <cb@256bit.org>
parents: 8969
diff changeset
7640 global
773d627cac0b commit https://github.com/vim/vim/commit/61be73bb0f965a895bfb064ea3e55476ac175162
Christian Brabandt <cb@256bit.org>
parents: 8969
diff changeset
7641 {not available when compiled without the
773d627cac0b commit https://github.com/vim/vim/commit/61be73bb0f965a895bfb064ea3e55476ac175162
Christian Brabandt <cb@256bit.org>
parents: 8969
diff changeset
7642 |+termguicolors| feature}
773d627cac0b commit https://github.com/vim/vim/commit/61be73bb0f965a895bfb064ea3e55476ac175162
Christian Brabandt <cb@256bit.org>
parents: 8969
diff changeset
7643 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
7644 the terminal (thus using 24-bit color).
13341
acd7eaa13d2b Updated runtime files.
Christian Brabandt <cb@256bit.org>
parents: 13314
diff changeset
7645
13314
65c3e8259124 patch 8.0.1531: cannot use 24 bit colors in MS-Windows console
Christian Brabandt <cb@256bit.org>
parents: 13234
diff changeset
7646 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
7647 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
7648 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
7649
65c3e8259124 patch 8.0.1531: cannot use 24 bit colors in MS-Windows console
Christian Brabandt <cb@256bit.org>
parents: 13234
diff changeset
7650 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
7651 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
7652 if has('vcon')
13341
acd7eaa13d2b Updated runtime files.
Christian Brabandt <cb@256bit.org>
parents: 13314
diff changeset
7653 < This requires Vim to be built with the |+vtp| feature.
acd7eaa13d2b Updated runtime files.
Christian Brabandt <cb@256bit.org>
parents: 13314
diff changeset
7654
11473
bd6ff5246c71 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 11442
diff changeset
7655 Note that the "cterm" attributes are still used, not the "gui" ones.
11160
d0a20101ecb2 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 11063
diff changeset
7656 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
7657
13735
a62eeee5f116 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 13700
diff changeset
7658 *'termwinkey'* *'twk'*
a62eeee5f116 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 13700
diff changeset
7659 'termwinkey' 'twk' string (default "")
11659
49c12c93abf3 Updated runtime files and translations.
Christian Brabandt <cb@256bit.org>
parents: 11529
diff changeset
7660 local to window
11914
4f7081eb1e26 Updated runtime files
Christian Brabandt <cb@256bit.org>
parents: 11757
diff changeset
7661 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
7662 are sent to the job running in the window.
11914
4f7081eb1e26 Updated runtime files
Christian Brabandt <cb@256bit.org>
parents: 11757
diff changeset
7663 The <> notation can be used, e.g.: >
13735
a62eeee5f116 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 13700
diff changeset
7664 :set termwinkey=<C-L>
11914
4f7081eb1e26 Updated runtime files
Christian Brabandt <cb@256bit.org>
parents: 11757
diff changeset
7665 < The string must be one key stroke but can be multiple bytes.
4f7081eb1e26 Updated runtime files
Christian Brabandt <cb@256bit.org>
parents: 11757
diff changeset
7666 When not set CTRL-W is used, so that CTRL-W : gets you to the command
13735
a62eeee5f116 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 13700
diff changeset
7667 line. If 'termwinkey' is set to CTRL-L then CTRL-L : gets you to the
11914
4f7081eb1e26 Updated runtime files
Christian Brabandt <cb@256bit.org>
parents: 11757
diff changeset
7668 command line.
11659
49c12c93abf3 Updated runtime files and translations.
Christian Brabandt <cb@256bit.org>
parents: 11529
diff changeset
7669
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
7670 *'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
7671 '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
7672 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
7673 {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
7674 |+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
7675 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
7676 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
7677 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
7678
13735
a62eeee5f116 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 13700
diff changeset
7679 *'termwinsize'* *'tws'*
a62eeee5f116 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 13700
diff changeset
7680 'termwinsize' 'tws' string (default "")
11659
49c12c93abf3 Updated runtime files and translations.
Christian Brabandt <cb@256bit.org>
parents: 11529
diff changeset
7681 local to window
13700
b28d679b1843 patch 8.0.1722: cannot specify a minimal size for a terminal window
Christian Brabandt <cb@256bit.org>
parents: 13680
diff changeset
7682 Size of the |terminal| window. Format: {rows}x{columns} or
b28d679b1843 patch 8.0.1722: cannot specify a minimal size for a terminal window
Christian Brabandt <cb@256bit.org>
parents: 13680
diff changeset
7683 {rows}*{columns}.
11659
49c12c93abf3 Updated runtime files and translations.
Christian Brabandt <cb@256bit.org>
parents: 11529
diff changeset
7684 - 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
7685 - 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
7686 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
7687 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
7688 - 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
7689 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
7690 columns.
b28d679b1843 patch 8.0.1722: cannot specify a minimal size for a terminal window
Christian Brabandt <cb@256bit.org>
parents: 13680
diff changeset
7691 - 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
7692 - 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
7693 - Using "0x0" or "0*0" is the same as empty.
b28d679b1843 patch 8.0.1722: cannot specify a minimal size for a terminal window
Christian Brabandt <cb@256bit.org>
parents: 13680
diff changeset
7694
b28d679b1843 patch 8.0.1722: cannot specify a minimal size for a terminal window
Christian Brabandt <cb@256bit.org>
parents: 13680
diff changeset
7695 Examples:
b28d679b1843 patch 8.0.1722: cannot specify a minimal size for a terminal window
Christian Brabandt <cb@256bit.org>
parents: 13680
diff changeset
7696 "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
7697 "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
7698 "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
7699 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
7700 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
7701 adjusted to that size, if possible.
11659
49c12c93abf3 Updated runtime files and translations.
Christian Brabandt <cb@256bit.org>
parents: 11529
diff changeset
7702
15746
c017195b121b patch 8.1.0880: MS-Windows: inconsistent selection of winpty/conpty
Bram Moolenaar <Bram@vim.org>
parents: 15729
diff changeset
7703 *'termwintype'* *'twt'*
c017195b121b patch 8.1.0880: MS-Windows: inconsistent selection of winpty/conpty
Bram Moolenaar <Bram@vim.org>
parents: 15729
diff changeset
7704 '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
7705 global
c017195b121b patch 8.1.0880: MS-Windows: inconsistent selection of winpty/conpty
Bram Moolenaar <Bram@vim.org>
parents: 15729
diff changeset
7706 {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
7707 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
7708 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
7709 window.
c017195b121b patch 8.1.0880: MS-Windows: inconsistent selection of winpty/conpty
Bram Moolenaar <Bram@vim.org>
parents: 15729
diff changeset
7710
c017195b121b patch 8.1.0880: MS-Windows: inconsistent selection of winpty/conpty
Bram Moolenaar <Bram@vim.org>
parents: 15729
diff changeset
7711 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
7712 "" 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
7713 "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
7714 "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
7715
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
7716 |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
7717 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
7718 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
7719 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
7720 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
7721
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7722 *'terse'* *'noterse'*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7723 'terse' boolean (default off)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7724 global
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7725 When set: Add 's' flag to 'shortmess' option (this makes the message
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7726 for a search that hits the start or end of the file not being
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7727 displayed). When reset: Remove 's' flag from 'shortmess' option. {Vi
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7728 shortens a lot of messages}
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7729
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7730 *'textauto'* *'ta'* *'notextauto'* *'nota'*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7731 'textauto' 'ta' boolean (Vim default: on, Vi default: off)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7732 global
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7733 This option is obsolete. Use 'fileformats'.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7734 For backwards compatibility, when 'textauto' is set, 'fileformats' is
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7735 set to the default value for the current system. When 'textauto' is
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7736 reset, 'fileformats' is made empty.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7737 NOTE: This option is set to the Vi default value when 'compatible' is
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7738 set and to the Vim default value when 'compatible' is reset.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7739
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7740 *'textmode'* *'tx'* *'notextmode'* *'notx'*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7741 'textmode' 'tx' boolean (MS-DOS, Win32 and OS/2: default on,
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7742 others: default off)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7743 local to buffer
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7744 This option is obsolete. Use 'fileformat'.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7745 For backwards compatibility, when 'textmode' is set, 'fileformat' is
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7746 set to "dos". When 'textmode' is reset, 'fileformat' is set to
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7747 "unix".
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7748
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7749 *'textwidth'* *'tw'*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7750 'textwidth' 'tw' number (default 0)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7751 local to buffer
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7752 Maximum width of text that is being inserted. A longer line will be
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7753 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
7754 this.
c590de398af9 commit https://github.com/vim/vim/commit/ca63501fbcd1cf9c8aa9ff12c093c95b62a89ed7
Christian Brabandt <cb@256bit.org>
parents: 7080
diff changeset
7755 '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
7756 when 'paste' is reset.
c590de398af9 commit https://github.com/vim/vim/commit/ca63501fbcd1cf9c8aa9ff12c093c95b62a89ed7
Christian Brabandt <cb@256bit.org>
parents: 7080
diff changeset
7757 When 'textwidth' is zero, 'wrapmargin' may be used. See also
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7758 'formatoptions' and |ins-textwidth|.
838
8e5830943bff updated for version 7.0e04
vimboss
parents: 836
diff changeset
7759 When 'formatexpr' is set it will be used to break the line.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7760 NOTE: This option is set to 0 when 'compatible' is set.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7761
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7762 *'thesaurus'* *'tsr'*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7763 'thesaurus' 'tsr' string (default "")
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7764 global or local to buffer |global-local|
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7765 List of file names, separated by commas, that are used to lookup words
15033
f8b0f1e42f2c Update runtime files.
Bram Moolenaar <Bram@vim.org>
parents: 14999
diff changeset
7766 for thesaurus completion commands |i_CTRL-X_CTRL-T|.
f8b0f1e42f2c Update runtime files.
Bram Moolenaar <Bram@vim.org>
parents: 14999
diff changeset
7767
f8b0f1e42f2c Update runtime files.
Bram Moolenaar <Bram@vim.org>
parents: 14999
diff changeset
7768 Each line in the file should contain words with similar meaning,
f8b0f1e42f2c Update runtime files.
Bram Moolenaar <Bram@vim.org>
parents: 14999
diff changeset
7769 separated by non-keyword characters (white space is preferred).
f8b0f1e42f2c Update runtime files.
Bram Moolenaar <Bram@vim.org>
parents: 14999
diff changeset
7770 Maximum line length is 510 bytes.
f8b0f1e42f2c Update runtime files.
Bram Moolenaar <Bram@vim.org>
parents: 14999
diff changeset
7771
15131
bc1a8d21c811 Update runtime files.
Bram Moolenaar <Bram@vim.org>
parents: 15068
diff changeset
7772 An English word list was added to this github issue:
bc1a8d21c811 Update runtime files.
Bram Moolenaar <Bram@vim.org>
parents: 15068
diff changeset
7773 https://github.com/vim/vim/issues/629#issuecomment-443293282
bc1a8d21c811 Update runtime files.
Bram Moolenaar <Bram@vim.org>
parents: 15068
diff changeset
7774 Unpack thesaurus_pkg.zip, put the thesaurus.txt file somewhere, e.g.
bc1a8d21c811 Update runtime files.
Bram Moolenaar <Bram@vim.org>
parents: 15068
diff changeset
7775 ~/.vim/thesaurus/english.txt, and the 'thesaurus' option to this file
bc1a8d21c811 Update runtime files.
Bram Moolenaar <Bram@vim.org>
parents: 15068
diff changeset
7776 name.
15033
f8b0f1e42f2c Update runtime files.
Bram Moolenaar <Bram@vim.org>
parents: 14999
diff changeset
7777
10
4e2284e71352 updated for version 7.0002
vimboss
parents: 8
diff changeset
7778 To include a comma in a file name precede it with a backslash. Spaces
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7779 after a comma are ignored, otherwise spaces are included in the file
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7780 name. See |option-backslash| about using backslashes.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7781 The use of |:set+=| and |:set-=| is preferred when adding or removing
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7782 directories from the list. This avoids problems when a future version
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7783 uses another default.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7784 Backticks cannot be used in this option for security reasons.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7785
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7786 *'tildeop'* *'top'* *'notildeop'* *'notop'*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7787 'tildeop' 'top' boolean (default off)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7788 global
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7789 When on: The tilde command "~" behaves like an operator.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7790 NOTE: This option is reset when 'compatible' is set.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7791
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7792 *'timeout'* *'to'* *'notimeout'* *'noto'*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7793 'timeout' 'to' boolean (default on)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7794 global
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7795 *'ttimeout'* *'nottimeout'*
11400
0f8713fe20dc Updated runtime files.
Christian Brabandt <cb@256bit.org>
parents: 11262
diff changeset
7796 'ttimeout' boolean (default off, set in |defaults.vim|)
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7797 global
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7798 These two options together determine the behavior when part of a
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7799 mapped key sequence or keyboard code has been received:
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7800
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7801 'timeout' 'ttimeout' action ~
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7802 off off do not time out
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7803 on on or off time out on :mappings and key codes
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7804 off on time out on key codes
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7805
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7806 If both options are off, Vim will wait until either the complete
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7807 mapping or key sequence has been received, or it is clear that there
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7808 is no mapping or key sequence for the received characters. For
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7809 example: if you have mapped "vl" and Vim has received 'v', the next
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7810 character is needed to see if the 'v' is followed by an 'l'.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7811 When one of the options is on, Vim will wait for about 1 second for
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7812 the next character to arrive. After that the already received
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7813 characters are interpreted as single characters. The waiting time can
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7814 be changed with the 'timeoutlen' option.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7815 On slow terminals or very busy systems timing out may cause
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7816 malfunctioning cursor keys. If both options are off, Vim waits
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7817 forever after an entered <Esc> if there are key codes that start
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7818 with <Esc>. You will have to type <Esc> twice. If you do not have
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7819 problems with key codes, but would like to have :mapped key
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7820 sequences not timing out in 1 second, set the 'ttimeout' option and
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7821 reset the 'timeout' option.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7822
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7823 NOTE: 'ttimeout' is reset when 'compatible' is set.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7824
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7825 *'timeoutlen'* *'tm'*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7826 'timeoutlen' 'tm' number (default 1000)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7827 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
7828
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7829 *'ttimeoutlen'* *'ttm'*
11400
0f8713fe20dc Updated runtime files.
Christian Brabandt <cb@256bit.org>
parents: 11262
diff changeset
7830 'ttimeoutlen' 'ttm' number (default -1, set to 100 in |defaults.vim|)
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7831 global
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7832 The time in milliseconds that is waited for a key code or mapped key
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7833 sequence to complete. Also used for CTRL-\ CTRL-N and CTRL-\ CTRL-G
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7834 when part of a command has been typed.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7835 Normally only 'timeoutlen' is used and 'ttimeoutlen' is -1. When a
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7836 different timeout value for key codes is desired set 'ttimeoutlen' to
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7837 a non-negative number.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7838
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7839 ttimeoutlen mapping delay key code delay ~
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7840 < 0 'timeoutlen' 'timeoutlen'
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7841 >= 0 'timeoutlen' 'ttimeoutlen'
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7842
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7843 The timeout only happens when the 'timeout' and 'ttimeout' options
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7844 tell so. A useful setting would be >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7845 :set timeout timeoutlen=3000 ttimeoutlen=100
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7846 < (time out on mapping after three seconds, time out on key codes after
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7847 a tenth of a second).
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7848
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7849 *'title'* *'notitle'*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7850 'title' boolean (default off, on when title can be restored)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7851 global
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7852 {not available when compiled without the |+title|
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7853 feature}
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7854 When on, the title of the window will be set to the value of
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7855 'titlestring' (if it is not empty), or to:
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7856 filename [+=-] (path) - VIM
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7857 Where:
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7858 filename the name of the file being edited
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7859 - indicates the file cannot be modified, 'ma' off
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7860 + indicates the file was modified
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7861 = indicates the file is read-only
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7862 =+ indicates the file is read-only and modified
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7863 (path) is the path of the file being edited
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7864 - VIM the server name |v:servername| or "VIM"
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7865 Only works if the terminal supports setting window titles
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7866 (currently Amiga console, Win32 console, all GUI versions and
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7867 terminals with a non- empty 't_ts' option - these are Unix xterm and
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7868 iris-ansi by default, where 't_ts' is taken from the builtin termcap).
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7869 *X11*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7870 When Vim was compiled with HAVE_X11 defined, the original title will
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7871 be restored if possible. The output of ":version" will include "+X11"
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7872 when HAVE_X11 was defined, otherwise it will be "-X11". This also
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7873 works for the icon name |'icon'|.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7874 But: When Vim was started with the |-X| argument, restoring the title
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7875 will not work (except in the GUI).
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7876 If the title cannot be restored, it is set to the value of 'titleold'.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7877 You might want to restore the title outside of Vim then.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7878 When using an xterm from a remote machine you can use this command:
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7879 rsh machine_name xterm -display $DISPLAY &
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7880 then the WINDOWID environment variable should be inherited and the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7881 title of the window should change back to what it should be after
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7882 exiting Vim.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7883
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7884 *'titlelen'*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7885 'titlelen' number (default 85)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7886 global
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7887 {not available when compiled without the |+title|
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7888 feature}
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7889 Gives the percentage of 'columns' to use for the length of the window
10
4e2284e71352 updated for version 7.0002
vimboss
parents: 8
diff changeset
7890 title. When the title is longer, only the end of the path name is
4e2284e71352 updated for version 7.0002
vimboss
parents: 8
diff changeset
7891 shown. A '<' character before the path name is used to indicate this.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7892 Using a percentage makes this adapt to the width of the window. But
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7893 it won't work perfectly, because the actual number of characters
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7894 available also depends on the font used and other things in the title
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7895 bar. When 'titlelen' is zero the full path is used. Otherwise,
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7896 values from 1 to 30000 percent can be used.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7897 'titlelen' is also used for the 'titlestring' option.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7898
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7899 *'titleold'*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7900 'titleold' string (default "Thanks for flying Vim")
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7901 global
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7902 {only available when compiled with the |+title|
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7903 feature}
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7904 This option will be used for the window title when exiting Vim if the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7905 original title cannot be restored. Only happens if 'title' is on or
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7906 'titlestring' is not empty.
36
125e80798a85 updated for version 7.0021
vimboss
parents: 33
diff changeset
7907 This option cannot be set from a |modeline| or in the |sandbox|, for
125e80798a85 updated for version 7.0021
vimboss
parents: 33
diff changeset
7908 security reasons.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7909 *'titlestring'*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7910 'titlestring' string (default "")
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7911 global
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7912 {not available when compiled without the |+title|
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7913 feature}
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7914 When this option is not empty, it will be used for the title of the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7915 window. This happens only when the 'title' option is on.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7916 Only works if the terminal supports setting window titles (currently
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7917 Amiga console, Win32 console, all GUI versions and terminals with a
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7918 non-empty 't_ts' option).
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7919 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
7920 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
7921
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7922 When this option contains printf-style '%' items, they will be
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7923 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
7924 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
7925
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7926 Example: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7927 :auto BufEnter * let &titlestring = hostname() . "/" . expand("%:p")
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7928 :set title titlestring=%<%F%=%l/%L-%P titlelen=70
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7929 < The value of 'titlelen' is used to align items in the middle or right
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7930 of the available space.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7931 Some people prefer to have the file name first: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7932 :set titlestring=%t%(\ %M%)%(\ (%{expand(\"%:~:.:h\")})%)%(\ %a%)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7933 < Note the use of "%{ }" and an expression to get the path of the file,
10
4e2284e71352 updated for version 7.0002
vimboss
parents: 8
diff changeset
7934 without the file name. The "%( %)" constructs are used to add a
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7935 separating space only when needed.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7936 NOTE: Use of special characters in 'titlestring' may cause the display
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7937 to be garbled (e.g., when it contains a CR or NL character).
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7938 {not available when compiled without the |+statusline| feature}
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7939
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7940 *'toolbar'* *'tb'*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7941 'toolbar' 'tb' string (default "icons,tooltips")
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7942 global
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7943 {only for |+GUI_GTK|, |+GUI_Athena|, |+GUI_Motif| and
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7944 |+GUI_Photon|}
10
4e2284e71352 updated for version 7.0002
vimboss
parents: 8
diff changeset
7945 The contents of this option controls various toolbar settings. The
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7946 possible values are:
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7947 icons Toolbar buttons are shown with icons.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7948 text Toolbar buttons shown with text.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7949 horiz Icon and text of a toolbar button are
10
4e2284e71352 updated for version 7.0002
vimboss
parents: 8
diff changeset
7950 horizontally arranged. {only in GTK+ 2 GUI}
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7951 tooltips Tooltips are active for toolbar buttons.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7952 Tooltips refer to the popup help text which appears after the mouse
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7953 cursor is placed over a toolbar button for a brief moment.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7954
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7955 If you want the toolbar to be shown with icons as well as text, do the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7956 following: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7957 :set tb=icons,text
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7958 < Motif and Athena cannot display icons and text at the same time. They
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7959 will show icons if both are requested.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7960
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7961 If none of the strings specified in 'toolbar' are valid or if
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7962 'toolbar' is empty, this option is ignored. If you want to disable
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7963 the toolbar, you need to set the 'guioptions' option. For example: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7964 :set guioptions-=T
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7965 < Also see |gui-toolbar|.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7966
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7967 *'toolbariconsize'* *'tbis'*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7968 'toolbariconsize' 'tbis' string (default "small")
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7969 global
10895
c391bfbdb452 Updated runtime files.
Christian Brabandt <cb@256bit.org>
parents: 10734
diff changeset
7970 {only in the GTK+ GUI}
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7971 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
7972 tiny Use tiny icons.
da01d5da2cfa commit https://github.com/vim/vim/commit/77cdfd10382e01cc51f4ba1a9177032351843151
Christian Brabandt <cb@256bit.org>
parents: 8246
diff changeset
7973 small Use small icons (default).
da01d5da2cfa commit https://github.com/vim/vim/commit/77cdfd10382e01cc51f4ba1a9177032351843151
Christian Brabandt <cb@256bit.org>
parents: 8246
diff changeset
7974 medium Use medium-sized icons.
da01d5da2cfa commit https://github.com/vim/vim/commit/77cdfd10382e01cc51f4ba1a9177032351843151
Christian Brabandt <cb@256bit.org>
parents: 8246
diff changeset
7975 large Use large icons.
da01d5da2cfa commit https://github.com/vim/vim/commit/77cdfd10382e01cc51f4ba1a9177032351843151
Christian Brabandt <cb@256bit.org>
parents: 8246
diff changeset
7976 huge Use even larger icons.
da01d5da2cfa commit https://github.com/vim/vim/commit/77cdfd10382e01cc51f4ba1a9177032351843151
Christian Brabandt <cb@256bit.org>
parents: 8246
diff changeset
7977 giant Use very big icons.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7978 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
7979 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
7980 large=24x24, medium=24x24, small=20x20 and tiny=16x16.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7981
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7982 If 'toolbariconsize' is empty, the global default size as determined
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7983 by user preferences or the current theme is used.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7984
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7985 *'ttybuiltin'* *'tbi'* *'nottybuiltin'* *'notbi'*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7986 'ttybuiltin' 'tbi' boolean (default on)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7987 global
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7988 When on, the builtin termcaps are searched before the external ones.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7989 When off the builtin termcaps are searched after the external ones.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7990 When this option is changed, you should set the 'term' option next for
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7991 the change to take effect, for example: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7992 :set notbi term=$TERM
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7993 < See also |termcap|.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7994 Rationale: The default for this option is "on", because the builtin
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7995 termcap entries are generally better (many systems contain faulty
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7996 xterm entries...).
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7997
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7998 *'ttyfast'* *'tf'* *'nottyfast'* *'notf'*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7999 'ttyfast' 'tf' boolean (default off, on when 'term' is xterm, hpterm,
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8000 sun-cmd, screen, rxvt, dtterm or
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8001 iris-ansi; also on when running Vim in
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8002 a DOS console)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8003 global
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8004 Indicates a fast terminal connection. More characters will be sent to
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8005 the screen for redrawing, instead of using insert/delete line
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8006 commands. Improves smoothness of redrawing when there are multiple
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8007 windows and the terminal does not support a scrolling region.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8008 Also enables the extra writing of characters at the end of each screen
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8009 line for lines that wrap. This helps when using copy/paste with the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8010 mouse in an xterm and other terminals.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8011
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8012 *'ttymouse'* *'ttym'*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8013 'ttymouse' 'ttym' string (default depends on 'term')
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8014 global
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8015 {only in Unix and VMS, doesn't work in the GUI; not
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8016 available when compiled without |+mouse|}
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8017 Name of the terminal type for which mouse codes are to be recognized.
1213
8906c10ecbb0 updated for version 7.1b
vimboss
parents: 1152
diff changeset
8018 Currently these strings are valid:
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8019 *xterm-mouse*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8020 xterm xterm-like mouse handling. The mouse generates
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8021 "<Esc>[Mscr", where "scr" is three bytes:
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8022 "s" = button state
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8023 "c" = column plus 33
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8024 "r" = row plus 33
5908
32de51778c27 Update runtime files.
Bram Moolenaar <bram@vim.org>
parents: 5862
diff changeset
8025 This only works up to 223 columns! See "dec",
32de51778c27 Update runtime files.
Bram Moolenaar <bram@vim.org>
parents: 5862
diff changeset
8026 "urxvt", and "sgr" for solutions.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8027 xterm2 Works like "xterm", but with the xterm reporting the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8028 mouse position while the mouse is dragged. This works
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8029 much faster and more precise. Your xterm must at
180
7e70fc748752 updated for version 7.0056
vimboss
parents: 179
diff changeset
8030 least at patchlevel 88 / XFree 3.3.3 for this to
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8031 work. See below for how Vim detects this
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8032 automatically.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8033 *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
8034 netterm NetTerm mouse handling. A left mouse click generates
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8035 "<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
8036 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
8037 supported.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8038 *dec-mouse*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8039 dec DEC terminal mouse handling. The mouse generates a
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8040 rather complex sequence, starting with "<Esc>[".
189
504c627f7474 updated for version 7.0057
vimboss
parents: 180
diff changeset
8041 This is also available for an Xterm, if it was
504c627f7474 updated for version 7.0057
vimboss
parents: 180
diff changeset
8042 configured with "--enable-dec-locator".
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8043 *jsbterm-mouse*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8044 jsbterm JSB term mouse handling.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8045 *pterm-mouse*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8046 pterm QNX pterm mouse handling.
3224
8b8ef1fed009 Update runtime files.
Bram Moolenaar <bram@vim.org>
parents: 3153
diff changeset
8047 *urxvt-mouse*
8b8ef1fed009 Update runtime files.
Bram Moolenaar <bram@vim.org>
parents: 3153
diff changeset
8048 urxvt Mouse handling for the urxvt (rxvt-unicode) terminal.
5908
32de51778c27 Update runtime files.
Bram Moolenaar <bram@vim.org>
parents: 5862
diff changeset
8049 The mouse works only if the terminal supports this
32de51778c27 Update runtime files.
Bram Moolenaar <bram@vim.org>
parents: 5862
diff changeset
8050 encoding style, but it does not have 223 columns limit
32de51778c27 Update runtime files.
Bram Moolenaar <bram@vim.org>
parents: 5862
diff changeset
8051 unlike "xterm" or "xterm2".
3750
536aa8b0c934 Update runtime files.
Bram Moolenaar <bram@vim.org>
parents: 3746
diff changeset
8052 *sgr-mouse*
536aa8b0c934 Update runtime files.
Bram Moolenaar <bram@vim.org>
parents: 3746
diff changeset
8053 sgr Mouse handling for the terminal that emits SGR-styled
5908
32de51778c27 Update runtime files.
Bram Moolenaar <bram@vim.org>
parents: 5862
diff changeset
8054 mouse reporting. The mouse works even in columns
32de51778c27 Update runtime files.
Bram Moolenaar <bram@vim.org>
parents: 5862
diff changeset
8055 beyond 223. This option is backward compatible with
32de51778c27 Update runtime files.
Bram Moolenaar <bram@vim.org>
parents: 5862
diff changeset
8056 "xterm2" because it can also decode "xterm2" style
32de51778c27 Update runtime files.
Bram Moolenaar <bram@vim.org>
parents: 5862
diff changeset
8057 mouse codes.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8058
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8059 The mouse handling must be enabled at compile time |+mouse_xterm|
5908
32de51778c27 Update runtime files.
Bram Moolenaar <bram@vim.org>
parents: 5862
diff changeset
8060 |+mouse_dec| |+mouse_netterm| |+mouse_jsbterm| |+mouse_urxvt|
32de51778c27 Update runtime files.
Bram Moolenaar <bram@vim.org>
parents: 5862
diff changeset
8061 |+mouse_sgr|.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8062 Only "xterm"(2) is really recognized. NetTerm mouse codes are always
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8063 recognized, if enabled at compile time. DEC terminal mouse codes
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8064 are recognized if enabled at compile time, and 'ttymouse' is not
5908
32de51778c27 Update runtime files.
Bram Moolenaar <bram@vim.org>
parents: 5862
diff changeset
8065 "xterm", "xterm2", "urxvt" or "sgr" (because dec mouse codes conflict
32de51778c27 Update runtime files.
Bram Moolenaar <bram@vim.org>
parents: 5862
diff changeset
8066 with them).
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8067 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
8068 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
8069 "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
8070 already.
5908
32de51778c27 Update runtime files.
Bram Moolenaar <bram@vim.org>
parents: 5862
diff changeset
8071 Additionally, if vim is compiled with the |+termresponse| feature and
32de51778c27 Update runtime files.
Bram Moolenaar <bram@vim.org>
parents: 5862
diff changeset
8072 |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
8073 number, more intelligent detection is done.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8074 The "xterm2" value will be set if the xterm version is reported to be
15131
bc1a8d21c811 Update runtime files.
Bram Moolenaar <Bram@vim.org>
parents: 15068
diff changeset
8075 from 95 to 276. The "sgr" value will be set if Vim detects Mac
bc1a8d21c811 Update runtime files.
Bram Moolenaar <Bram@vim.org>
parents: 15068
diff changeset
8076 Terminal.app, iTerm2 or mintty, and when the xterm version is 277 or
bc1a8d21c811 Update runtime files.
Bram Moolenaar <Bram@vim.org>
parents: 15068
diff changeset
8077 higher.
5908
32de51778c27 Update runtime files.
Bram Moolenaar <bram@vim.org>
parents: 5862
diff changeset
8078 If you do not want 'ttymouse' to be set to "xterm2" or "sgr"
32de51778c27 Update runtime files.
Bram Moolenaar <bram@vim.org>
parents: 5862
diff changeset
8079 automatically, set t_RV to an empty string: >
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8080 :set t_RV=
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8081 <
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8082 *'ttyscroll'* *'tsl'*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8083 'ttyscroll' 'tsl' number (default 999)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8084 global
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8085 Maximum number of lines to scroll the screen. If there are more lines
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8086 to scroll the window is redrawn. For terminals where scrolling is
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8087 very slow and redrawing is not slow this can be set to a small number,
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8088 e.g., 3, to speed up displaying.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8089
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8090 *'ttytype'* *'tty'*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8091 'ttytype' 'tty' string (default from $TERM)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8092 global
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8093 Alias for 'term', see above.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8094
2214
f8222d1f9a73 Included patch for persistent undo. Lots of changes and added test.
Bram Moolenaar <bram@vim.org>
parents: 2209
diff changeset
8095 *'undodir'* *'udir'*
f8222d1f9a73 Included patch for persistent undo. Lots of changes and added test.
Bram Moolenaar <bram@vim.org>
parents: 2209
diff changeset
8096 '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
8097 global
2570
71b56b4e7785 Make the references to features in the help more consistent. (Sylvain Hitier)
Bram Moolenaar <bram@vim.org>
parents: 2561
diff changeset
8098 {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
8099 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
8100 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
8101 "." 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
8102 "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
8103 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
8104 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
8105 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
8106 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
8107 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
8108 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
8109 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
8110 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
8111 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
8112 security reasons.
2214
f8222d1f9a73 Included patch for persistent undo. Lots of changes and added test.
Bram Moolenaar <bram@vim.org>
parents: 2209
diff changeset
8113
4681
2eb30f341e8d Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents: 4502
diff changeset
8114 *'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
8115 '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
8116 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
8117 {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
8118 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
8119 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
8120 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
8121 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
8122 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
8123 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
8124 before a reload to be saved for undo.
3920
c53344bacabf Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 3893
diff changeset
8125 When 'undofile' is turned off the undo file is NOT deleted.
11160
d0a20101ecb2 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 11063
diff changeset
8126 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
8127
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8128 *'undolevels'* *'ul'*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8129 'undolevels' 'ul' number (default 100, 1000 for Unix, VMS,
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8130 Win32 and OS/2)
5446
d0595545e98a updated for version 7.4.073
Bram Moolenaar <bram@vim.org>
parents: 5340
diff changeset
8131 global or local to buffer |global-local|
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8132 Maximum number of changes that can be undone. Since undo information
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8133 is kept in memory, higher numbers will cause more memory to be used
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8134 (nevertheless, a single change can use an unlimited amount of memory).
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8135 Set to 0 for Vi compatibility: One level of undo and "u" undoes
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8136 itself: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8137 set ul=0
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8138 < But you can also get Vi compatibility by including the 'u' flag in
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8139 '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
8140 Also see |undo-two-ways|.
5446
d0595545e98a updated for version 7.4.073
Bram Moolenaar <bram@vim.org>
parents: 5340
diff changeset
8141 Set to -1 for no undo at all. You might want to do this only for the
d0595545e98a updated for version 7.4.073
Bram Moolenaar <bram@vim.org>
parents: 5340
diff changeset
8142 current buffer: >
d0595545e98a updated for version 7.4.073
Bram Moolenaar <bram@vim.org>
parents: 5340
diff changeset
8143 setlocal ul=-1
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8144 < This helps when you run out of memory for a single change.
6336
4abac79c0b7a Update runtime files.
Bram Moolenaar <bram@vim.org>
parents: 6328
diff changeset
8145
4abac79c0b7a Update runtime files.
Bram Moolenaar <bram@vim.org>
parents: 6328
diff changeset
8146 The local value is set to -123456 when the global value is to be used.
4abac79c0b7a Update runtime files.
Bram Moolenaar <bram@vim.org>
parents: 6328
diff changeset
8147
2249
6d3d35ff2c2b Use full path in undofile(). Updated docs.
Bram Moolenaar <bram@vim.org>
parents: 2240
diff changeset
8148 Also see |clear-undo|.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8149
2394
a3aca345aafa Add the 'undoreload' option to be able to undo a file reload.
Bram Moolenaar <bram@vim.org>
parents: 2382
diff changeset
8150 *'undoreload'* *'ur'*
a3aca345aafa Add the 'undoreload' option to be able to undo a file reload.
Bram Moolenaar <bram@vim.org>
parents: 2382
diff changeset
8151 '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
8152 global
a3aca345aafa Add the 'undoreload' option to be able to undo a file reload.
Bram Moolenaar <bram@vim.org>
parents: 2382
diff changeset
8153 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
8154 ":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
8155 Vim. |FileChangedShell|
12559
34c8ec888122 Update runtime files
Christian Brabandt <cb@256bit.org>
parents: 12499
diff changeset
8156 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
8157 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
8158 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
8159
a3aca345aafa Add the 'undoreload' option to be able to undo a file reload.
Bram Moolenaar <bram@vim.org>
parents: 2382
diff changeset
8160 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
8161
a3aca345aafa Add the 'undoreload' option to be able to undo a file reload.
Bram Moolenaar <bram@vim.org>
parents: 2382
diff changeset
8162 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
8163 this option to a lower value if you run out of memory.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8164
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8165 *'updatecount'* *'uc'*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8166 'updatecount' 'uc' number (default: 200)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8167 global
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8168 After typing this many characters the swap file will be written to
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8169 disk. When zero, no swap file will be created at all (see chapter on
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8170 recovery |crash-recovery|). 'updatecount' is set to zero by starting
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8171 Vim with the "-n" option, see |startup|. When editing in readonly
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8172 mode this option will be initialized to 10000.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8173 The swapfile can be disabled per buffer with |'swapfile'|.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8174 When 'updatecount' is set from zero to non-zero, swap files are
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8175 created for all buffers that have 'swapfile' set. When 'updatecount'
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8176 is set to zero, existing swap files are not deleted.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8177 Also see |'swapsync'|.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8178 This option has no meaning in buffers where |'buftype'| is "nofile"
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8179 or "nowrite".
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8180
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8181 *'updatetime'* *'ut'*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8182 'updatetime' 'ut' number (default 4000)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8183 global
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8184 If this many milliseconds nothing is typed the swap file will be
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8185 written to disk (see |crash-recovery|). Also used for the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8186 |CursorHold| autocommand event.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8187
14175
2ad722003b36 patch 8.1.0105: all tab stops are the same
Christian Brabandt <cb@256bit.org>
parents: 14019
diff changeset
8188 *'varsofttabstop'* *'vsts'*
2ad722003b36 patch 8.1.0105: all tab stops are the same
Christian Brabandt <cb@256bit.org>
parents: 14019
diff changeset
8189 'varsofttabstop' 'vsts' string (default "")
2ad722003b36 patch 8.1.0105: all tab stops are the same
Christian Brabandt <cb@256bit.org>
parents: 14019
diff changeset
8190 local to buffer
2ad722003b36 patch 8.1.0105: all tab stops are the same
Christian Brabandt <cb@256bit.org>
parents: 14019
diff changeset
8191 {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
8192 feature}
2ad722003b36 patch 8.1.0105: all tab stops are the same
Christian Brabandt <cb@256bit.org>
parents: 14019
diff changeset
8193 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
8194 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
8195 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
8196 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
8197 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
8198
2ad722003b36 patch 8.1.0105: all tab stops are the same
Christian Brabandt <cb@256bit.org>
parents: 14019
diff changeset
8199 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
8200 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
8201 to use the following: >
2ad722003b36 patch 8.1.0105: all tab stops are the same
Christian Brabandt <cb@256bit.org>
parents: 14019
diff changeset
8202 :set varsofttabstop=8,32,8
14249
4543777545a3 Updated runtime and language files.
Christian Brabandt <cb@256bit.org>
parents: 14175
diff changeset
8203 < 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
8204 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
8205
2ad722003b36 patch 8.1.0105: all tab stops are the same
Christian Brabandt <cb@256bit.org>
parents: 14019
diff changeset
8206 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
8207 'varsofttabstop' is set.
2ad722003b36 patch 8.1.0105: all tab stops are the same
Christian Brabandt <cb@256bit.org>
parents: 14019
diff changeset
8208
2ad722003b36 patch 8.1.0105: all tab stops are the same
Christian Brabandt <cb@256bit.org>
parents: 14019
diff changeset
8209 *'vartabstop'* *'vts'*
2ad722003b36 patch 8.1.0105: all tab stops are the same
Christian Brabandt <cb@256bit.org>
parents: 14019
diff changeset
8210 'vartabstop' 'vts' string (default "")
2ad722003b36 patch 8.1.0105: all tab stops are the same
Christian Brabandt <cb@256bit.org>
parents: 14019
diff changeset
8211 local to buffer
2ad722003b36 patch 8.1.0105: all tab stops are the same
Christian Brabandt <cb@256bit.org>
parents: 14019
diff changeset
8212 {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
8213 feature}
2ad722003b36 patch 8.1.0105: all tab stops are the same
Christian Brabandt <cb@256bit.org>
parents: 14019
diff changeset
8214 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
8215 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
8216 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
8217 :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
8218 < 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
8219 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
8220
2ad722003b36 patch 8.1.0105: all tab stops are the same
Christian Brabandt <cb@256bit.org>
parents: 14019
diff changeset
8221 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
8222 is set.
2ad722003b36 patch 8.1.0105: all tab stops are the same
Christian Brabandt <cb@256bit.org>
parents: 14019
diff changeset
8223
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8224 *'verbose'* *'vbs'*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8225 'verbose' 'vbs' number (default 0)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8226 global
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8227 When bigger than zero, Vim will give messages about what it is doing.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8228 Currently, these messages are given:
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8229 >= 1 When the viminfo file is read or written.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8230 >= 2 When a file is ":source"'ed.
712
2e887dfa8917 updated for version 7.0214
vimboss
parents: 707
diff changeset
8231 >= 5 Every searched tags file and include file.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8232 >= 8 Files for which a group of autocommands is executed.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8233 >= 9 Every executed autocommand.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8234 >= 12 Every executed function.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8235 >= 13 When an exception is thrown, caught, finished, or discarded.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8236 >= 14 Anything pending in a ":finally" clause.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8237 >= 15 Every executed Ex command (truncated at 200 characters).
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8238
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8239 This option can also be set with the "-V" argument. See |-V|.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8240 This option is also set by the |:verbose| command.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8241
293
f811be6fa9b5 updated for version 7.0077
vimboss
parents: 236
diff changeset
8242 When the 'verbosefile' option is set then the verbose messages are not
f811be6fa9b5 updated for version 7.0077
vimboss
parents: 236
diff changeset
8243 displayed.
f811be6fa9b5 updated for version 7.0077
vimboss
parents: 236
diff changeset
8244
f811be6fa9b5 updated for version 7.0077
vimboss
parents: 236
diff changeset
8245 *'verbosefile'* *'vfile'*
f811be6fa9b5 updated for version 7.0077
vimboss
parents: 236
diff changeset
8246 'verbosefile' 'vfile' string (default empty)
f811be6fa9b5 updated for version 7.0077
vimboss
parents: 236
diff changeset
8247 global
f811be6fa9b5 updated for version 7.0077
vimboss
parents: 236
diff changeset
8248 When not empty all messages are written in a file with this name.
f811be6fa9b5 updated for version 7.0077
vimboss
parents: 236
diff changeset
8249 When the file exists messages are appended.
f811be6fa9b5 updated for version 7.0077
vimboss
parents: 236
diff changeset
8250 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
8251 empty. Writes are buffered, thus may not show up for some time.
293
f811be6fa9b5 updated for version 7.0077
vimboss
parents: 236
diff changeset
8252 Setting 'verbosefile' to a new value is like making it empty first.
f811be6fa9b5 updated for version 7.0077
vimboss
parents: 236
diff changeset
8253 The difference with |:redir| is that verbose messages are not
f811be6fa9b5 updated for version 7.0077
vimboss
parents: 236
diff changeset
8254 displayed when 'verbosefile' is set.
f811be6fa9b5 updated for version 7.0077
vimboss
parents: 236
diff changeset
8255
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8256 *'viewdir'* *'vdir'*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8257 'viewdir' 'vdir' string (default for Amiga, MS-DOS, OS/2 and Win32:
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8258 "$VIM/vimfiles/view",
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8259 for Unix: "~/.vim/view",
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8260 for Macintosh: "$VIM:vimfiles:view"
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8261 for VMS: "sys$login:vimfiles/view"
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8262 for RiscOS: "Choices:vimfiles/view")
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8263 global
2570
71b56b4e7785 Make the references to features in the help more consistent. (Sylvain Hitier)
Bram Moolenaar <bram@vim.org>
parents: 2561
diff changeset
8264 {not available when compiled without the |+mksession|
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8265 feature}
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8266 Name of the directory where to store files for |:mkview|.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8267 This option cannot be set from a |modeline| or in the |sandbox|, for
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8268 security reasons.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8269
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8270 *'viewoptions'* *'vop'*
12824
79a754456110 patch 8.0.1289: mkview always includes the local directory
Christian Brabandt <cb@256bit.org>
parents: 12802
diff changeset
8271 'viewoptions' 'vop' string (default: "folds,options,cursor,curdir")
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8272 global
2570
71b56b4e7785 Make the references to features in the help more consistent. (Sylvain Hitier)
Bram Moolenaar <bram@vim.org>
parents: 2561
diff changeset
8273 {not available when compiled without the |+mksession|
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8274 feature}
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8275 Changes the effect of the |:mkview| command. It is a comma separated
10
4e2284e71352 updated for version 7.0002
vimboss
parents: 8
diff changeset
8276 list of words. Each word enables saving and restoring something:
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8277 word save and restore ~
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8278 cursor cursor position in file and in window
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8279 folds manually created folds, opened/closed folds and local
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8280 fold options
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8281 options options and mappings local to a window or buffer (not
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8282 global values for local options)
6213
37c24033b260 Update runtime files.
Bram Moolenaar <bram@vim.org>
parents: 6153
diff changeset
8283 localoptions same as "options"
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8284 slash backslashes in file names replaced with forward
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8285 slashes
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8286 unix with Unix end-of-line format (single <NL>), even when
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8287 on Windows or DOS
12824
79a754456110 patch 8.0.1289: mkview always includes the local directory
Christian Brabandt <cb@256bit.org>
parents: 12802
diff changeset
8288 curdir the window-local directory, if set with `:lcd`
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8289
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8290 "slash" and "unix" are useful on Windows when sharing view files
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8291 with Unix. The Unix version of Vim cannot source dos format scripts,
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8292 but the Windows version of Vim can source unix format scripts.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8293
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8294 *'viminfo'* *'vi'* *E526* *E527* *E528*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8295 'viminfo' 'vi' string (Vi default: "", Vim default for MS-DOS,
2033
de5a43c5eedc Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents: 1904
diff changeset
8296 Windows and OS/2: '100,<50,s10,h,rA:,rB:,
de5a43c5eedc Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents: 1904
diff changeset
8297 for Amiga: '100,<50,s10,h,rdf0:,rdf1:,rdf2:
de5a43c5eedc Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents: 1904
diff changeset
8298 for others: '100,<50,s10,h)
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8299 global
2570
71b56b4e7785 Make the references to features in the help more consistent. (Sylvain Hitier)
Bram Moolenaar <bram@vim.org>
parents: 2561
diff changeset
8300 {not available when compiled without the |+viminfo|
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8301 feature}
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8302 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
8303 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
8304 "NONE".
5cd9ba96561d patch 8.0.0716: not easy to start Vim cleanly
Christian Brabandt <cb@256bit.org>
parents: 11659
diff changeset
8305 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
8306 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
8307 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
8308 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
8309 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
8310 identifying characters and the effect of their value.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8311 CHAR VALUE ~
3224
8b8ef1fed009 Update runtime files.
Bram Moolenaar <bram@vim.org>
parents: 3153
diff changeset
8312 *viminfo-!*
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8313 ! When included, save and restore global variables that start
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8314 with an uppercase letter, and don't contain a lowercase
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8315 letter. Thus "KEEPTHIS and "K_L_M" are stored, but "KeepThis"
2607
2f57d93bdbf6 updated for version 7.3.030
Bram Moolenaar <bram@vim.org>
parents: 2587
diff changeset
8316 and "_K_L_M" are not. Nested List and Dict items may not be
2642
840c3cadb842 Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 2625
diff changeset
8317 read back correctly, you end up with an empty item.
3224
8b8ef1fed009 Update runtime files.
Bram Moolenaar <bram@vim.org>
parents: 3153
diff changeset
8318 *viminfo-quote*
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8319 " Maximum number of lines saved for each register. Old name of
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8320 the '<' item, with the disadvantage that you need to put a
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8321 backslash before the ", otherwise it will be recognized as the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8322 start of a comment!
3224
8b8ef1fed009 Update runtime files.
Bram Moolenaar <bram@vim.org>
parents: 3153
diff changeset
8323 *viminfo-%*
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8324 % When included, save and restore the buffer list. If Vim is
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8325 started with a file name argument, the buffer list is not
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8326 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
8327 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
8328 ('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
8329 removable media (|viminfo-r|) are not saved.
23
3f44e9abe4ec updated for version 7.0015
vimboss
parents: 22
diff changeset
8330 When followed by a number, the number specifies the maximum
3f44e9abe4ec updated for version 7.0015
vimboss
parents: 22
diff changeset
8331 number of buffers that are stored. Without a number all
3f44e9abe4ec updated for version 7.0015
vimboss
parents: 22
diff changeset
8332 buffers are stored.
3224
8b8ef1fed009 Update runtime files.
Bram Moolenaar <bram@vim.org>
parents: 3153
diff changeset
8333 *viminfo-'*
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8334 ' Maximum number of previously edited files for which the marks
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8335 are remembered. This parameter must always be included when
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8336 'viminfo' is non-empty.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8337 Including this item also means that the |jumplist| and the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8338 |changelist| are stored in the viminfo file.
3224
8b8ef1fed009 Update runtime files.
Bram Moolenaar <bram@vim.org>
parents: 3153
diff changeset
8339 *viminfo-/*
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8340 / Maximum number of items in the search pattern history to be
10
4e2284e71352 updated for version 7.0002
vimboss
parents: 8
diff changeset
8341 saved. If non-zero, then the previous search and substitute
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8342 patterns are also saved. When not included, the value of
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8343 'history' is used.
3224
8b8ef1fed009 Update runtime files.
Bram Moolenaar <bram@vim.org>
parents: 3153
diff changeset
8344 *viminfo-:*
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8345 : Maximum number of items in the command-line history to be
10
4e2284e71352 updated for version 7.0002
vimboss
parents: 8
diff changeset
8346 saved. When not included, the value of 'history' is used.
3224
8b8ef1fed009 Update runtime files.
Bram Moolenaar <bram@vim.org>
parents: 3153
diff changeset
8347 *viminfo-<*
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8348 < Maximum number of lines saved for each register. If zero then
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8349 registers are not saved. When not included, all lines are
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8350 saved. '"' is the old name for this item.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8351 Also see the 's' item below: limit specified in Kbyte.
3224
8b8ef1fed009 Update runtime files.
Bram Moolenaar <bram@vim.org>
parents: 3153
diff changeset
8352 *viminfo-@*
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8353 @ Maximum number of items in the input-line history to be
10
4e2284e71352 updated for version 7.0002
vimboss
parents: 8
diff changeset
8354 saved. When not included, the value of 'history' is used.
3224
8b8ef1fed009 Update runtime files.
Bram Moolenaar <bram@vim.org>
parents: 3153
diff changeset
8355 *viminfo-c*
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8356 c When included, convert the text in the viminfo file from the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8357 'encoding' used when writing the file to the current
233
fca8a9b65afa updated for version 7.0065
vimboss
parents: 227
diff changeset
8358 'encoding'. See |viminfo-encoding|.
3224
8b8ef1fed009 Update runtime files.
Bram Moolenaar <bram@vim.org>
parents: 3153
diff changeset
8359 *viminfo-f*
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8360 f Whether file marks need to be stored. If zero, file marks ('0
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8361 to '9, 'A to 'Z) are not stored. When not present or when
10
4e2284e71352 updated for version 7.0002
vimboss
parents: 8
diff changeset
8362 non-zero, they are all stored. '0 is used for the current
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8363 cursor position (when exiting or when doing ":wviminfo").
3224
8b8ef1fed009 Update runtime files.
Bram Moolenaar <bram@vim.org>
parents: 3153
diff changeset
8364 *viminfo-h*
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8365 h Disable the effect of 'hlsearch' when loading the viminfo
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8366 file. When not included, it depends on whether ":nohlsearch"
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8367 has been used since the last search command.
3224
8b8ef1fed009 Update runtime files.
Bram Moolenaar <bram@vim.org>
parents: 3153
diff changeset
8368 *viminfo-n*
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8369 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
8370 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
8371 '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
8372 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
8373 expanded when opening the file, not when setting the option.
3224
8b8ef1fed009 Update runtime files.
Bram Moolenaar <bram@vim.org>
parents: 3153
diff changeset
8374 *viminfo-r*
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8375 r Removable media. The argument is a string (up to the next
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8376 ','). This parameter can be given several times. Each
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8377 specifies the start of a path for which no marks will be
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8378 stored. This is to avoid removable media. For MS-DOS you
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8379 could use "ra:,rb:", for Amiga "rdf0:,rdf1:,rdf2:". You can
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8380 also use it for temp files, e.g., for Unix: "r/tmp". Case is
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8381 ignored. Maximum length of each 'r' argument is 50
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8382 characters.
3224
8b8ef1fed009 Update runtime files.
Bram Moolenaar <bram@vim.org>
parents: 3153
diff changeset
8383 *viminfo-s*
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8384 s Maximum size of an item in Kbyte. If zero then registers are
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8385 not saved. Currently only applies to registers. The default
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8386 "s10" will exclude registers with more than 10 Kbyte of text.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8387 Also see the '<' item above: line count limit.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8388
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8389 Example: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8390 :set viminfo='50,<1000,s100,:0,n~/vim/viminfo
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8391 <
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8392 '50 Marks will be remembered for the last 50 files you
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8393 edited.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8394 <1000 Contents of registers (up to 1000 lines each) will be
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8395 remembered.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8396 s100 Registers with more than 100 Kbyte text are skipped.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8397 :0 Command-line history will not be saved.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8398 n~/vim/viminfo The name of the file to use is "~/vim/viminfo".
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8399 no / Since '/' is not specified, the default will be used,
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8400 that is, save all of the search history, and also the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8401 previous search and substitute patterns.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8402 no % The buffer list will not be saved nor read back.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8403 no h 'hlsearch' highlighting will be restored.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8404
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8405 When setting 'viminfo' from an empty value you can use |:rviminfo| to
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8406 load the contents of the file, this is not done automatically.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8407
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8408 This option cannot be set from a |modeline| or in the |sandbox|, for
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8409 security reasons.
11160
d0a20101ecb2 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 11063
diff changeset
8410 NOTE: This option is set to the Vim default value when 'compatible'
d0a20101ecb2 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 11063
diff changeset
8411 is reset.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8412
11666
5cd9ba96561d patch 8.0.0716: not easy to start Vim cleanly
Christian Brabandt <cb@256bit.org>
parents: 11659
diff changeset
8413 *'viminfofile'* *'vif'*
5cd9ba96561d patch 8.0.0716: not easy to start Vim cleanly
Christian Brabandt <cb@256bit.org>
parents: 11659
diff changeset
8414 'viminfofile' 'vif' string (default: "")
5cd9ba96561d patch 8.0.0716: not easy to start Vim cleanly
Christian Brabandt <cb@256bit.org>
parents: 11659
diff changeset
8415 global
5cd9ba96561d patch 8.0.0716: not easy to start Vim cleanly
Christian Brabandt <cb@256bit.org>
parents: 11659
diff changeset
8416 {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
8417 feature}
5cd9ba96561d patch 8.0.0716: not easy to start Vim cleanly
Christian Brabandt <cb@256bit.org>
parents: 11659
diff changeset
8418 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
8419 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
8420 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
8421 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
8422 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
8423 security reasons.
11666
5cd9ba96561d patch 8.0.0716: not easy to start Vim cleanly
Christian Brabandt <cb@256bit.org>
parents: 11659
diff changeset
8424
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8425 *'virtualedit'* *'ve'*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8426 'virtualedit' 've' string (default "")
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8427 global
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8428 {not available when compiled without the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8429 |+virtualedit| feature}
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8430 A comma separated list of these words:
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8431 block Allow virtual editing in Visual block mode.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8432 insert Allow virtual editing in Insert mode.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8433 all Allow virtual editing in all modes.
772
aaaca5077255 updated for version 7.0226
vimboss
parents: 766
diff changeset
8434 onemore Allow the cursor to move just past the end of the line
782
d20041a02ee5 updated for version 7.0228
vimboss
parents: 777
diff changeset
8435
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8436 Virtual editing means that the cursor can be positioned where there is
1263
57361514f73a updated for version 7.1
vimboss
parents: 1213
diff changeset
8437 no actual character. This can be halfway into a tab or beyond the end
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8438 of the line. Useful for selecting a rectangle in Visual mode and
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8439 editing a table.
772
aaaca5077255 updated for version 7.0226
vimboss
parents: 766
diff changeset
8440 "onemore" is not the same, it will only allow moving the cursor just
aaaca5077255 updated for version 7.0226
vimboss
parents: 766
diff changeset
8441 after the last character of the line. This makes some commands more
aaaca5077255 updated for version 7.0226
vimboss
parents: 766
diff changeset
8442 consistent. Previously the cursor was always past the end of the line
aaaca5077255 updated for version 7.0226
vimboss
parents: 766
diff changeset
8443 if the line was empty. But it is far from Vi compatible. It may also
782
d20041a02ee5 updated for version 7.0228
vimboss
parents: 777
diff changeset
8444 break some plugins or Vim scripts. For example because |l| can move
d20041a02ee5 updated for version 7.0228
vimboss
parents: 777
diff changeset
8445 the cursor after the last character. Use with care!
5220
050893d44c33 Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 5161
diff changeset
8446 Using the `$` command will move to the last character in the line, not
782
d20041a02ee5 updated for version 7.0228
vimboss
parents: 777
diff changeset
8447 past it. This may actually move the cursor to the left!
5220
050893d44c33 Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 5161
diff changeset
8448 The `g$` command will move to the end of the screen line.
772
aaaca5077255 updated for version 7.0226
vimboss
parents: 766
diff changeset
8449 It doesn't make sense to combine "all" with "onemore", but you will
aaaca5077255 updated for version 7.0226
vimboss
parents: 766
diff changeset
8450 not get a warning for it.
11160
d0a20101ecb2 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 11063
diff changeset
8451 NOTE: This option is set to "" when 'compatible' is set.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8452
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8453 *'visualbell'* *'vb'* *'novisualbell'* *'novb'* *beep*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8454 'visualbell' 'vb' boolean (default off)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8455 global
11659
49c12c93abf3 Updated runtime files and translations.
Christian Brabandt <cb@256bit.org>
parents: 11529
diff changeset
8456 Use a visual bell instead of beeping. The terminal code to display the
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8457 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
8458 use: >
49c12c93abf3 Updated runtime files and translations.
Christian Brabandt <cb@256bit.org>
parents: 11529
diff changeset
8459 :set vb t_vb=
49c12c93abf3 Updated runtime files and translations.
Christian Brabandt <cb@256bit.org>
parents: 11529
diff changeset
8460 < 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
8461 :set vb t_vb=[?5h$<100>[?5l
49c12c93abf3 Updated runtime files and translations.
Christian Brabandt <cb@256bit.org>
parents: 11529
diff changeset
8462 < 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
8463 to get a shorter or longer flash.
49c12c93abf3 Updated runtime files and translations.
Christian Brabandt <cb@256bit.org>
parents: 11529
diff changeset
8464
49c12c93abf3 Updated runtime files and translations.
Christian Brabandt <cb@256bit.org>
parents: 11529
diff changeset
8465 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
8466 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
8467 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
8468 set.
49c12c93abf3 Updated runtime files and translations.
Christian Brabandt <cb@256bit.org>
parents: 11529
diff changeset
8469
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8470 In the GUI, 't_vb' defaults to "<Esc>|f", which inverts the display
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8471 for 20 msec. If you want to use a different time, use "<Esc>|40f",
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8472 where 40 is the time in msec.
11659
49c12c93abf3 Updated runtime files and translations.
Christian Brabandt <cb@256bit.org>
parents: 11529
diff changeset
8473
49c12c93abf3 Updated runtime files and translations.
Christian Brabandt <cb@256bit.org>
parents: 11529
diff changeset
8474 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
8475 might want to set it again in your |gvimrc|.
49c12c93abf3 Updated runtime files and translations.
Christian Brabandt <cb@256bit.org>
parents: 11529
diff changeset
8476
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8477 Does not work on the Amiga, you always get a screen flash.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8478 Also see 'errorbells'.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8479
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8480 *'warn'* *'nowarn'*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8481 'warn' boolean (default on)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8482 global
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8483 Give a warning message when a shell command is used while the buffer
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8484 has been changed.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8485
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8486 *'weirdinvert'* *'wiv'* *'noweirdinvert'* *'nowiv'*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8487 'weirdinvert' 'wiv' boolean (default off)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8488 global
667
9090f866cd57 updated for version 7.0197
vimboss
parents: 665
diff changeset
8489 This option has the same effect as the 't_xs' terminal option.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8490 It is provided for backwards compatibility with version 4.x.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8491 Setting 'weirdinvert' has the effect of making 't_xs' non-empty, and
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8492 vice versa. Has no effect when the GUI is running.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8493
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8494 *'whichwrap'* *'ww'*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8495 'whichwrap' 'ww' string (Vim default: "b,s", Vi default: "")
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8496 global
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8497 Allow specified keys that move the cursor left/right to move to the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8498 previous/next line when the cursor is on the first/last character in
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8499 the line. Concatenate characters to allow this for these keys:
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8500 char key mode ~
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8501 b <BS> Normal and Visual
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8502 s <Space> Normal and Visual
712
2e887dfa8917 updated for version 7.0214
vimboss
parents: 707
diff changeset
8503 h "h" Normal and Visual (not recommended)
2e887dfa8917 updated for version 7.0214
vimboss
parents: 707
diff changeset
8504 l "l" Normal and Visual (not recommended)
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8505 < <Left> Normal and Visual
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8506 > <Right> Normal and Visual
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8507 ~ "~" Normal
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8508 [ <Left> Insert and Replace
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8509 ] <Right> Insert and Replace
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8510 For example: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8511 :set ww=<,>,[,]
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8512 < allows wrap only when cursor keys are used.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8513 When the movement keys are used in combination with a delete or change
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8514 operator, the <EOL> also counts for a character. This makes "3h"
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8515 different from "3dh" when the cursor crosses the end of a line. This
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8516 is also true for "x" and "X", because they do the same as "dl" and
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8517 "dh". If you use this, you may also want to use the mapping
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8518 ":map <BS> X" to make backspace delete the character in front of the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8519 cursor.
714
0f9f4761ad9c updated for version 7.0216
vimboss
parents: 712
diff changeset
8520 When 'l' is included and it is used after an operator at the end of a
0f9f4761ad9c updated for version 7.0216
vimboss
parents: 712
diff changeset
8521 line then it will not move to the next line. This makes "dl", "cl",
0f9f4761ad9c updated for version 7.0216
vimboss
parents: 712
diff changeset
8522 "yl" etc. work normally.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8523 NOTE: This option is set to the Vi default value when 'compatible' is
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8524 set and to the Vim default value when 'compatible' is reset.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8525
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8526 *'wildchar'* *'wc'*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8527 'wildchar' 'wc' number (Vim default: <Tab>, Vi default: CTRL-E)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8528 global
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8529 Character you have to type to start wildcard expansion in the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8530 command-line, as specified with 'wildmode'.
1621
82b5078be2dd updated for version 7.2a
vimboss
parents: 1564
diff changeset
8531 More info here: |cmdline-completion|.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8532 The character is not recognized when used inside a macro. See
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8533 'wildcharm' for that.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8534 Although 'wc' is a number option, you can set it to a special key: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8535 :set wc=<Esc>
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8536 < NOTE: This option is set to the Vi default value when 'compatible' is
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8537 set and to the Vim default value when 'compatible' is reset.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8538
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8539 *'wildcharm'* *'wcm'*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8540 'wildcharm' 'wcm' number (default: none (0))
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8541 global
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8542 'wildcharm' works exactly like 'wildchar', except that it is
233
fca8a9b65afa updated for version 7.0065
vimboss
parents: 227
diff changeset
8543 recognized when used inside a macro. You can find "spare" command-line
fca8a9b65afa updated for version 7.0065
vimboss
parents: 227
diff changeset
8544 keys suitable for this option by looking at |ex-edit-index|. Normally
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8545 you'll never actually type 'wildcharm', just use it in mappings that
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8546 automatically invoke completion mode, e.g.: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8547 :set wcm=<C-Z>
1621
82b5078be2dd updated for version 7.2a
vimboss
parents: 1564
diff changeset
8548 :cnoremap ss so $vim/sessions/*.vim<C-Z>
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8549 < Then after typing :ss you can use CTRL-P & CTRL-N.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8550
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8551 *'wildignore'* *'wig'*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8552 'wildignore' 'wig' string (default "")
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8553 global
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8554 {not available when compiled without the |+wildignore|
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8555 feature}
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8556 A list of file patterns. A file that matches with one of these
3682
11d40fc82f11 Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 3674
diff changeset
8557 patterns is ignored when expanding |wildcards|, completing file or
11d40fc82f11 Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 3674
diff changeset
8558 directory names, and influences the result of |expand()|, |glob()| and
11d40fc82f11 Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 3674
diff changeset
8559 |globpath()| unless a flag is passed to disable this.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8560 The pattern is used like with |:autocmd|, see |autocmd-patterns|.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8561 Also see 'suffixes'.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8562 Example: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8563 :set wildignore=*.o,*.obj
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8564 < The use of |:set+=| and |:set-=| is preferred when adding or removing
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8565 a pattern from the list. This avoids problems when a future version
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8566 uses another default.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8567
2652
b2a7d143abe2 updated for version 7.3.072
Bram Moolenaar <bram@vim.org>
parents: 2642
diff changeset
8568
2662
916c90b37ea9 Update runtime files.
Bram Moolenaar <bram@vim.org>
parents: 2654
diff changeset
8569 *'wildignorecase'* *'wic'* *'nowildignorecase'* *'nowic'*
2652
b2a7d143abe2 updated for version 7.3.072
Bram Moolenaar <bram@vim.org>
parents: 2642
diff changeset
8570 'wildignorecase' 'wic' boolean (default off)
b2a7d143abe2 updated for version 7.3.072
Bram Moolenaar <bram@vim.org>
parents: 2642
diff changeset
8571 global
b2a7d143abe2 updated for version 7.3.072
Bram Moolenaar <bram@vim.org>
parents: 2642
diff changeset
8572 When set case is ignored when completing file names and directories.
4242
edd0bc1f26bd updated for version 7.3.872
Bram Moolenaar <bram@vim.org>
parents: 4229
diff changeset
8573 Has no effect when 'fileignorecase' is set.
2652
b2a7d143abe2 updated for version 7.3.072
Bram Moolenaar <bram@vim.org>
parents: 2642
diff changeset
8574 Does not apply when the shell is used to expand wildcards, which
b2a7d143abe2 updated for version 7.3.072
Bram Moolenaar <bram@vim.org>
parents: 2642
diff changeset
8575 happens when there are special characters.
b2a7d143abe2 updated for version 7.3.072
Bram Moolenaar <bram@vim.org>
parents: 2642
diff changeset
8576
b2a7d143abe2 updated for version 7.3.072
Bram Moolenaar <bram@vim.org>
parents: 2642
diff changeset
8577
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8578 *'wildmenu'* *'wmnu'* *'nowildmenu'* *'nowmnu'*
9669
284b4eb307fc commit https://github.com/vim/vim/commit/8c08b5b569e2a9e9f63dea514591ecfa2d3bb392
Christian Brabandt <cb@256bit.org>
parents: 9665
diff changeset
8579 'wildmenu' 'wmnu' boolean (default off, set in |defaults.vim|)
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8580 global
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8581 {not available if compiled without the |+wildmenu|
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8582 feature}
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8583 When 'wildmenu' is on, command-line completion operates in an enhanced
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8584 mode. On pressing 'wildchar' (usually <Tab>) to invoke completion,
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8585 the possible matches are shown just above the command line, with the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8586 first match highlighted (overwriting the status line, if there is
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8587 one). Keys that show the previous/next match, such as <Tab> or
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8588 CTRL-P/CTRL-N, cause the highlight to move to the appropriate match.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8589 When 'wildmode' is used, "wildmenu" mode is used where "full" is
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8590 specified. "longest" and "list" do not start "wildmenu" mode.
4159
8b86b69546a9 Update runtime files.
Bram Moolenaar <bram@vim.org>
parents: 4119
diff changeset
8591 You can check the current mode with |wildmenumode()|.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8592 If there are more matches than can fit in the line, a ">" is shown on
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8593 the right and/or a "<" is shown on the left. The status line scrolls
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8594 as needed.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8595 The "wildmenu" mode is abandoned when a key is hit that is not used
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8596 for selecting a completion.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8597 While the "wildmenu" is active the following keys have special
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8598 meanings:
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8599
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8600 <Left> <Right> - select previous/next match (like CTRL-P/CTRL-N)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8601 <Down> - in filename/menu name completion: move into a
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8602 subdirectory or submenu.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8603 <CR> - in menu completion, when the cursor is just after a
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8604 dot: move into a submenu.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8605 <Up> - in filename/menu name completion: move up into
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8606 parent directory or parent menu.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8607
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8608 This makes the menus accessible from the console |console-menus|.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8609
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8610 If you prefer the <Left> and <Right> keys to move the cursor instead
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8611 of selecting a different match, use this: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8612 :cnoremap <Left> <Space><BS><Left>
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8613 :cnoremap <Right> <Space><BS><Right>
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8614 <
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8615 The "WildMenu" highlighting is used for displaying the current match
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8616 |hl-WildMenu|.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8617
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8618 *'wildmode'* *'wim'*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8619 'wildmode' 'wim' string (Vim default: "full")
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8620 global
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8621 Completion mode that is used for the character specified with
10
4e2284e71352 updated for version 7.0002
vimboss
parents: 8
diff changeset
8622 'wildchar'. It is a comma separated list of up to four parts. Each
1152
e1787f5b90da updated for version 7.1a
vimboss
parents: 1111
diff changeset
8623 part specifies what to do for each consecutive use of 'wildchar'. The
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8624 first part specifies the behavior for the first use of 'wildchar',
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8625 The second part for the second use, etc.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8626 These are the possible values for each part:
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8627 "" Complete only the first match.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8628 "full" Complete the next full match. After the last match,
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8629 the original string is used and then the first match
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8630 again.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8631 "longest" Complete till longest common string. If this doesn't
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8632 result in a longer string, use the next part.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8633 "longest:full" Like "longest", but also start 'wildmenu' if it is
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8634 enabled.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8635 "list" When more than one match, list all matches.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8636 "list:full" When more than one match, list all matches and
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8637 complete first match.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8638 "list:longest" When more than one match, list all matches and
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8639 complete till longest common string.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8640 When there is only a single match, it is fully completed in all cases.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8641
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8642 Examples: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8643 :set wildmode=full
233
fca8a9b65afa updated for version 7.0065
vimboss
parents: 227
diff changeset
8644 < Complete first full match, next match, etc. (the default) >
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8645 :set wildmode=longest,full
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8646 < Complete longest common string, then each full match >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8647 :set wildmode=list:full
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8648 < List all matches and complete each full match >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8649 :set wildmode=list,full
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8650 < List all matches without completing, then each full match >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8651 :set wildmode=longest,list
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8652 < Complete longest common string, then list alternatives.
1621
82b5078be2dd updated for version 7.2a
vimboss
parents: 1564
diff changeset
8653 More info here: |cmdline-completion|.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8654
40
f1d2a58883b9 updated for version 7.0024
vimboss
parents: 39
diff changeset
8655 *'wildoptions'* *'wop'*
f1d2a58883b9 updated for version 7.0024
vimboss
parents: 39
diff changeset
8656 'wildoptions' 'wop' string (default "")
f1d2a58883b9 updated for version 7.0024
vimboss
parents: 39
diff changeset
8657 global
f1d2a58883b9 updated for version 7.0024
vimboss
parents: 39
diff changeset
8658 {not available when compiled without the |+wildignore|
f1d2a58883b9 updated for version 7.0024
vimboss
parents: 39
diff changeset
8659 feature}
f1d2a58883b9 updated for version 7.0024
vimboss
parents: 39
diff changeset
8660 A list of words that change how command line completion is done.
f1d2a58883b9 updated for version 7.0024
vimboss
parents: 39
diff changeset
8661 Currently only one word is allowed:
f1d2a58883b9 updated for version 7.0024
vimboss
parents: 39
diff changeset
8662 tagfile When using CTRL-D to list matching tags, the kind of
856
8cd729851562 updated for version 7.0g
vimboss
parents: 853
diff changeset
8663 tag and the file of the tag is listed. Only one match
40
f1d2a58883b9 updated for version 7.0024
vimboss
parents: 39
diff changeset
8664 is displayed per line. Often used tag kinds are:
f1d2a58883b9 updated for version 7.0024
vimboss
parents: 39
diff changeset
8665 d #define
f1d2a58883b9 updated for version 7.0024
vimboss
parents: 39
diff changeset
8666 f function
f1d2a58883b9 updated for version 7.0024
vimboss
parents: 39
diff changeset
8667 Also see |cmdline-completion|.
f1d2a58883b9 updated for version 7.0024
vimboss
parents: 39
diff changeset
8668
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8669 *'winaltkeys'* *'wak'*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8670 'winaltkeys' 'wak' string (default "menu")
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8671 global
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8672 {only used in Win32, Motif, GTK and Photon GUI}
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8673 Some GUI versions allow the access to menu entries by using the ALT
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8674 key in combination with a character that appears underlined in the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8675 menu. This conflicts with the use of the ALT key for mappings and
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8676 entering special characters. This option tells what to do:
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8677 no Don't use ALT keys for menus. ALT key combinations can be
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8678 mapped, but there is no automatic handling. This can then be
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8679 done with the |:simalt| command.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8680 yes ALT key handling is done by the windowing system. ALT key
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8681 combinations cannot be mapped.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8682 menu Using ALT in combination with a character that is a menu
10
4e2284e71352 updated for version 7.0002
vimboss
parents: 8
diff changeset
8683 shortcut key, will be handled by the windowing system. Other
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8684 keys can be mapped.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8685 If the menu is disabled by excluding 'm' from 'guioptions', the ALT
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8686 key is never used for the menu.
36
125e80798a85 updated for version 7.0021
vimboss
parents: 33
diff changeset
8687 This option is not used for <F10>; on Win32 and with GTK <F10> will
125e80798a85 updated for version 7.0021
vimboss
parents: 33
diff changeset
8688 select the menu, unless it has been mapped.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8689
16778
eda4d65f232c patch 8.1.1391: no popup window support
Bram Moolenaar <Bram@vim.org>
parents: 16740
diff changeset
8690 *'wincolor'* *'wcr'*
eda4d65f232c patch 8.1.1391: no popup window support
Bram Moolenaar <Bram@vim.org>
parents: 16740
diff changeset
8691 'wincolor' 'wcr' string (default empty)
eda4d65f232c patch 8.1.1391: no popup window support
Bram Moolenaar <Bram@vim.org>
parents: 16740
diff changeset
8692 local to window
eda4d65f232c patch 8.1.1391: no popup window support
Bram Moolenaar <Bram@vim.org>
parents: 16740
diff changeset
8693 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
8694 color |hl-Normal|.
eda4d65f232c patch 8.1.1391: no popup window support
Bram Moolenaar <Bram@vim.org>
parents: 16740
diff changeset
8695
164
8b0ee9d57d7f updated for version 7.0050
vimboss
parents: 161
diff changeset
8696 *'window'* *'wi'*
8b0ee9d57d7f updated for version 7.0050
vimboss
parents: 161
diff changeset
8697 'window' 'wi' number (default screen height - 1)
8b0ee9d57d7f updated for version 7.0050
vimboss
parents: 161
diff changeset
8698 global
8b0ee9d57d7f updated for version 7.0050
vimboss
parents: 161
diff changeset
8699 Window height. Do not confuse this with the height of the Vim window,
8b0ee9d57d7f updated for version 7.0050
vimboss
parents: 161
diff changeset
8700 use 'lines' for that.
179
7fd70926e2e1 updated for version 7.0055
vimboss
parents: 170
diff changeset
8701 Used for |CTRL-F| and |CTRL-B| when there is only one window and the
7fd70926e2e1 updated for version 7.0055
vimboss
parents: 170
diff changeset
8702 value is smaller than 'lines' minus one. The screen will scroll
7fd70926e2e1 updated for version 7.0055
vimboss
parents: 170
diff changeset
8703 'window' minus two lines, with a minimum of one.
164
8b0ee9d57d7f updated for version 7.0050
vimboss
parents: 161
diff changeset
8704 When 'window' is equal to 'lines' minus one CTRL-F and CTRL-B scroll
8b0ee9d57d7f updated for version 7.0050
vimboss
parents: 161
diff changeset
8705 in a much smarter way, taking care of wrapping lines.
8b0ee9d57d7f updated for version 7.0050
vimboss
parents: 161
diff changeset
8706 When resizing the Vim window, the value is smaller than 1 or more than
8b0ee9d57d7f updated for version 7.0050
vimboss
parents: 161
diff changeset
8707 or equal to 'lines' it will be set to 'lines' minus 1.
8b0ee9d57d7f updated for version 7.0050
vimboss
parents: 161
diff changeset
8708
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8709 *'winheight'* *'wh'* *E591*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8710 'winheight' 'wh' number (default 1)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8711 global
2570
71b56b4e7785 Make the references to features in the help more consistent. (Sylvain Hitier)
Bram Moolenaar <bram@vim.org>
parents: 2561
diff changeset
8712 {not available when compiled without the |+windows|
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8713 feature}
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8714 Minimal number of lines for the current window. This is not a hard
10
4e2284e71352 updated for version 7.0002
vimboss
parents: 8
diff changeset
8715 minimum, Vim will use fewer lines if there is not enough room. If the
1621
82b5078be2dd updated for version 7.2a
vimboss
parents: 1564
diff changeset
8716 focus goes to a window that is smaller, its size is increased, at the
82b5078be2dd updated for version 7.2a
vimboss
parents: 1564
diff changeset
8717 cost of the height of other windows.
82b5078be2dd updated for version 7.2a
vimboss
parents: 1564
diff changeset
8718 Set 'winheight' to a small number for normal editing.
82b5078be2dd updated for version 7.2a
vimboss
parents: 1564
diff changeset
8719 Set it to 999 to make the current window fill most of the screen.
82b5078be2dd updated for version 7.2a
vimboss
parents: 1564
diff changeset
8720 Other windows will be only 'winminheight' high. This has the drawback
82b5078be2dd updated for version 7.2a
vimboss
parents: 1564
diff changeset
8721 that ":all" will create only two windows. To avoid "vim -o 1 2 3 4"
82b5078be2dd updated for version 7.2a
vimboss
parents: 1564
diff changeset
8722 to create only two windows, set the option after startup is done,
82b5078be2dd updated for version 7.2a
vimboss
parents: 1564
diff changeset
8723 using the |VimEnter| event: >
82b5078be2dd updated for version 7.2a
vimboss
parents: 1564
diff changeset
8724 au VimEnter * set winheight=999
82b5078be2dd updated for version 7.2a
vimboss
parents: 1564
diff changeset
8725 < Minimum value is 1.
82b5078be2dd updated for version 7.2a
vimboss
parents: 1564
diff changeset
8726 The height is not adjusted after one of the commands that change the
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8727 height of the current window.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8728 'winheight' applies to the current window. Use 'winminheight' to set
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8729 the minimal height for other windows.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8730
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8731 *'winfixheight'* *'wfh'* *'nowinfixheight'* *'nowfh'*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8732 'winfixheight' 'wfh' boolean (default off)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8733 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
8734 {not available when compiled without the |+windows|
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8735 feature}
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8736 Keep the window height when windows are opened or closed and
1152
e1787f5b90da updated for version 7.1a
vimboss
parents: 1111
diff changeset
8737 'equalalways' is set. Also for |CTRL-W_=|. Set by default for the
e1787f5b90da updated for version 7.1a
vimboss
parents: 1111
diff changeset
8738 |preview-window| and |quickfix-window|.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8739 The height may be changed anyway when running out of room.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8740
782
d20041a02ee5 updated for version 7.0228
vimboss
parents: 777
diff changeset
8741 *'winfixwidth'* *'wfw'* *'nowinfixwidth'* *'nowfw'*
d20041a02ee5 updated for version 7.0228
vimboss
parents: 777
diff changeset
8742 'winfixwidth' 'wfw' boolean (default off)
d20041a02ee5 updated for version 7.0228
vimboss
parents: 777
diff changeset
8743 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
8744 {not available when compiled without the |+windows|
782
d20041a02ee5 updated for version 7.0228
vimboss
parents: 777
diff changeset
8745 feature}
d20041a02ee5 updated for version 7.0228
vimboss
parents: 777
diff changeset
8746 Keep the window width when windows are opened or closed and
1152
e1787f5b90da updated for version 7.1a
vimboss
parents: 1111
diff changeset
8747 'equalalways' is set. Also for |CTRL-W_=|.
782
d20041a02ee5 updated for version 7.0228
vimboss
parents: 777
diff changeset
8748 The width may be changed anyway when running out of room.
d20041a02ee5 updated for version 7.0228
vimboss
parents: 777
diff changeset
8749
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8750 *'winminheight'* *'wmh'*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8751 'winminheight' 'wmh' number (default 1)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8752 global
2570
71b56b4e7785 Make the references to features in the help more consistent. (Sylvain Hitier)
Bram Moolenaar <bram@vim.org>
parents: 2561
diff changeset
8753 {not available when compiled without the |+windows|
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8754 feature}
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8755 The minimal height of a window, when it's not the current window.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8756 This is a hard minimum, windows will never become smaller.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8757 When set to zero, windows may be "squashed" to zero lines (i.e. just a
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8758 status bar) if necessary. They will return to at least one line when
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8759 they become active (since the cursor has to have somewhere to go.)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8760 Use 'winheight' to set the minimal height of the current window.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8761 This option is only checked when making a window smaller. Don't use a
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8762 large number, it will cause errors when opening more than a few
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8763 windows. A value of 0 to 3 is reasonable.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8764
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8765 *'winminwidth'* *'wmw'*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8766 'winminwidth' 'wmw' number (default 1)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8767 global
2570
71b56b4e7785 Make the references to features in the help more consistent. (Sylvain Hitier)
Bram Moolenaar <bram@vim.org>
parents: 2561
diff changeset
8768 {not available when compiled without the |+vertsplit|
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8769 feature}
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8770 The minimal width of a window, when it's not the current window.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8771 This is a hard minimum, windows will never become smaller.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8772 When set to zero, windows may be "squashed" to zero columns (i.e. just
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8773 a vertical separator) if necessary. They will return to at least one
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8774 line when they become active (since the cursor has to have somewhere
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8775 to go.)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8776 Use 'winwidth' to set the minimal width of the current window.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8777 This option is only checked when making a window smaller. Don't use a
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8778 large number, it will cause errors when opening more than a few
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8779 windows. A value of 0 to 12 is reasonable.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8780
12138
bee3751f3d4e patch 8.0.0949: winpty.dll name is fixed
Christian Brabandt <cb@256bit.org>
parents: 11914
diff changeset
8781 *'winptydll'*
bee3751f3d4e patch 8.0.0949: winpty.dll name is fixed
Christian Brabandt <cb@256bit.org>
parents: 11914
diff changeset
8782 '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
8783 global
bee3751f3d4e patch 8.0.0949: winpty.dll name is fixed
Christian Brabandt <cb@256bit.org>
parents: 11914
diff changeset
8784 {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
8785 feature on MS-Windows}
bee3751f3d4e patch 8.0.0949: winpty.dll name is fixed
Christian Brabandt <cb@256bit.org>
parents: 11914
diff changeset
8786 Specifies the name of the winpty shared library, used for the
bee3751f3d4e patch 8.0.0949: winpty.dll name is fixed
Christian Brabandt <cb@256bit.org>
parents: 11914
diff changeset
8787 |:terminal| command. The default depends on whether was build as a
12254
8d76a56861ec Update runtime files
Christian Brabandt <cb@256bit.org>
parents: 12138
diff changeset
8788 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
8789 a fallback.
bee3751f3d4e patch 8.0.0949: winpty.dll name is fixed
Christian Brabandt <cb@256bit.org>
parents: 11914
diff changeset
8790 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
8791 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
8792 security reasons.
bee3751f3d4e patch 8.0.0949: winpty.dll name is fixed
Christian Brabandt <cb@256bit.org>
parents: 11914
diff changeset
8793
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8794 *'winwidth'* *'wiw'* *E592*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8795 'winwidth' 'wiw' number (default 20)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8796 global
2570
71b56b4e7785 Make the references to features in the help more consistent. (Sylvain Hitier)
Bram Moolenaar <bram@vim.org>
parents: 2561
diff changeset
8797 {not available when compiled without the |+vertsplit|
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8798 feature}
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8799 Minimal number of columns for the current window. This is not a hard
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8800 minimum, Vim will use fewer columns if there is not enough room. If
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8801 the current window is smaller, its size is increased, at the cost of
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8802 the width of other windows. Set it to 999 to make the current window
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8803 always fill the screen. Set it to a small number for normal editing.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8804 The width is not adjusted after one of the commands to change the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8805 width of the current window.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8806 'winwidth' applies to the current window. Use 'winminwidth' to set
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8807 the minimal width for other windows.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8808
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8809 *'wrap'* *'nowrap'*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8810 'wrap' boolean (default on)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8811 local to window
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8812 This option changes how text is displayed. It doesn't change the text
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8813 in the buffer, see 'textwidth' for that.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8814 When on, lines longer than the width of the window will wrap and
10
4e2284e71352 updated for version 7.0002
vimboss
parents: 8
diff changeset
8815 displaying continues on the next line. When off lines will not wrap
4e2284e71352 updated for version 7.0002
vimboss
parents: 8
diff changeset
8816 and only part of long lines will be displayed. When the cursor is
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8817 moved to a part that is not shown, the screen will scroll
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8818 horizontally.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8819 The line will be broken in the middle of a word if necessary. See
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8820 'linebreak' to get the break at a word boundary.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8821 To make scrolling horizontally a bit more useful, try this: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8822 :set sidescroll=5
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8823 :set listchars+=precedes:<,extends:>
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8824 < See 'sidescroll', 'listchars' and |wrap-off|.
2033
de5a43c5eedc Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents: 1904
diff changeset
8825 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
8826 on.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8827
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8828 *'wrapmargin'* *'wm'*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8829 'wrapmargin' 'wm' number (default 0)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8830 local to buffer
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8831 Number of characters from the right window border where wrapping
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8832 starts. When typing text beyond this limit, an <EOL> will be inserted
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8833 and inserting continues on the next line.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8834 Options that add a margin, such as 'number' and 'foldcolumn', cause
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8835 the text width to be further reduced. This is Vi compatible.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8836 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
8837 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
8838 is reset.
16610
1eaf34420bb3 Update runtime files
Bram Moolenaar <Bram@vim.org>
parents: 16553
diff changeset
8839 See also 'formatoptions' and |ins-textwidth|.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8840
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8841 *'wrapscan'* *'ws'* *'nowrapscan'* *'nows'*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8842 'wrapscan' 'ws' boolean (default on) *E384* *E385*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8843 global
500
4772a5e3f9fa updated for version 7.0138
vimboss
parents: 493
diff changeset
8844 Searches wrap around the end of the file. Also applies to |]s| and
4772a5e3f9fa updated for version 7.0138
vimboss
parents: 493
diff changeset
8845 |[s|, searching for spelling mistakes.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8846
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8847 *'write'* *'nowrite'*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8848 'write' boolean (default on)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8849 global
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8850 Allows writing files. When not set, writing a file is not allowed.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8851 Can be used for a view-only mode, where modifications to the text are
10
4e2284e71352 updated for version 7.0002
vimboss
parents: 8
diff changeset
8852 still allowed. Can be reset with the |-m| or |-M| command line
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8853 argument. Filtering text is still possible, even though this requires
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8854 writing a temporary file.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8855
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8856 *'writeany'* *'wa'* *'nowriteany'* *'nowa'*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8857 'writeany' 'wa' boolean (default off)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8858 global
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8859 Allows writing to any file with no need for "!" override.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8860
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8861 *'writebackup'* *'wb'* *'nowritebackup'* *'nowb'*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8862 'writebackup' 'wb' boolean (default on with |+writebackup| feature, off
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8863 otherwise)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8864 global
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8865 Make a backup before overwriting a file. The backup is removed after
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8866 the file was successfully written, unless the 'backup' option is
3513
1b584a6f446c Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 3496
diff changeset
8867 also on.
1b584a6f446c Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 3496
diff changeset
8868 WARNING: Switching this option off means that when Vim fails to write
1b584a6f446c Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 3496
diff changeset
8869 your buffer correctly and then, for whatever reason, Vim exits, you
1b584a6f446c Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 3496
diff changeset
8870 lose both the original file and what you were writing. Only reset
1b584a6f446c Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 3496
diff changeset
8871 this option if your file system is almost full and it makes the write
1b584a6f446c Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 3496
diff changeset
8872 fail (and make sure not to exit Vim until the write was successful).
1b584a6f446c Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 3496
diff changeset
8873 See |backup-table| for another explanation.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8874 When the 'backupskip' pattern matches, a backup is not made anyway.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8875 NOTE: This option is set to the default value when 'compatible' is
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8876 set.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8877
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8878 *'writedelay'* *'wd'*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8879 'writedelay' 'wd' number (default 0)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8880 global
9344
33c1b85d408c commit https://github.com/vim/vim/commit/802a0d902fca423acb15f835d7b09183883d79a0
Christian Brabandt <cb@256bit.org>
parents: 9286
diff changeset
8881 The number of milliseconds to wait for each character sent to the
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8882 screen. When non-zero, characters are sent to the terminal one by
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8883 one. For MS-DOS pcterm this does not work. For debugging purposes.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8884
14421
2f7e67dd088c Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 14372
diff changeset
8885 vim:tw=78:ts=8:noet:ft=help:norl: